查询会员卡模板信息

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

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