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