企业商户查询企业员工开通授权状态
更新时间:2025.05.09企业商户查询企业员工开通授权状态。该接口允许服务商查询指定出资子商户下特定员工的企业支付授权状态,包括授权状态、授权时间和解除授权时间等信息。服务商可通过此接口确认员工是否已开通企业支付功能,是后续发放额度卡的前提条件。
接口说明
支持商户:【普通服务商】
请求方式:【GET】/v3/webizpay/users/{user_id}/authorization-state
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
path 路径参数
user_id 必填 string(32)
【企业员工 ID】 商户企业员工ID,由企业系统提供的唯一标识员工的ID。要求6-32个字符内,只能是数字、大小写字母_-|* 且在同一个商户号下唯一。
query 查询参数
sp_mchid 必填 string(32)
【服务商商户号】 是由微信支付系统生成并分配给每个服务商的唯一标识符,具体请参考服务商模式开发必要参数说明。
sub_mchid 必填 string(32)
【出资子商户号】 由服务商为子商户进件后获取,具体请参考服务商模式开发必要参数说明。
请求示例
需配合微信支付工具库 WXPayUtility 使用,请参考 Java
1package com.java.demo; 2 3import com.java.utils.WXPayUtility; // 引用微信支付工具库,参考:https://pay.weixin.qq.com/doc/v3/partner/4014985777 4 5import com.google.gson.annotations.SerializedName; 6import com.google.gson.annotations.Expose; 7import okhttp3.MediaType; 8import okhttp3.OkHttpClient; 9import okhttp3.Request; 10import okhttp3.RequestBody; 11import okhttp3.Response; 12 13import java.io.IOException; 14import java.io.UncheckedIOException; 15import java.security.PrivateKey; 16import java.security.PublicKey; 17import java.util.ArrayList; 18import java.util.HashMap; 19import java.util.List; 20import java.util.Map; 21 22/** 23 * 企业商户查询企业员工开通授权状态 24 */ 25public class QueryAuthorizationState { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "GET"; 28 private static String PATH = "/v3/webizpay/users/{user_id}/authorization-state"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 32 QueryAuthorizationState client = new QueryAuthorizationState( 33 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340 34 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924 35 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 36 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589 37 "/path/to/wxp_pub.pem" // 微信支付公钥文件路径,本地文件路径 38 ); 39 40 QueryAuthorizationStateRequest request = new QueryAuthorizationStateRequest(); 41 request.userId = "123456"; 42 request.spMchid = "12341234"; 43 request.subMchid = "43214321"; 44 try { 45 UsersQueryAuthorizationStateResponse response = client.run(request); 46 47 // TODO: 请求成功,继续业务逻辑 48 System.out.println(response); 49 } catch (WXPayUtility.ApiException e) { 50 // TODO: 请求失败,根据状态码执行不同的逻辑 51 e.printStackTrace(); 52 } 53 } 54 55 public UsersQueryAuthorizationStateResponse run(QueryAuthorizationStateRequest request) { 56 String uri = PATH; 57 uri = uri.replace("{user_id}", WXPayUtility.urlEncode(request.userId)); 58 Map<String, Object> args = new HashMap<>(); 59 args.put("sp_mchid", request.spMchid); 60 args.put("sub_mchid", request.subMchid); 61 uri = uri + "?" + WXPayUtility.urlEncode(args); 62 63 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 64 reqBuilder.addHeader("Accept", "application/json"); 65 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 66 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo, privateKey, METHOD, uri, null)); 67 reqBuilder.method(METHOD, null); 68 Request httpRequest = reqBuilder.build(); 69 70 // 发送HTTP请求 71 OkHttpClient client = new OkHttpClient.Builder().build(); 72 try (Response httpResponse = client.newCall(httpRequest).execute()) { 73 String respBody = WXPayUtility.extractBody(httpResponse); 74 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 75 // 2XX 成功,验证应答签名 76 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 77 httpResponse.headers(), respBody); 78 79 // 从HTTP应答报文构建返回数据 80 return WXPayUtility.fromJson(respBody, UsersQueryAuthorizationStateResponse.class); 81 } else { 82 throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 83 } 84 } catch (IOException e) { 85 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 86 } 87 } 88 89 private final String mchid; 90 private final String certificateSerialNo; 91 private final PrivateKey privateKey; 92 private final String wechatPayPublicKeyId; 93 private final PublicKey wechatPayPublicKey; 94 95 public QueryAuthorizationState(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 96 this.mchid = mchid; 97 this.certificateSerialNo = certificateSerialNo; 98 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 99 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 100 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 101 } 102 103 public static class QueryAuthorizationStateRequest { 104 @SerializedName("sp_mchid") 105 @Expose(serialize = false) 106 public String spMchid; 107 108 @SerializedName("sub_mchid") 109 @Expose(serialize = false) 110 public String subMchid; 111 112 @SerializedName("user_id") 113 @Expose(serialize = false) 114 public String userId; 115 } 116 117 public static class UsersQueryAuthorizationStateResponse { 118 @SerializedName("sp_mchid") 119 public String spMchid; 120 121 @SerializedName("sub_mchid") 122 public String subMchid; 123 124 @SerializedName("user_id") 125 public String userId; 126 127 @SerializedName("employee_list") 128 public List<Employee> employeeList; 129 } 130 131 public static class Employee { 132 @SerializedName("employee_id") 133 public String employeeId; 134 135 @SerializedName("authorization_state") 136 public EmployeeState authorizationState; 137 138 @SerializedName("authorization_time") 139 public String authorizationTime; 140 141 @SerializedName("authorization_revoked_time") 142 public String authorizationRevokedTime; 143 } 144 145 public enum EmployeeState { 146 @SerializedName("AUTHORIZED") 147 AUTHORIZED, 148 @SerializedName("REVOKED") 149 REVOKED 150 } 151 152} 153
需配合微信支付工具库 wxpay_utility 使用,请参考 Go
1package main 2 3import ( 4 "demo/wxpay_utility" // 引用微信支付工具库,参考 https://pay.weixin.qq.com/doc/v3/partner/4015119446 5 "encoding/json" 6 "fmt" 7 "net/http" 8 "net/url" 9 "strings" 10 "time" 11) 12 13func main() { 14 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 15 config, err := wxpay_utility.CreateMchConfig( 16 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340 17 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924 18 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 19 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589 20 "/path/to/wxp_pub.pem", // 微信支付公钥文件路径,本地文件路径 21 ) 22 if err != nil { 23 fmt.Println(err) 24 return 25 } 26 27 request := &QueryAuthorizationStateRequest{ 28 SpMchid: wxpay_utility.String("12341234"), 29 SubMchid: wxpay_utility.String("43214321"), 30 UserId: wxpay_utility.String("123456"), 31 } 32 33 response, err := QueryAuthorizationState(config, request) 34 if err != nil { 35 fmt.Printf("请求失败: %+v\n", err) 36 // TODO: 请求失败,根据状态码执行不同的处理 37 return 38 } 39 40 // TODO: 请求成功,继续业务逻辑 41 fmt.Printf("请求成功: %+v\n", response) 42} 43 44func QueryAuthorizationState(config *wxpay_utility.MchConfig, request *QueryAuthorizationStateRequest) (response *UsersQueryAuthorizationStateResponse, err error) { 45 const ( 46 host = "https://api.mch.weixin.qq.com" 47 method = "GET" 48 path = "/v3/webizpay/users/{user_id}/authorization-state" 49 ) 50 51 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 52 if err != nil { 53 return nil, err 54 } 55 reqUrl.Path = strings.Replace(reqUrl.Path, "{user_id}", url.PathEscape(*request.UserId), -1) 56 query := reqUrl.Query() 57 query.Add("sp_mchid", *request.SpMchid) 58 query.Add("sub_mchid", *request.SubMchid) 59 reqUrl.RawQuery = query.Encode() 60 httpRequest, err := http.NewRequest(method, reqUrl.String(), nil) 61 if err != nil { 62 return nil, err 63 } 64 httpRequest.Header.Set("Accept", "application/json") 65 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 66 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), nil) 67 if err != nil { 68 return nil, err 69 } 70 httpRequest.Header.Set("Authorization", authorization) 71 72 client := &http.Client{} 73 httpResponse, err := client.Do(httpRequest) 74 if err != nil { 75 return nil, err 76 } 77 78 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 79 if err != nil { 80 return nil, err 81 } 82 83 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 84 // 2XX 成功,验证应答签名 85 err = wxpay_utility.ValidateResponse( 86 config.WechatPayPublicKeyId(), 87 config.WechatPayPublicKey(), 88 &httpResponse.Header, 89 respBody, 90 ) 91 if err != nil { 92 return nil, err 93 } 94 95 if err := json.Unmarshal(respBody, response); err != nil { 96 return nil, err 97 } 98 99 return response, nil 100 } else { 101 return nil, wxpay_utility.NewApiException( 102 httpResponse.StatusCode, 103 httpResponse.Header, 104 respBody, 105 ) 106 } 107} 108 109type QueryAuthorizationStateRequest struct { 110 SpMchid *string `json:"sp_mchid,omitempty"` 111 SubMchid *string `json:"sub_mchid,omitempty"` 112 UserId *string `json:"user_id,omitempty"` 113} 114 115func (o *QueryAuthorizationStateRequest) MarshalJSON() ([]byte, error) { 116 type Alias QueryAuthorizationStateRequest 117 a := &struct { 118 SpMchid *string `json:"sp_mchid,omitempty"` 119 SubMchid *string `json:"sub_mchid,omitempty"` 120 UserId *string `json:"user_id,omitempty"` 121 *Alias 122 }{ 123 // 序列化时移除非 Body 字段 124 SpMchid: nil, 125 SubMchid: nil, 126 UserId: nil, 127 Alias: (*Alias)(o), 128 } 129 return json.Marshal(a) 130} 131 132type UsersQueryAuthorizationStateResponse struct { 133 SpMchid *string `json:"sp_mchid,omitempty"` 134 SubMchid *string `json:"sub_mchid,omitempty"` 135 UserId *string `json:"user_id,omitempty"` 136 EmployeeList []Employee `json:"employee_list,omitempty"` 137} 138 139type Employee struct { 140 EmployeeId *string `json:"employee_id,omitempty"` 141 AuthorizationState *EmployeeState `json:"authorization_state,omitempty"` 142 AuthorizationTime *time.Time `json:"authorization_time,omitempty"` 143 AuthorizationRevokedTime *time.Time `json:"authorization_revoked_time,omitempty"` 144} 145 146type EmployeeState string 147 148func (e EmployeeState) Ptr() *EmployeeState { 149 return &e 150} 151 152const ( 153 EMPLOYEESTATE_AUTHORIZED EmployeeState = "AUTHORIZED" 154 EMPLOYEESTATE_REVOKED EmployeeState = "REVOKED" 155) 156
GET
1curl -X GET \ 2 https://api.mch.weixin.qq.com/v3/webizpay/users/123456/authorization-state?sp_mchid=12341234&sub_mchid=43214321 \ 3 -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \ 4 -H "Accept: application/json" 5
应答参数
200 OK
sp_mchid 必填 string(32)
【服务商商户号】 服务商商户号,具有企业支付服务商资质的微信支付商户号,由商户请求时传入
sub_mchid 必填 string(32)
【出资子商户号】 出资子商户号,企业支付的出资方商户号,由商户请求时传入
user_id 必填 string(32)
【商户企业员工ID】 商户企业员工ID,由企业系统提供的唯一标识员工的ID,由商户请求时传入
employee_list 选填 array[object]
【微信授权关系列表】 微信授权关系列表,包含该员工所有的微信企业支付授权关系,若此商户下,相同企业员工ID没有开通过企业支付,则数组长度为0
| 属性 | |
employee_id 必填 string(64) 【微信授权关系 ID】 微信授权关系ID,微信支付平台生成的唯一标识授权关系的ID,用于后续额度卡发放、注销等操作 authorization_state 必填 string 【授权状态】 授权状态,表示员工授权关系是否有效,包括已授权(AUTHORIZED)和已解除授权(REVOKED)两种状态 可选取值
authorization_time 必填 string 【授权时间】 授权时间,员工完成授权操作的时间。 authorization_revoked_time 必填 string 【解除授权时间】 解除授权时间,员工或企业解除授权的时间。 |
应答示例
200 OK
1{ 2 "sp_mchid" : "12341234", 3 "sub_mchid" : "43214321", 4 "user_id" : "employee123", 5 "employee_list" : [ 6 { 7 "employee_id" : "WeBizPay_a968402a-73bb-43e2-9e1a-8371b0ca3d7c", 8 "authorization_state" : "AUTHORIZED", 9 "authorization_time" : "2018-06-08T10:34:56+08:00", 10 "authorization_revoked_time" : "2018-06-08T10:34:56+08:00" 11 } 12 ] 13} 14
错误码
公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
|---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |

