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