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

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      ,
37      "PUB_KEY_ID_xxxxxxxxxxxxx",      // 微信支付公钥ID，如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589
38      "/path/to/wxp_pub.pem"           // 微信支付公钥文件路径，本地文件路径
39    );
40
41    ListUserCardRequest request = new ListUserCardRequest();
42    request.brandId = "1004";
43    request.openid = "obLatjnx9gnqzS4myYGmLZ7LgLBA";
44    request.userCardState = UserCardState.EFFECTIVE;
45    request.offset = 0L;
46    request.limit = 20L;
47    try {
48      ListUserCardResponse response = client.run(request);
49        // TODO: 请求成功，继续业务逻辑
50        System.out.println(response);
51    } catch (WXPayUtility.ApiException e) {
52        // TODO: 请求失败，根据状态码执行不同的逻辑
53        e.printStackTrace();
54    }
55  }
56
57  public ListUserCardResponse run(ListUserCardRequest request) {
58    String uri = PATH;
59    Map<String, Object> args = new HashMap<>();
60    args.put("brand_id", request.brandId);
61    args.put("openid", request.openid);
62    args.put("user_card_state", request.userCardState);
63    args.put("offset", request.offset);
64    args.put("limit", request.limit);
65    uri = uri + "?" + WXPayUtility.urlEncode(args);
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", WXPayUtility.buildAuthorization(mchid, 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 = WXPayUtility.extractBody(httpResponse);
78      if (httpResponse.code() >= 200 && httpResponse.code() < 300) {
79        // 2XX 成功，验证应答签名
80        WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey,
81            httpResponse.headers(), respBody);
82
83        // 从HTTP应答报文构建返回数据
84        return WXPayUtility.fromJson(respBody, ListUserCardResponse.class);
85      } else {
86        throw new WXPayUtility.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 mchid;
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 mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) {
100    this.mchid = mchid;
101    this.certificateSerialNo = certificateSerialNo;
102    this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath);
103    this.wechatPayPublicKeyId = wechatPayPublicKeyId;
104    this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath);
105  }
106
107  public static class ListUserCardRequest {
108    @SerializedName("brand_id")
109    @Expose(serialize = false)
110    public String brandId;
111  
112    @SerializedName("openid")
113    @Expose(serialize = false)
114    public String openid;
115  
116    @SerializedName("offset")
117    @Expose(serialize = false)
118    public Long offset;
119  
120    @SerializedName("limit")
121    @Expose(serialize = false)
122    public Long limit;
123  
124    @SerializedName("user_card_state")
125    @Expose(serialize = false)
126    public UserCardState userCardState;
127  }
128  
129  public static class ListUserCardResponse {
130    @SerializedName("data")
131    public List<UserCard> data;
132  
133    @SerializedName("total_count")
134    public Long totalCount;
135  
136    @SerializedName("offset")
137    public Long offset;
138  
139    @SerializedName("limit")
140    public Long limit;
141  }
142  
143  public enum UserCardState {
144    @SerializedName("UNACTIVATED")
145    UNACTIVATED,
146    @SerializedName("EFFECTIVE")
147    EFFECTIVE,
148    @SerializedName("EXPIRED")
149    EXPIRED,
150    @SerializedName("INVALID")
151    INVALID
152  }
153  
154  public static class UserCard {
155    @SerializedName("user_card_code")
156    public String userCardCode;
157  
158    @SerializedName("card_id")
159    public String cardId;
160  
161    @SerializedName("openid")
162    public String openid;
163  
164    @SerializedName("card_color")
165    public String cardColor;
166  
167    @SerializedName("card_picture_url")
168    public String cardPictureUrl;
169  
170    @SerializedName("brand_id")
171    public String brandId;
172  
173    @SerializedName("card_type")
174    public CardType cardType;
175  
176    @SerializedName("phone_number")
177    public String phoneNumber;
178  
179    @SerializedName("level")
180    public String level;
181  
182    @SerializedName("valid_date_information")
183    public DateInfo validDateInformation;
184  
185    @SerializedName("pickup_time")
186    public String pickupTime;
187  
188    @SerializedName("user_information")
189    public UserInfo userInformation;
190  
191    @SerializedName("attach")
192    public String attach;
193  
194    @SerializedName("user_card_state")
195    public UserCardState userCardState;
196  
197    @SerializedName("invalid_reason")
198    public String invalidReason;
199  
200    @SerializedName("invalid_time")
201    public String invalidTime;
202  
203    @SerializedName("create_time")
204    public String createTime;
205  
206    @SerializedName("modify_time")
207    public String modifyTime;
208  }
209  
210  public enum CardType {
211    @SerializedName("PURCHASE")
212    PURCHASE,
213    @SerializedName("NORMAL")
214    NORMAL,
215    @SerializedName("BALANCE")
216    BALANCE
217  }
218  
219  public static class DateInfo {
220    @SerializedName("type")
221    public DateType type;
222  
223    @SerializedName("available_begin_time")
224    public String availableBeginTime;
225  
226    @SerializedName("available_end_time")
227    public String availableEndTime;
228  
229    @SerializedName("available_day_after_receive")
230    public Long availableDayAfterReceive;
231  }
232  
233  public static class UserInfo {
234    @SerializedName("common_field_list")
235    public List<UserInfoCommonField> commonFieldList;
236  
237    @SerializedName("custom_field_list")
238    public List<UserInfoCustomField> customFieldList;
239  }
240  
241  public enum DateType {
242    @SerializedName("FIX_TIME_RANGE")
243    FIX_TIME_RANGE,
244    @SerializedName("FIX_TERM")
245    FIX_TERM,
246    @SerializedName("PERMANENT")
247    PERMANENT
248  }
249  
250  public static class UserInfoCommonField {
251    @SerializedName("name")
252    public CommonFieldFlag name;
253  
254    @SerializedName("value")
255    public String value;
256  }
257  
258  public static class UserInfoCustomField {
259    @SerializedName("name")
260    public String name;
261  
262    @SerializedName("user_chosen_values")
263    public List<String> userChosenValues;
264  }
265  
266  public enum CommonFieldFlag {
267    @SerializedName("USER_FORM_FLAG_SEX")
268    USER_FORM_FLAG_SEX,
269    @SerializedName("USER_FORM_FLAG_NAME")
270    USER_FORM_FLAG_NAME,
271    @SerializedName("USER_FORM_FLAG_BIRTHDAY")
272    USER_FORM_FLAG_BIRTHDAY,
273    @SerializedName("USER_FORM_FLAG_ADDRESS")
274    USER_FORM_FLAG_ADDRESS,
275    @SerializedName("USER_FORM_FLAG_EMAIL")
276    USER_FORM_FLAG_EMAIL,
277    @SerializedName("USER_FORM_FLAG_CITY")
278    USER_FORM_FLAG_CITY
279  }
280  
281}
282

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	query.Add("brand_id", *request.BrandId)
57	query.Add("openid", *request.Openid)
58	query.Add("user_card_state", fmt.Sprintf("%v", *request.UserCardState))
59	query.Add("offset", fmt.Sprintf("%v", *request.Offset))
60	query.Add("limit", fmt.Sprintf("%v", *request.Limit))
61	reqUrl.RawQuery = query.Encode()
62	httpRequest, err := http.NewRequest(method, reqUrl.String(), nil)
63	if err != nil {
64		return nil, err
65	}
66	httpRequest.Header.Set("Accept", "application/json")
67	httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId())
68	authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), nil)
69	if err != nil {
70		return nil, err
71	}
72	httpRequest.Header.Set("Authorization", authorization)
73
74	client := &http.Client{}
75	httpResponse, err := client.Do(httpRequest)
76	if err != nil {
77		return nil, err
78	}
79	respBody, err := wxpay_utility.ExtractResponseBody(httpResponse)
80	if err != nil {
81		return nil, err
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		response := &ListUserCardResponse{}
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 ListUserCardRequest struct {
110	BrandId       *string        `json:"brand_id,omitempty"`
111	Openid        *string        `json:"openid,omitempty"`
112	Offset        *int64         `json:"offset,omitempty"`
113	Limit         *int64         `json:"limit,omitempty"`
114	UserCardState *UserCardState `json:"user_card_state,omitempty"`
115}
116
117func (o *ListUserCardRequest) MarshalJSON() ([]byte, error) {
118	type Alias ListUserCardRequest
119	a := &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		*Alias
126	}{
127		// 序列化时移除非 Body 字段
128		BrandId:       nil,
129		Openid:        nil,
130		Offset:        nil,
131		Limit:         nil,
132		UserCardState: nil,
133		Alias:         (*Alias)(o),
134	}
135	return json.Marshal(a)
136}
137
138type ListUserCardResponse struct {
139	Data       []UserCard `json:"data,omitempty"`
140	TotalCount *int64     `json:"total_count,omitempty"`
141	Offset     *int64     `json:"offset,omitempty"`
142	Limit      *int64     `json:"limit,omitempty"`
143}
144
145type UserCardState string
146
147func (e UserCardState) Ptr() *UserCardState {
148	return &e
149}
150
151const (
152	USERCARDSTATE_UNACTIVATED UserCardState = "UNACTIVATED"
153	USERCARDSTATE_EFFECTIVE   UserCardState = "EFFECTIVE"
154	USERCARDSTATE_EXPIRED     UserCardState = "EXPIRED"
155	USERCARDSTATE_INVALID     UserCardState = "INVALID"
156)
157
158type UserCard struct {
159	UserCardCode         *string        `json:"user_card_code,omitempty"`
160	CardId               *string        `json:"card_id,omitempty"`
161	Openid               *string        `json:"openid,omitempty"`
162	CardColor            *string        `json:"card_color,omitempty"`
163	CardPictureUrl       *string        `json:"card_picture_url,omitempty"`
164	BrandId              *string        `json:"brand_id,omitempty"`
165	CardType             *CardType      `json:"card_type,omitempty"`
166	PhoneNumber          *string        `json:"phone_number,omitempty"`
167	Level                *string        `json:"level,omitempty"`
168	ValidDateInformation *DateInfo      `json:"valid_date_information,omitempty"`
169	PickupTime           *string        `json:"pickup_time,omitempty"`
170	UserInformation      *UserInfo      `json:"user_information,omitempty"`
171	Attach               *string        `json:"attach,omitempty"`
172	UserCardState        *UserCardState `json:"user_card_state,omitempty"`
173	InvalidReason        *string        `json:"invalid_reason,omitempty"`
174	InvalidTime          *string        `json:"invalid_time,omitempty"`
175	CreateTime           *string        `json:"create_time,omitempty"`
176	ModifyTime           *string        `json:"modify_time,omitempty"`
177}
178
179type CardType string
180
181func (e CardType) Ptr() *CardType {
182	return &e
183}
184
185const (
186	CARDTYPE_PURCHASE CardType = "PURCHASE"
187	CARDTYPE_NORMAL   CardType = "NORMAL"
188	CARDTYPE_BALANCE  CardType = "BALANCE"
189)
190
191type DateInfo struct {
192	Type                     *DateType `json:"type,omitempty"`
193	AvailableBeginTime       *string   `json:"available_begin_time,omitempty"`
194	AvailableEndTime         *string   `json:"available_end_time,omitempty"`
195	AvailableDayAfterReceive *int64    `json:"available_day_after_receive,omitempty"`
196}
197
198type UserInfo struct {
199	CommonFieldList []UserInfoCommonField `json:"common_field_list,omitempty"`
200	CustomFieldList []UserInfoCustomField `json:"custom_field_list,omitempty"`
201}
202
203type DateType string
204
205func (e DateType) Ptr() *DateType {
206	return &e
207}
208
209const (
210	DATETYPE_FIX_TIME_RANGE DateType = "FIX_TIME_RANGE"
211	DATETYPE_FIX_TERM       DateType = "FIX_TERM"
212	DATETYPE_PERMANENT      DateType = "PERMANENT"
213)
214
215type UserInfoCommonField struct {
216	Name  *CommonFieldFlag `json:"name,omitempty"`
217	Value *string          `json:"value,omitempty"`
218}
219
220type UserInfoCustomField struct {
221	Name             *string  `json:"name,omitempty"`
222	UserChosenValues []string `json:"user_chosen_values,omitempty"`
223}
224
225type CommonFieldFlag string
226
227func (e CommonFieldFlag) Ptr() *CommonFieldFlag {
228	return &e
229}
230
231const (
232	COMMONFIELDFLAG_USER_FORM_FLAG_SEX      CommonFieldFlag = "USER_FORM_FLAG_SEX"
233	COMMONFIELDFLAG_USER_FORM_FLAG_NAME     CommonFieldFlag = "USER_FORM_FLAG_NAME"
234	COMMONFIELDFLAG_USER_FORM_FLAG_BIRTHDAY CommonFieldFlag = "USER_FORM_FLAG_BIRTHDAY"
235	COMMONFIELDFLAG_USER_FORM_FLAG_ADDRESS  CommonFieldFlag = "USER_FORM_FLAG_ADDRESS"
236	COMMONFIELDFLAG_USER_FORM_FLAG_EMAIL    CommonFieldFlag = "USER_FORM_FLAG_EMAIL"
237	COMMONFIELDFLAG_USER_FORM_FLAG_CITY     CommonFieldFlag = "USER_FORM_FLAG_CITY"
238)
239