作废会员卡模板

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  
187  public enum CardType {
188    @SerializedName("PURCHASE")
189    PURCHASE,
190    @SerializedName("NORMAL")
191    NORMAL,
192    @SerializedName("BALANCE")
193    BALANCE
194  }
195  
196  public enum CodeMode {
197    @SerializedName("SYSTEM_ALLOCATE")
198    SYSTEM_ALLOCATE,
199    @SerializedName("MERCHANT_ALLOCATE")
200    MERCHANT_ALLOCATE
201  }
202  
203  public enum CodeType {
204    @SerializedName("NONE_CODE")
205    NONE_CODE,
206    @SerializedName("BAR_CODE")
207    BAR_CODE,
208    @SerializedName("QR_CODE")
209    QR_CODE,
210    @SerializedName("BAR_CODE_AND_QR_CODE")
211    BAR_CODE_AND_QR_CODE,
212    @SerializedName("JUMP_MINI_PROGRAM")
213    JUMP_MINI_PROGRAM
214  }
215  
216  public static class CodeJumpInfo {
217    @SerializedName("jump_appid")
218    public String jumpAppid;
219  
220    @SerializedName("jump_path")
221    public String jumpPath;
222  }
223  
224  public static class DateInfo {
225    @SerializedName("type")
226    public DateType type;
227  
228    @SerializedName("available_begin_time")
229    public String availableBeginTime;
230  
231    @SerializedName("available_end_time")
232    public String availableEndTime;
233  
234    @SerializedName("available_day_after_receive")
235    public Long availableDayAfterReceive;
236  }
237  
238  public static class MemberInfo {
239    @SerializedName("jump_appid")
240    public String jumpAppid;
241  
242    @SerializedName("jump_path")
243    public String jumpPath;
244  }
245  
246  public static class PointsInfo {
247    @SerializedName("jump_appid")
248    public String jumpAppid;
249  
250    @SerializedName("jump_path")
251    public String jumpPath;
252  }
253  
254  public static class BalanceInfo {
255    @SerializedName("jump_appid")
256    public String jumpAppid;
257  
258    @SerializedName("jump_path")
259    public String jumpPath;
260  }
261  
262  public static class PurchaseInfo {
263    @SerializedName("price")
264    public Long price;
265  
266    @SerializedName("jump_appid")
267    public String jumpAppid;
268  
269    @SerializedName("jump_path")
270    public String jumpPath;
271  }
272  
273  public static class UserInfoForm {
274    @SerializedName("common_field_list")
275    public List<CommonFieldFlag> commonFieldList;
276  
277    @SerializedName("custom_field_list")
278    public List<UserCustomFieldForm> customFieldList;
279  }
280  
281  public enum CardState {
282    @SerializedName("CARD_EFFECTIVE")
283    CARD_EFFECTIVE,
284    @SerializedName("CARD_INVALID")
285    CARD_INVALID
286  }
287  
288  public enum DateType {
289    @SerializedName("FIX_TIME_RANGE")
290    FIX_TIME_RANGE,
291    @SerializedName("FIX_TERM")
292    FIX_TERM,
293    @SerializedName("PERMANENT")
294    PERMANENT
295  }
296  
297  public enum CommonFieldFlag {
298    @SerializedName("USER_FORM_FLAG_SEX")
299    USER_FORM_FLAG_SEX,
300    @SerializedName("USER_FORM_FLAG_NAME")
301    USER_FORM_FLAG_NAME,
302    @SerializedName("USER_FORM_FLAG_BIRTHDAY")
303    USER_FORM_FLAG_BIRTHDAY,
304    @SerializedName("USER_FORM_FLAG_ADDRESS")
305    USER_FORM_FLAG_ADDRESS,
306    @SerializedName("USER_FORM_FLAG_EMAIL")
307    USER_FORM_FLAG_EMAIL,
308    @SerializedName("USER_FORM_FLAG_CITY")
309    USER_FORM_FLAG_CITY
310  }
311  
312  public static class UserCustomFieldForm {
313    @SerializedName("type")
314    public CustomFieldType type;
315  
316    @SerializedName("name")
317    public String name;
318  
319    @SerializedName("values")
320    public List<String> values;
321  }
322  
323  public enum CustomFieldType {
324    @SerializedName("CHECK_BOX")
325    CHECK_BOX,
326    @SerializedName("RADIO")
327    RADIO
328  }
329  
330}
331

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