查询会员卡模板列表

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

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