确认发放用户商品券
更新时间:2025.11.06给用户发券后,微信支付会给品牌方发送【商品券回调通知】,此时品牌方应调用本接口确认发放成功。
注:商品券有多个发券渠道,可以由微信支付提供的营销渠道发券,品牌方也可以调用【向用户发放商品券API】主动发券,不论由何渠道发放,微信支付均会发送该通知给品牌方,品牌方均需调用本接口确认发放成功。
频率限制:500/s
接口说明
支持商户:【品牌商户】
请求方式:【POST】/brand/marketing/product-coupon/users/{openid}/coupons/{coupon_code}/confirm
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
Content-Type 必填 string
请设置为application/json
Wechatpay-Serial 必填 string
【微信支付公钥ID】 请传入brand_id对应的微信支付公钥ID,接口将会校验两者的关联关系,参考微信支付公钥产品简介及使用说明获取微信支付公钥ID和相关的介绍。以下两种场景将使用到微信支付公钥: 1、接收到接口的返回内容,需要使用微信支付公钥进行验签; 2、调用含有敏感信息参数(如姓名、身份证号码)的接口时,需要使用微信支付公钥加密敏感信息后再传输参数,加密指引请参考微信支付公钥加密敏感信息指引。
path 路径参数
coupon_code 必填 string(40)
【用户商品券Code】 用户商品券的唯一标识
openid 必填 string
【用户OpenID】 OpenID信息,用户在AppID下的唯一标识,获取方式参考OpenID
body 包体参数
product_coupon_id 必填 string
【商品券ID】 商品券的唯一标识,创建商品券时由微信支付生成
stock_id 必填 string
【批次ID】 商品券批次的唯一标识,商品券批次创建时由微信支付生成(可使用【创建商品券API】或【添加商品券批次API】创建),请确保该批次属于 product_coupon_id 对应的商品券
appid 必填 string
【公众账号ID】 公众账号ID也称AppID,是(微信开放平台、微信公众平台)为开发者提供的一个唯一标识,用于识别开发者的应用程序(APP、小程序、公众号)。 开发者需要先在微信开放平台或微信公众平台中申请ID,然后在品牌经营平台中绑定,详见品牌经营平台指引。
out_request_no 必填 string(40)
【确认发放请求单号】 品牌确认发放用户商品券的请求流水号,品牌侧需保持唯一性,可使用 数字、大小写字母、下划线_、短横线- 组成,长度在6-40个字符之间
请求示例
POST
确认发放用户券
1curl -X POST \ 2 https://api.mch.weixin.qq.com/brand/marketing/product-coupon/users/oh-394z-6CGkNoJrsDLTTUKiAnp4/coupons/Code_123456/confirm \ 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 "product_coupon_id" : "1000000013", 9 "appid" : "wx233544546545989", 10 "stock_id" : "1000000013001", 11 "out_request_no" : "MCHCONFIRM202003101234" 12 }' 13
需配合微信支付工具库 WXPayUtility 使用,请参考Java
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 ConfirmSendUserProductCoupon { 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/{coupon_code}/confirm"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/brand/4015415289 32 ConfirmSendUserProductCoupon client = new ConfirmSendUserProductCoupon( 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 ConfirmSendUserProductCouponRequest request = new ConfirmSendUserProductCouponRequest(); 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 = "MCHCONFIRM202003101234"; 47 try { 48 UserProductCouponEntity response = client.run(request); 49 // TODO: 请求成功,继续业务逻辑 50 System.out.println(response); 51 } catch (WXPayBrandUtility.ApiException e) { 52 // TODO: 请求失败,根据状态码执行不同的逻辑 53 e.printStackTrace(); 54 } 55 } 56 57 public UserProductCouponEntity run(ConfirmSendUserProductCouponRequest request) { 58 String uri = PATH; 59 uri = uri.replace("{coupon_code}", WXPayBrandUtility.urlEncode(request.couponCode)); 60 uri = uri.replace("{openid}", WXPayBrandUtility.urlEncode(request.openid)); 61 String reqBody = WXPayBrandUtility.toJson(request); 62 63 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 64 reqBuilder.addHeader("Accept", "application/json"); 65 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 66 reqBuilder.addHeader("Authorization", WXPayBrandUtility.buildAuthorization(brand_id, certificateSerialNo,privateKey, METHOD, uri, reqBody)); 67 reqBuilder.addHeader("Content-Type", "application/json"); 68 RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody); 69 reqBuilder.method(METHOD, requestBody); 70 Request httpRequest = reqBuilder.build(); 71 72 // 发送HTTP请求 73 OkHttpClient client = new OkHttpClient.Builder().build(); 74 try (Response httpResponse = client.newCall(httpRequest).execute()) { 75 String respBody = WXPayBrandUtility.extractBody(httpResponse); 76 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 77 // 2XX 成功,验证应答签名 78 WXPayBrandUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 79 httpResponse.headers(), respBody); 80 81 // 从HTTP应答报文构建返回数据 82 return WXPayBrandUtility.fromJson(respBody, UserProductCouponEntity.class); 83 } else { 84 throw new WXPayBrandUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 85 } 86 } catch (IOException e) { 87 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 88 } 89 } 90 91 private final String brand_id; 92 private final String certificateSerialNo; 93 private final PrivateKey privateKey; 94 private final String wechatPayPublicKeyId; 95 private final PublicKey wechatPayPublicKey; 96 97 public ConfirmSendUserProductCoupon(String brand_id, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 98 this.brand_id = brand_id; 99 this.certificateSerialNo = certificateSerialNo; 100 this.privateKey = WXPayBrandUtility.loadPrivateKeyFromPath(privateKeyFilePath); 101 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 102 this.wechatPayPublicKey = WXPayBrandUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 103 } 104 105 public static class ConfirmSendUserProductCouponRequest { 106 @SerializedName("product_coupon_id") 107 public String productCouponId; 108 109 @SerializedName("stock_id") 110 public String stockId; 111 112 @SerializedName("coupon_code") 113 @Expose(serialize = false) 114 public String couponCode; 115 116 @SerializedName("appid") 117 public String appid; 118 119 @SerializedName("openid") 120 @Expose(serialize = false) 121 public String openid; 122 123 @SerializedName("out_request_no") 124 public String outRequestNo; 125 } 126 127 public static class UserProductCouponEntity { 128 @SerializedName("coupon_code") 129 public String couponCode; 130 131 @SerializedName("coupon_state") 132 public UserProductCouponState couponState; 133 134 @SerializedName("valid_begin_time") 135 public String validBeginTime; 136 137 @SerializedName("valid_end_time") 138 public String validEndTime; 139 140 @SerializedName("receive_time") 141 public String receiveTime; 142 143 @SerializedName("send_request_no") 144 public String sendRequestNo; 145 146 @SerializedName("send_channel") 147 public UserProductCouponSendChannel sendChannel; 148 149 @SerializedName("confirm_request_no") 150 public String confirmRequestNo; 151 152 @SerializedName("confirm_time") 153 public String confirmTime; 154 155 @SerializedName("deactivate_request_no") 156 public String deactivateRequestNo; 157 158 @SerializedName("deactivate_time") 159 public String deactivateTime; 160 161 @SerializedName("deactivate_reason") 162 public String deactivateReason; 163 164 @SerializedName("user_product_coupon_bundle_info") 165 public UserProductCouponBundleInfo userProductCouponBundleInfo; 166 167 @SerializedName("product_coupon") 168 public ProductCouponEntity productCoupon; 169 170 @SerializedName("stock") 171 public StockEntity stock; 172 173 @SerializedName("attach") 174 public String attach; 175 176 @SerializedName("channel_custom_info") 177 public String channelCustomInfo; 178 179 @SerializedName("coupon_tag_info") 180 public CouponTagInfo couponTagInfo; 181 } 182 183 public enum UserProductCouponState { 184 @SerializedName("CONFIRMING") 185 CONFIRMING, 186 @SerializedName("PENDING") 187 PENDING, 188 @SerializedName("EFFECTIVE") 189 EFFECTIVE, 190 @SerializedName("USED") 191 USED, 192 @SerializedName("EXPIRED") 193 EXPIRED, 194 @SerializedName("DELETED") 195 DELETED, 196 @SerializedName("DEACTIVATED") 197 DEACTIVATED 198 } 199 200 public enum UserProductCouponSendChannel { 201 @SerializedName("BRAND_MANAGE") 202 BRAND_MANAGE, 203 @SerializedName("API") 204 API, 205 @SerializedName("RECEIVE_COMPONENT") 206 RECEIVE_COMPONENT 207 } 208 209 public static class UserProductCouponBundleInfo { 210 @SerializedName("user_coupon_bundle_id") 211 public String userCouponBundleId; 212 213 @SerializedName("user_coupon_bundle_index") 214 public Long userCouponBundleIndex; 215 216 @SerializedName("total_count") 217 public Long totalCount; 218 219 @SerializedName("used_count") 220 public Long usedCount; 221 } 222 223 public static class ProductCouponEntity { 224 @SerializedName("product_coupon_id") 225 public String productCouponId; 226 227 @SerializedName("scope") 228 public ProductCouponScope scope; 229 230 @SerializedName("type") 231 public ProductCouponType type; 232 233 @SerializedName("usage_mode") 234 public UsageMode usageMode; 235 236 @SerializedName("single_usage_info") 237 public SingleUsageInfo singleUsageInfo; 238 239 @SerializedName("progressive_bundle_usage_info") 240 public ProgressiveBundleUsageInfo progressiveBundleUsageInfo; 241 242 @SerializedName("display_info") 243 public ProductCouponDisplayInfo displayInfo; 244 245 @SerializedName("out_product_no") 246 public String outProductNo; 247 248 @SerializedName("state") 249 public ProductCouponState state; 250 251 @SerializedName("deactivate_request_no") 252 public String deactivateRequestNo; 253 254 @SerializedName("deactivate_time") 255 public String deactivateTime; 256 257 @SerializedName("deactivate_reason") 258 public String deactivateReason; 259 } 260 261 public static class StockEntity { 262 @SerializedName("product_coupon_id") 263 public String productCouponId; 264 265 @SerializedName("stock_id") 266 public String stockId; 267 268 @SerializedName("remark") 269 public String remark; 270 271 @SerializedName("coupon_code_mode") 272 public CouponCodeMode couponCodeMode; 273 274 @SerializedName("coupon_code_count_info") 275 public CouponCodeCountInfo couponCodeCountInfo; 276 277 @SerializedName("stock_send_rule") 278 public StockSendRule stockSendRule; 279 280 @SerializedName("single_usage_rule") 281 public SingleUsageRule singleUsageRule; 282 283 @SerializedName("progressive_bundle_usage_rule") 284 public StockUsageRule progressiveBundleUsageRule; 285 286 @SerializedName("stock_bundle_info") 287 public StockBundleInfo stockBundleInfo; 288 289 @SerializedName("usage_rule_display_info") 290 public UsageRuleDisplayInfo usageRuleDisplayInfo; 291 292 @SerializedName("coupon_display_info") 293 public CouponDisplayInfo couponDisplayInfo; 294 295 @SerializedName("notify_config") 296 public NotifyConfig notifyConfig; 297 298 @SerializedName("store_scope") 299 public StockStoreScope storeScope; 300 301 @SerializedName("sent_count_info") 302 public StockSentCountInfo sentCountInfo; 303 304 @SerializedName("state") 305 public StockState state; 306 307 @SerializedName("deactivate_request_no") 308 public String deactivateRequestNo; 309 310 @SerializedName("deactivate_time") 311 public String deactivateTime; 312 313 @SerializedName("deactivate_reason") 314 public String deactivateReason; 315 } 316 317 public static class CouponTagInfo { 318 @SerializedName("coupon_tag_list") 319 public List<UserProductCouponTag> couponTagList; 320 321 @SerializedName("member_tag_info") 322 public MemberTagInfo memberTagInfo; 323 } 324 325 public enum ProductCouponScope { 326 @SerializedName("ALL") 327 ALL, 328 @SerializedName("SINGLE") 329 SINGLE 330 } 331 332 public enum ProductCouponType { 333 @SerializedName("NORMAL") 334 NORMAL, 335 @SerializedName("DISCOUNT") 336 DISCOUNT, 337 @SerializedName("EXCHANGE") 338 EXCHANGE 339 } 340 341 public enum UsageMode { 342 @SerializedName("SINGLE") 343 SINGLE, 344 @SerializedName("PROGRESSIVE_BUNDLE") 345 PROGRESSIVE_BUNDLE 346 } 347 348 public static class SingleUsageInfo { 349 @SerializedName("normal_coupon") 350 public NormalCouponUsageRule normalCoupon; 351 352 @SerializedName("discount_coupon") 353 public DiscountCouponUsageRule discountCoupon; 354 } 355 356 public static class ProgressiveBundleUsageInfo { 357 @SerializedName("count") 358 public Long count; 359 360 @SerializedName("interval_days") 361 public Long intervalDays; 362 } 363 364 public static class ProductCouponDisplayInfo { 365 @SerializedName("name") 366 public String name; 367 368 @SerializedName("image_url") 369 public String imageUrl; 370 371 @SerializedName("background_url") 372 public String backgroundUrl; 373 374 @SerializedName("detail_image_url_list") 375 public List<String> detailImageUrlList; 376 377 @SerializedName("original_price") 378 public Long originalPrice; 379 380 @SerializedName("combo_package_list") 381 public List<ComboPackage> comboPackageList; 382 } 383 384 public enum ProductCouponState { 385 @SerializedName("AUDITING") 386 AUDITING, 387 @SerializedName("EFFECTIVE") 388 EFFECTIVE, 389 @SerializedName("DEACTIVATED") 390 DEACTIVATED 391 } 392 393 public enum CouponCodeMode { 394 @SerializedName("WECHATPAY") 395 WECHATPAY, 396 @SerializedName("UPLOAD") 397 UPLOAD, 398 @SerializedName("API_ASSIGN") 399 API_ASSIGN 400 } 401 402 public static class CouponCodeCountInfo { 403 @SerializedName("total_count") 404 public Long totalCount; 405 406 @SerializedName("available_count") 407 public Long availableCount; 408 } 409 410 public static class StockSendRule { 411 @SerializedName("max_count") 412 public Long maxCount; 413 414 @SerializedName("max_count_per_day") 415 public Long maxCountPerDay; 416 417 @SerializedName("max_count_per_user") 418 public Long maxCountPerUser; 419 } 420 421 public static class SingleUsageRule { 422 @SerializedName("coupon_available_period") 423 public CouponAvailablePeriod couponAvailablePeriod; 424 425 @SerializedName("normal_coupon") 426 public NormalCouponUsageRule normalCoupon; 427 428 @SerializedName("discount_coupon") 429 public DiscountCouponUsageRule discountCoupon; 430 431 @SerializedName("exchange_coupon") 432 public ExchangeCouponUsageRule exchangeCoupon; 433 } 434 435 public static class StockUsageRule { 436 @SerializedName("coupon_available_period") 437 public CouponAvailablePeriod couponAvailablePeriod; 438 439 @SerializedName("normal_coupon") 440 public NormalCouponUsageRule normalCoupon; 441 442 @SerializedName("discount_coupon") 443 public DiscountCouponUsageRule discountCoupon; 444 445 @SerializedName("exchange_coupon") 446 public ExchangeCouponUsageRule exchangeCoupon; 447 } 448 449 public static class StockBundleInfo { 450 @SerializedName("stock_bundle_id") 451 public String stockBundleId; 452 453 @SerializedName("stock_bundle_index") 454 public Long stockBundleIndex; 455 } 456 457 public static class UsageRuleDisplayInfo { 458 @SerializedName("coupon_usage_method_list") 459 public List<CouponUsageMethod> couponUsageMethodList = new ArrayList<CouponUsageMethod>(); 460 461 @SerializedName("mini_program_appid") 462 public String miniProgramAppid; 463 464 @SerializedName("mini_program_path") 465 public String miniProgramPath; 466 467 @SerializedName("app_path") 468 public String appPath; 469 470 @SerializedName("usage_description") 471 public String usageDescription; 472 473 @SerializedName("coupon_available_store_info") 474 public CouponAvailableStoreInfo couponAvailableStoreInfo; 475 } 476 477 public static class CouponDisplayInfo { 478 @SerializedName("code_display_mode") 479 public CouponCodeDisplayMode codeDisplayMode; 480 481 @SerializedName("background_color") 482 public String backgroundColor; 483 484 @SerializedName("entrance_mini_program") 485 public EntranceMiniProgram entranceMiniProgram; 486 487 @SerializedName("entrance_official_account") 488 public EntranceOfficialAccount entranceOfficialAccount; 489 490 @SerializedName("entrance_finder") 491 public EntranceFinder entranceFinder; 492 } 493 494 public static class NotifyConfig { 495 @SerializedName("notify_appid") 496 public String notifyAppid; 497 } 498 499 public enum StockStoreScope { 500 @SerializedName("NONE") 501 NONE, 502 @SerializedName("ALL") 503 ALL, 504 @SerializedName("SPECIFIC") 505 SPECIFIC 506 } 507 508 public static class StockSentCountInfo { 509 @SerializedName("total_count") 510 public Long totalCount; 511 512 @SerializedName("today_count") 513 public Long todayCount; 514 } 515 516 public enum StockState { 517 @SerializedName("AUDITING") 518 AUDITING, 519 @SerializedName("SENDING") 520 SENDING, 521 @SerializedName("PAUSED") 522 PAUSED, 523 @SerializedName("STOPPED") 524 STOPPED, 525 @SerializedName("DEACTIVATED") 526 DEACTIVATED 527 } 528 529 public enum UserProductCouponTag { 530 @SerializedName("MEMBER") 531 MEMBER 532 } 533 534 public static class MemberTagInfo { 535 @SerializedName("member_card_id") 536 public String memberCardId; 537 } 538 539 public static class NormalCouponUsageRule { 540 @SerializedName("threshold") 541 public Long threshold; 542 543 @SerializedName("discount_amount") 544 public Long discountAmount; 545 } 546 547 public static class DiscountCouponUsageRule { 548 @SerializedName("threshold") 549 public Long threshold; 550 551 @SerializedName("percent_off") 552 public Long percentOff; 553 } 554 555 public static class ComboPackage { 556 @SerializedName("name") 557 public String name; 558 559 @SerializedName("pick_count") 560 public Long pickCount; 561 562 @SerializedName("choice_list") 563 public List<ComboPackageChoice> choiceList = new ArrayList<ComboPackageChoice>(); 564 } 565 566 public static class CouponAvailablePeriod { 567 @SerializedName("available_begin_time") 568 public String availableBeginTime; 569 570 @SerializedName("available_end_time") 571 public String availableEndTime; 572 573 @SerializedName("available_days") 574 public Long availableDays; 575 576 @SerializedName("wait_days_after_receive") 577 public Long waitDaysAfterReceive; 578 579 @SerializedName("weekly_available_period") 580 public FixedWeekPeriod weeklyAvailablePeriod; 581 582 @SerializedName("irregular_available_period_list") 583 public List<TimePeriod> irregularAvailablePeriodList; 584 } 585 586 public static class ExchangeCouponUsageRule { 587 @SerializedName("threshold") 588 public Long threshold; 589 590 @SerializedName("exchange_price") 591 public Long exchangePrice; 592 } 593 594 public enum CouponUsageMethod { 595 @SerializedName("OFFLINE") 596 OFFLINE, 597 @SerializedName("MINI_PROGRAM") 598 MINI_PROGRAM, 599 @SerializedName("APP") 600 APP, 601 @SerializedName("PAYMENT_CODE") 602 PAYMENT_CODE 603 } 604 605 public static class CouponAvailableStoreInfo { 606 @SerializedName("description") 607 public String description; 608 609 @SerializedName("mini_program_appid") 610 public String miniProgramAppid; 611 612 @SerializedName("mini_program_path") 613 public String miniProgramPath; 614 } 615 616 public enum CouponCodeDisplayMode { 617 @SerializedName("INVISIBLE") 618 INVISIBLE, 619 @SerializedName("BARCODE") 620 BARCODE, 621 @SerializedName("QRCODE") 622 QRCODE 623 } 624 625 public static class EntranceMiniProgram { 626 @SerializedName("appid") 627 public String appid; 628 629 @SerializedName("path") 630 public String path; 631 632 @SerializedName("entrance_wording") 633 public String entranceWording; 634 635 @SerializedName("guidance_wording") 636 public String guidanceWording; 637 } 638 639 public static class EntranceOfficialAccount { 640 @SerializedName("appid") 641 public String appid; 642 } 643 644 public static class EntranceFinder { 645 @SerializedName("finder_id") 646 public String finderId; 647 648 @SerializedName("finder_video_id") 649 public String finderVideoId; 650 651 @SerializedName("finder_video_cover_image_url") 652 public String finderVideoCoverImageUrl; 653 } 654 655 public static class ComboPackageChoice { 656 @SerializedName("name") 657 public String name; 658 659 @SerializedName("price") 660 public Long price; 661 662 @SerializedName("count") 663 public Long count; 664 665 @SerializedName("image_url") 666 public String imageUrl; 667 668 @SerializedName("mini_program_appid") 669 public String miniProgramAppid; 670 671 @SerializedName("mini_program_path") 672 public String miniProgramPath; 673 } 674 675 public static class FixedWeekPeriod { 676 @SerializedName("day_list") 677 public List<WeekEnum> dayList; 678 679 @SerializedName("day_period_list") 680 public List<PeriodOfTheDay> dayPeriodList; 681 } 682 683 public static class TimePeriod { 684 @SerializedName("begin_time") 685 public String beginTime; 686 687 @SerializedName("end_time") 688 public String endTime; 689 } 690 691 public enum WeekEnum { 692 @SerializedName("MONDAY") 693 MONDAY, 694 @SerializedName("TUESDAY") 695 TUESDAY, 696 @SerializedName("WEDNESDAY") 697 WEDNESDAY, 698 @SerializedName("THURSDAY") 699 THURSDAY, 700 @SerializedName("FRIDAY") 701 FRIDAY, 702 @SerializedName("SATURDAY") 703 SATURDAY, 704 @SerializedName("SUNDAY") 705 SUNDAY 706 } 707 708 public static class PeriodOfTheDay { 709 @SerializedName("begin_time") 710 public Long beginTime; 711 712 @SerializedName("end_time") 713 public Long endTime; 714 } 715 716} 717
需配合微信支付工具库 wxpay_utility 使用,请参考Go
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 := &ConfirmSendUserProductCouponRequest{ 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 OutRequestNo: wxpay_brand_utility.String("MCHCONFIRM202003101234"), 35 } 36 37 response, err := ConfirmSendUserProductCoupon(config, request) 38 if err != nil { 39 fmt.Printf("请求失败: %+v\n", err) 40 // TODO: 请求失败,根据状态码执行不同的处理 41 return 42 } 43 44 // TODO: 请求成功,继续业务逻辑 45 fmt.Printf("请求成功: %+v\n", response) 46} 47 48func ConfirmSendUserProductCoupon(config *wxpay_brand_utility.BrandConfig, request *ConfirmSendUserProductCouponRequest) (response *UserProductCouponEntity, err error) { 49 const ( 50 host = "https://api.mch.weixin.qq.com" 51 method = "POST" 52 path = "/brand/marketing/product-coupon/users/{openid}/coupons/{coupon_code}/confirm" 53 ) 54 55 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 56 if err != nil { 57 return nil, err 58 } 59 reqUrl.Path = strings.Replace(reqUrl.Path, "{coupon_code}", url.PathEscape(*request.CouponCode), -1) 60 reqUrl.Path = strings.Replace(reqUrl.Path, "{openid}", url.PathEscape(*request.Openid), -1) 61 reqBody, err := json.Marshal(request) 62 if err != nil { 63 return nil, err 64 } 65 httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody)) 66 if err != nil { 67 return nil, err 68 } 69 httpRequest.Header.Set("Accept", "application/json") 70 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 71 httpRequest.Header.Set("Content-Type", "application/json") 72 authorization, err := wxpay_brand_utility.BuildAuthorization(config.BrandId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), reqBody) 73 if err != nil { 74 return nil, err 75 } 76 httpRequest.Header.Set("Authorization", authorization) 77 78 client := &http.Client{} 79 httpResponse, err := client.Do(httpRequest) 80 if err != nil { 81 return nil, err 82 } 83 respBody, err := wxpay_brand_utility.ExtractResponseBody(httpResponse) 84 if err != nil { 85 return nil, err 86 } 87 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 88 // 2XX 成功,验证应答签名 89 err = wxpay_brand_utility.ValidateResponse( 90 config.WechatPayPublicKeyId(), 91 config.WechatPayPublicKey(), 92 &httpResponse.Header, 93 respBody, 94 ) 95 if err != nil { 96 return nil, err 97 } 98 response := &UserProductCouponEntity{} 99 if err := json.Unmarshal(respBody, response); err != nil { 100 return nil, err 101 } 102 103 return response, nil 104 } else { 105 return nil, wxpay_brand_utility.NewApiException( 106 httpResponse.StatusCode, 107 httpResponse.Header, 108 respBody, 109 ) 110 } 111} 112 113type ConfirmSendUserProductCouponRequest struct { 114 ProductCouponId *string `json:"product_coupon_id,omitempty"` 115 StockId *string `json:"stock_id,omitempty"` 116 CouponCode *string `json:"coupon_code,omitempty"` 117 Appid *string `json:"appid,omitempty"` 118 Openid *string `json:"openid,omitempty"` 119 OutRequestNo *string `json:"out_request_no,omitempty"` 120} 121 122func (o *ConfirmSendUserProductCouponRequest) MarshalJSON() ([]byte, error) { 123 type Alias ConfirmSendUserProductCouponRequest 124 a := &struct { 125 CouponCode *string `json:"coupon_code,omitempty"` 126 Openid *string `json:"openid,omitempty"` 127 *Alias 128 }{ 129 // 序列化时移除非 Body 字段 130 CouponCode: nil, 131 Openid: nil, 132 Alias: (*Alias)(o), 133 } 134 return json.Marshal(a) 135} 136 137type UserProductCouponEntity struct { 138 CouponCode *string `json:"coupon_code,omitempty"` 139 CouponState *UserProductCouponState `json:"coupon_state,omitempty"` 140 ValidBeginTime *time.Time `json:"valid_begin_time,omitempty"` 141 ValidEndTime *time.Time `json:"valid_end_time,omitempty"` 142 ReceiveTime *string `json:"receive_time,omitempty"` 143 SendRequestNo *string `json:"send_request_no,omitempty"` 144 SendChannel *UserProductCouponSendChannel `json:"send_channel,omitempty"` 145 ConfirmRequestNo *string `json:"confirm_request_no,omitempty"` 146 ConfirmTime *time.Time `json:"confirm_time,omitempty"` 147 DeactivateRequestNo *string `json:"deactivate_request_no,omitempty"` 148 DeactivateTime *string `json:"deactivate_time,omitempty"` 149 DeactivateReason *string `json:"deactivate_reason,omitempty"` 150 UserProductCouponBundleInfo *UserProductCouponBundleInfo `json:"user_product_coupon_bundle_info,omitempty"` 151 ProductCoupon *ProductCouponEntity `json:"product_coupon,omitempty"` 152 Stock *StockEntity `json:"stock,omitempty"` 153 Attach *string `json:"attach,omitempty"` 154 ChannelCustomInfo *string `json:"channel_custom_info,omitempty"` 155 CouponTagInfo *CouponTagInfo `json:"coupon_tag_info,omitempty"` 156} 157 158type UserProductCouponState string 159 160func (e UserProductCouponState) Ptr() *UserProductCouponState { 161 return &e 162} 163 164const ( 165 USERPRODUCTCOUPONSTATE_CONFIRMING UserProductCouponState = "CONFIRMING" 166 USERPRODUCTCOUPONSTATE_PENDING UserProductCouponState = "PENDING" 167 USERPRODUCTCOUPONSTATE_EFFECTIVE UserProductCouponState = "EFFECTIVE" 168 USERPRODUCTCOUPONSTATE_USED UserProductCouponState = "USED" 169 USERPRODUCTCOUPONSTATE_EXPIRED UserProductCouponState = "EXPIRED" 170 USERPRODUCTCOUPONSTATE_DELETED UserProductCouponState = "DELETED" 171 USERPRODUCTCOUPONSTATE_DEACTIVATED UserProductCouponState = "DEACTIVATED" 172) 173 174type UserProductCouponSendChannel string 175 176func (e UserProductCouponSendChannel) Ptr() *UserProductCouponSendChannel { 177 return &e 178} 179 180const ( 181 USERPRODUCTCOUPONSENDCHANNEL_BRAND_MANAGE UserProductCouponSendChannel = "BRAND_MANAGE" 182 USERPRODUCTCOUPONSENDCHANNEL_API UserProductCouponSendChannel = "API" 183 USERPRODUCTCOUPONSENDCHANNEL_RECEIVE_COMPONENT UserProductCouponSendChannel = "RECEIVE_COMPONENT" 184) 185 186type UserProductCouponBundleInfo struct { 187 UserCouponBundleId *string `json:"user_coupon_bundle_id,omitempty"` 188 UserCouponBundleIndex *int64 `json:"user_coupon_bundle_index,omitempty"` 189 TotalCount *int64 `json:"total_count,omitempty"` 190 UsedCount *int64 `json:"used_count,omitempty"` 191} 192 193type ProductCouponEntity struct { 194 ProductCouponId *string `json:"product_coupon_id,omitempty"` 195 Scope *ProductCouponScope `json:"scope,omitempty"` 196 Type *ProductCouponType `json:"type,omitempty"` 197 UsageMode *UsageMode `json:"usage_mode,omitempty"` 198 SingleUsageInfo *SingleUsageInfo `json:"single_usage_info,omitempty"` 199 ProgressiveBundleUsageInfo *ProgressiveBundleUsageInfo `json:"progressive_bundle_usage_info,omitempty"` 200 DisplayInfo *ProductCouponDisplayInfo `json:"display_info,omitempty"` 201 OutProductNo *string `json:"out_product_no,omitempty"` 202 State *ProductCouponState `json:"state,omitempty"` 203 DeactivateRequestNo *string `json:"deactivate_request_no,omitempty"` 204 DeactivateTime *string `json:"deactivate_time,omitempty"` 205 DeactivateReason *string `json:"deactivate_reason,omitempty"` 206} 207 208type StockEntity struct { 209 ProductCouponId *string `json:"product_coupon_id,omitempty"` 210 StockId *string `json:"stock_id,omitempty"` 211 Remark *string `json:"remark,omitempty"` 212 CouponCodeMode *CouponCodeMode `json:"coupon_code_mode,omitempty"` 213 CouponCodeCountInfo *CouponCodeCountInfo `json:"coupon_code_count_info,omitempty"` 214 StockSendRule *StockSendRule `json:"stock_send_rule,omitempty"` 215 SingleUsageRule *SingleUsageRule `json:"single_usage_rule,omitempty"` 216 ProgressiveBundleUsageRule *StockUsageRule `json:"progressive_bundle_usage_rule,omitempty"` 217 StockBundleInfo *StockBundleInfo `json:"stock_bundle_info,omitempty"` 218 UsageRuleDisplayInfo *UsageRuleDisplayInfo `json:"usage_rule_display_info,omitempty"` 219 CouponDisplayInfo *CouponDisplayInfo `json:"coupon_display_info,omitempty"` 220 NotifyConfig *NotifyConfig `json:"notify_config,omitempty"` 221 StoreScope *StockStoreScope `json:"store_scope,omitempty"` 222 SentCountInfo *StockSentCountInfo `json:"sent_count_info,omitempty"` 223 State *StockState `json:"state,omitempty"` 224 DeactivateRequestNo *string `json:"deactivate_request_no,omitempty"` 225 DeactivateTime *time.Time `json:"deactivate_time,omitempty"` 226 DeactivateReason *string `json:"deactivate_reason,omitempty"` 227} 228 229type CouponTagInfo struct { 230 CouponTagList []UserProductCouponTag `json:"coupon_tag_list,omitempty"` 231 MemberTagInfo *MemberTagInfo `json:"member_tag_info,omitempty"` 232} 233 234type ProductCouponScope string 235 236func (e ProductCouponScope) Ptr() *ProductCouponScope { 237 return &e 238} 239 240const ( 241 PRODUCTCOUPONSCOPE_ALL ProductCouponScope = "ALL" 242 PRODUCTCOUPONSCOPE_SINGLE ProductCouponScope = "SINGLE" 243) 244 245type ProductCouponType string 246 247func (e ProductCouponType) Ptr() *ProductCouponType { 248 return &e 249} 250 251const ( 252 PRODUCTCOUPONTYPE_NORMAL ProductCouponType = "NORMAL" 253 PRODUCTCOUPONTYPE_DISCOUNT ProductCouponType = "DISCOUNT" 254 PRODUCTCOUPONTYPE_EXCHANGE ProductCouponType = "EXCHANGE" 255) 256 257type UsageMode string 258 259func (e UsageMode) Ptr() *UsageMode { 260 return &e 261} 262 263const ( 264 USAGEMODE_SINGLE UsageMode = "SINGLE" 265 USAGEMODE_PROGRESSIVE_BUNDLE UsageMode = "PROGRESSIVE_BUNDLE" 266) 267 268type SingleUsageInfo struct { 269 NormalCoupon *NormalCouponUsageRule `json:"normal_coupon,omitempty"` 270 DiscountCoupon *DiscountCouponUsageRule `json:"discount_coupon,omitempty"` 271} 272 273type ProgressiveBundleUsageInfo struct { 274 Count *int64 `json:"count,omitempty"` 275 IntervalDays *int64 `json:"interval_days,omitempty"` 276} 277 278type ProductCouponDisplayInfo struct { 279 Name *string `json:"name,omitempty"` 280 ImageUrl *string `json:"image_url,omitempty"` 281 BackgroundUrl *string `json:"background_url,omitempty"` 282 DetailImageUrlList []string `json:"detail_image_url_list,omitempty"` 283 OriginalPrice *int64 `json:"original_price,omitempty"` 284 ComboPackageList []ComboPackage `json:"combo_package_list,omitempty"` 285} 286 287type ProductCouponState string 288 289func (e ProductCouponState) Ptr() *ProductCouponState { 290 return &e 291} 292 293const ( 294 PRODUCTCOUPONSTATE_AUDITING ProductCouponState = "AUDITING" 295 PRODUCTCOUPONSTATE_EFFECTIVE ProductCouponState = "EFFECTIVE" 296 PRODUCTCOUPONSTATE_DEACTIVATED ProductCouponState = "DEACTIVATED" 297) 298 299type CouponCodeMode string 300 301func (e CouponCodeMode) Ptr() *CouponCodeMode { 302 return &e 303} 304 305const ( 306 COUPONCODEMODE_WECHATPAY CouponCodeMode = "WECHATPAY" 307 COUPONCODEMODE_UPLOAD CouponCodeMode = "UPLOAD" 308 COUPONCODEMODE_API_ASSIGN CouponCodeMode = "API_ASSIGN" 309) 310 311type CouponCodeCountInfo struct { 312 TotalCount *int64 `json:"total_count,omitempty"` 313 AvailableCount *int64 `json:"available_count,omitempty"` 314} 315 316type StockSendRule struct { 317 MaxCount *int64 `json:"max_count,omitempty"` 318 MaxCountPerDay *int64 `json:"max_count_per_day,omitempty"` 319 MaxCountPerUser *int64 `json:"max_count_per_user,omitempty"` 320} 321 322type SingleUsageRule struct { 323 CouponAvailablePeriod *CouponAvailablePeriod `json:"coupon_available_period,omitempty"` 324 NormalCoupon *NormalCouponUsageRule `json:"normal_coupon,omitempty"` 325 DiscountCoupon *DiscountCouponUsageRule `json:"discount_coupon,omitempty"` 326 ExchangeCoupon *ExchangeCouponUsageRule `json:"exchange_coupon,omitempty"` 327} 328 329type StockUsageRule struct { 330 CouponAvailablePeriod *CouponAvailablePeriod `json:"coupon_available_period,omitempty"` 331 NormalCoupon *NormalCouponUsageRule `json:"normal_coupon,omitempty"` 332 DiscountCoupon *DiscountCouponUsageRule `json:"discount_coupon,omitempty"` 333 ExchangeCoupon *ExchangeCouponUsageRule `json:"exchange_coupon,omitempty"` 334} 335 336type StockBundleInfo struct { 337 StockBundleId *string `json:"stock_bundle_id,omitempty"` 338 StockBundleIndex *int64 `json:"stock_bundle_index,omitempty"` 339} 340 341type UsageRuleDisplayInfo struct { 342 CouponUsageMethodList []CouponUsageMethod `json:"coupon_usage_method_list,omitempty"` 343 MiniProgramAppid *string `json:"mini_program_appid,omitempty"` 344 MiniProgramPath *string `json:"mini_program_path,omitempty"` 345 AppPath *string `json:"app_path,omitempty"` 346 UsageDescription *string `json:"usage_description,omitempty"` 347 CouponAvailableStoreInfo *CouponAvailableStoreInfo `json:"coupon_available_store_info,omitempty"` 348} 349 350type CouponDisplayInfo struct { 351 CodeDisplayMode *CouponCodeDisplayMode `json:"code_display_mode,omitempty"` 352 BackgroundColor *string `json:"background_color,omitempty"` 353 EntranceMiniProgram *EntranceMiniProgram `json:"entrance_mini_program,omitempty"` 354 EntranceOfficialAccount *EntranceOfficialAccount `json:"entrance_official_account,omitempty"` 355 EntranceFinder *EntranceFinder `json:"entrance_finder,omitempty"` 356} 357 358type NotifyConfig struct { 359 NotifyAppid *string `json:"notify_appid,omitempty"` 360} 361 362type StockStoreScope string 363 364func (e StockStoreScope) Ptr() *StockStoreScope { 365 return &e 366} 367 368const ( 369 STOCKSTORESCOPE_NONE StockStoreScope = "NONE" 370 STOCKSTORESCOPE_ALL StockStoreScope = "ALL" 371 STOCKSTORESCOPE_SPECIFIC StockStoreScope = "SPECIFIC" 372) 373 374type StockSentCountInfo struct { 375 TotalCount *int64 `json:"total_count,omitempty"` 376 TodayCount *int64 `json:"today_count,omitempty"` 377} 378 379type StockState string 380 381func (e StockState) Ptr() *StockState { 382 return &e 383} 384 385const ( 386 STOCKSTATE_AUDITING StockState = "AUDITING" 387 STOCKSTATE_SENDING StockState = "SENDING" 388 STOCKSTATE_PAUSED StockState = "PAUSED" 389 STOCKSTATE_STOPPED StockState = "STOPPED" 390 STOCKSTATE_DEACTIVATED StockState = "DEACTIVATED" 391) 392 393type UserProductCouponTag string 394 395func (e UserProductCouponTag) Ptr() *UserProductCouponTag { 396 return &e 397} 398 399const ( 400 USERPRODUCTCOUPONTAG_MEMBER UserProductCouponTag = "MEMBER" 401) 402 403type MemberTagInfo struct { 404 MemberCardId *string `json:"member_card_id,omitempty"` 405} 406 407type NormalCouponUsageRule struct { 408 Threshold *int64 `json:"threshold,omitempty"` 409 DiscountAmount *int64 `json:"discount_amount,omitempty"` 410} 411 412type DiscountCouponUsageRule struct { 413 Threshold *int64 `json:"threshold,omitempty"` 414 PercentOff *int64 `json:"percent_off,omitempty"` 415} 416 417type ComboPackage struct { 418 Name *string `json:"name,omitempty"` 419 PickCount *int64 `json:"pick_count,omitempty"` 420 ChoiceList []ComboPackageChoice `json:"choice_list,omitempty"` 421} 422 423type CouponAvailablePeriod struct { 424 AvailableBeginTime *string `json:"available_begin_time,omitempty"` 425 AvailableEndTime *string `json:"available_end_time,omitempty"` 426 AvailableDays *int64 `json:"available_days,omitempty"` 427 WaitDaysAfterReceive *int64 `json:"wait_days_after_receive,omitempty"` 428 WeeklyAvailablePeriod *FixedWeekPeriod `json:"weekly_available_period,omitempty"` 429 IrregularAvailablePeriodList []TimePeriod `json:"irregular_available_period_list,omitempty"` 430} 431 432type ExchangeCouponUsageRule struct { 433 Threshold *int64 `json:"threshold,omitempty"` 434 ExchangePrice *int64 `json:"exchange_price,omitempty"` 435} 436 437type CouponUsageMethod string 438 439func (e CouponUsageMethod) Ptr() *CouponUsageMethod { 440 return &e 441} 442 443const ( 444 COUPONUSAGEMETHOD_OFFLINE CouponUsageMethod = "OFFLINE" 445 COUPONUSAGEMETHOD_MINI_PROGRAM CouponUsageMethod = "MINI_PROGRAM" 446 COUPONUSAGEMETHOD_APP CouponUsageMethod = "APP" 447 COUPONUSAGEMETHOD_PAYMENT_CODE CouponUsageMethod = "PAYMENT_CODE" 448) 449 450type CouponAvailableStoreInfo struct { 451 Description *string `json:"description,omitempty"` 452 MiniProgramAppid *string `json:"mini_program_appid,omitempty"` 453 MiniProgramPath *string `json:"mini_program_path,omitempty"` 454} 455 456type CouponCodeDisplayMode string 457 458func (e CouponCodeDisplayMode) Ptr() *CouponCodeDisplayMode { 459 return &e 460} 461 462const ( 463 COUPONCODEDISPLAYMODE_INVISIBLE CouponCodeDisplayMode = "INVISIBLE" 464 COUPONCODEDISPLAYMODE_BARCODE CouponCodeDisplayMode = "BARCODE" 465 COUPONCODEDISPLAYMODE_QRCODE CouponCodeDisplayMode = "QRCODE" 466) 467 468type EntranceMiniProgram struct { 469 Appid *string `json:"appid,omitempty"` 470 Path *string `json:"path,omitempty"` 471 EntranceWording *string `json:"entrance_wording,omitempty"` 472 GuidanceWording *string `json:"guidance_wording,omitempty"` 473} 474 475type EntranceOfficialAccount struct { 476 Appid *string `json:"appid,omitempty"` 477} 478 479type EntranceFinder struct { 480 FinderId *string `json:"finder_id,omitempty"` 481 FinderVideoId *string `json:"finder_video_id,omitempty"` 482 FinderVideoCoverImageUrl *string `json:"finder_video_cover_image_url,omitempty"` 483} 484 485type ComboPackageChoice struct { 486 Name *string `json:"name,omitempty"` 487 Price *int64 `json:"price,omitempty"` 488 Count *int64 `json:"count,omitempty"` 489 ImageUrl *string `json:"image_url,omitempty"` 490 MiniProgramAppid *string `json:"mini_program_appid,omitempty"` 491 MiniProgramPath *string `json:"mini_program_path,omitempty"` 492} 493 494type FixedWeekPeriod struct { 495 DayList []WeekEnum `json:"day_list,omitempty"` 496 DayPeriodList []PeriodOfTheDay `json:"day_period_list,omitempty"` 497} 498 499type TimePeriod struct { 500 BeginTime *string `json:"begin_time,omitempty"` 501 EndTime *string `json:"end_time,omitempty"` 502} 503 504type WeekEnum string 505 506func (e WeekEnum) Ptr() *WeekEnum { 507 return &e 508} 509 510const ( 511 WEEKENUM_MONDAY WeekEnum = "MONDAY" 512 WEEKENUM_TUESDAY WeekEnum = "TUESDAY" 513 WEEKENUM_WEDNESDAY WeekEnum = "WEDNESDAY" 514 WEEKENUM_THURSDAY WeekEnum = "THURSDAY" 515 WEEKENUM_FRIDAY WeekEnum = "FRIDAY" 516 WEEKENUM_SATURDAY WeekEnum = "SATURDAY" 517 WEEKENUM_SUNDAY WeekEnum = "SUNDAY" 518) 519 520type PeriodOfTheDay struct { 521 BeginTime *int64 `json:"begin_time,omitempty"` 522 EndTime *int64 `json:"end_time,omitempty"` 523} 524
应答参数
200 OK
coupon_code 必填 string(40)
【用户商品券Code】 用户商品券的唯一标识
coupon_state 必填 string
【用户商品券状态】
可选取值
CONFIRMING: 待确认,用户商品券发放需要品牌方调用【确认发放用户商品券API】后才能生效PENDING: 已发放待生效,用户商品券已发放成功但尚未到达可用开始时间EFFECTIVE: 已生效,用户商品券已成功发放且到达可用开始时间USED: 已核销,用户商品券已核销EXPIRED: 已过期,用户商品券已超过有效期,不再可用DELETED: 已删除,用户主动删除该券DEACTIVATED: 已失效,品牌方主动调用【失效用户商品券API】或【失效用户商品券组API】使用户商品券失效
valid_begin_time 必填 string
【有效期开始时间】 用户商品券可用开始时间,遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)
valid_end_time 必填 string
【有效期结束时间】 用户商品券可用结束时间。遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)
receive_time 必填 string
【领券时间】 用户领券时间。遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)
send_request_no 必填 string(128)
【发券请求单号】 发券时传入的请求流水号
send_channel 必填 string
【发券渠道】 描述用户商品券是经由什么渠道发送的
可选取值
BRAND_MANAGE: 摇一摇有优惠,通过摇一摇有优惠渠道发放API: 品牌方自主发券,品牌方通过发券接口自主发券到商家名片RECEIVE_COMPONENT: 小程序领券组件,品牌方通过小程序领券组件发券
confirm_request_no 选填 string
【确认请求单号】 品牌方确认发券请求时传入的的请求流水号。当且仅当 品牌方调用【确认发放用户商品券API】后提供。
confirm_time 选填 string
【确认发放时间】 品牌方确认发券时间,当且仅当 品牌方调用【确认发放用户商品券API】后提供。遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)
deactivate_request_no 选填 string(128)
【失效请求单号】 品牌方失效券请求时传入的的请求流水号。当且仅当 coupon_state 为 DEACTIVATED 时提供,返回品牌方调用【失效用户商品券API】或【失效用户商品券组API】时传入的请求流水号
deactivate_time 选填 string
【失效时间】 失效时间,当且仅当 coupon_state 为 DEACTIVATED 时提供。遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)
deactivate_reason 选填 string(150)
【失效原因】 失效券的原因,当且仅当 coupon_state 为 DEACTIVATED 时提供,返回品牌方调用【失效用户商品券API】或【失效用户商品券组API】时传入的失效原因
user_product_coupon_bundle_info 选填 object
【用户券组信息】 当前用户券所属用户券组的信息,当且仅当 usage_mode 为 PROGRESSIVE_BUNDLE 时提供
| 属性 | |
user_coupon_bundle_id 必填 string 【用户券组ID】 本券所属的用户券组ID,【向用户发放商品券批次组】时由微信支付生成 user_coupon_bundle_index 必填 integer 【用户券组内索引】 本券在所属用户券组内的序号,从 0 开始编号 total_count 必填 integer 【总可使用次数】 所属用户券组总计可用次数 used_count 必填 integer 【已使用次数】 所属用户券组已使用次数 |
product_coupon 必填 object
【商品券信息】 该用户商品券对应的商品券详情
| 属性 | |||||||||||||||||||||||||||||
product_coupon_id 必填 string(40) 【商品券ID】 商品券的唯一标识,由微信支付生成 scope 必填 string 【优惠范围】 商品券优惠范围 可选取值
type 必填 string 【商品券类型】 商品券的优惠类型 可选取值
usage_mode 必填 string 【使用模式】 商品券使用模式 可选取值
single_usage_info 选填 object 【单券模式信息】 单券模式配置信息,仅当
progressive_bundle_usage_info 选填 object 【多次优惠模式信息】 多次优惠模式配置信息,当且仅当
display_info 必填 object 【展示信息】 商品券展示信息
out_product_no 选填 string 【外部商品ID】 商户创建商品券时主动传入的外部商品ID,原样返回 state 必填 string 【商品券状态】 商品券状态 可选取值
deactivate_request_no 选填 string(128) 【失效请求单号】 当且仅当 deactivate_time 选填 string 【失效时间】 当且仅当 deactivate_reason 选填 string(150) 【失效原因】 当且仅当 |
stock 必填 object
【批次信息】 该用户商品券发券时使用的批次详情
| 属性 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
product_coupon_id 必填 string(40) 【商品券ID】 商品券的唯一标识,由微信支付生成 stock_id 必填 string(40) 【批次ID】 商品券批次的唯一标识,由微信支付生成 remark 选填 string(20) 【备注】 仅配置品牌可见,用于自定义信息 coupon_code_mode 必填 string 【券Code分配模式】 决定发券时用户商品券Code如何产生 可选取值
coupon_code_count_info 选填 object 【品牌方预上传的券Code数量信息】 当且仅当
stock_send_rule 必填 object 【发放规则】 发放规则
single_usage_rule 选填 object 【单券使用规则】 当且仅当
progressive_bundle_usage_rule 选填 object 【多次优惠使用规则】 当且仅当
stock_bundle_info 选填 object 【批次组信息】 批次所在批次组信息,当且仅当
usage_rule_display_info 必填 object 【券使用规则展示信息】 券使用规则展示信息
coupon_display_info 必填 object 【用户商品券展示信息】 用户商品券在卡包中的展示详情,包括引导用户的自定义入口
notify_config 必填 object 【事件通知配置】 发生券相关事件时,微信支付会向品牌方发送通知,需要提供通知相关配置
store_scope 必填 string 【可用门店范围】 控制该批次可以在品牌下哪些门店使用 可选取值
sent_count_info 必填 object 【已发放次数】 本批次已发放次数
state 必填 string 【批次状态】 商品券批次状态 可选取值
deactivate_request_no 选填 string(128) 【失效请求单号】 当且仅当 deactivate_time 选填 string 【失效时间】 当且仅当 deactivate_reason 选填 string(150) 【失效原因】 当且仅当 |
attach 选填 string
【自定义附加信息】 调用发券接口时品牌方使用 attach 字段主动设置的附加信息。微信支付不会解析该信息,仅在查询用户商品券和回调中原样返回。
注: 发券渠道多样,只有品牌方通过发券接口发放的券才会在查询和回调中携带此字段,其他渠道发放的券 attach 为空。
channel_custom_info 选填 string(1000)
【渠道自定义信息】 使用微信支付提供的其他渠道(比如「摇一摇有优惠」)发放商品券时,渠道可能会设置该渠道特定的自定义信息,请根据 send_channel 字段判断如何解析本字段。不同渠道的自定义信息格式不同,请根据对应渠道的文档解析。
coupon_tag_info 选填 object
【用户商品券标签信息】 用户商品券标签信息
| 属性 | |||||
coupon_tag_list 选填 array[string] 【用户商品券标签列表】 用户商品券标签列表 可选取值
member_tag_info 选填 object 【会员标签信息】 当用户商品券标签列表中有
|
应答示例
200 OK
确认发放用户券
1{ 2 "coupon_code" : "Code_123456", 3 "coupon_state" : "EFFECTIVE", 4 "valid_begin_time" : "2025-08-02T00:00:00+08:00", 5 "valid_end_time" : "2025-08-31T23:59:59+08:00", 6 "receive_time" : "2025-08-02T00:00:00+08:00", 7 "send_request_no" : "MCHSEND202003101234", 8 "send_channel" : "API", 9 "confirm_request_no" : "MCHCONFIRM202003101234", 10 "confirm_time" : "2025-08-02T00:00:05+08:00", 11 "single_usage_detail" : { }, 12 "product_coupon" : { 13 "product_coupon_id" : "1000000013", 14 "scope" : "ALL", 15 "type" : "DISCOUNT", 16 "usage_mode" : "SINGLE", 17 "single_usage_info" : { 18 "discount_coupon" : { 19 "threshold" : 10000, 20 "percent_off" : 20 21 } 22 }, 23 "display_info" : { 24 "name" : "全场满100立打8折-新名字", 25 "image_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx", 26 "background_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx", 27 "detail_image_url_list" : [ 28 "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx" 29 ] 30 }, 31 "state" : "EFFECTIVE", 32 "out_product_no" : "Product_1234567890" 33 }, 34 "stock" : { 35 "product_coupon_id" : "1000000013", 36 "stock_id" : "1000000013001", 37 "remark" : "8月工作日有效批次", 38 "coupon_code_mode" : "UPLOAD", 39 "coupon_code_count_info" : { 40 "total_count" : 0, 41 "available_count" : 0 42 }, 43 "stock_send_rule" : { 44 "max_count" : 10000000, 45 "max_count_per_user" : 1 46 }, 47 "single_usage_rule" : { 48 "coupon_available_period" : { 49 "available_begin_time" : "2025-08-01T00:00:00+08:00", 50 "available_end_time" : "2025-08-31T23:59:59+08:00", 51 "available_days" : 30, 52 "weekly_available_period" : { 53 "day_list" : [ 54 "MONDAY", 55 "TUESDAY", 56 "WEDNESDAY", 57 "THURSDAY", 58 "FRIDAY" 59 ] 60 } 61 } 62 }, 63 "usage_rule_display_info" : { 64 "coupon_usage_method_list" : [ 65 "OFFLINE", 66 "MINI_PROGRAM", 67 "PAYMENT_CODE" 68 ], 69 "mini_program_appid" : "wx1234567890", 70 "mini_program_path" : "/pages/index/product", 71 "usage_description" : "工作日可用", 72 "coupon_available_store_info" : { 73 "description" : "所有门店可用,可使用小程序查看门店列表", 74 "mini_program_appid" : "wx1234567890", 75 "mini_program_path" : "/pages/index/store-list" 76 } 77 }, 78 "coupon_display_info" : { 79 "code_display_mode" : "QRCODE", 80 "background_color" : "Color010", 81 "entrance_mini_program" : { 82 "appid" : "wx1234567890", 83 "path" : "/pages/index/product", 84 "entrance_wording" : "欢迎选购", 85 "guidance_wording" : "获取更多优惠" 86 }, 87 "entrance_official_account" : { 88 "appid" : "wx1234567890" 89 }, 90 "entrance_finder" : { 91 "finder_id" : "gh_12345678", 92 "finder_video_id" : "UDFsdf24df34dD456Hdf34", 93 "finder_video_cover_image_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx" 94 } 95 }, 96 "notify_config" : { 97 "notify_appid" : "wx4fd12345678" 98 }, 99 "store_scope" : "NONE", 100 "sent_count_info" : { 101 "total_count" : 0, 102 "today_count" : 0 103 }, 104 "state" : "SENDING" 105 }, 106 "attach" : "any attach content" 107} 108
错误码
以下是本接口返回的错误码列表。详细错误码规则,请参考微信支付接口规则-错误码和错误提示
状态码 | 错误码 | 描述 | 解决方案 |
|---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
400 | INVALID_REQUEST | 单券使用模式的商品券批次,应该在「单券使用规则」中包含对应类型的优惠规则。对于文档中标记不应填写的优惠规则应删除。 | 请在「单券使用规则」中包含对应类型的优惠规则,并删除文档中标记不应填写的优惠规则。 |
400 | INVALID_REQUEST | 多次优惠使用模式的商品券批次,应该在「多次优惠使用规则」中包含对应类型的优惠规则,且数量与多次优惠的优惠次数相等 | 在「多次优惠使用规则」中包含对应类型的优惠规则,且数量与多次优惠的优惠次数相等 |
400 | INVALID_REQUEST | 单品满减券或单品折扣券不应在商品券中设置「满减券使用规则」或「折扣券使用规则」,而是应该在商品券批次中设置 | 请删除商品券中的「满减券使用规则」或「折扣券使用规则」,并在商品券批次中设置对应的优惠规则 |
403 | NO_AUTH | 品牌没有此接口权限 | 品牌没有此接口权限 |
400 | INVALID_REQUEST | 商品券支持APP核销时,必须提供「APP跳转路径」 | 请提供「APP跳转路径」参数 |
400 | PARAM_ERROR | 分页大小超出限制,请根据接口文档调整到允许的范围 | 请调整分页大小到规定范围 |
400 | INVALID_REQUEST | 商品券支持小程序核销时,必须提供「小程序AppID」 | 请提供「小程序AppID」 |
400 | INVALID_REQUEST | 单品券必须提供商品原价,请补充 | 请补充商品原价 |
400 | INVALID_REQUEST | 商品券支持小程序核销时,必须提供「小程序跳转路径」 | 请提供提供「小程序跳转路径」 |
400 | INVALID_REQUEST | 单品券必须提供商品券套餐组合信息,请补充 | 请提供商品券套餐组合信息 |
400 | PARAM_ERROR | 时间字符串格式错误,请使用 RFC3339 标准格式 | 请使用 RFC3339 标准格式 |
400 | INVALID_REQUEST | 单券模式下,全场折扣券应在商品券中提供折扣券使用规则信息 | 请在商品券中提供「折扣券使用规则信息」 |
400 | INVALID_REQUEST | 单券模式下,全场满减券应在商品券中提供满减券使用规则信息 | 请在商品券中提供「满减券使用规则信息」 |
400 | INVALID_REQUEST | 每周固定可用时间(weekly_available_period)中提供当天可用时间段时(day_period_list),每周可用星期数(day_list)必填 | 请补充 每周可用星期数(day_list) |
400 | INVALID_REQUEST | 单券模式下,全场券需要提供「单券模式信息(single_usage_info)」 | 请提供单券模式信息(single_usage_info) |
400 | INVALID_REQUEST | 多次优惠模式下必须提供「多次优惠模式信息(sequential_usage_info)」 | 请填写 多次优惠模式信息(sequential_usage_info) |
400 | INVALID_REQUEST | 传入的OpenID不合法 | 请使用参数 AppID 对应的的OpenID |


