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

