作废会员卡模板

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

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