查询用户会员卡信息

1curl -X GET \
2  https://api.mch.weixin.qq.com/brand/card-member/user-cards/478515832665?card_id=pbLatjvWOibDc5-TBnbUk1pD12o0&openid=obLatjnx9gnqzS4myYGmLZ7LgLBA \
3  -H "Authorization: WECHATPAY-BRAND-SHA256-RSA2048 brand_id=\"XXXX\",..." \
4  -H "Accept: application/json" \
5  -H "Wechatpay-Serial: PUB_KEY_ID_XXXX"  
6

1package com.java.demo;
2
3import com.java.utils.WXPayBrandUtility; // 引用微信支付工具库，参考：https://pay.weixin.qq.com/doc/brand/4015826861
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 GetUserCard {
26  private static String HOST = "https://api.mch.weixin.qq.com";
27  private static String METHOD = "GET";
28  private static String PATH = "/brand/card-member/user-cards/{user_card_code}";
29
30  public static void main(String[] args) {
31    // TODO: 请准备商户开发必要参数，参考：https://pay.weixin.qq.com/doc/brand/4015415289
32    GetUserCard client = new GetUserCard(
33      "xxxxxxxx",                    // 品牌ID，是由微信支付系统生成并分配给每个品牌方的唯一标识符，品牌ID获取方式参考 https://pay.weixin.qq.com/doc/brand/4015415289
34      "1DDE55AD98Exxxxxxxxxx",         // 品牌API证书序列号，如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015407570
35      "/path/to/apiclient_key.pem",     // 品牌API证书私钥文件路径，本地文件路径
36      "PUB_KEY_ID_xxxxxxxxxxxxx",      // 微信支付公钥ID，如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015453439
37      "/path/to/wxp_pub.pem"           // 微信支付公钥文件路径，本地文件路径
38    );
39
40    GetUserCardRequest request = new GetUserCardRequest();
41    request.userCardCode = "478515832665";
42    request.cardId = "pbLatjvWOibDc5-TBnbUk1pD12o0";
43    request.openid = "obLatjnx9gnqzS4myYGmLZ7LgLBA";
44    try {
45      UserCard response = client.run(request);
46        // TODO: 请求成功，继续业务逻辑
47        System.out.println(response);
48    } catch (WXPayBrandUtility.ApiException e) {
49        // TODO: 请求失败，根据状态码执行不同的逻辑
50        e.printStackTrace();
51    }
52  }
53
54  public UserCard run(GetUserCardRequest request) {
55    String uri = PATH;
56    uri = uri.replace("{user_card_code}", WXPayBrandUtility.urlEncode(request.userCardCode));
57    Map<String, Object> args = new HashMap<>();
58    args.put("card_id", request.cardId);
59    args.put("openid", request.openid);
60    String queryString = WXPayBrandUtility.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", WXPayBrandUtility.buildAuthorization(brand_id, 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 = WXPayBrandUtility.extractBody(httpResponse);
76      if (httpResponse.code() >= 200 && httpResponse.code() < 300) {
77        // 2XX 成功，验证应答签名
78        WXPayBrandUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey,
79            httpResponse.headers(), respBody);
80
81        // 从HTTP应答报文构建返回数据
82        return WXPayBrandUtility.fromJson(respBody, UserCard.class);
83      } else {
84        throw new WXPayBrandUtility.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 brand_id;
92  private final String certificateSerialNo;
93  private final PrivateKey privateKey;
94  private final String wechatPayPublicKeyId;
95  private final PublicKey wechatPayPublicKey;
96
97  public GetUserCard(String brand_id, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) {
98    this.brand_id = brand_id;
99    this.certificateSerialNo = certificateSerialNo;
100    this.privateKey = WXPayBrandUtility.loadPrivateKeyFromPath(privateKeyFilePath);
101    this.wechatPayPublicKeyId = wechatPayPublicKeyId;
102    this.wechatPayPublicKey = WXPayBrandUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath);
103  }
104
105  public static class GetUserCardRequest {
106    @SerializedName("card_id")
107    @Expose(serialize = false)
108    public String cardId;
109  
110    @SerializedName("user_card_code")
111    @Expose(serialize = false)
112    public String userCardCode;
113  
114    @SerializedName("openid")
115    @Expose(serialize = false)
116    public String openid;
117  }
118  
119  public static class UserCard {
120    @SerializedName("user_card_code")
121    public String userCardCode;
122  
123    @SerializedName("card_id")
124    public String cardId;
125  
126    @SerializedName("openid")
127    public String openid;
128  
129    @SerializedName("card_color")
130    public String cardColor;
131  
132    @SerializedName("card_picture_url")
133    public String cardPictureUrl;
134  
135    @SerializedName("brand_id")
136    public String brandId;
137  
138    @SerializedName("card_type")
139    public CardType cardType;
140  
141    @SerializedName("phone_number")
142    public String phoneNumber;
143  
144    @SerializedName("level")
145    public String level;
146  
147    @SerializedName("valid_date_information")
148    public DateInfo validDateInformation;
149  
150    @SerializedName("pickup_time")
151    public String pickupTime;
152  
153    @SerializedName("user_information")
154    public UserInfo userInformation;
155  
156    @SerializedName("attach")
157    public String attach;
158  
159    @SerializedName("user_card_state")
160    public UserCardState userCardState;
161  
162    @SerializedName("invalid_reason")
163    public String invalidReason;
164  
165    @SerializedName("invalid_time")
166    public String invalidTime;
167  
168    @SerializedName("create_time")
169    public String createTime;
170  
171    @SerializedName("modify_time")
172    public String modifyTime;
173  }
174  
175  public enum CardType {
176    @SerializedName("PURCHASE")
177    PURCHASE,
178    @SerializedName("NORMAL")
179    NORMAL,
180    @SerializedName("BALANCE")
181    BALANCE
182  }
183  
184  public static class DateInfo {
185    @SerializedName("type")
186    public DateType type;
187  
188    @SerializedName("available_begin_time")
189    public String availableBeginTime;
190  
191    @SerializedName("available_end_time")
192    public String availableEndTime;
193  
194    @SerializedName("available_day_after_receive")
195    public Long availableDayAfterReceive;
196  }
197  
198  public static class UserInfo {
199    @SerializedName("common_field_list")
200    public List<UserInfoCommonField> commonFieldList;
201  
202    @SerializedName("custom_field_list")
203    public List<UserInfoCustomField> customFieldList;
204  }
205  
206  public enum UserCardState {
207    @SerializedName("UNACTIVATED")
208    UNACTIVATED,
209    @SerializedName("EFFECTIVE")
210    EFFECTIVE,
211    @SerializedName("EXPIRED")
212    EXPIRED,
213    @SerializedName("INVALID")
214    INVALID
215  }
216  
217  public enum DateType {
218    @SerializedName("FIX_TIME_RANGE")
219    FIX_TIME_RANGE,
220    @SerializedName("FIX_TERM")
221    FIX_TERM,
222    @SerializedName("PERMANENT")
223    PERMANENT
224  }
225  
226  public static class UserInfoCommonField {
227    @SerializedName("name")
228    public CommonFieldFlag name;
229  
230    @SerializedName("value")
231    public String value;
232  }
233  
234  public static class UserInfoCustomField {
235    @SerializedName("name")
236    public String name;
237  
238    @SerializedName("user_chosen_values")
239    public List<String> userChosenValues;
240  }
241  
242  public enum CommonFieldFlag {
243    @SerializedName("USER_FORM_FLAG_SEX")
244    USER_FORM_FLAG_SEX,
245    @SerializedName("USER_FORM_FLAG_NAME")
246    USER_FORM_FLAG_NAME,
247    @SerializedName("USER_FORM_FLAG_BIRTHDAY")
248    USER_FORM_FLAG_BIRTHDAY,
249    @SerializedName("USER_FORM_FLAG_ADDRESS")
250    USER_FORM_FLAG_ADDRESS,
251    @SerializedName("USER_FORM_FLAG_EMAIL")
252    USER_FORM_FLAG_EMAIL,
253    @SerializedName("USER_FORM_FLAG_CITY")
254    USER_FORM_FLAG_CITY
255  }
256  
257}
258

1package main
2
3import (
4	"demo/wxpay_brand_utility" // 引用微信支付工具库，参考 https://pay.weixin.qq.com/doc/brand/4015826866
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/brand/4015415289
14	config, err := wxpay_brand_utility.CreateBrandConfig(
15		"xxxxxxxx",                   // 品牌ID，是由微信支付系统生成并分配给每个品牌方的唯一标识符，品牌ID获取方式参考 https://pay.weixin.qq.com/doc/brand/4015415289
16		"1DDE55AD98Exxxxxxxxxx",      // 品牌API证书序列号，如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015407570
17		"/path/to/apiclient_key.pem", // 品牌API证书私钥文件路径，本地文件路径
18		"PUB_KEY_ID_xxxxxxxxxxxxx",   // 微信支付公钥ID，如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015453439
19		"/path/to/wxp_pub.pem",       // 微信支付公钥文件路径，本地文件路径
20	)
21	if err != nil {
22		fmt.Println(err)
23		return
24	}
25
26	request := &GetUserCardRequest{
27		CardId:       wxpay_brand_utility.String("pbLatjvWOibDc5-TBnbUk1pD12o0"),
28		UserCardCode: wxpay_brand_utility.String("478515832665"),
29		Openid:       wxpay_brand_utility.String("obLatjnx9gnqzS4myYGmLZ7LgLBA"),
30	}
31
32	response, err := GetUserCard(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 GetUserCard(config *wxpay_brand_utility.BrandConfig, request *GetUserCardRequest) (response *UserCard, err error) {
44	const (
45		host   = "https://api.mch.weixin.qq.com"
46		method = "GET"
47		path   = "/brand/card-member/user-cards/{user_card_code}"
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, "{user_card_code}", url.PathEscape(*request.UserCardCode), -1)
55	query := reqUrl.Query()
56	if request.CardId != nil {
57		query.Add("card_id", *request.CardId)
58	}
59	if request.Openid != nil {
60		query.Add("openid", *request.Openid)
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_brand_utility.BuildAuthorization(config.BrandId(), 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_brand_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_brand_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 := &UserCard{}
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_brand_utility.NewApiException(
103			httpResponse.StatusCode,
104			httpResponse.Header,
105			respBody,
106		)
107	}
108}
109
110type GetUserCardRequest struct {
111	CardId       *string `json:"card_id,omitempty"`
112	UserCardCode *string `json:"user_card_code,omitempty"`
113	Openid       *string `json:"openid,omitempty"`
114}
115
116func (o *GetUserCardRequest) MarshalJSON() ([]byte, error) {
117	type Alias GetUserCardRequest
118	a := &struct {
119		CardId       *string `json:"card_id,omitempty"`
120		UserCardCode *string `json:"user_card_code,omitempty"`
121		Openid       *string `json:"openid,omitempty"`
122		*Alias
123	}{
124		// 序列化时移除非 Body 字段
125		CardId:       nil,
126		UserCardCode: nil,
127		Openid:       nil,
128		Alias:        (*Alias)(o),
129	}
130	return json.Marshal(a)
131}
132
133type UserCard struct {
134	UserCardCode         *string        `json:"user_card_code,omitempty"`
135	CardId               *string        `json:"card_id,omitempty"`
136	Openid               *string        `json:"openid,omitempty"`
137	CardColor            *string        `json:"card_color,omitempty"`
138	CardPictureUrl       *string        `json:"card_picture_url,omitempty"`
139	BrandId              *string        `json:"brand_id,omitempty"`
140	CardType             *CardType      `json:"card_type,omitempty"`
141	PhoneNumber          *string        `json:"phone_number,omitempty"`
142	Level                *string        `json:"level,omitempty"`
143	ValidDateInformation *DateInfo      `json:"valid_date_information,omitempty"`
144	PickupTime           *string        `json:"pickup_time,omitempty"`
145	UserInformation      *UserInfo      `json:"user_information,omitempty"`
146	Attach               *string        `json:"attach,omitempty"`
147	UserCardState        *UserCardState `json:"user_card_state,omitempty"`
148	InvalidReason        *string        `json:"invalid_reason,omitempty"`
149	InvalidTime          *string        `json:"invalid_time,omitempty"`
150	CreateTime           *string        `json:"create_time,omitempty"`
151	ModifyTime           *string        `json:"modify_time,omitempty"`
152}
153
154type CardType string
155
156func (e CardType) Ptr() *CardType {
157	return &e
158}
159
160const (
161	CARDTYPE_PURCHASE CardType = "PURCHASE"
162	CARDTYPE_NORMAL   CardType = "NORMAL"
163	CARDTYPE_BALANCE  CardType = "BALANCE"
164)
165
166type DateInfo struct {
167	Type                     *DateType `json:"type,omitempty"`
168	AvailableBeginTime       *string   `json:"available_begin_time,omitempty"`
169	AvailableEndTime         *string   `json:"available_end_time,omitempty"`
170	AvailableDayAfterReceive *int64    `json:"available_day_after_receive,omitempty"`
171}
172
173type UserInfo struct {
174	CommonFieldList []UserInfoCommonField `json:"common_field_list,omitempty"`
175	CustomFieldList []UserInfoCustomField `json:"custom_field_list,omitempty"`
176}
177
178type UserCardState string
179
180func (e UserCardState) Ptr() *UserCardState {
181	return &e
182}
183
184const (
185	USERCARDSTATE_UNACTIVATED UserCardState = "UNACTIVATED"
186	USERCARDSTATE_EFFECTIVE   UserCardState = "EFFECTIVE"
187	USERCARDSTATE_EXPIRED     UserCardState = "EXPIRED"
188	USERCARDSTATE_INVALID     UserCardState = "INVALID"
189)
190
191type DateType string
192
193func (e DateType) Ptr() *DateType {
194	return &e
195}
196
197const (
198	DATETYPE_FIX_TIME_RANGE DateType = "FIX_TIME_RANGE"
199	DATETYPE_FIX_TERM       DateType = "FIX_TERM"
200	DATETYPE_PERMANENT      DateType = "PERMANENT"
201)
202
203type UserInfoCommonField struct {
204	Name  *CommonFieldFlag `json:"name,omitempty"`
205	Value *string          `json:"value,omitempty"`
206}
207
208type UserInfoCustomField struct {
209	Name             *string  `json:"name,omitempty"`
210	UserChosenValues []string `json:"user_chosen_values,omitempty"`
211}
212
213type CommonFieldFlag string
214
215func (e CommonFieldFlag) Ptr() *CommonFieldFlag {
216	return &e
217}
218
219const (
220	COMMONFIELDFLAG_USER_FORM_FLAG_SEX      CommonFieldFlag = "USER_FORM_FLAG_SEX"
221	COMMONFIELDFLAG_USER_FORM_FLAG_NAME     CommonFieldFlag = "USER_FORM_FLAG_NAME"
222	COMMONFIELDFLAG_USER_FORM_FLAG_BIRTHDAY CommonFieldFlag = "USER_FORM_FLAG_BIRTHDAY"
223	COMMONFIELDFLAG_USER_FORM_FLAG_ADDRESS  CommonFieldFlag = "USER_FORM_FLAG_ADDRESS"
224	COMMONFIELDFLAG_USER_FORM_FLAG_EMAIL    CommonFieldFlag = "USER_FORM_FLAG_EMAIL"
225	COMMONFIELDFLAG_USER_FORM_FLAG_CITY     CommonFieldFlag = "USER_FORM_FLAG_CITY"
226)
227