查询用户在品牌下所有会员卡

1curl -X GET \
2  https://api.mch.weixin.qq.com/brand/card-member/user-cards?openid=obLatjnx9gnqzS4myYGmLZ7LgLBA&user_card_state=EFFECTIVE&offset=0&limit=20 \
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 ListUserCard {
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";
29
30  public static void main(String[] args) {
31    // TODO: 请准备商户开发必要参数，参考：https://pay.weixin.qq.com/doc/brand/4015415289
32    ListUserCard client = new ListUserCard(
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    ListUserCardRequest request = new ListUserCardRequest();
41    request.openid = "obLatjnx9gnqzS4myYGmLZ7LgLBA";
42    request.userCardState = UserCardState.EFFECTIVE;
43    request.offset = 0L;
44    request.limit = 20L;
45    try {
46      ListUserCardResponse response = client.run(request);
47        // TODO: 请求成功，继续业务逻辑
48        System.out.println(response);
49    } catch (WXPayBrandUtility.ApiException e) {
50        // TODO: 请求失败，根据状态码执行不同的逻辑
51        e.printStackTrace();
52    }
53  }
54
55  public ListUserCardResponse run(ListUserCardRequest request) {
56    String uri = PATH;
57    Map<String, Object> args = new HashMap<>();
58    args.put("openid", request.openid);
59    args.put("user_card_state", request.userCardState);
60    args.put("offset", request.offset);
61    args.put("limit", request.limit);
62    String queryString = WXPayBrandUtility.urlEncode(args);
63    if (!queryString.isEmpty()) {
64        uri = uri + "?" + queryString;
65    }
66
67    Request.Builder reqBuilder = new Request.Builder().url(HOST + uri);
68    reqBuilder.addHeader("Accept", "application/json");
69    reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId);
70    reqBuilder.addHeader("Authorization", WXPayBrandUtility.buildAuthorization(brand_id, certificateSerialNo, privateKey, METHOD, uri, null));
71    reqBuilder.method(METHOD, null);
72    Request httpRequest = reqBuilder.build();
73
74    // 发送HTTP请求
75    OkHttpClient client = new OkHttpClient.Builder().build();
76    try (Response httpResponse = client.newCall(httpRequest).execute()) {
77      String respBody = WXPayBrandUtility.extractBody(httpResponse);
78      if (httpResponse.code() >= 200 && httpResponse.code() < 300) {
79        // 2XX 成功，验证应答签名
80        WXPayBrandUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey,
81            httpResponse.headers(), respBody);
82
83        // 从HTTP应答报文构建返回数据
84        return WXPayBrandUtility.fromJson(respBody, ListUserCardResponse.class);
85      } else {
86        throw new WXPayBrandUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers());
87      }
88    } catch (IOException e) {
89      throw new UncheckedIOException("Sending request to " + uri + " failed.", e);
90    }
91  }
92
93  private final String brand_id;
94  private final String certificateSerialNo;
95  private final PrivateKey privateKey;
96  private final String wechatPayPublicKeyId;
97  private final PublicKey wechatPayPublicKey;
98
99  public ListUserCard(String brand_id, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) {
100    this.brand_id = brand_id;
101    this.certificateSerialNo = certificateSerialNo;
102    this.privateKey = WXPayBrandUtility.loadPrivateKeyFromPath(privateKeyFilePath);
103    this.wechatPayPublicKeyId = wechatPayPublicKeyId;
104    this.wechatPayPublicKey = WXPayBrandUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath);
105  }
106
107  public static class ListUserCardRequest {
108    @SerializedName("openid")
109    @Expose(serialize = false)
110    public String openid;
111  
112    @SerializedName("offset")
113    @Expose(serialize = false)
114    public Long offset;
115  
116    @SerializedName("limit")
117    @Expose(serialize = false)
118    public Long limit;
119  
120    @SerializedName("user_card_state")
121    @Expose(serialize = false)
122    public UserCardState userCardState;
123  }
124  
125  public static class ListUserCardResponse {
126    @SerializedName("data")
127    public List<UserCard> data;
128  
129    @SerializedName("total_count")
130    public Long totalCount;
131  
132    @SerializedName("offset")
133    public Long offset;
134  
135    @SerializedName("limit")
136    public Long limit;
137  }
138  
139  public enum UserCardState {
140    @SerializedName("UNACTIVATED")
141    UNACTIVATED,
142    @SerializedName("EFFECTIVE")
143    EFFECTIVE,
144    @SerializedName("EXPIRED")
145    EXPIRED,
146    @SerializedName("INVALID")
147    INVALID
148  }
149  
150  public static class UserCard {
151    @SerializedName("user_card_code")
152    public String userCardCode;
153  
154    @SerializedName("card_id")
155    public String cardId;
156  
157    @SerializedName("openid")
158    public String openid;
159  
160    @SerializedName("card_color")
161    public String cardColor;
162  
163    @SerializedName("card_picture_url")
164    public String cardPictureUrl;
165  
166    @SerializedName("brand_id")
167    public String brandId;
168  
169    @SerializedName("card_type")
170    public CardType cardType;
171  
172    @SerializedName("phone_number")
173    public String phoneNumber;
174  
175    @SerializedName("level")
176    public String level;
177  
178    @SerializedName("valid_date_information")
179    public DateInfo validDateInformation;
180  
181    @SerializedName("pickup_time")
182    public String pickupTime;
183  
184    @SerializedName("user_information")
185    public UserInfo userInformation;
186  
187    @SerializedName("attach")
188    public String attach;
189  
190    @SerializedName("user_card_state")
191    public UserCardState userCardState;
192  
193    @SerializedName("invalid_reason")
194    public String invalidReason;
195  
196    @SerializedName("invalid_time")
197    public String invalidTime;
198  
199    @SerializedName("create_time")
200    public String createTime;
201  
202    @SerializedName("modify_time")
203    public String modifyTime;
204  }
205  
206  public enum CardType {
207    @SerializedName("PURCHASE")
208    PURCHASE,
209    @SerializedName("NORMAL")
210    NORMAL,
211    @SerializedName("BALANCE")
212    BALANCE
213  }
214  
215  public static class DateInfo {
216    @SerializedName("type")
217    public DateType type;
218  
219    @SerializedName("available_begin_time")
220    public String availableBeginTime;
221  
222    @SerializedName("available_end_time")
223    public String availableEndTime;
224  
225    @SerializedName("available_day_after_receive")
226    public Long availableDayAfterReceive;
227  }
228  
229  public static class UserInfo {
230    @SerializedName("common_field_list")
231    public List<UserInfoCommonField> commonFieldList;
232  
233    @SerializedName("custom_field_list")
234    public List<UserInfoCustomField> customFieldList;
235  }
236  
237  public enum DateType {
238    @SerializedName("FIX_TIME_RANGE")
239    FIX_TIME_RANGE,
240    @SerializedName("FIX_TERM")
241    FIX_TERM,
242    @SerializedName("PERMANENT")
243    PERMANENT
244  }
245  
246  public static class UserInfoCommonField {
247    @SerializedName("name")
248    public CommonFieldFlag name;
249  
250    @SerializedName("value")
251    public String value;
252  }
253  
254  public static class UserInfoCustomField {
255    @SerializedName("name")
256    public String name;
257  
258    @SerializedName("user_chosen_values")
259    public List<String> userChosenValues;
260  }
261  
262  public enum CommonFieldFlag {
263    @SerializedName("USER_FORM_FLAG_SEX")
264    USER_FORM_FLAG_SEX,
265    @SerializedName("USER_FORM_FLAG_NAME")
266    USER_FORM_FLAG_NAME,
267    @SerializedName("USER_FORM_FLAG_BIRTHDAY")
268    USER_FORM_FLAG_BIRTHDAY,
269    @SerializedName("USER_FORM_FLAG_ADDRESS")
270    USER_FORM_FLAG_ADDRESS,
271    @SerializedName("USER_FORM_FLAG_EMAIL")
272    USER_FORM_FLAG_EMAIL,
273    @SerializedName("USER_FORM_FLAG_CITY")
274    USER_FORM_FLAG_CITY
275  }
276  
277}
278

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)
10
11func main() {
12	// TODO: 请准备商户开发必要参数，参考：https://pay.weixin.qq.com/doc/brand/4015415289
13	config, err := wxpay_brand_utility.CreateBrandConfig(
14		"xxxxxxxx",                   // 品牌ID，是由微信支付系统生成并分配给每个品牌方的唯一标识符，品牌ID获取方式参考 https://pay.weixin.qq.com/doc/brand/4015415289
15		"1DDE55AD98Exxxxxxxxxx",      // 品牌API证书序列号，如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015407570
16		"/path/to/apiclient_key.pem", // 品牌API证书私钥文件路径，本地文件路径
17		"PUB_KEY_ID_xxxxxxxxxxxxx",   // 微信支付公钥ID，如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015453439
18		"/path/to/wxp_pub.pem",       // 微信支付公钥文件路径，本地文件路径
19	)
20	if err != nil {
21		fmt.Println(err)
22		return
23	}
24
25	request := &ListUserCardRequest{
26		Openid:        wxpay_brand_utility.String("obLatjnx9gnqzS4myYGmLZ7LgLBA"),
27		UserCardState: USERCARDSTATE_EFFECTIVE.Ptr(),
28		Offset:        wxpay_brand_utility.Int64(0),
29		Limit:         wxpay_brand_utility.Int64(20),
30	}
31
32	response, err := ListUserCard(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 ListUserCard(config *wxpay_brand_utility.BrandConfig, request *ListUserCardRequest) (response *ListUserCardResponse, err error) {
44	const (
45		host   = "https://api.mch.weixin.qq.com"
46		method = "GET"
47		path   = "/brand/card-member/user-cards"
48	)
49
50	reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path))
51	if err != nil {
52		return nil, err
53	}
54	query := reqUrl.Query()
55	if request.Openid != nil {
56		query.Add("openid", *request.Openid)
57	}
58	if request.UserCardState != nil {
59		query.Add("user_card_state", fmt.Sprintf("%v", *request.UserCardState))
60	}
61	if request.Offset != nil {
62		query.Add("offset", fmt.Sprintf("%v", *request.Offset))
63	}
64	if request.Limit != nil {
65		query.Add("limit", fmt.Sprintf("%v", *request.Limit))
66	}
67	reqUrl.RawQuery = query.Encode()
68	httpRequest, err := http.NewRequest(method, reqUrl.String(), nil)
69	if err != nil {
70		return nil, err
71	}
72	httpRequest.Header.Set("Accept", "application/json")
73	httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId())
74	authorization, err := wxpay_brand_utility.BuildAuthorization(config.BrandId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), nil)
75	if err != nil {
76		return nil, err
77	}
78	httpRequest.Header.Set("Authorization", authorization)
79
80	client := &http.Client{}
81	httpResponse, err := client.Do(httpRequest)
82	if err != nil {
83		return nil, err
84	}
85	respBody, err := wxpay_brand_utility.ExtractResponseBody(httpResponse)
86	if err != nil {
87		return nil, err
88	}
89	if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 {
90		// 2XX 成功，验证应答签名
91		err = wxpay_brand_utility.ValidateResponse(
92			config.WechatPayPublicKeyId(),
93			config.WechatPayPublicKey(),
94			&httpResponse.Header,
95			respBody,
96		)
97		if err != nil {
98			return nil, err
99		}
100		response := &ListUserCardResponse{}
101		if err := json.Unmarshal(respBody, response); err != nil {
102			return nil, err
103		}
104
105		return response, nil
106	} else {
107		return nil, wxpay_brand_utility.NewApiException(
108			httpResponse.StatusCode,
109			httpResponse.Header,
110			respBody,
111		)
112	}
113}
114
115type ListUserCardRequest struct {
116	Openid        *string        `json:"openid,omitempty"`
117	Offset        *int64         `json:"offset,omitempty"`
118	Limit         *int64         `json:"limit,omitempty"`
119	UserCardState *UserCardState `json:"user_card_state,omitempty"`
120}
121
122func (o *ListUserCardRequest) MarshalJSON() ([]byte, error) {
123	type Alias ListUserCardRequest
124	a := &struct {
125		Openid        *string        `json:"openid,omitempty"`
126		Offset        *int64         `json:"offset,omitempty"`
127		Limit         *int64         `json:"limit,omitempty"`
128		UserCardState *UserCardState `json:"user_card_state,omitempty"`
129		*Alias
130	}{
131		// 序列化时移除非 Body 字段
132		Openid:        nil,
133		Offset:        nil,
134		Limit:         nil,
135		UserCardState: nil,
136		Alias:         (*Alias)(o),
137	}
138	return json.Marshal(a)
139}
140
141type ListUserCardResponse struct {
142	Data       []UserCard `json:"data,omitempty"`
143	TotalCount *int64     `json:"total_count,omitempty"`
144	Offset     *int64     `json:"offset,omitempty"`
145	Limit      *int64     `json:"limit,omitempty"`
146}
147
148type UserCardState string
149
150func (e UserCardState) Ptr() *UserCardState {
151	return &e
152}
153
154const (
155	USERCARDSTATE_UNACTIVATED UserCardState = "UNACTIVATED"
156	USERCARDSTATE_EFFECTIVE   UserCardState = "EFFECTIVE"
157	USERCARDSTATE_EXPIRED     UserCardState = "EXPIRED"
158	USERCARDSTATE_INVALID     UserCardState = "INVALID"
159)
160
161type UserCard struct {
162	UserCardCode         *string        `json:"user_card_code,omitempty"`
163	CardId               *string        `json:"card_id,omitempty"`
164	Openid               *string        `json:"openid,omitempty"`
165	CardColor            *string        `json:"card_color,omitempty"`
166	CardPictureUrl       *string        `json:"card_picture_url,omitempty"`
167	BrandId              *string        `json:"brand_id,omitempty"`
168	CardType             *CardType      `json:"card_type,omitempty"`
169	PhoneNumber          *string        `json:"phone_number,omitempty"`
170	Level                *string        `json:"level,omitempty"`
171	ValidDateInformation *DateInfo      `json:"valid_date_information,omitempty"`
172	PickupTime           *string        `json:"pickup_time,omitempty"`
173	UserInformation      *UserInfo      `json:"user_information,omitempty"`
174	Attach               *string        `json:"attach,omitempty"`
175	UserCardState        *UserCardState `json:"user_card_state,omitempty"`
176	InvalidReason        *string        `json:"invalid_reason,omitempty"`
177	InvalidTime          *string        `json:"invalid_time,omitempty"`
178	CreateTime           *string        `json:"create_time,omitempty"`
179	ModifyTime           *string        `json:"modify_time,omitempty"`
180}
181
182type CardType string
183
184func (e CardType) Ptr() *CardType {
185	return &e
186}
187
188const (
189	CARDTYPE_PURCHASE CardType = "PURCHASE"
190	CARDTYPE_NORMAL   CardType = "NORMAL"
191	CARDTYPE_BALANCE  CardType = "BALANCE"
192)
193
194type DateInfo struct {
195	Type                     *DateType `json:"type,omitempty"`
196	AvailableBeginTime       *string   `json:"available_begin_time,omitempty"`
197	AvailableEndTime         *string   `json:"available_end_time,omitempty"`
198	AvailableDayAfterReceive *int64    `json:"available_day_after_receive,omitempty"`
199}
200
201type UserInfo struct {
202	CommonFieldList []UserInfoCommonField `json:"common_field_list,omitempty"`
203	CustomFieldList []UserInfoCustomField `json:"custom_field_list,omitempty"`
204}
205
206type DateType string
207
208func (e DateType) Ptr() *DateType {
209	return &e
210}
211
212const (
213	DATETYPE_FIX_TIME_RANGE DateType = "FIX_TIME_RANGE"
214	DATETYPE_FIX_TERM       DateType = "FIX_TERM"
215	DATETYPE_PERMANENT      DateType = "PERMANENT"
216)
217
218type UserInfoCommonField struct {
219	Name  *CommonFieldFlag `json:"name,omitempty"`
220	Value *string          `json:"value,omitempty"`
221}
222
223type UserInfoCustomField struct {
224	Name             *string  `json:"name,omitempty"`
225	UserChosenValues []string `json:"user_chosen_values,omitempty"`
226}
227
228type CommonFieldFlag string
229
230func (e CommonFieldFlag) Ptr() *CommonFieldFlag {
231	return &e
232}
233
234const (
235	COMMONFIELDFLAG_USER_FORM_FLAG_SEX      CommonFieldFlag = "USER_FORM_FLAG_SEX"
236	COMMONFIELDFLAG_USER_FORM_FLAG_NAME     CommonFieldFlag = "USER_FORM_FLAG_NAME"
237	COMMONFIELDFLAG_USER_FORM_FLAG_BIRTHDAY CommonFieldFlag = "USER_FORM_FLAG_BIRTHDAY"
238	COMMONFIELDFLAG_USER_FORM_FLAG_ADDRESS  CommonFieldFlag = "USER_FORM_FLAG_ADDRESS"
239	COMMONFIELDFLAG_USER_FORM_FLAG_EMAIL    CommonFieldFlag = "USER_FORM_FLAG_EMAIL"
240	COMMONFIELDFLAG_USER_FORM_FLAG_CITY     CommonFieldFlag = "USER_FORM_FLAG_CITY"
241)
242