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