失效用户商品券

1curl -X POST \
2  https://api.mch.weixin.qq.com/v3/marketing/partner/product-coupon/users/oh-394z-6CGkNoJrsDLTTUKiAnp4/coupons/Code_123456/deactivate \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" \
5  -H "Content-Type: application/json" \
6  -d '{
7    "product_coupon_id" : "1000000013",
8    "appid" : "wx233544546545989",
9    "deactivate_reason" : "商品已下线，使用户商品券失效",
10    "stock_id" : "1000000013001",
11    "out_request_no" : "MCHDEACTIVATE202003101234",
12    "brand_id" : "120344"
13  }'
14

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 DeactivateUserProductCoupon {
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/users/{openid}/coupons/{coupon_code}/deactivate";
29
30  public static void main(String[] args) {
31    // TODO: 请准备商户开发必要参数，参考：https://pay.weixin.qq.com/doc/v3/partner/4013080340
32    DeactivateUserProductCoupon client = new DeactivateUserProductCoupon(
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    DeactivateUserProductCouponRequest request = new DeactivateUserProductCouponRequest();
41    request.productCouponId = "1000000013";
42    request.stockId = "1000000013001";
43    request.couponCode = "Code_123456";
44    request.appid = "wx233544546545989";
45    request.openid = "oh-394z-6CGkNoJrsDLTTUKiAnp4";
46    request.outRequestNo = "MCHDEACTIVATE202003101234";
47    request.deactivateReason = "商品已下线，使用户商品券失效";
48    request.brandId = "120344";
49    try {
50      UserProductCouponEntity response = client.run(request);
51        // TODO: 请求成功，继续业务逻辑
52        System.out.println(response);
53    } catch (WXPayUtility.ApiException e) {
54        // TODO: 请求失败，根据状态码执行不同的逻辑
55        e.printStackTrace();
56    }
57  }
58
59  public UserProductCouponEntity run(DeactivateUserProductCouponRequest request) {
60    String uri = PATH;
61    uri = uri.replace("{coupon_code}", WXPayUtility.urlEncode(request.couponCode));
62    uri = uri.replace("{openid}", WXPayUtility.urlEncode(request.openid));
63    String reqBody = WXPayUtility.toJson(request);
64
65    Request.Builder reqBuilder = new Request.Builder().url(HOST + uri);
66    reqBuilder.addHeader("Accept", "application/json");
67    reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId);
68    reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo,privateKey, METHOD, uri, reqBody));
69    reqBuilder.addHeader("Content-Type", "application/json");
70    RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody);
71    reqBuilder.method(METHOD, requestBody);
72    Request httpRequest = reqBuilder.build();
73
74    // 发送HTTP请求
75    OkHttpClient client = new OkHttpClient.Builder().build();
76    try (Response httpResponse = client.newCall(httpRequest).execute()) {
77      String respBody = WXPayUtility.extractBody(httpResponse);
78      if (httpResponse.code() >= 200 && httpResponse.code() < 300) {
79        // 2XX 成功，验证应答签名
80        WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey,
81            httpResponse.headers(), respBody);
82
83        // 从HTTP应答报文构建返回数据
84        return WXPayUtility.fromJson(respBody, UserProductCouponEntity.class);
85      } else {
86        throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers());
87      }
88    } catch (IOException e) {
89      throw new UncheckedIOException("Sending request to " + uri + " failed.", e);
90    }
91  }
92
93  private final String mchid;
94  private final String certificateSerialNo;
95  private final PrivateKey privateKey;
96  private final String wechatPayPublicKeyId;
97  private final PublicKey wechatPayPublicKey;
98
99  public DeactivateUserProductCoupon(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) {
100    this.mchid = mchid;
101    this.certificateSerialNo = certificateSerialNo;
102    this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath);
103    this.wechatPayPublicKeyId = wechatPayPublicKeyId;
104    this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath);
105  }
106
107  public static class DeactivateUserProductCouponRequest {
108    @SerializedName("product_coupon_id")
109    public String productCouponId;
110  
111    @SerializedName("stock_id")
112    public String stockId;
113  
114    @SerializedName("coupon_code")
115    @Expose(serialize = false)
116    public String couponCode;
117  
118    @SerializedName("appid")
119    public String appid;
120  
121    @SerializedName("openid")
122    @Expose(serialize = false)
123    public String openid;
124  
125    @SerializedName("out_request_no")
126    public String outRequestNo;
127  
128    @SerializedName("deactivate_reason")
129    public String deactivateReason;
130  
131    @SerializedName("brand_id")
132    public String brandId;
133  }
134  
135  public static class UserProductCouponEntity {
136    @SerializedName("coupon_code")
137    public String couponCode;
138  
139    @SerializedName("coupon_state")
140    public UserProductCouponState couponState;
141  
142    @SerializedName("valid_begin_time")
143    public String validBeginTime;
144  
145    @SerializedName("valid_end_time")
146    public String validEndTime;
147  
148    @SerializedName("receive_time")
149    public String receiveTime;
150  
151    @SerializedName("send_request_no")
152    public String sendRequestNo;
153  
154    @SerializedName("send_channel")
155    public UserProductCouponSendChannel sendChannel;
156  
157    @SerializedName("confirm_request_no")
158    public String confirmRequestNo;
159  
160    @SerializedName("confirm_time")
161    public String confirmTime;
162  
163    @SerializedName("deactivate_request_no")
164    public String deactivateRequestNo;
165  
166    @SerializedName("deactivate_time")
167    public String deactivateTime;
168  
169    @SerializedName("deactivate_reason")
170    public String deactivateReason;
171  
172    @SerializedName("single_usage_detail")
173    public CouponUsageDetail singleUsageDetail;
174  
175    @SerializedName("user_product_coupon_bundle_info")
176    public UserProductCouponBundleInfo userProductCouponBundleInfo;
177  
178    @SerializedName("product_coupon")
179    public ProductCouponEntity productCoupon;
180  
181    @SerializedName("stock")
182    public StockEntity stock;
183  
184    @SerializedName("attach")
185    public String attach;
186  
187    @SerializedName("channel_custom_info")
188    public String channelCustomInfo;
189  
190    @SerializedName("coupon_tag_info")
191    public CouponTagInfo couponTagInfo;
192  
193    @SerializedName("brand_id")
194    public String brandId;
195  }
196  
197  public enum UserProductCouponState {
198    @SerializedName("CONFIRMING")
199    CONFIRMING,
200    @SerializedName("PENDING")
201    PENDING,
202    @SerializedName("EFFECTIVE")
203    EFFECTIVE,
204    @SerializedName("USED")
205    USED,
206    @SerializedName("EXPIRED")
207    EXPIRED,
208    @SerializedName("DELETED")
209    DELETED,
210    @SerializedName("DEACTIVATED")
211    DEACTIVATED
212  }
213  
214  public enum UserProductCouponSendChannel {
215    @SerializedName("BRAND_MANAGE")
216    BRAND_MANAGE,
217    @SerializedName("API")
218    API,
219    @SerializedName("RECEIVE_COMPONENT")
220    RECEIVE_COMPONENT
221  }
222  
223  public static class CouponUsageDetail {
224    @SerializedName("use_request_no")
225    public String useRequestNo;
226  
227    @SerializedName("use_time")
228    public String useTime;
229  
230    @SerializedName("return_request_no")
231    public String returnRequestNo;
232  
233    @SerializedName("return_time")
234    public String returnTime;
235  
236    @SerializedName("associated_order_info")
237    public UserProductCouponAssociatedOrderInfo associatedOrderInfo;
238  
239    @SerializedName("associated_pay_score_order_info")
240    public UserProductCouponAssociatedPayScoreOrderInfo associatedPayScoreOrderInfo;
241  }
242  
243  public static class UserProductCouponBundleInfo {
244    @SerializedName("user_coupon_bundle_id")
245    public String userCouponBundleId;
246  
247    @SerializedName("user_coupon_bundle_index")
248    public Long userCouponBundleIndex;
249  
250    @SerializedName("total_count")
251    public Long totalCount;
252  
253    @SerializedName("used_count")
254    public Long usedCount;
255  }
256  
257  public static class ProductCouponEntity {
258    @SerializedName("product_coupon_id")
259    public String productCouponId;
260  
261    @SerializedName("scope")
262    public ProductCouponScope scope;
263  
264    @SerializedName("type")
265    public ProductCouponType type;
266  
267    @SerializedName("usage_mode")
268    public UsageMode usageMode;
269  
270    @SerializedName("single_usage_info")
271    public SingleUsageInfo singleUsageInfo;
272  
273    @SerializedName("progressive_bundle_usage_info")
274    public ProgressiveBundleUsageInfo progressiveBundleUsageInfo;
275  
276    @SerializedName("display_info")
277    public ProductCouponDisplayInfo displayInfo;
278  
279    @SerializedName("out_product_no")
280    public String outProductNo;
281  
282    @SerializedName("state")
283    public ProductCouponState state;
284  
285    @SerializedName("deactivate_request_no")
286    public String deactivateRequestNo;
287  
288    @SerializedName("deactivate_time")
289    public String deactivateTime;
290  
291    @SerializedName("deactivate_reason")
292    public String deactivateReason;
293  
294    @SerializedName("brand_id")
295    public String brandId;
296  }
297  
298  public static class StockEntity {
299    @SerializedName("product_coupon_id")
300    public String productCouponId;
301  
302    @SerializedName("stock_id")
303    public String stockId;
304  
305    @SerializedName("remark")
306    public String remark;
307  
308    @SerializedName("coupon_code_mode")
309    public CouponCodeMode couponCodeMode;
310  
311    @SerializedName("coupon_code_count_info")
312    public CouponCodeCountInfo couponCodeCountInfo;
313  
314    @SerializedName("stock_send_rule")
315    public StockSendRule stockSendRule;
316  
317    @SerializedName("single_usage_rule")
318    public SingleUsageRule singleUsageRule;
319  
320    @SerializedName("usage_rule_display_info")
321    public UsageRuleDisplayInfo usageRuleDisplayInfo;
322  
323    @SerializedName("coupon_display_info")
324    public CouponDisplayInfo couponDisplayInfo;
325  
326    @SerializedName("notify_config")
327    public NotifyConfig notifyConfig;
328  
329    @SerializedName("store_scope")
330    public StockStoreScope storeScope;
331  
332    @SerializedName("sent_count_info")
333    public StockSentCountInfo sentCountInfo;
334  
335    @SerializedName("state")
336    public StockState state;
337  
338    @SerializedName("deactivate_request_no")
339    public String deactivateRequestNo;
340  
341    @SerializedName("deactivate_time")
342    public String deactivateTime;
343  
344    @SerializedName("deactivate_reason")
345    public String deactivateReason;
346  
347    @SerializedName("brand_id")
348    public String brandId;
349  }
350  
351  public static class CouponTagInfo {
352    @SerializedName("coupon_tag_list")
353    public List<UserProductCouponTag> couponTagList;
354  
355    @SerializedName("member_tag_info")
356    public MemberTagInfo memberTagInfo;
357  }
358  
359  public static class UserProductCouponAssociatedOrderInfo {
360    @SerializedName("transaction_id")
361    public String transactionId;
362  
363    @SerializedName("out_trade_no")
364    public String outTradeNo;
365  
366    @SerializedName("mchid")
367    public String mchid;
368  
369    @SerializedName("sub_mchid")
370    public String subMchid;
371  }
372  
373  public static class UserProductCouponAssociatedPayScoreOrderInfo {
374    @SerializedName("order_id")
375    public String orderId;
376  
377    @SerializedName("out_order_no")
378    public String outOrderNo;
379  
380    @SerializedName("mchid")
381    public String mchid;
382  
383    @SerializedName("sub_mchid")
384    public String subMchid;
385  }
386  
387  public enum ProductCouponScope {
388    @SerializedName("ALL")
389    ALL,
390    @SerializedName("SINGLE")
391    SINGLE
392  }
393  
394  public enum ProductCouponType {
395    @SerializedName("NORMAL")
396    NORMAL,
397    @SerializedName("DISCOUNT")
398    DISCOUNT,
399    @SerializedName("EXCHANGE")
400    EXCHANGE
401  }
402  
403  public enum UsageMode {
404    @SerializedName("SINGLE")
405    SINGLE,
406    @SerializedName("PROGRESSIVE_BUNDLE")
407    PROGRESSIVE_BUNDLE
408  }
409  
410  public static class SingleUsageInfo {
411    @SerializedName("normal_coupon")
412    public NormalCouponUsageRule normalCoupon;
413  
414    @SerializedName("discount_coupon")
415    public DiscountCouponUsageRule discountCoupon;
416  }
417  
418  public static class ProgressiveBundleUsageInfo {
419    @SerializedName("count")
420    public Long count;
421  
422    @SerializedName("interval_days")
423    public Long intervalDays;
424  }
425  
426  public static class ProductCouponDisplayInfo {
427    @SerializedName("name")
428    public String name;
429  
430    @SerializedName("image_url")
431    public String imageUrl;
432  
433    @SerializedName("background_url")
434    public String backgroundUrl;
435  
436    @SerializedName("detail_image_url_list")
437    public List<String> detailImageUrlList;
438  
439    @SerializedName("original_price")
440    public Long originalPrice;
441  
442    @SerializedName("combo_package_list")
443    public List<ComboPackage> comboPackageList;
444  }
445  
446  public enum ProductCouponState {
447    @SerializedName("AUDITING")
448    AUDITING,
449    @SerializedName("EFFECTIVE")
450    EFFECTIVE,
451    @SerializedName("DEACTIVATED")
452    DEACTIVATED
453  }
454  
455  public enum CouponCodeMode {
456    @SerializedName("WECHATPAY")
457    WECHATPAY,
458    @SerializedName("UPLOAD")
459    UPLOAD,
460    @SerializedName("API_ASSIGN")
461    API_ASSIGN
462  }
463  
464  public static class CouponCodeCountInfo {
465    @SerializedName("total_count")
466    public Long totalCount;
467  
468    @SerializedName("available_count")
469    public Long availableCount;
470  }
471  
472  public static class StockSendRule {
473    @SerializedName("max_count")
474    public Long maxCount;
475  
476    @SerializedName("max_count_per_day")
477    public Long maxCountPerDay;
478  
479    @SerializedName("max_count_per_user")
480    public Long maxCountPerUser;
481  }
482  
483  public static class SingleUsageRule {
484    @SerializedName("coupon_available_period")
485    public CouponAvailablePeriod couponAvailablePeriod;
486  
487    @SerializedName("normal_coupon")
488    public NormalCouponUsageRule normalCoupon;
489  
490    @SerializedName("discount_coupon")
491    public DiscountCouponUsageRule discountCoupon;
492  
493    @SerializedName("exchange_coupon")
494    public ExchangeCouponUsageRule exchangeCoupon;
495  }
496  
497  public static class UsageRuleDisplayInfo {
498    @SerializedName("coupon_usage_method_list")
499    public List<CouponUsageMethod> couponUsageMethodList = new ArrayList<CouponUsageMethod>();
500  
501    @SerializedName("mini_program_appid")
502    public String miniProgramAppid;
503  
504    @SerializedName("mini_program_path")
505    public String miniProgramPath;
506  
507    @SerializedName("app_path")
508    public String appPath;
509  
510    @SerializedName("usage_description")
511    public String usageDescription;
512  
513    @SerializedName("coupon_available_store_info")
514    public CouponAvailableStoreInfo couponAvailableStoreInfo;
515  }
516  
517  public static class CouponDisplayInfo {
518    @SerializedName("code_display_mode")
519    public CouponCodeDisplayMode codeDisplayMode;
520  
521    @SerializedName("background_color")
522    public String backgroundColor;
523  
524    @SerializedName("entrance_mini_program")
525    public EntranceMiniProgram entranceMiniProgram;
526  
527    @SerializedName("entrance_official_account")
528    public EntranceOfficialAccount entranceOfficialAccount;
529  
530    @SerializedName("entrance_finder")
531    public EntranceFinder entranceFinder;
532  }
533  
534  public static class NotifyConfig {
535    @SerializedName("notify_appid")
536    public String notifyAppid;
537  }
538  
539  public enum StockStoreScope {
540    @SerializedName("NONE")
541    NONE,
542    @SerializedName("ALL")
543    ALL,
544    @SerializedName("SPECIFIC")
545    SPECIFIC
546  }
547  
548  public static class StockSentCountInfo {
549    @SerializedName("total_count")
550    public Long totalCount;
551  
552    @SerializedName("today_count")
553    public Long todayCount;
554  }
555  
556  public enum StockState {
557    @SerializedName("AUDITING")
558    AUDITING,
559    @SerializedName("SENDING")
560    SENDING,
561    @SerializedName("PAUSED")
562    PAUSED,
563    @SerializedName("STOPPED")
564    STOPPED,
565    @SerializedName("DEACTIVATED")
566    DEACTIVATED
567  }
568  
569  public enum UserProductCouponTag {
570    @SerializedName("MEMBER")
571    MEMBER
572  }
573  
574  public static class MemberTagInfo {
575    @SerializedName("member_card_id")
576    public String memberCardId;
577  }
578  
579  public static class NormalCouponUsageRule {
580    @SerializedName("threshold")
581    public Long threshold;
582  
583    @SerializedName("discount_amount")
584    public Long discountAmount;
585  }
586  
587  public static class DiscountCouponUsageRule {
588    @SerializedName("threshold")
589    public Long threshold;
590  
591    @SerializedName("percent_off")
592    public Long percentOff;
593  }
594  
595  public static class ComboPackage {
596    @SerializedName("name")
597    public String name;
598  
599    @SerializedName("pick_count")
600    public Long pickCount;
601  
602    @SerializedName("choice_list")
603    public List<ComboPackageChoice> choiceList = new ArrayList<ComboPackageChoice>();
604  }
605  
606  public static class CouponAvailablePeriod {
607    @SerializedName("available_begin_time")
608    public String availableBeginTime;
609  
610    @SerializedName("available_end_time")
611    public String availableEndTime;
612  
613    @SerializedName("available_days")
614    public Long availableDays;
615  
616    @SerializedName("wait_days_after_receive")
617    public Long waitDaysAfterReceive;
618  
619    @SerializedName("weekly_available_period")
620    public FixedWeekPeriod weeklyAvailablePeriod;
621  
622    @SerializedName("irregular_available_period_list")
623    public List<TimePeriod> irregularAvailablePeriodList;
624  }
625  
626  public static class ExchangeCouponUsageRule {
627    @SerializedName("threshold")
628    public Long threshold;
629  
630    @SerializedName("exchange_price")
631    public Long exchangePrice;
632  }
633  
634  public enum CouponUsageMethod {
635    @SerializedName("OFFLINE")
636    OFFLINE,
637    @SerializedName("MINI_PROGRAM")
638    MINI_PROGRAM,
639    @SerializedName("APP")
640    APP,
641    @SerializedName("PAYMENT_CODE")
642    PAYMENT_CODE
643  }
644  
645  public static class CouponAvailableStoreInfo {
646    @SerializedName("description")
647    public String description;
648  
649    @SerializedName("mini_program_appid")
650    public String miniProgramAppid;
651  
652    @SerializedName("mini_program_path")
653    public String miniProgramPath;
654  }
655  
656  public enum CouponCodeDisplayMode {
657    @SerializedName("INVISIBLE")
658    INVISIBLE,
659    @SerializedName("BARCODE")
660    BARCODE,
661    @SerializedName("QRCODE")
662    QRCODE
663  }
664  
665  public static class EntranceMiniProgram {
666    @SerializedName("appid")
667    public String appid;
668  
669    @SerializedName("path")
670    public String path;
671  
672    @SerializedName("entrance_wording")
673    public String entranceWording;
674  
675    @SerializedName("guidance_wording")
676    public String guidanceWording;
677  }
678  
679  public static class EntranceOfficialAccount {
680    @SerializedName("appid")
681    public String appid;
682  }
683  
684  public static class EntranceFinder {
685    @SerializedName("finder_id")
686    public String finderId;
687  
688    @SerializedName("finder_video_id")
689    public String finderVideoId;
690  
691    @SerializedName("finder_video_cover_image_url")
692    public String finderVideoCoverImageUrl;
693  }
694  
695  public static class ComboPackageChoice {
696    @SerializedName("name")
697    public String name;
698  
699    @SerializedName("price")
700    public Long price;
701  
702    @SerializedName("count")
703    public Long count;
704  
705    @SerializedName("image_url")
706    public String imageUrl;
707  
708    @SerializedName("mini_program_appid")
709    public String miniProgramAppid;
710  
711    @SerializedName("mini_program_path")
712    public String miniProgramPath;
713  }
714  
715  public static class FixedWeekPeriod {
716    @SerializedName("day_list")
717    public List<WeekEnum> dayList;
718  
719    @SerializedName("day_period_list")
720    public List<PeriodOfTheDay> dayPeriodList;
721  }
722  
723  public static class TimePeriod {
724    @SerializedName("begin_time")
725    public String beginTime;
726  
727    @SerializedName("end_time")
728    public String endTime;
729  }
730  
731  public enum WeekEnum {
732    @SerializedName("MONDAY")
733    MONDAY,
734    @SerializedName("TUESDAY")
735    TUESDAY,
736    @SerializedName("WEDNESDAY")
737    WEDNESDAY,
738    @SerializedName("THURSDAY")
739    THURSDAY,
740    @SerializedName("FRIDAY")
741    FRIDAY,
742    @SerializedName("SATURDAY")
743    SATURDAY,
744    @SerializedName("SUNDAY")
745    SUNDAY
746  }
747  
748  public static class PeriodOfTheDay {
749    @SerializedName("begin_time")
750    public Long beginTime;
751  
752    @SerializedName("end_time")
753    public Long endTime;
754  }
755  
756}
757

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 := &DeactivateUserProductCouponRequest{
29		ProductCouponId:  wxpay_utility.String("1000000013"),
30		StockId:          wxpay_utility.String("1000000013001"),
31		CouponCode:       wxpay_utility.String("Code_123456"),
32		Appid:            wxpay_utility.String("wx233544546545989"),
33		Openid:           wxpay_utility.String("oh-394z-6CGkNoJrsDLTTUKiAnp4"),
34		OutRequestNo:     wxpay_utility.String("MCHDEACTIVATE202003101234"),
35		DeactivateReason: wxpay_utility.String("商品已下线，使用户商品券失效"),
36		BrandId:          wxpay_utility.String("120344"),
37	}
38
39	response, err := DeactivateUserProductCoupon(config, request)
40	if err != nil {
41		fmt.Printf("请求失败: %+v\n", err)
42		// TODO: 请求失败，根据状态码执行不同的处理
43		return
44	}
45
46	// TODO: 请求成功，继续业务逻辑
47	fmt.Printf("请求成功: %+v\n", response)
48}
49
50func DeactivateUserProductCoupon(config *wxpay_utility.MchConfig, request *DeactivateUserProductCouponRequest) (response *UserProductCouponEntity, err error) {
51	const (
52		host   = "https://api.mch.weixin.qq.com"
53		method = "POST"
54		path   = "/v3/marketing/partner/product-coupon/users/{openid}/coupons/{coupon_code}/deactivate"
55	)
56
57	reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path))
58	if err != nil {
59		return nil, err
60	}
61	reqUrl.Path = strings.Replace(reqUrl.Path, "{coupon_code}", url.PathEscape(*request.CouponCode), -1)
62	reqUrl.Path = strings.Replace(reqUrl.Path, "{openid}", url.PathEscape(*request.Openid), -1)
63	reqBody, err := json.Marshal(request)
64	if err != nil {
65		return nil, err
66	}
67	httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody))
68	if err != nil {
69		return nil, err
70	}
71	httpRequest.Header.Set("Accept", "application/json")
72	httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId())
73	httpRequest.Header.Set("Content-Type", "application/json")
74	authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), reqBody)
75	if err != nil {
76		return nil, err
77	}
78	httpRequest.Header.Set("Authorization", authorization)
79
80	client := &http.Client{}
81	httpResponse, err := client.Do(httpRequest)
82	if err != nil {
83		return nil, err
84	}
85	respBody, err := wxpay_utility.ExtractResponseBody(httpResponse)
86	if err != nil {
87		return nil, err
88	}
89	if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 {
90		// 2XX 成功，验证应答签名
91		err = wxpay_utility.ValidateResponse(
92			config.WechatPayPublicKeyId(),
93			config.WechatPayPublicKey(),
94			&httpResponse.Header,
95			respBody,
96		)
97		if err != nil {
98			return nil, err
99		}
100		response := &UserProductCouponEntity{}
101		if err := json.Unmarshal(respBody, response); err != nil {
102			return nil, err
103		}
104
105		return response, nil
106	} else {
107		return nil, wxpay_utility.NewApiException(
108			httpResponse.StatusCode,
109			httpResponse.Header,
110			respBody,
111		)
112	}
113}
114
115type DeactivateUserProductCouponRequest struct {
116	ProductCouponId  *string `json:"product_coupon_id,omitempty"`
117	StockId          *string `json:"stock_id,omitempty"`
118	CouponCode       *string `json:"coupon_code,omitempty"`
119	Appid            *string `json:"appid,omitempty"`
120	Openid           *string `json:"openid,omitempty"`
121	OutRequestNo     *string `json:"out_request_no,omitempty"`
122	DeactivateReason *string `json:"deactivate_reason,omitempty"`
123	BrandId          *string `json:"brand_id,omitempty"`
124}
125
126func (o *DeactivateUserProductCouponRequest) MarshalJSON() ([]byte, error) {
127	type Alias DeactivateUserProductCouponRequest
128	a := &struct {
129		CouponCode *string `json:"coupon_code,omitempty"`
130		Openid     *string `json:"openid,omitempty"`
131		*Alias
132	}{
133		// 序列化时移除非 Body 字段
134		CouponCode: nil,
135		Openid:     nil,
136		Alias:      (*Alias)(o),
137	}
138	return json.Marshal(a)
139}
140
141type UserProductCouponEntity struct {
142	CouponCode                  *string                       `json:"coupon_code,omitempty"`
143	CouponState                 *UserProductCouponState       `json:"coupon_state,omitempty"`
144	ValidBeginTime              *time.Time                    `json:"valid_begin_time,omitempty"`
145	ValidEndTime                *time.Time                    `json:"valid_end_time,omitempty"`
146	ReceiveTime                 *string                       `json:"receive_time,omitempty"`
147	SendRequestNo               *string                       `json:"send_request_no,omitempty"`
148	SendChannel                 *UserProductCouponSendChannel `json:"send_channel,omitempty"`
149	ConfirmRequestNo            *string                       `json:"confirm_request_no,omitempty"`
150	ConfirmTime                 *time.Time                    `json:"confirm_time,omitempty"`
151	DeactivateRequestNo         *string                       `json:"deactivate_request_no,omitempty"`
152	DeactivateTime              *string                       `json:"deactivate_time,omitempty"`
153	DeactivateReason            *string                       `json:"deactivate_reason,omitempty"`
154	SingleUsageDetail           *CouponUsageDetail            `json:"single_usage_detail,omitempty"`
155	UserProductCouponBundleInfo *UserProductCouponBundleInfo  `json:"user_product_coupon_bundle_info,omitempty"`
156	ProductCoupon               *ProductCouponEntity          `json:"product_coupon,omitempty"`
157	Stock                       *StockEntity                  `json:"stock,omitempty"`
158	Attach                      *string                       `json:"attach,omitempty"`
159	ChannelCustomInfo           *string                       `json:"channel_custom_info,omitempty"`
160	CouponTagInfo               *CouponTagInfo                `json:"coupon_tag_info,omitempty"`
161	BrandId                     *string                       `json:"brand_id,omitempty"`
162}
163
164type UserProductCouponState string
165
166func (e UserProductCouponState) Ptr() *UserProductCouponState {
167	return &e
168}
169
170const (
171	USERPRODUCTCOUPONSTATE_CONFIRMING  UserProductCouponState = "CONFIRMING"
172	USERPRODUCTCOUPONSTATE_PENDING     UserProductCouponState = "PENDING"
173	USERPRODUCTCOUPONSTATE_EFFECTIVE   UserProductCouponState = "EFFECTIVE"
174	USERPRODUCTCOUPONSTATE_USED        UserProductCouponState = "USED"
175	USERPRODUCTCOUPONSTATE_EXPIRED     UserProductCouponState = "EXPIRED"
176	USERPRODUCTCOUPONSTATE_DELETED     UserProductCouponState = "DELETED"
177	USERPRODUCTCOUPONSTATE_DEACTIVATED UserProductCouponState = "DEACTIVATED"
178)
179
180type UserProductCouponSendChannel string
181
182func (e UserProductCouponSendChannel) Ptr() *UserProductCouponSendChannel {
183	return &e
184}
185
186const (
187	USERPRODUCTCOUPONSENDCHANNEL_BRAND_MANAGE      UserProductCouponSendChannel = "BRAND_MANAGE"
188	USERPRODUCTCOUPONSENDCHANNEL_API               UserProductCouponSendChannel = "API"
189	USERPRODUCTCOUPONSENDCHANNEL_RECEIVE_COMPONENT UserProductCouponSendChannel = "RECEIVE_COMPONENT"
190)
191
192type CouponUsageDetail struct {
193	UseRequestNo                *string                                       `json:"use_request_no,omitempty"`
194	UseTime                     *time.Time                                    `json:"use_time,omitempty"`
195	ReturnRequestNo             *string                                       `json:"return_request_no,omitempty"`
196	ReturnTime                  *time.Time                                    `json:"return_time,omitempty"`
197	AssociatedOrderInfo         *UserProductCouponAssociatedOrderInfo         `json:"associated_order_info,omitempty"`
198	AssociatedPayScoreOrderInfo *UserProductCouponAssociatedPayScoreOrderInfo `json:"associated_pay_score_order_info,omitempty"`
199}
200
201type UserProductCouponBundleInfo struct {
202	UserCouponBundleId    *string `json:"user_coupon_bundle_id,omitempty"`
203	UserCouponBundleIndex *int64  `json:"user_coupon_bundle_index,omitempty"`
204	TotalCount            *int64  `json:"total_count,omitempty"`
205	UsedCount             *int64  `json:"used_count,omitempty"`
206}
207
208type ProductCouponEntity struct {
209	ProductCouponId            *string                     `json:"product_coupon_id,omitempty"`
210	Scope                      *ProductCouponScope         `json:"scope,omitempty"`
211	Type                       *ProductCouponType          `json:"type,omitempty"`
212	UsageMode                  *UsageMode                  `json:"usage_mode,omitempty"`
213	SingleUsageInfo            *SingleUsageInfo            `json:"single_usage_info,omitempty"`
214	ProgressiveBundleUsageInfo *ProgressiveBundleUsageInfo `json:"progressive_bundle_usage_info,omitempty"`
215	DisplayInfo                *ProductCouponDisplayInfo   `json:"display_info,omitempty"`
216	OutProductNo               *string                     `json:"out_product_no,omitempty"`
217	State                      *ProductCouponState         `json:"state,omitempty"`
218	DeactivateRequestNo        *string                     `json:"deactivate_request_no,omitempty"`
219	DeactivateTime             *string                     `json:"deactivate_time,omitempty"`
220	DeactivateReason           *string                     `json:"deactivate_reason,omitempty"`
221	BrandId                    *string                     `json:"brand_id,omitempty"`
222}
223
224type StockEntity struct {
225	ProductCouponId      *string               `json:"product_coupon_id,omitempty"`
226	StockId              *string               `json:"stock_id,omitempty"`
227	Remark               *string               `json:"remark,omitempty"`
228	CouponCodeMode       *CouponCodeMode       `json:"coupon_code_mode,omitempty"`
229	CouponCodeCountInfo  *CouponCodeCountInfo  `json:"coupon_code_count_info,omitempty"`
230	StockSendRule        *StockSendRule        `json:"stock_send_rule,omitempty"`
231	SingleUsageRule      *SingleUsageRule      `json:"single_usage_rule,omitempty"`
232	UsageRuleDisplayInfo *UsageRuleDisplayInfo `json:"usage_rule_display_info,omitempty"`
233	CouponDisplayInfo    *CouponDisplayInfo    `json:"coupon_display_info,omitempty"`
234	NotifyConfig         *NotifyConfig         `json:"notify_config,omitempty"`
235	StoreScope           *StockStoreScope      `json:"store_scope,omitempty"`
236	SentCountInfo        *StockSentCountInfo   `json:"sent_count_info,omitempty"`
237	State                *StockState           `json:"state,omitempty"`
238	DeactivateRequestNo  *string               `json:"deactivate_request_no,omitempty"`
239	DeactivateTime       *time.Time            `json:"deactivate_time,omitempty"`
240	DeactivateReason     *string               `json:"deactivate_reason,omitempty"`
241	BrandId              *string               `json:"brand_id,omitempty"`
242}
243
244type CouponTagInfo struct {
245	CouponTagList []UserProductCouponTag `json:"coupon_tag_list,omitempty"`
246	MemberTagInfo *MemberTagInfo         `json:"member_tag_info,omitempty"`
247}
248
249type UserProductCouponAssociatedOrderInfo struct {
250	TransactionId *string `json:"transaction_id,omitempty"`
251	OutTradeNo    *string `json:"out_trade_no,omitempty"`
252	Mchid         *string `json:"mchid,omitempty"`
253	SubMchid      *string `json:"sub_mchid,omitempty"`
254}
255
256type UserProductCouponAssociatedPayScoreOrderInfo struct {
257	OrderId    *string `json:"order_id,omitempty"`
258	OutOrderNo *string `json:"out_order_no,omitempty"`
259	Mchid      *string `json:"mchid,omitempty"`
260	SubMchid   *string `json:"sub_mchid,omitempty"`
261}
262
263type ProductCouponScope string
264
265func (e ProductCouponScope) Ptr() *ProductCouponScope {
266	return &e
267}
268
269const (
270	PRODUCTCOUPONSCOPE_ALL    ProductCouponScope = "ALL"
271	PRODUCTCOUPONSCOPE_SINGLE ProductCouponScope = "SINGLE"
272)
273
274type ProductCouponType string
275
276func (e ProductCouponType) Ptr() *ProductCouponType {
277	return &e
278}
279
280const (
281	PRODUCTCOUPONTYPE_NORMAL   ProductCouponType = "NORMAL"
282	PRODUCTCOUPONTYPE_DISCOUNT ProductCouponType = "DISCOUNT"
283	PRODUCTCOUPONTYPE_EXCHANGE ProductCouponType = "EXCHANGE"
284)
285
286type UsageMode string
287
288func (e UsageMode) Ptr() *UsageMode {
289	return &e
290}
291
292const (
293	USAGEMODE_SINGLE             UsageMode = "SINGLE"
294	USAGEMODE_PROGRESSIVE_BUNDLE UsageMode = "PROGRESSIVE_BUNDLE"
295)
296
297type SingleUsageInfo struct {
298	NormalCoupon   *NormalCouponUsageRule   `json:"normal_coupon,omitempty"`
299	DiscountCoupon *DiscountCouponUsageRule `json:"discount_coupon,omitempty"`
300}
301
302type ProgressiveBundleUsageInfo struct {
303	Count        *int64 `json:"count,omitempty"`
304	IntervalDays *int64 `json:"interval_days,omitempty"`
305}
306
307type ProductCouponDisplayInfo struct {
308	Name               *string        `json:"name,omitempty"`
309	ImageUrl           *string        `json:"image_url,omitempty"`
310	BackgroundUrl      *string        `json:"background_url,omitempty"`
311	DetailImageUrlList []string       `json:"detail_image_url_list,omitempty"`
312	OriginalPrice      *int64         `json:"original_price,omitempty"`
313	ComboPackageList   []ComboPackage `json:"combo_package_list,omitempty"`
314}
315
316type ProductCouponState string
317
318func (e ProductCouponState) Ptr() *ProductCouponState {
319	return &e
320}
321
322const (
323	PRODUCTCOUPONSTATE_AUDITING    ProductCouponState = "AUDITING"
324	PRODUCTCOUPONSTATE_EFFECTIVE   ProductCouponState = "EFFECTIVE"
325	PRODUCTCOUPONSTATE_DEACTIVATED ProductCouponState = "DEACTIVATED"
326)
327
328type CouponCodeMode string
329
330func (e CouponCodeMode) Ptr() *CouponCodeMode {
331	return &e
332}
333
334const (
335	COUPONCODEMODE_WECHATPAY  CouponCodeMode = "WECHATPAY"
336	COUPONCODEMODE_UPLOAD     CouponCodeMode = "UPLOAD"
337	COUPONCODEMODE_API_ASSIGN CouponCodeMode = "API_ASSIGN"
338)
339
340type CouponCodeCountInfo struct {
341	TotalCount     *int64 `json:"total_count,omitempty"`
342	AvailableCount *int64 `json:"available_count,omitempty"`
343}
344
345type StockSendRule struct {
346	MaxCount        *int64 `json:"max_count,omitempty"`
347	MaxCountPerDay  *int64 `json:"max_count_per_day,omitempty"`
348	MaxCountPerUser *int64 `json:"max_count_per_user,omitempty"`
349}
350
351type SingleUsageRule struct {
352	CouponAvailablePeriod *CouponAvailablePeriod   `json:"coupon_available_period,omitempty"`
353	NormalCoupon          *NormalCouponUsageRule   `json:"normal_coupon,omitempty"`
354	DiscountCoupon        *DiscountCouponUsageRule `json:"discount_coupon,omitempty"`
355	ExchangeCoupon        *ExchangeCouponUsageRule `json:"exchange_coupon,omitempty"`
356}
357
358type UsageRuleDisplayInfo struct {
359	CouponUsageMethodList    []CouponUsageMethod       `json:"coupon_usage_method_list,omitempty"`
360	MiniProgramAppid         *string                   `json:"mini_program_appid,omitempty"`
361	MiniProgramPath          *string                   `json:"mini_program_path,omitempty"`
362	AppPath                  *string                   `json:"app_path,omitempty"`
363	UsageDescription         *string                   `json:"usage_description,omitempty"`
364	CouponAvailableStoreInfo *CouponAvailableStoreInfo `json:"coupon_available_store_info,omitempty"`
365}
366
367type CouponDisplayInfo struct {
368	CodeDisplayMode         *CouponCodeDisplayMode   `json:"code_display_mode,omitempty"`
369	BackgroundColor         *string                  `json:"background_color,omitempty"`
370	EntranceMiniProgram     *EntranceMiniProgram     `json:"entrance_mini_program,omitempty"`
371	EntranceOfficialAccount *EntranceOfficialAccount `json:"entrance_official_account,omitempty"`
372	EntranceFinder          *EntranceFinder          `json:"entrance_finder,omitempty"`
373}
374
375type NotifyConfig struct {
376	NotifyAppid *string `json:"notify_appid,omitempty"`
377}
378
379type StockStoreScope string
380
381func (e StockStoreScope) Ptr() *StockStoreScope {
382	return &e
383}
384
385const (
386	STOCKSTORESCOPE_NONE     StockStoreScope = "NONE"
387	STOCKSTORESCOPE_ALL      StockStoreScope = "ALL"
388	STOCKSTORESCOPE_SPECIFIC StockStoreScope = "SPECIFIC"
389)
390
391type StockSentCountInfo struct {
392	TotalCount *int64 `json:"total_count,omitempty"`
393	TodayCount *int64 `json:"today_count,omitempty"`
394}
395
396type StockState string
397
398func (e StockState) Ptr() *StockState {
399	return &e
400}
401
402const (
403	STOCKSTATE_AUDITING    StockState = "AUDITING"
404	STOCKSTATE_SENDING     StockState = "SENDING"
405	STOCKSTATE_PAUSED      StockState = "PAUSED"
406	STOCKSTATE_STOPPED     StockState = "STOPPED"
407	STOCKSTATE_DEACTIVATED StockState = "DEACTIVATED"
408)
409
410type UserProductCouponTag string
411
412func (e UserProductCouponTag) Ptr() *UserProductCouponTag {
413	return &e
414}
415
416const (
417	USERPRODUCTCOUPONTAG_MEMBER UserProductCouponTag = "MEMBER"
418)
419
420type MemberTagInfo struct {
421	MemberCardId *string `json:"member_card_id,omitempty"`
422}
423
424type NormalCouponUsageRule struct {
425	Threshold      *int64 `json:"threshold,omitempty"`
426	DiscountAmount *int64 `json:"discount_amount,omitempty"`
427}
428
429type DiscountCouponUsageRule struct {
430	Threshold  *int64 `json:"threshold,omitempty"`
431	PercentOff *int64 `json:"percent_off,omitempty"`
432}
433
434type ComboPackage struct {
435	Name       *string              `json:"name,omitempty"`
436	PickCount  *int64               `json:"pick_count,omitempty"`
437	ChoiceList []ComboPackageChoice `json:"choice_list,omitempty"`
438}
439
440type CouponAvailablePeriod struct {
441	AvailableBeginTime           *string          `json:"available_begin_time,omitempty"`
442	AvailableEndTime             *string          `json:"available_end_time,omitempty"`
443	AvailableDays                *int64           `json:"available_days,omitempty"`
444	WaitDaysAfterReceive         *int64           `json:"wait_days_after_receive,omitempty"`
445	WeeklyAvailablePeriod        *FixedWeekPeriod `json:"weekly_available_period,omitempty"`
446	IrregularAvailablePeriodList []TimePeriod     `json:"irregular_available_period_list,omitempty"`
447}
448
449type ExchangeCouponUsageRule struct {
450	Threshold     *int64 `json:"threshold,omitempty"`
451	ExchangePrice *int64 `json:"exchange_price,omitempty"`
452}
453
454type CouponUsageMethod string
455
456func (e CouponUsageMethod) Ptr() *CouponUsageMethod {
457	return &e
458}
459
460const (
461	COUPONUSAGEMETHOD_OFFLINE      CouponUsageMethod = "OFFLINE"
462	COUPONUSAGEMETHOD_MINI_PROGRAM CouponUsageMethod = "MINI_PROGRAM"
463	COUPONUSAGEMETHOD_APP          CouponUsageMethod = "APP"
464	COUPONUSAGEMETHOD_PAYMENT_CODE CouponUsageMethod = "PAYMENT_CODE"
465)
466
467type CouponAvailableStoreInfo struct {
468	Description      *string `json:"description,omitempty"`
469	MiniProgramAppid *string `json:"mini_program_appid,omitempty"`
470	MiniProgramPath  *string `json:"mini_program_path,omitempty"`
471}
472
473type CouponCodeDisplayMode string
474
475func (e CouponCodeDisplayMode) Ptr() *CouponCodeDisplayMode {
476	return &e
477}
478
479const (
480	COUPONCODEDISPLAYMODE_INVISIBLE CouponCodeDisplayMode = "INVISIBLE"
481	COUPONCODEDISPLAYMODE_BARCODE   CouponCodeDisplayMode = "BARCODE"
482	COUPONCODEDISPLAYMODE_QRCODE    CouponCodeDisplayMode = "QRCODE"
483)
484
485type EntranceMiniProgram struct {
486	Appid           *string `json:"appid,omitempty"`
487	Path            *string `json:"path,omitempty"`
488	EntranceWording *string `json:"entrance_wording,omitempty"`
489	GuidanceWording *string `json:"guidance_wording,omitempty"`
490}
491
492type EntranceOfficialAccount struct {
493	Appid *string `json:"appid,omitempty"`
494}
495
496type EntranceFinder struct {
497	FinderId                 *string `json:"finder_id,omitempty"`
498	FinderVideoId            *string `json:"finder_video_id,omitempty"`
499	FinderVideoCoverImageUrl *string `json:"finder_video_cover_image_url,omitempty"`
500}
501
502type ComboPackageChoice struct {
503	Name             *string `json:"name,omitempty"`
504	Price            *int64  `json:"price,omitempty"`
505	Count            *int64  `json:"count,omitempty"`
506	ImageUrl         *string `json:"image_url,omitempty"`
507	MiniProgramAppid *string `json:"mini_program_appid,omitempty"`
508	MiniProgramPath  *string `json:"mini_program_path,omitempty"`
509}
510
511type FixedWeekPeriod struct {
512	DayList       []WeekEnum       `json:"day_list,omitempty"`
513	DayPeriodList []PeriodOfTheDay `json:"day_period_list,omitempty"`
514}
515
516type TimePeriod struct {
517	BeginTime *string `json:"begin_time,omitempty"`
518	EndTime   *string `json:"end_time,omitempty"`
519}
520
521type WeekEnum string
522
523func (e WeekEnum) Ptr() *WeekEnum {
524	return &e
525}
526
527const (
528	WEEKENUM_MONDAY    WeekEnum = "MONDAY"
529	WEEKENUM_TUESDAY   WeekEnum = "TUESDAY"
530	WEEKENUM_WEDNESDAY WeekEnum = "WEDNESDAY"
531	WEEKENUM_THURSDAY  WeekEnum = "THURSDAY"
532	WEEKENUM_FRIDAY    WeekEnum = "FRIDAY"
533	WEEKENUM_SATURDAY  WeekEnum = "SATURDAY"
534	WEEKENUM_SUNDAY    WeekEnum = "SUNDAY"
535)
536
537type PeriodOfTheDay struct {
538	BeginTime *int64 `json:"begin_time,omitempty"`
539	EndTime   *int64 `json:"end_time,omitempty"`
540}
541