查询会员卡模板列表

1curl -X GET \
2  https://api.mch.weixin.qq.com/brand/card-member/cards?state=CARD_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 ListCard {
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/cards";
29
30  public static void main(String[] args) {
31    // TODO: 请准备商户开发必要参数，参考：https://pay.weixin.qq.com/doc/brand/4015415289
32    ListCard client = new ListCard(
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    ListCardRequest request = new ListCardRequest();
41    request.state = CardState.CARD_EFFECTIVE;
42    request.offset = 0L;
43    request.limit = 20L;
44    try {
45      ListCardResponse 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 ListCardResponse run(ListCardRequest request) {
55    String uri = PATH;
56    Map<String, Object> args = new HashMap<>();
57    args.put("state", request.state);
58    args.put("offset", request.offset);
59    args.put("limit", request.limit);
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, ListCardResponse.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 ListCard(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 ListCardRequest {
106    @SerializedName("offset")
107    @Expose(serialize = false)
108    public Long offset;
109  
110    @SerializedName("limit")
111    @Expose(serialize = false)
112    public Long limit;
113  
114    @SerializedName("state")
115    @Expose(serialize = false)
116    public CardState state;
117  }
118  
119  public static class ListCardResponse {
120    @SerializedName("data")
121    public List<Card> data;
122  
123    @SerializedName("total_count")
124    public Long totalCount;
125  
126    @SerializedName("offset")
127    public Long offset;
128  
129    @SerializedName("limit")
130    public Long limit;
131  }
132  
133  public enum CardState {
134    @SerializedName("CARD_EFFECTIVE")
135    CARD_EFFECTIVE,
136    @SerializedName("CARD_INVALID")
137    CARD_INVALID
138  }
139  
140  public static class Card {
141    @SerializedName("out_request_no")
142    public String outRequestNo;
143  
144    @SerializedName("card_id")
145    public String cardId;
146  
147    @SerializedName("brand_id")
148    public String brandId;
149  
150    @SerializedName("appid")
151    public String appid;
152  
153    @SerializedName("card_type")
154    public CardType cardType;
155  
156    @SerializedName("card_title")
157    public String cardTitle;
158  
159    @SerializedName("card_color")
160    public String cardColor;
161  
162    @SerializedName("card_picture_url")
163    public String cardPictureUrl;
164  
165    @SerializedName("code_mode")
166    public CodeMode codeMode;
167  
168    @SerializedName("code_type")
169    public CodeType codeType;
170  
171    @SerializedName("code_jump_information")
172    public CodeJumpInfo codeJumpInformation;
173  
174    @SerializedName("benefits")
175    public String benefits;
176  
177    @SerializedName("notify_url")
178    public String notifyUrl;
179  
180    @SerializedName("need_pinned")
181    public Boolean needPinned;
182  
183    @SerializedName("need_display_level")
184    public Boolean needDisplayLevel;
185  
186    @SerializedName("init_level")
187    public String initLevel;
188  
189    @SerializedName("service_phone")
190    public String servicePhone;
191  
192    @SerializedName("legal_agreement")
193    public String legalAgreement;
194  
195    @SerializedName("valid_date_information")
196    public DateInfo validDateInformation;
197  
198    @SerializedName("member_information")
199    public MemberInfo memberInformation;
200  
201    @SerializedName("points_information")
202    public PointsInfo pointsInformation;
203  
204    @SerializedName("balance_information")
205    public BalanceInfo balanceInformation;
206  
207    @SerializedName("purchase_information")
208    public PurchaseInfo purchaseInformation;
209  
210    @SerializedName("user_information")
211    public UserInfoForm userInformation;
212  
213    @SerializedName("state")
214    public CardState state;
215  
216    @SerializedName("create_time")
217    public String createTime;
218  
219    @SerializedName("modify_time")
220    public String modifyTime;
221  }
222  
223  public enum CardType {
224    @SerializedName("PURCHASE")
225    PURCHASE,
226    @SerializedName("NORMAL")
227    NORMAL,
228    @SerializedName("BALANCE")
229    BALANCE
230  }
231  
232  public enum CodeMode {
233    @SerializedName("SYSTEM_ALLOCATE")
234    SYSTEM_ALLOCATE,
235    @SerializedName("MERCHANT_ALLOCATE")
236    MERCHANT_ALLOCATE
237  }
238  
239  public enum CodeType {
240    @SerializedName("NONE_CODE")
241    NONE_CODE,
242    @SerializedName("BAR_CODE")
243    BAR_CODE,
244    @SerializedName("QR_CODE")
245    QR_CODE,
246    @SerializedName("BAR_CODE_AND_QR_CODE")
247    BAR_CODE_AND_QR_CODE,
248    @SerializedName("JUMP_MINI_PROGRAM")
249    JUMP_MINI_PROGRAM
250  }
251  
252  public static class CodeJumpInfo {
253    @SerializedName("jump_appid")
254    public String jumpAppid;
255  
256    @SerializedName("jump_path")
257    public String jumpPath;
258  }
259  
260  public static class DateInfo {
261    @SerializedName("type")
262    public DateType type;
263  
264    @SerializedName("available_begin_time")
265    public String availableBeginTime;
266  
267    @SerializedName("available_end_time")
268    public String availableEndTime;
269  
270    @SerializedName("available_day_after_receive")
271    public Long availableDayAfterReceive;
272  }
273  
274  public static class MemberInfo {
275    @SerializedName("jump_appid")
276    public String jumpAppid;
277  
278    @SerializedName("jump_path")
279    public String jumpPath;
280  }
281  
282  public static class PointsInfo {
283    @SerializedName("jump_appid")
284    public String jumpAppid;
285  
286    @SerializedName("jump_path")
287    public String jumpPath;
288  }
289  
290  public static class BalanceInfo {
291    @SerializedName("jump_appid")
292    public String jumpAppid;
293  
294    @SerializedName("jump_path")
295    public String jumpPath;
296  }
297  
298  public static class PurchaseInfo {
299    @SerializedName("price")
300    public Long price;
301  
302    @SerializedName("jump_appid")
303    public String jumpAppid;
304  
305    @SerializedName("jump_path")
306    public String jumpPath;
307  }
308  
309  public static class UserInfoForm {
310    @SerializedName("common_field_list")
311    public List<CommonFieldFlag> commonFieldList;
312  
313    @SerializedName("custom_field_list")
314    public List<UserCustomFieldForm> customFieldList;
315  }
316  
317  public enum DateType {
318    @SerializedName("FIX_TIME_RANGE")
319    FIX_TIME_RANGE,
320    @SerializedName("FIX_TERM")
321    FIX_TERM,
322    @SerializedName("PERMANENT")
323    PERMANENT
324  }
325  
326  public enum CommonFieldFlag {
327    @SerializedName("USER_FORM_FLAG_SEX")
328    USER_FORM_FLAG_SEX,
329    @SerializedName("USER_FORM_FLAG_NAME")
330    USER_FORM_FLAG_NAME,
331    @SerializedName("USER_FORM_FLAG_BIRTHDAY")
332    USER_FORM_FLAG_BIRTHDAY,
333    @SerializedName("USER_FORM_FLAG_ADDRESS")
334    USER_FORM_FLAG_ADDRESS,
335    @SerializedName("USER_FORM_FLAG_EMAIL")
336    USER_FORM_FLAG_EMAIL,
337    @SerializedName("USER_FORM_FLAG_CITY")
338    USER_FORM_FLAG_CITY
339  }
340  
341  public static class UserCustomFieldForm {
342    @SerializedName("type")
343    public CustomFieldType type;
344  
345    @SerializedName("name")
346    public String name;
347  
348    @SerializedName("values")
349    public List<String> values;
350  }
351  
352  public enum CustomFieldType {
353    @SerializedName("CHECK_BOX")
354    CHECK_BOX,
355    @SerializedName("RADIO")
356    RADIO
357  }
358  
359}
360

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 := &ListCardRequest{
26		State:  CARDSTATE_CARD_EFFECTIVE.Ptr(),
27		Offset: wxpay_brand_utility.Int64(0),
28		Limit:  wxpay_brand_utility.Int64(20),
29	}
30
31	response, err := ListCard(config, request)
32	if err != nil {
33		fmt.Printf("请求失败: %+v\n", err)
34		// TODO: 请求失败，根据状态码执行不同的处理
35		return
36	}
37
38	// TODO: 请求成功，继续业务逻辑
39	fmt.Printf("请求成功: %+v\n", response)
40}
41
42func ListCard(config *wxpay_brand_utility.BrandConfig, request *ListCardRequest) (response *ListCardResponse, err error) {
43	const (
44		host   = "https://api.mch.weixin.qq.com"
45		method = "GET"
46		path   = "/brand/card-member/cards"
47	)
48
49	reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path))
50	if err != nil {
51		return nil, err
52	}
53	query := reqUrl.Query()
54	if request.State != nil {
55		query.Add("state", fmt.Sprintf("%v", *request.State))
56	}
57	if request.Offset != nil {
58		query.Add("offset", fmt.Sprintf("%v", *request.Offset))
59	}
60	if request.Limit != nil {
61		query.Add("limit", fmt.Sprintf("%v", *request.Limit))
62	}
63	reqUrl.RawQuery = query.Encode()
64	httpRequest, err := http.NewRequest(method, reqUrl.String(), nil)
65	if err != nil {
66		return nil, err
67	}
68	httpRequest.Header.Set("Accept", "application/json")
69	httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId())
70	authorization, err := wxpay_brand_utility.BuildAuthorization(config.BrandId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), nil)
71	if err != nil {
72		return nil, err
73	}
74	httpRequest.Header.Set("Authorization", authorization)
75
76	client := &http.Client{}
77	httpResponse, err := client.Do(httpRequest)
78	if err != nil {
79		return nil, err
80	}
81	respBody, err := wxpay_brand_utility.ExtractResponseBody(httpResponse)
82	if err != nil {
83		return nil, err
84	}
85	if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 {
86		// 2XX 成功，验证应答签名
87		err = wxpay_brand_utility.ValidateResponse(
88			config.WechatPayPublicKeyId(),
89			config.WechatPayPublicKey(),
90			&httpResponse.Header,
91			respBody,
92		)
93		if err != nil {
94			return nil, err
95		}
96		response := &ListCardResponse{}
97		if err := json.Unmarshal(respBody, response); err != nil {
98			return nil, err
99		}
100
101		return response, nil
102	} else {
103		return nil, wxpay_brand_utility.NewApiException(
104			httpResponse.StatusCode,
105			httpResponse.Header,
106			respBody,
107		)
108	}
109}
110
111type ListCardRequest struct {
112	Offset *int64     `json:"offset,omitempty"`
113	Limit  *int64     `json:"limit,omitempty"`
114	State  *CardState `json:"state,omitempty"`
115}
116
117func (o *ListCardRequest) MarshalJSON() ([]byte, error) {
118	type Alias ListCardRequest
119	a := &struct {
120		Offset *int64     `json:"offset,omitempty"`
121		Limit  *int64     `json:"limit,omitempty"`
122		State  *CardState `json:"state,omitempty"`
123		*Alias
124	}{
125		// 序列化时移除非 Body 字段
126		Offset: nil,
127		Limit:  nil,
128		State:  nil,
129		Alias:  (*Alias)(o),
130	}
131	return json.Marshal(a)
132}
133
134type ListCardResponse struct {
135	Data       []Card `json:"data,omitempty"`
136	TotalCount *int64 `json:"total_count,omitempty"`
137	Offset     *int64 `json:"offset,omitempty"`
138	Limit      *int64 `json:"limit,omitempty"`
139}
140
141type CardState string
142
143func (e CardState) Ptr() *CardState {
144	return &e
145}
146
147const (
148	CARDSTATE_CARD_EFFECTIVE CardState = "CARD_EFFECTIVE"
149	CARDSTATE_CARD_INVALID   CardState = "CARD_INVALID"
150)
151
152type Card struct {
153	OutRequestNo         *string       `json:"out_request_no,omitempty"`
154	CardId               *string       `json:"card_id,omitempty"`
155	BrandId              *string       `json:"brand_id,omitempty"`
156	Appid                *string       `json:"appid,omitempty"`
157	CardType             *CardType     `json:"card_type,omitempty"`
158	CardTitle            *string       `json:"card_title,omitempty"`
159	CardColor            *string       `json:"card_color,omitempty"`
160	CardPictureUrl       *string       `json:"card_picture_url,omitempty"`
161	CodeMode             *CodeMode     `json:"code_mode,omitempty"`
162	CodeType             *CodeType     `json:"code_type,omitempty"`
163	CodeJumpInformation  *CodeJumpInfo `json:"code_jump_information,omitempty"`
164	Benefits             *string       `json:"benefits,omitempty"`
165	NotifyUrl            *string       `json:"notify_url,omitempty"`
166	NeedPinned           *bool         `json:"need_pinned,omitempty"`
167	NeedDisplayLevel     *bool         `json:"need_display_level,omitempty"`
168	InitLevel            *string       `json:"init_level,omitempty"`
169	ServicePhone         *string       `json:"service_phone,omitempty"`
170	LegalAgreement       *string       `json:"legal_agreement,omitempty"`
171	ValidDateInformation *DateInfo     `json:"valid_date_information,omitempty"`
172	MemberInformation    *MemberInfo   `json:"member_information,omitempty"`
173	PointsInformation    *PointsInfo   `json:"points_information,omitempty"`
174	BalanceInformation   *BalanceInfo  `json:"balance_information,omitempty"`
175	PurchaseInformation  *PurchaseInfo `json:"purchase_information,omitempty"`
176	UserInformation      *UserInfoForm `json:"user_information,omitempty"`
177	State                *CardState    `json:"state,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 CodeMode string
195
196func (e CodeMode) Ptr() *CodeMode {
197	return &e
198}
199
200const (
201	CODEMODE_SYSTEM_ALLOCATE   CodeMode = "SYSTEM_ALLOCATE"
202	CODEMODE_MERCHANT_ALLOCATE CodeMode = "MERCHANT_ALLOCATE"
203)
204
205type CodeType string
206
207func (e CodeType) Ptr() *CodeType {
208	return &e
209}
210
211const (
212	CODETYPE_NONE_CODE            CodeType = "NONE_CODE"
213	CODETYPE_BAR_CODE             CodeType = "BAR_CODE"
214	CODETYPE_QR_CODE              CodeType = "QR_CODE"
215	CODETYPE_BAR_CODE_AND_QR_CODE CodeType = "BAR_CODE_AND_QR_CODE"
216	CODETYPE_JUMP_MINI_PROGRAM    CodeType = "JUMP_MINI_PROGRAM"
217)
218
219type CodeJumpInfo struct {
220	JumpAppid *string `json:"jump_appid,omitempty"`
221	JumpPath  *string `json:"jump_path,omitempty"`
222}
223
224type DateInfo struct {
225	Type                     *DateType `json:"type,omitempty"`
226	AvailableBeginTime       *string   `json:"available_begin_time,omitempty"`
227	AvailableEndTime         *string   `json:"available_end_time,omitempty"`
228	AvailableDayAfterReceive *int64    `json:"available_day_after_receive,omitempty"`
229}
230
231type MemberInfo struct {
232	JumpAppid *string `json:"jump_appid,omitempty"`
233	JumpPath  *string `json:"jump_path,omitempty"`
234}
235
236type PointsInfo struct {
237	JumpAppid *string `json:"jump_appid,omitempty"`
238	JumpPath  *string `json:"jump_path,omitempty"`
239}
240
241type BalanceInfo struct {
242	JumpAppid *string `json:"jump_appid,omitempty"`
243	JumpPath  *string `json:"jump_path,omitempty"`
244}
245
246type PurchaseInfo struct {
247	Price     *int64  `json:"price,omitempty"`
248	JumpAppid *string `json:"jump_appid,omitempty"`
249	JumpPath  *string `json:"jump_path,omitempty"`
250}
251
252type UserInfoForm struct {
253	CommonFieldList []CommonFieldFlag     `json:"common_field_list,omitempty"`
254	CustomFieldList []UserCustomFieldForm `json:"custom_field_list,omitempty"`
255}
256
257type DateType string
258
259func (e DateType) Ptr() *DateType {
260	return &e
261}
262
263const (
264	DATETYPE_FIX_TIME_RANGE DateType = "FIX_TIME_RANGE"
265	DATETYPE_FIX_TERM       DateType = "FIX_TERM"
266	DATETYPE_PERMANENT      DateType = "PERMANENT"
267)
268
269type CommonFieldFlag string
270
271func (e CommonFieldFlag) Ptr() *CommonFieldFlag {
272	return &e
273}
274
275const (
276	COMMONFIELDFLAG_USER_FORM_FLAG_SEX      CommonFieldFlag = "USER_FORM_FLAG_SEX"
277	COMMONFIELDFLAG_USER_FORM_FLAG_NAME     CommonFieldFlag = "USER_FORM_FLAG_NAME"
278	COMMONFIELDFLAG_USER_FORM_FLAG_BIRTHDAY CommonFieldFlag = "USER_FORM_FLAG_BIRTHDAY"
279	COMMONFIELDFLAG_USER_FORM_FLAG_ADDRESS  CommonFieldFlag = "USER_FORM_FLAG_ADDRESS"
280	COMMONFIELDFLAG_USER_FORM_FLAG_EMAIL    CommonFieldFlag = "USER_FORM_FLAG_EMAIL"
281	COMMONFIELDFLAG_USER_FORM_FLAG_CITY     CommonFieldFlag = "USER_FORM_FLAG_CITY"
282)
283
284type UserCustomFieldForm struct {
285	Type   *CustomFieldType `json:"type,omitempty"`
286	Name   *string          `json:"name,omitempty"`
287	Values []string         `json:"values,omitempty"`
288}
289
290type CustomFieldType string
291
292func (e CustomFieldType) Ptr() *CustomFieldType {
293	return &e
294}
295
296const (
297	CUSTOMFIELDTYPE_CHECK_BOX CustomFieldType = "CHECK_BOX"
298	CUSTOMFIELDTYPE_RADIO     CustomFieldType = "RADIO"
299)
300