失效商品券

1curl -X POST \
2  https://api.mch.weixin.qq.com/v3/marketing/partner/product-coupon/product-coupons/200000001/deactivate \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" \
5  -H "Content-Type: application/json" \
6  -d '{
7    "out_request_no" : "34657_20250101_123456",
8    "deactivate_reason" : "批次信息有误，重新创建",
9    "brand_id" : "120344"
10  }'
11

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 DeactivateProductCoupon {
26  private static String HOST = "https://api.mch.weixin.qq.com";
27  private static String METHOD = "POST";
28  private static String PATH = "/v3/marketing/partner/product-coupon/product-coupons/{product_coupon_id}/deactivate";
29
30  public static void main(String[] args) {
31    // TODO: 请准备商户开发必要参数，参考：https://pay.weixin.qq.com/doc/v3/partner/4013080340
32    DeactivateProductCoupon client = new DeactivateProductCoupon(
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    DeactivateProductCouponRequest request = new DeactivateProductCouponRequest();
42    request.productCouponId = "200000001";
43    request.outRequestNo = "34657_20250101_123456";
44    request.deactivateReason = "批次信息有误，重新创建";
45    request.brandId = "120344";
46    try {
47      ProductCouponEntity response = client.run(request);
48        // TODO: 请求成功，继续业务逻辑
49        System.out.println(response);
50    } catch (WXPayUtility.ApiException e) {
51        // TODO: 请求失败，根据状态码执行不同的逻辑
52        e.printStackTrace();
53    }
54  }
55
56  public ProductCouponEntity run(DeactivateProductCouponRequest request) {
57    String uri = PATH;
58    uri = uri.replace("{product_coupon_id}", WXPayUtility.urlEncode(request.productCouponId));
59    String reqBody = WXPayUtility.toJson(request);
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, reqBody));
65    reqBuilder.addHeader("Content-Type", "application/json");
66    RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody);
67    reqBuilder.method(METHOD, requestBody);
68    Request httpRequest = reqBuilder.build();
69
70    // 发送HTTP请求
71    OkHttpClient client = new OkHttpClient.Builder().build();
72    try (Response httpResponse = client.newCall(httpRequest).execute()) {
73      String respBody = WXPayUtility.extractBody(httpResponse);
74      if (httpResponse.code() >= 200 && httpResponse.code() < 300) {
75        // 2XX 成功，验证应答签名
76        WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey,
77            httpResponse.headers(), respBody);
78
79        // 从HTTP应答报文构建返回数据
80        return WXPayUtility.fromJson(respBody, ProductCouponEntity.class);
81      } else {
82        throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers());
83      }
84    } catch (IOException e) {
85      throw new UncheckedIOException("Sending request to " + uri + " failed.", e);
86    }
87  }
88
89  private final String mchid;
90  private final String certificateSerialNo;
91  private final PrivateKey privateKey;
92  private final String wechatPayPublicKeyId;
93  private final PublicKey wechatPayPublicKey;
94
95  public DeactivateProductCoupon(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) {
96    this.mchid = mchid;
97    this.certificateSerialNo = certificateSerialNo;
98    this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath);
99    this.wechatPayPublicKeyId = wechatPayPublicKeyId;
100    this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath);
101  }
102
103  public static class DeactivateProductCouponRequest {
104    @SerializedName("out_request_no")
105    public String outRequestNo;
106  
107    @SerializedName("product_coupon_id")
108    @Expose(serialize = false)
109    public String productCouponId;
110  
111    @SerializedName("deactivate_reason")
112    public String deactivateReason;
113  
114    @SerializedName("brand_id")
115    public String brandId;
116  }
117  
118  public static class ProductCouponEntity {
119    @SerializedName("product_coupon_id")
120    public String productCouponId;
121  
122    @SerializedName("scope")
123    public ProductCouponScope scope;
124  
125    @SerializedName("type")
126    public ProductCouponType type;
127  
128    @SerializedName("usage_mode")
129    public UsageMode usageMode;
130  
131    @SerializedName("single_usage_info")
132    public SingleUsageInfo singleUsageInfo;
133  
134    @SerializedName("sequential_usage_info")
135    public SequentialUsageInfo sequentialUsageInfo;
136  
137    @SerializedName("display_info")
138    public ProductCouponDisplayInfo displayInfo;
139  
140    @SerializedName("out_product_no")
141    public String outProductNo;
142  
143    @SerializedName("state")
144    public ProductCouponState state;
145  
146    @SerializedName("deactivate_request_no")
147    public String deactivateRequestNo;
148  
149    @SerializedName("deactivate_time")
150    public String deactivateTime;
151  
152    @SerializedName("deactivate_reason")
153    public String deactivateReason;
154  
155    @SerializedName("brand_id")
156    public String brandId;
157  }
158  
159  public enum ProductCouponScope {
160    @SerializedName("ALL")
161    ALL,
162    @SerializedName("SINGLE")
163    SINGLE
164  }
165  
166  public enum ProductCouponType {
167    @SerializedName("NORMAL")
168    NORMAL,
169    @SerializedName("DISCOUNT")
170    DISCOUNT,
171    @SerializedName("EXCHANGE")
172    EXCHANGE
173  }
174  
175  public enum UsageMode {
176    @SerializedName("SINGLE")
177    SINGLE,
178    @SerializedName("SEQUENTIAL")
179    SEQUENTIAL
180  }
181  
182  public static class SingleUsageInfo {
183    @SerializedName("normal_coupon")
184    public NormalCouponUsageRule normalCoupon;
185  
186    @SerializedName("discount_coupon")
187    public DiscountCouponUsageRule discountCoupon;
188  }
189  
190  public static class SequentialUsageInfo {
191    @SerializedName("type")
192    public SequentialUsageType type;
193  
194    @SerializedName("count")
195    public Long count;
196  
197    @SerializedName("available_days")
198    public Long availableDays;
199  
200    @SerializedName("interval_days")
201    public Long intervalDays;
202  }
203  
204  public static class ProductCouponDisplayInfo {
205    @SerializedName("name")
206    public String name;
207  
208    @SerializedName("image_url")
209    public String imageUrl;
210  
211    @SerializedName("background_url")
212    public String backgroundUrl;
213  
214    @SerializedName("detail_image_url_list")
215    public List<String> detailImageUrlList;
216  
217    @SerializedName("original_price")
218    public Long originalPrice;
219  
220    @SerializedName("combo_package_list")
221    public List<ComboPackage> comboPackageList;
222  }
223  
224  public enum ProductCouponState {
225    @SerializedName("AUDITING")
226    AUDITING,
227    @SerializedName("EFFECTIVE")
228    EFFECTIVE,
229    @SerializedName("DEACTIVATED")
230    DEACTIVATED
231  }
232  
233  public static class NormalCouponUsageRule {
234    @SerializedName("threshold")
235    public Long threshold;
236  
237    @SerializedName("discount_amount")
238    public Long discountAmount;
239  }
240  
241  public static class DiscountCouponUsageRule {
242    @SerializedName("threshold")
243    public Long threshold;
244  
245    @SerializedName("percent_off")
246    public Long percentOff;
247  }
248  
249  public enum SequentialUsageType {
250    @SerializedName("INCREMENTAL")
251    INCREMENTAL,
252    @SerializedName("EQUAL")
253    EQUAL
254  }
255  
256  public static class ComboPackage {
257    @SerializedName("name")
258    public String name;
259  
260    @SerializedName("pick_count")
261    public Long pickCount;
262  
263    @SerializedName("choice_list")
264    public List<ComboPackageChoice> choiceList = new ArrayList<ComboPackageChoice>();
265  }
266  
267  public static class ComboPackageChoice {
268    @SerializedName("name")
269    public String name;
270  
271    @SerializedName("price")
272    public Long price;
273  
274    @SerializedName("count")
275    public Long count;
276  
277    @SerializedName("image_url")
278    public String imageUrl;
279  
280    @SerializedName("mini_program_appid")
281    public String miniProgramAppid;
282  
283    @SerializedName("mini_program_path")
284    public String miniProgramPath;
285  }
286  
287}
288

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 := &DeactivateProductCouponRequest{
28		ProductCouponId:  wxpay_utility.String("200000001"),
29		OutRequestNo:     wxpay_utility.String("34657_20250101_123456"),
30		DeactivateReason: wxpay_utility.String("批次信息有误，重新创建"),
31		BrandId:          wxpay_utility.String("120344"),
32	}
33
34	response, err := DeactivateProductCoupon(config, request)
35	if err != nil {
36		fmt.Printf("请求失败: %+v\n", err)
37		// TODO: 请求失败，根据状态码执行不同的处理
38		return
39	}
40
41	// TODO: 请求成功，继续业务逻辑
42	fmt.Printf("请求成功: %+v\n", response)
43}
44
45func DeactivateProductCoupon(config *wxpay_utility.MchConfig, request *DeactivateProductCouponRequest) (response *ProductCouponEntity, err error) {
46	const (
47		host   = "https://api.mch.weixin.qq.com"
48		method = "POST"
49		path   = "/v3/marketing/partner/product-coupon/product-coupons/{product_coupon_id}/deactivate"
50	)
51
52	reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path))
53	if err != nil {
54		return nil, err
55	}
56	reqUrl.Path = strings.Replace(reqUrl.Path, "{product_coupon_id}", url.PathEscape(*request.ProductCouponId), -1)
57	reqBody, err := json.Marshal(request)
58	if err != nil {
59		return nil, err
60	}
61	httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody))
62	if err != nil {
63		return nil, err
64	}
65	httpRequest.Header.Set("Accept", "application/json")
66	httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId())
67	httpRequest.Header.Set("Content-Type", "application/json")
68	authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), reqBody)
69	if err != nil {
70		return nil, err
71	}
72	httpRequest.Header.Set("Authorization", authorization)
73
74	client := &http.Client{}
75	httpResponse, err := client.Do(httpRequest)
76	if err != nil {
77		return nil, err
78	}
79	respBody, err := wxpay_utility.ExtractResponseBody(httpResponse)
80	if err != nil {
81		return nil, err
82	}
83	if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 {
84		// 2XX 成功，验证应答签名
85		err = wxpay_utility.ValidateResponse(
86			config.WechatPayPublicKeyId(),
87			config.WechatPayPublicKey(),
88			&httpResponse.Header,
89			respBody,
90		)
91		if err != nil {
92			return nil, err
93		}
94		response := &ProductCouponEntity{}
95		if err := json.Unmarshal(respBody, response); err != nil {
96			return nil, err
97		}
98
99		return response, nil
100	} else {
101		return nil, wxpay_utility.NewApiException(
102			httpResponse.StatusCode,
103			httpResponse.Header,
104			respBody,
105		)
106	}
107}
108
109type DeactivateProductCouponRequest struct {
110	OutRequestNo     *string `json:"out_request_no,omitempty"`
111	ProductCouponId  *string `json:"product_coupon_id,omitempty"`
112	DeactivateReason *string `json:"deactivate_reason,omitempty"`
113	BrandId          *string `json:"brand_id,omitempty"`
114}
115
116func (o *DeactivateProductCouponRequest) MarshalJSON() ([]byte, error) {
117	type Alias DeactivateProductCouponRequest
118	a := &struct {
119		ProductCouponId *string `json:"product_coupon_id,omitempty"`
120		*Alias
121	}{
122		// 序列化时移除非 Body 字段
123		ProductCouponId: nil,
124		Alias:           (*Alias)(o),
125	}
126	return json.Marshal(a)
127}
128
129type ProductCouponEntity struct {
130	ProductCouponId     *string                   `json:"product_coupon_id,omitempty"`
131	Scope               *ProductCouponScope       `json:"scope,omitempty"`
132	Type                *ProductCouponType        `json:"type,omitempty"`
133	UsageMode           *UsageMode                `json:"usage_mode,omitempty"`
134	SingleUsageInfo     *SingleUsageInfo          `json:"single_usage_info,omitempty"`
135	SequentialUsageInfo *SequentialUsageInfo      `json:"sequential_usage_info,omitempty"`
136	DisplayInfo         *ProductCouponDisplayInfo `json:"display_info,omitempty"`
137	OutProductNo        *string                   `json:"out_product_no,omitempty"`
138	State               *ProductCouponState       `json:"state,omitempty"`
139	DeactivateRequestNo *string                   `json:"deactivate_request_no,omitempty"`
140	DeactivateTime      *string                   `json:"deactivate_time,omitempty"`
141	DeactivateReason    *string                   `json:"deactivate_reason,omitempty"`
142	BrandId             *string                   `json:"brand_id,omitempty"`
143}
144
145type ProductCouponScope string
146
147func (e ProductCouponScope) Ptr() *ProductCouponScope {
148	return &e
149}
150
151const (
152	PRODUCTCOUPONSCOPE_ALL    ProductCouponScope = "ALL"
153	PRODUCTCOUPONSCOPE_SINGLE ProductCouponScope = "SINGLE"
154)
155
156type ProductCouponType string
157
158func (e ProductCouponType) Ptr() *ProductCouponType {
159	return &e
160}
161
162const (
163	PRODUCTCOUPONTYPE_NORMAL   ProductCouponType = "NORMAL"
164	PRODUCTCOUPONTYPE_DISCOUNT ProductCouponType = "DISCOUNT"
165	PRODUCTCOUPONTYPE_EXCHANGE ProductCouponType = "EXCHANGE"
166)
167
168type UsageMode string
169
170func (e UsageMode) Ptr() *UsageMode {
171	return &e
172}
173
174const (
175	USAGEMODE_SINGLE     UsageMode = "SINGLE"
176	USAGEMODE_SEQUENTIAL UsageMode = "SEQUENTIAL"
177)
178
179type SingleUsageInfo struct {
180	NormalCoupon   *NormalCouponUsageRule   `json:"normal_coupon,omitempty"`
181	DiscountCoupon *DiscountCouponUsageRule `json:"discount_coupon,omitempty"`
182}
183
184type SequentialUsageInfo struct {
185	Type          *SequentialUsageType `json:"type,omitempty"`
186	Count         *int64               `json:"count,omitempty"`
187	AvailableDays *int64               `json:"available_days,omitempty"`
188	IntervalDays  *int64               `json:"interval_days,omitempty"`
189}
190
191type ProductCouponDisplayInfo struct {
192	Name               *string        `json:"name,omitempty"`
193	ImageUrl           *string        `json:"image_url,omitempty"`
194	BackgroundUrl      *string        `json:"background_url,omitempty"`
195	DetailImageUrlList []string       `json:"detail_image_url_list,omitempty"`
196	OriginalPrice      *int64         `json:"original_price,omitempty"`
197	ComboPackageList   []ComboPackage `json:"combo_package_list,omitempty"`
198}
199
200type ProductCouponState string
201
202func (e ProductCouponState) Ptr() *ProductCouponState {
203	return &e
204}
205
206const (
207	PRODUCTCOUPONSTATE_AUDITING    ProductCouponState = "AUDITING"
208	PRODUCTCOUPONSTATE_EFFECTIVE   ProductCouponState = "EFFECTIVE"
209	PRODUCTCOUPONSTATE_DEACTIVATED ProductCouponState = "DEACTIVATED"
210)
211
212type NormalCouponUsageRule struct {
213	Threshold      *int64 `json:"threshold,omitempty"`
214	DiscountAmount *int64 `json:"discount_amount,omitempty"`
215}
216
217type DiscountCouponUsageRule struct {
218	Threshold  *int64 `json:"threshold,omitempty"`
219	PercentOff *int64 `json:"percent_off,omitempty"`
220}
221
222type SequentialUsageType string
223
224func (e SequentialUsageType) Ptr() *SequentialUsageType {
225	return &e
226}
227
228const (
229	SEQUENTIALUSAGETYPE_INCREMENTAL SequentialUsageType = "INCREMENTAL"
230	SEQUENTIALUSAGETYPE_EQUAL       SequentialUsageType = "EQUAL"
231)
232
233type ComboPackage struct {
234	Name       *string              `json:"name,omitempty"`
235	PickCount  *int64               `json:"pick_count,omitempty"`
236	ChoiceList []ComboPackageChoice `json:"choice_list,omitempty"`
237}
238
239type ComboPackageChoice struct {
240	Name             *string `json:"name,omitempty"`
241	Price            *int64  `json:"price,omitempty"`
242	Count            *int64  `json:"count,omitempty"`
243	ImageUrl         *string `json:"image_url,omitempty"`
244	MiniProgramAppid *string `json:"mini_program_appid,omitempty"`
245	MiniProgramPath  *string `json:"mini_program_path,omitempty"`
246}
247