作废会员卡模板

1curl -X POST \
2  https://api.mch.weixin.qq.com/v3/brand/partner/card-member/cards/pbLatjvWOibDc5-TBnbUk1pD12o0/invalidate \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" \
5  -H "Content-Type: application/json" \
6  -d '{
7    "brand_id" : "1004"
8  }'
9

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

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