商圈会员积分服务授权查询
更新时间:2024.11.18通过此API,商圈商户/服务商可自行查询用户的商圈会员积分服务授权状态。
接口频率:150QPS
前置条件:商圈商户/服务商已开通支付即积分产品功能
接口说明
支持商户:【普通服务商】
请求方式:【GET】/v3/businesscircle/user-authorizations/{openid}
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
path 路径参数
openid 必填 string(64)
【顾客OpenID】顾客授权时使用的小程序上的OpenID
query 查询参数
sub_mchid 选填 string(64)
【商圈商户ID】当以服务商模式管理商圈积分能力时,则要带上商圈商户ID,否则留空
appid 必填 string(128)
【小程序AppID】顾客授权积分时使用的小程序的AppID
请求示例
GET
1curl -X GET \ 2 https://api.mch.weixin.qq.com/v3/businesscircle/user-authorizations/oWmnN4xxxxxxxxxxe92NHIGf1xd8?sub_mchid=1234567890&appid=wx1234567890abcdef \ 3 -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \ 4 -H "Accept: application/json" 5
需配合微信支付工具库 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 QueryUserAuthorization { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "GET"; 28 private static String PATH = "/v3/businesscircle/user-authorizations/{openid}"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 32 QueryUserAuthorization client = new QueryUserAuthorization( 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 QueryUserAuthorizationRequest request = new QueryUserAuthorizationRequest(); 41 request.openid = "oWmnN4xxxxxxxxxxe92NHIGf1xd8"; 42 request.subMchid = "1234567890"; 43 request.appid = "wx1234567890abcdef"; 44 try { 45 UserAuthorization response = client.run(request); 46 // TODO: 请求成功,继续业务逻辑 47 System.out.println(response); 48 } catch (WXPayUtility.ApiException e) { 49 // TODO: 请求失败,根据状态码执行不同的逻辑 50 e.printStackTrace(); 51 } 52 } 53 54 public UserAuthorization run(QueryUserAuthorizationRequest request) { 55 String uri = PATH; 56 uri = uri.replace("{openid}", WXPayUtility.urlEncode(request.openid)); 57 Map<String, Object> args = new HashMap<>(); 58 args.put("sub_mchid", request.subMchid); 59 args.put("appid", request.appid); 60 String queryString = WXPayUtility.urlEncode(args); 61 if (!queryString.isEmpty()) { 62 uri = uri + "?" + queryString; 63 } 64 65 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 66 reqBuilder.addHeader("Accept", "application/json"); 67 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 68 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo, privateKey, METHOD, uri, null)); 69 reqBuilder.method(METHOD, null); 70 Request httpRequest = reqBuilder.build(); 71 72 // 发送HTTP请求 73 OkHttpClient client = new OkHttpClient.Builder().build(); 74 try (Response httpResponse = client.newCall(httpRequest).execute()) { 75 String respBody = WXPayUtility.extractBody(httpResponse); 76 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 77 // 2XX 成功,验证应答签名 78 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 79 httpResponse.headers(), respBody); 80 81 // 从HTTP应答报文构建返回数据 82 return WXPayUtility.fromJson(respBody, UserAuthorization.class); 83 } else { 84 throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 85 } 86 } catch (IOException e) { 87 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 88 } 89 } 90 91 private final String mchid; 92 private final String certificateSerialNo; 93 private final PrivateKey privateKey; 94 private final String wechatPayPublicKeyId; 95 private final PublicKey wechatPayPublicKey; 96 97 public QueryUserAuthorization(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 98 this.mchid = mchid; 99 this.certificateSerialNo = certificateSerialNo; 100 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 101 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 102 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 103 } 104 105 public static class QueryUserAuthorizationRequest { 106 @SerializedName("sub_mchid") 107 @Expose(serialize = false) 108 public String subMchid; 109 110 @SerializedName("appid") 111 @Expose(serialize = false) 112 public String appid; 113 114 @SerializedName("openid") 115 @Expose(serialize = false) 116 public String openid; 117 } 118 119 public static class UserAuthorization { 120 @SerializedName("openid") 121 public String openid; 122 123 @SerializedName("authorize_state") 124 public AuthorizeState authorizeState; 125 126 @SerializedName("authorize_time") 127 public String authorizeTime; 128 129 @SerializedName("deauthorize_time") 130 public String deauthorizeTime; 131 } 132 133 public enum AuthorizeState { 134 @SerializedName("UNAUTHORIZED") 135 UNAUTHORIZED, 136 @SerializedName("AUTHORIZED") 137 AUTHORIZED, 138 @SerializedName("DEAUTHORIZED") 139 DEAUTHORIZED 140 } 141 142} 143
需配合微信支付工具库 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) 11 12func main() { 13 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 14 config, err := wxpay_utility.CreateMchConfig( 15 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340 16 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924 17 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 18 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589 19 "/path/to/wxp_pub.pem", // 微信支付公钥文件路径,本地文件路径 20 ) 21 if err != nil { 22 fmt.Println(err) 23 return 24 } 25 26 request := &QueryUserAuthorizationRequest{ 27 SubMchid: wxpay_utility.String("1234567890"), 28 Appid: wxpay_utility.String("wx1234567890abcdef"), 29 Openid: wxpay_utility.String("oWmnN4xxxxxxxxxxe92NHIGf1xd8"), 30 } 31 32 response, err := QueryUserAuthorization(config, request) 33 if err != nil { 34 fmt.Printf("请求失败: %+v\n", err) 35 // TODO: 请求失败,根据状态码执行不同的处理 36 return 37 } 38 39 // TODO: 请求成功,继续业务逻辑 40 fmt.Printf("请求成功: %+v\n", response) 41} 42 43func QueryUserAuthorization(config *wxpay_utility.MchConfig, request *QueryUserAuthorizationRequest) (response *UserAuthorization, err error) { 44 const ( 45 host = "https://api.mch.weixin.qq.com" 46 method = "GET" 47 path = "/v3/businesscircle/user-authorizations/{openid}" 48 ) 49 50 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 51 if err != nil { 52 return nil, err 53 } 54 reqUrl.Path = strings.Replace(reqUrl.Path, "{openid}", url.PathEscape(*request.Openid), -1) 55 query := reqUrl.Query() 56 if request.SubMchid != nil { 57 query.Add("sub_mchid", *request.SubMchid) 58 } 59 if request.Appid != nil { 60 query.Add("appid", *request.Appid) 61 } 62 reqUrl.RawQuery = query.Encode() 63 httpRequest, err := http.NewRequest(method, reqUrl.String(), nil) 64 if err != nil { 65 return nil, err 66 } 67 httpRequest.Header.Set("Accept", "application/json") 68 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 69 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), nil) 70 if err != nil { 71 return nil, err 72 } 73 httpRequest.Header.Set("Authorization", authorization) 74 75 client := &http.Client{} 76 httpResponse, err := client.Do(httpRequest) 77 if err != nil { 78 return nil, err 79 } 80 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 81 if err != nil { 82 return nil, err 83 } 84 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 85 // 2XX 成功,验证应答签名 86 err = wxpay_utility.ValidateResponse( 87 config.WechatPayPublicKeyId(), 88 config.WechatPayPublicKey(), 89 &httpResponse.Header, 90 respBody, 91 ) 92 if err != nil { 93 return nil, err 94 } 95 response := &UserAuthorization{} 96 if err := json.Unmarshal(respBody, response); err != nil { 97 return nil, err 98 } 99 100 return response, nil 101 } else { 102 return nil, wxpay_utility.NewApiException( 103 httpResponse.StatusCode, 104 httpResponse.Header, 105 respBody, 106 ) 107 } 108} 109 110type QueryUserAuthorizationRequest struct { 111 SubMchid *string `json:"sub_mchid,omitempty"` 112 Appid *string `json:"appid,omitempty"` 113 Openid *string `json:"openid,omitempty"` 114} 115 116func (o *QueryUserAuthorizationRequest) MarshalJSON() ([]byte, error) { 117 type Alias QueryUserAuthorizationRequest 118 a := &struct { 119 SubMchid *string `json:"sub_mchid,omitempty"` 120 Appid *string `json:"appid,omitempty"` 121 Openid *string `json:"openid,omitempty"` 122 *Alias 123 }{ 124 // 序列化时移除非 Body 字段 125 SubMchid: nil, 126 Appid: nil, 127 Openid: nil, 128 Alias: (*Alias)(o), 129 } 130 return json.Marshal(a) 131} 132 133type UserAuthorization struct { 134 Openid *string `json:"openid,omitempty"` 135 AuthorizeState *AuthorizeState `json:"authorize_state,omitempty"` 136 AuthorizeTime *string `json:"authorize_time,omitempty"` 137 DeauthorizeTime *string `json:"deauthorize_time,omitempty"` 138} 139 140type AuthorizeState string 141 142func (e AuthorizeState) Ptr() *AuthorizeState { 143 return &e 144} 145 146const ( 147 AUTHORIZESTATE_UNAUTHORIZED AuthorizeState = "UNAUTHORIZED" 148 AUTHORIZESTATE_AUTHORIZED AuthorizeState = "AUTHORIZED" 149 AUTHORIZESTATE_DEAUTHORIZED AuthorizeState = "DEAUTHORIZED" 150) 151
应答参数
|
openid 必填 string(64)
【顾客OpenID】顾客授权时使用的小程序上的OpenID
authorize_state 必填 string
【授权状态】顾客授权商圈积分结果,1."UNAUTHORIZED":未授权 ,2."AUTHORIZED":已授权 ,3."DEAUTHORIZED":已取消授权
可选取值:
UNAUTHORIZED
: 顾客无授权商圈进行支付即积分的记录
AUTHORIZED
: 顾客已授权商圈进行支付即积分的能力
DEAUTHORIZED
: 顾客已取消授权商圈进行支付即积分的能力
authorize_time 选填 string(32)
【授权时间】顾客成功授权商圈积分的时间
deauthorize_time 选填 string(32)
【取消授权时间】顾客关闭授权商圈积分的时间
应答示例
200 OK
1{ 2 "openid" : "oWmnN4xxxxxxxxxxe92NHIGf1xd8", 3 "authorize_state" : "UNAUTHORIZED", 4 "authorize_time" : "2020-05-20T13:29:35+08:00", 5 "deauthorize_time" : "2020-05-20T13:29:35+08:00" 6} 7
错误码
公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | INVALID_REQUEST | 当前请求服务商非商圈支付即积分服务商 | 请以商圈支付即积分功能的服务商身份调用 |
400 | PARAM_ERROR | 请求参数中AppID非商圈支付即积分配置的AppID | 请确保AppID为支付即积分配置的AppID |
400 | PARAM_ERROR | 请求参数中AppID和OpenID不匹配 | 请使用AppID匹配的OpenID调用 |
400 | PARAM_ERROR | 请求参数中AppID无效 | 请使用正确的AppID调用 |
400 | PARAM_ERROR | 请求参数中OpenID无效 | 请使用正确的OpenID调用 |