查询会员卡模板信息

1curl -X GET \
2  https://api.mch.weixin.qq.com/brand/card-member/cards/pbLatjvWOibDc5-TBnbUk1pD1 \
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 GetCard {
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/{card_id}";
29
30  public static void main(String[] args) {
31    // TODO: 请准备商户开发必要参数，参考：https://pay.weixin.qq.com/doc/brand/4015415289
32    GetCard client = new GetCard(
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    GetCardRequest request = new GetCardRequest();
41    request.cardId = "pbLatjvWOibDc5-TBnbUk1pD1";
42    try {
43      Card response = client.run(request);
44        // TODO: 请求成功，继续业务逻辑
45        System.out.println(response);
46    } catch (WXPayBrandUtility.ApiException e) {
47        // TODO: 请求失败，根据状态码执行不同的逻辑
48        e.printStackTrace();
49    }
50  }
51
52  public Card run(GetCardRequest request) {
53    String uri = PATH;
54    uri = uri.replace("{card_id}", WXPayBrandUtility.urlEncode(request.cardId));
55
56    Request.Builder reqBuilder = new Request.Builder().url(HOST + uri);
57    reqBuilder.addHeader("Accept", "application/json");
58    reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId);
59    reqBuilder.addHeader("Authorization", WXPayBrandUtility.buildAuthorization(brand_id, certificateSerialNo, privateKey, METHOD, uri, null));
60    reqBuilder.method(METHOD, null);
61    Request httpRequest = reqBuilder.build();
62
63    // 发送HTTP请求
64    OkHttpClient client = new OkHttpClient.Builder().build();
65    try (Response httpResponse = client.newCall(httpRequest).execute()) {
66      String respBody = WXPayBrandUtility.extractBody(httpResponse);
67      if (httpResponse.code() >= 200 && httpResponse.code() < 300) {
68        // 2XX 成功，验证应答签名
69        WXPayBrandUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey,
70            httpResponse.headers(), respBody);
71
72        // 从HTTP应答报文构建返回数据
73        return WXPayBrandUtility.fromJson(respBody, Card.class);
74      } else {
75        throw new WXPayBrandUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers());
76      }
77    } catch (IOException e) {
78      throw new UncheckedIOException("Sending request to " + uri + " failed.", e);
79    }
80  }
81
82  private final String brand_id;
83  private final String certificateSerialNo;
84  private final PrivateKey privateKey;
85  private final String wechatPayPublicKeyId;
86  private final PublicKey wechatPayPublicKey;
87
88  public GetCard(String brand_id, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) {
89    this.brand_id = brand_id;
90    this.certificateSerialNo = certificateSerialNo;
91    this.privateKey = WXPayBrandUtility.loadPrivateKeyFromPath(privateKeyFilePath);
92    this.wechatPayPublicKeyId = wechatPayPublicKeyId;
93    this.wechatPayPublicKey = WXPayBrandUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath);
94  }
95
96  public static class GetCardRequest {
97    @SerializedName("card_id")
98    @Expose(serialize = false)
99    public String cardId;
100  }
101  
102  public static class Card {
103    @SerializedName("out_request_no")
104    public String outRequestNo;
105  
106    @SerializedName("card_id")
107    public String cardId;
108  
109    @SerializedName("brand_id")
110    public String brandId;
111  
112    @SerializedName("appid")
113    public String appid;
114  
115    @SerializedName("card_type")
116    public CardType cardType;
117  
118    @SerializedName("card_title")
119    public String cardTitle;
120  
121    @SerializedName("card_color")
122    public String cardColor;
123  
124    @SerializedName("card_picture_url")
125    public String cardPictureUrl;
126  
127    @SerializedName("code_mode")
128    public CodeMode codeMode;
129  
130    @SerializedName("code_type")
131    public CodeType codeType;
132  
133    @SerializedName("code_jump_information")
134    public CodeJumpInfo codeJumpInformation;
135  
136    @SerializedName("benefits")
137    public String benefits;
138  
139    @SerializedName("notify_url")
140    public String notifyUrl;
141  
142    @SerializedName("need_pinned")
143    public Boolean needPinned;
144  
145    @SerializedName("need_display_level")
146    public Boolean needDisplayLevel;
147  
148    @SerializedName("init_level")
149    public String initLevel;
150  
151    @SerializedName("service_phone")
152    public String servicePhone;
153  
154    @SerializedName("legal_agreement")
155    public String legalAgreement;
156  
157    @SerializedName("valid_date_information")
158    public DateInfo validDateInformation;
159  
160    @SerializedName("member_information")
161    public MemberInfo memberInformation;
162  
163    @SerializedName("points_information")
164    public PointsInfo pointsInformation;
165  
166    @SerializedName("balance_information")
167    public BalanceInfo balanceInformation;
168  
169    @SerializedName("purchase_information")
170    public PurchaseInfo purchaseInformation;
171  
172    @SerializedName("user_information")
173    public UserInfoForm userInformation;
174  
175    @SerializedName("state")
176    public CardState state;
177  
178    @SerializedName("create_time")
179    public String createTime;
180  
181    @SerializedName("modify_time")
182    public String modifyTime;
183  }
184  
185  public enum CardType {
186    @SerializedName("PURCHASE")
187    PURCHASE,
188    @SerializedName("NORMAL")
189    NORMAL,
190    @SerializedName("BALANCE")
191    BALANCE
192  }
193  
194  public enum CodeMode {
195    @SerializedName("SYSTEM_ALLOCATE")
196    SYSTEM_ALLOCATE,
197    @SerializedName("MERCHANT_ALLOCATE")
198    MERCHANT_ALLOCATE
199  }
200  
201  public enum CodeType {
202    @SerializedName("NONE_CODE")
203    NONE_CODE,
204    @SerializedName("BAR_CODE")
205    BAR_CODE,
206    @SerializedName("QR_CODE")
207    QR_CODE,
208    @SerializedName("BAR_CODE_AND_QR_CODE")
209    BAR_CODE_AND_QR_CODE,
210    @SerializedName("JUMP_MINI_PROGRAM")
211    JUMP_MINI_PROGRAM
212  }
213  
214  public static class CodeJumpInfo {
215    @SerializedName("jump_appid")
216    public String jumpAppid;
217  
218    @SerializedName("jump_path")
219    public String jumpPath;
220  }
221  
222  public static class DateInfo {
223    @SerializedName("type")
224    public DateType type;
225  
226    @SerializedName("available_begin_time")
227    public String availableBeginTime;
228  
229    @SerializedName("available_end_time")
230    public String availableEndTime;
231  
232    @SerializedName("available_day_after_receive")
233    public Long availableDayAfterReceive;
234  }
235  
236  public static class MemberInfo {
237    @SerializedName("jump_appid")
238    public String jumpAppid;
239  
240    @SerializedName("jump_path")
241    public String jumpPath;
242  }
243  
244  public static class PointsInfo {
245    @SerializedName("jump_appid")
246    public String jumpAppid;
247  
248    @SerializedName("jump_path")
249    public String jumpPath;
250  }
251  
252  public static class BalanceInfo {
253    @SerializedName("jump_appid")
254    public String jumpAppid;
255  
256    @SerializedName("jump_path")
257    public String jumpPath;
258  }
259  
260  public static class PurchaseInfo {
261    @SerializedName("price")
262    public Long price;
263  
264    @SerializedName("jump_appid")
265    public String jumpAppid;
266  
267    @SerializedName("jump_path")
268    public String jumpPath;
269  }
270  
271  public static class UserInfoForm {
272    @SerializedName("common_field_list")
273    public List<CommonFieldFlag> commonFieldList;
274  
275    @SerializedName("custom_field_list")
276    public List<UserCustomFieldForm> customFieldList;
277  }
278  
279  public enum CardState {
280    @SerializedName("CARD_EFFECTIVE")
281    CARD_EFFECTIVE,
282    @SerializedName("CARD_INVALID")
283    CARD_INVALID
284  }
285  
286  public enum DateType {
287    @SerializedName("FIX_TIME_RANGE")
288    FIX_TIME_RANGE,
289    @SerializedName("FIX_TERM")
290    FIX_TERM,
291    @SerializedName("PERMANENT")
292    PERMANENT
293  }
294  
295  public enum CommonFieldFlag {
296    @SerializedName("USER_FORM_FLAG_SEX")
297    USER_FORM_FLAG_SEX,
298    @SerializedName("USER_FORM_FLAG_NAME")
299    USER_FORM_FLAG_NAME,
300    @SerializedName("USER_FORM_FLAG_BIRTHDAY")
301    USER_FORM_FLAG_BIRTHDAY,
302    @SerializedName("USER_FORM_FLAG_ADDRESS")
303    USER_FORM_FLAG_ADDRESS,
304    @SerializedName("USER_FORM_FLAG_EMAIL")
305    USER_FORM_FLAG_EMAIL,
306    @SerializedName("USER_FORM_FLAG_CITY")
307    USER_FORM_FLAG_CITY
308  }
309  
310  public static class UserCustomFieldForm {
311    @SerializedName("type")
312    public CustomFieldType type;
313  
314    @SerializedName("name")
315    public String name;
316  
317    @SerializedName("values")
318    public List<String> values;
319  }
320  
321  public enum CustomFieldType {
322    @SerializedName("CHECK_BOX")
323    CHECK_BOX,
324    @SerializedName("RADIO")
325    RADIO
326  }
327  
328}
329

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	"strings"
10)
11
12func main() {
13	// TODO: 请准备商户开发必要参数，参考：https://pay.weixin.qq.com/doc/brand/4015415289
14	config, err := wxpay_brand_utility.CreateBrandConfig(
15		"xxxxxxxx",                   // 品牌ID，是由微信支付系统生成并分配给每个品牌方的唯一标识符，品牌ID获取方式参考 https://pay.weixin.qq.com/doc/brand/4015415289
16		"1DDE55AD98Exxxxxxxxxx",      // 品牌API证书序列号，如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015407570
17		"/path/to/apiclient_key.pem", // 品牌API证书私钥文件路径，本地文件路径
18		"PUB_KEY_ID_xxxxxxxxxxxxx",   // 微信支付公钥ID，如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015453439
19		"/path/to/wxp_pub.pem",       // 微信支付公钥文件路径，本地文件路径
20	)
21	if err != nil {
22		fmt.Println(err)
23		return
24	}
25
26	request := &GetCardRequest{
27		CardId: wxpay_brand_utility.String("pbLatjvWOibDc5-TBnbUk1pD1"),
28	}
29
30	response, err := GetCard(config, request)
31	if err != nil {
32		fmt.Printf("请求失败: %+v\n", err)
33		// TODO: 请求失败，根据状态码执行不同的处理
34		return
35	}
36
37	// TODO: 请求成功，继续业务逻辑
38	fmt.Printf("请求成功: %+v\n", response)
39}
40
41func GetCard(config *wxpay_brand_utility.BrandConfig, request *GetCardRequest) (response *Card, err error) {
42	const (
43		host   = "https://api.mch.weixin.qq.com"
44		method = "GET"
45		path   = "/brand/card-member/cards/{card_id}"
46	)
47
48	reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path))
49	if err != nil {
50		return nil, err
51	}
52	reqUrl.Path = strings.Replace(reqUrl.Path, "{card_id}", url.PathEscape(*request.CardId), -1)
53	httpRequest, err := http.NewRequest(method, reqUrl.String(), nil)
54	if err != nil {
55		return nil, err
56	}
57	httpRequest.Header.Set("Accept", "application/json")
58	httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId())
59	authorization, err := wxpay_brand_utility.BuildAuthorization(config.BrandId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), nil)
60	if err != nil {
61		return nil, err
62	}
63	httpRequest.Header.Set("Authorization", authorization)
64
65	client := &http.Client{}
66	httpResponse, err := client.Do(httpRequest)
67	if err != nil {
68		return nil, err
69	}
70	respBody, err := wxpay_brand_utility.ExtractResponseBody(httpResponse)
71	if err != nil {
72		return nil, err
73	}
74	if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 {
75		// 2XX 成功，验证应答签名
76		err = wxpay_brand_utility.ValidateResponse(
77			config.WechatPayPublicKeyId(),
78			config.WechatPayPublicKey(),
79			&httpResponse.Header,
80			respBody,
81		)
82		if err != nil {
83			return nil, err
84		}
85		response := &Card{}
86		if err := json.Unmarshal(respBody, response); err != nil {
87			return nil, err
88		}
89
90		return response, nil
91	} else {
92		return nil, wxpay_brand_utility.NewApiException(
93			httpResponse.StatusCode,
94			httpResponse.Header,
95			respBody,
96		)
97	}
98}
99
100type GetCardRequest struct {
101	CardId *string `json:"card_id,omitempty"`
102}
103
104func (o *GetCardRequest) MarshalJSON() ([]byte, error) {
105	type Alias GetCardRequest
106	a := &struct {
107		CardId *string `json:"card_id,omitempty"`
108		*Alias
109	}{
110		// 序列化时移除非 Body 字段
111		CardId: nil,
112		Alias:  (*Alias)(o),
113	}
114	return json.Marshal(a)
115}
116
117type Card struct {
118	OutRequestNo         *string       `json:"out_request_no,omitempty"`
119	CardId               *string       `json:"card_id,omitempty"`
120	BrandId              *string       `json:"brand_id,omitempty"`
121	Appid                *string       `json:"appid,omitempty"`
122	CardType             *CardType     `json:"card_type,omitempty"`
123	CardTitle            *string       `json:"card_title,omitempty"`
124	CardColor            *string       `json:"card_color,omitempty"`
125	CardPictureUrl       *string       `json:"card_picture_url,omitempty"`
126	CodeMode             *CodeMode     `json:"code_mode,omitempty"`
127	CodeType             *CodeType     `json:"code_type,omitempty"`
128	CodeJumpInformation  *CodeJumpInfo `json:"code_jump_information,omitempty"`
129	Benefits             *string       `json:"benefits,omitempty"`
130	NotifyUrl            *string       `json:"notify_url,omitempty"`
131	NeedPinned           *bool         `json:"need_pinned,omitempty"`
132	NeedDisplayLevel     *bool         `json:"need_display_level,omitempty"`
133	InitLevel            *string       `json:"init_level,omitempty"`
134	ServicePhone         *string       `json:"service_phone,omitempty"`
135	LegalAgreement       *string       `json:"legal_agreement,omitempty"`
136	ValidDateInformation *DateInfo     `json:"valid_date_information,omitempty"`
137	MemberInformation    *MemberInfo   `json:"member_information,omitempty"`
138	PointsInformation    *PointsInfo   `json:"points_information,omitempty"`
139	BalanceInformation   *BalanceInfo  `json:"balance_information,omitempty"`
140	PurchaseInformation  *PurchaseInfo `json:"purchase_information,omitempty"`
141	UserInformation      *UserInfoForm `json:"user_information,omitempty"`
142	State                *CardState    `json:"state,omitempty"`
143	CreateTime           *string       `json:"create_time,omitempty"`
144	ModifyTime           *string       `json:"modify_time,omitempty"`
145}
146
147type CardType string
148
149func (e CardType) Ptr() *CardType {
150	return &e
151}
152
153const (
154	CARDTYPE_PURCHASE CardType = "PURCHASE"
155	CARDTYPE_NORMAL   CardType = "NORMAL"
156	CARDTYPE_BALANCE  CardType = "BALANCE"
157)
158
159type CodeMode string
160
161func (e CodeMode) Ptr() *CodeMode {
162	return &e
163}
164
165const (
166	CODEMODE_SYSTEM_ALLOCATE   CodeMode = "SYSTEM_ALLOCATE"
167	CODEMODE_MERCHANT_ALLOCATE CodeMode = "MERCHANT_ALLOCATE"
168)
169
170type CodeType string
171
172func (e CodeType) Ptr() *CodeType {
173	return &e
174}
175
176const (
177	CODETYPE_NONE_CODE            CodeType = "NONE_CODE"
178	CODETYPE_BAR_CODE             CodeType = "BAR_CODE"
179	CODETYPE_QR_CODE              CodeType = "QR_CODE"
180	CODETYPE_BAR_CODE_AND_QR_CODE CodeType = "BAR_CODE_AND_QR_CODE"
181	CODETYPE_JUMP_MINI_PROGRAM    CodeType = "JUMP_MINI_PROGRAM"
182)
183
184type CodeJumpInfo struct {
185	JumpAppid *string `json:"jump_appid,omitempty"`
186	JumpPath  *string `json:"jump_path,omitempty"`
187}
188
189type DateInfo struct {
190	Type                     *DateType `json:"type,omitempty"`
191	AvailableBeginTime       *string   `json:"available_begin_time,omitempty"`
192	AvailableEndTime         *string   `json:"available_end_time,omitempty"`
193	AvailableDayAfterReceive *int64    `json:"available_day_after_receive,omitempty"`
194}
195
196type MemberInfo struct {
197	JumpAppid *string `json:"jump_appid,omitempty"`
198	JumpPath  *string `json:"jump_path,omitempty"`
199}
200
201type PointsInfo struct {
202	JumpAppid *string `json:"jump_appid,omitempty"`
203	JumpPath  *string `json:"jump_path,omitempty"`
204}
205
206type BalanceInfo struct {
207	JumpAppid *string `json:"jump_appid,omitempty"`
208	JumpPath  *string `json:"jump_path,omitempty"`
209}
210
211type PurchaseInfo struct {
212	Price     *int64  `json:"price,omitempty"`
213	JumpAppid *string `json:"jump_appid,omitempty"`
214	JumpPath  *string `json:"jump_path,omitempty"`
215}
216
217type UserInfoForm struct {
218	CommonFieldList []CommonFieldFlag     `json:"common_field_list,omitempty"`
219	CustomFieldList []UserCustomFieldForm `json:"custom_field_list,omitempty"`
220}
221
222type CardState string
223
224func (e CardState) Ptr() *CardState {
225	return &e
226}
227
228const (
229	CARDSTATE_CARD_EFFECTIVE CardState = "CARD_EFFECTIVE"
230	CARDSTATE_CARD_INVALID   CardState = "CARD_INVALID"
231)
232
233type DateType string
234
235func (e DateType) Ptr() *DateType {
236	return &e
237}
238
239const (
240	DATETYPE_FIX_TIME_RANGE DateType = "FIX_TIME_RANGE"
241	DATETYPE_FIX_TERM       DateType = "FIX_TERM"
242	DATETYPE_PERMANENT      DateType = "PERMANENT"
243)
244
245type CommonFieldFlag string
246
247func (e CommonFieldFlag) Ptr() *CommonFieldFlag {
248	return &e
249}
250
251const (
252	COMMONFIELDFLAG_USER_FORM_FLAG_SEX      CommonFieldFlag = "USER_FORM_FLAG_SEX"
253	COMMONFIELDFLAG_USER_FORM_FLAG_NAME     CommonFieldFlag = "USER_FORM_FLAG_NAME"
254	COMMONFIELDFLAG_USER_FORM_FLAG_BIRTHDAY CommonFieldFlag = "USER_FORM_FLAG_BIRTHDAY"
255	COMMONFIELDFLAG_USER_FORM_FLAG_ADDRESS  CommonFieldFlag = "USER_FORM_FLAG_ADDRESS"
256	COMMONFIELDFLAG_USER_FORM_FLAG_EMAIL    CommonFieldFlag = "USER_FORM_FLAG_EMAIL"
257	COMMONFIELDFLAG_USER_FORM_FLAG_CITY     CommonFieldFlag = "USER_FORM_FLAG_CITY"
258)
259
260type UserCustomFieldForm struct {
261	Type   *CustomFieldType `json:"type,omitempty"`
262	Name   *string          `json:"name,omitempty"`
263	Values []string         `json:"values,omitempty"`
264}
265
266type CustomFieldType string
267
268func (e CustomFieldType) Ptr() *CustomFieldType {
269	return &e
270}
271
272const (
273	CUSTOMFIELDTYPE_CHECK_BOX CustomFieldType = "CHECK_BOX"
274	CUSTOMFIELDTYPE_RADIO     CustomFieldType = "RADIO"
275)
276