向用户发放商品券

1curl -X POST \
2  https://api.mch.weixin.qq.com/brand/marketing/product-coupon/users/oh-394z-6CGkNoJrsDLTTUKiAnp4/coupons \
3  -H "Authorization: WECHATPAY-BRAND-SHA256-RSA2048 brand_id=\"XXXX\",..." \
4  -H "Accept: application/json" \
5  -H "Wechatpay-Serial: PUB_KEY_ID_XXXX"  \
6  -H "Content-Type: application/json" \
7  -d '{
8    "coupon_code" : "Code_123456",
9    "product_coupon_id" : "1000000013",
10    "appid" : "wx233544546545989",
11    "attach" : "any attach content",
12    "coupon_tag_info" : {
13      "coupon_tag_list" : [
14        "MEMBER"
15      ],
16      "member_tag_info" : {
17        "member_card_id" : "MemberCardId_1234567890"
18      }
19    },
20    "stock_id" : "1000000013001",
21    "send_request_no" : "MCHSEND202003101234"
22  }'
23

1curl -X POST \
2  https://api.mch.weixin.qq.com/brand/marketing/product-coupon/users/oh-394z-6CGkNoJrsDLTTUKiAnp4/coupons \
3  -H "Authorization: WECHATPAY-BRAND-SHA256-RSA2048 brand_id=\"XXXX\",..." \
4  -H "Accept: application/json" \
5  -H "Wechatpay-Serial: PUB_KEY_ID_XXXX"  \
6  -H "Content-Type: application/json" \
7  -d '{
8    "coupon_code" : "Code_123456",
9    "product_coupon_id" : "1000000013",
10    "appid" : "wx233544546545989",
11    "attach" : "any attach content",
12    "stock_id" : "1000000013001",
13    "send_request_no" : "MCHSEND202003101234"
14  }'
15

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

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