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