作废会员卡模板

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

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