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

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/brand/partner/card-member/user-cards?brand_id=1004&openid=obLatjnx9gnqzS4myYGmLZ7LgLBA&user_card_state=EFFECTIVE&offset=0&limit=20 \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" 
5

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

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