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