向用户发放商品券
更新时间:2025.08.28品牌方可以通过本接口向用户发放指定商品券批次,能否发放受限于商品券批次的发放限额:
商品券批次总预算
商品券批次每日预算(如果有)
商品券批次每人限领(如果有)
前置条件:已创建商品券批次,商品券批次处于 SENDING 状态
频率限制:500/s
接口说明
支持商户:【品牌商户】
请求方式:【POST】/brand/marketing/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
Wechatpay-Serial 必填 string
【微信支付公钥ID】 请传入brand_id对应的微信支付公钥ID,接口将会校验两者的关联关系,参考微信支付公钥产品简介及使用说明获取微信支付公钥ID和相关的介绍。以下两种场景将使用到微信支付公钥: 1、接收到接口的返回内容,需要使用微信支付公钥进行验签; 2、调用含有敏感信息参数(如姓名、身份证号码)的接口时,需要使用微信支付公钥加密敏感信息后再传输参数,加密指引请参考微信支付公钥加密敏感信息指引。
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】 请传入与当前调用接口品牌ID有绑定关系的AppID,如何绑定请参考品牌经营平台指引,支持小程序、服务号、公众号、APP类型的AppID
send_request_no 必填 string(40)
【发券请求单号】 品牌给用户发券的请求流水号,品牌侧需保持唯一性,可使用 数字、大小写字母、下划线_、短横线- 组成,长度在6-40个字符之间
attach 选填 string(150)
【自定义附加信息】 发券时品牌方可以使用该字段附带自定义附加信息,长度限制150个UTF-8字符。微信支付不会解析该信息,仅在查询用户商品券和回调中原样返回。
注: 发券渠道多样,只有品牌方通过此接口发放以及调用「向用户预发放商品券」接口并在领券组件中发放的券才会在查询和回调中携带此字段,其他渠道发放的券 attach 为空。
coupon_tag_info 选填 object
【用户商品券标签信息】 用户商品券标签信息
| 属性 | |||||
coupon_tag_list 选填 array[string] 【用户商品券标签列表】 用户商品券标签列表 可选取值
member_tag_info 选填 object 【会员标签信息】 当用户商品券标签列表中有
|
请求示例
POST
1curl -X POST \ 2 https://api.mch.weixin.qq.com/brand/marketing/product-coupon/users/oh-394z-6CGkNoJrsDLTTUKiAnp4/coupons \ 3 -H "Authorization: WECHATPAY-BRAND-SHA256-RSA2048 brand_id=\"XXXX\",..." \ 4 -H "Accept: application/json" \ 5 -H "Wechatpay-Serial: PUB_KEY_ID_XXXX" \ 6 -H "Content-Type: application/json" \ 7 -d '{ 8 "product_coupon_id" : "200000001", 9 "stock_id" : "100232301", 10 "coupon_code" : "123446565767", 11 "appid" : "wx233544546545989", 12 "send_request_no" : "34657_20250101_123456", 13 "attach" : "example_attach", 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.WXPayBrandUtility; // 引用微信支付工具库,参考:https://pay.weixin.qq.com/doc/brand/4015826861 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 = "/brand/marketing/product-coupon/users/{openid}/coupons"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/brand/4015415289 32 SendUserProductCoupon client = new SendUserProductCoupon( 33 "xxxxxxxx", // 品牌ID,是由微信支付系统生成并分配给每个品牌方的唯一标识符,品牌ID获取方式参考 https://pay.weixin.qq.com/doc/brand/4015415289 34 "1DDE55AD98Exxxxxxxxxx", // 品牌API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015407570 35 "/path/to/apiclient_key.pem", // 品牌API证书私钥文件路径,本地文件路径 36 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015453439 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.couponTagInfo = new CouponTagInfo(); 49 request.couponTagInfo.couponTagList = new ArrayList<>(); 50 { 51 request.couponTagInfo.couponTagList.add(UserProductCouponTag.MEMBER); 52 }; 53 request.couponTagInfo.memberTagInfo = new MemberTagInfo(); 54 request.couponTagInfo.memberTagInfo.memberCardId = "MemberCardId_1234567890"; 55 try { 56 UserProductCouponEntity response = client.run(request); 57 // TODO: 请求成功,继续业务逻辑 58 System.out.println(response); 59 } catch (WXPayBrandUtility.ApiException e) { 60 // TODO: 请求失败,根据状态码执行不同的逻辑 61 e.printStackTrace(); 62 } 63 } 64 65 public UserProductCouponEntity run(SendUserProductCouponRequest request) { 66 String uri = PATH; 67 uri = uri.replace("{openid}", WXPayBrandUtility.urlEncode(request.openid)); 68 String reqBody = WXPayBrandUtility.toJson(request); 69 70 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 71 reqBuilder.addHeader("Accept", "application/json"); 72 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 73 reqBuilder.addHeader("Authorization", WXPayBrandUtility.buildAuthorization(brand_id, certificateSerialNo,privateKey, METHOD, uri, reqBody)); 74 reqBuilder.addHeader("Content-Type", "application/json"); 75 RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody); 76 reqBuilder.method(METHOD, requestBody); 77 Request httpRequest = reqBuilder.build(); 78 79 // 发送HTTP请求 80 OkHttpClient client = new OkHttpClient.Builder().build(); 81 try (Response httpResponse = client.newCall(httpRequest).execute()) { 82 String respBody = WXPayBrandUtility.extractBody(httpResponse); 83 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 84 // 2XX 成功,验证应答签名 85 WXPayBrandUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 86 httpResponse.headers(), respBody); 87 88 // 从HTTP应答报文构建返回数据 89 return WXPayBrandUtility.fromJson(respBody, UserProductCouponEntity.class); 90 } else { 91 throw new WXPayBrandUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 92 } 93 } catch (IOException e) { 94 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 95 } 96 } 97 98 private final String brand_id; 99 private final String certificateSerialNo; 100 private final PrivateKey privateKey; 101 private final String wechatPayPublicKeyId; 102 private final PublicKey wechatPayPublicKey; 103 104 public SendUserProductCoupon(String brand_id, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 105 this.brand_id = brand_id; 106 this.certificateSerialNo = certificateSerialNo; 107 this.privateKey = WXPayBrandUtility.loadPrivateKeyFromPath(privateKeyFilePath); 108 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 109 this.wechatPayPublicKey = WXPayBrandUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 110 } 111 112 public static class SendUserProductCouponRequest { 113 @SerializedName("product_coupon_id") 114 public String productCouponId; 115 116 @SerializedName("stock_id") 117 public String stockId; 118 119 @SerializedName("coupon_code") 120 public String couponCode; 121 122 @SerializedName("appid") 123 public String appid; 124 125 @SerializedName("openid") 126 @Expose(serialize = false) 127 public String openid; 128 129 @SerializedName("send_request_no") 130 public String sendRequestNo; 131 132 @SerializedName("attach") 133 public String attach; 134 135 @SerializedName("coupon_tag_info") 136 public CouponTagInfo couponTagInfo; 137 } 138 139 public static class UserProductCouponEntity { 140 @SerializedName("coupon_code") 141 public String couponCode; 142 143 @SerializedName("coupon_state") 144 public UserProductCouponState couponState; 145 146 @SerializedName("valid_begin_time") 147 public String validBeginTime; 148 149 @SerializedName("valid_end_time") 150 public String validEndTime; 151 152 @SerializedName("receive_time") 153 public String receiveTime; 154 155 @SerializedName("send_request_no") 156 public String sendRequestNo; 157 158 @SerializedName("send_channel") 159 public UserProductCouponSendChannel sendChannel; 160 161 @SerializedName("confirm_request_no") 162 public String confirmRequestNo; 163 164 @SerializedName("confirm_time") 165 public String confirmTime; 166 167 @SerializedName("deactivate_request_no") 168 public String deactivateRequestNo; 169 170 @SerializedName("deactivate_time") 171 public String deactivateTime; 172 173 @SerializedName("deactivate_reason") 174 public String deactivateReason; 175 176 @SerializedName("single_usage_detail") 177 public SingleUsageDetail singleUsageDetail; 178 179 @SerializedName("sequential_usage_detail") 180 public SequentialUsageDetail sequentialUsageDetail; 181 182 @SerializedName("product_coupon") 183 public ProductCouponEntity productCoupon; 184 185 @SerializedName("stock") 186 public StockEntity stock; 187 188 @SerializedName("attach") 189 public String attach; 190 191 @SerializedName("channel_custom_info") 192 public String channelCustomInfo; 193 194 @SerializedName("coupon_tag_info") 195 public CouponTagInfo couponTagInfo; 196 } 197 198 public static class CouponTagInfo { 199 @SerializedName("coupon_tag_list") 200 public List<UserProductCouponTag> couponTagList; 201 202 @SerializedName("member_tag_info") 203 public MemberTagInfo memberTagInfo; 204 } 205 206 public enum UserProductCouponState { 207 @SerializedName("CONFIRMING") 208 CONFIRMING, 209 @SerializedName("PENDING") 210 PENDING, 211 @SerializedName("EFFECTIVE") 212 EFFECTIVE, 213 @SerializedName("USED") 214 USED, 215 @SerializedName("EXPIRED") 216 EXPIRED, 217 @SerializedName("DELETED") 218 DELETED, 219 @SerializedName("DEACTIVATED") 220 DEACTIVATED 221 } 222 223 public enum UserProductCouponSendChannel { 224 @SerializedName("BRAND_MANAGE") 225 BRAND_MANAGE, 226 @SerializedName("API") 227 API, 228 @SerializedName("RECEIVE_COMPONENT") 229 RECEIVE_COMPONENT 230 } 231 232 public static class SingleUsageDetail { 233 @SerializedName("use_request_no") 234 public String useRequestNo; 235 236 @SerializedName("use_time") 237 public String useTime; 238 239 @SerializedName("associated_order_info") 240 public UserProductCouponAssociatedOrderInfo associatedOrderInfo; 241 242 @SerializedName("return_request_no") 243 public String returnRequestNo; 244 245 @SerializedName("return_time") 246 public String returnTime; 247 } 248 249 public static class SequentialUsageDetail { 250 @SerializedName("total_count") 251 public Long totalCount; 252 253 @SerializedName("used_count") 254 public Long usedCount; 255 256 @SerializedName("detail_item_list") 257 public List<SequentialUsageDetailItem> detailItemList; 258 } 259 260 public static class ProductCouponEntity { 261 @SerializedName("product_coupon_id") 262 public String productCouponId; 263 264 @SerializedName("scope") 265 public ProductCouponScope scope; 266 267 @SerializedName("type") 268 public ProductCouponType type; 269 270 @SerializedName("usage_mode") 271 public UsageMode usageMode; 272 273 @SerializedName("single_usage_info") 274 public SingleUsageInfo singleUsageInfo; 275 276 @SerializedName("sequential_usage_info") 277 public SequentialUsageInfo sequentialUsageInfo; 278 279 @SerializedName("display_info") 280 public ProductCouponDisplayInfo displayInfo; 281 282 @SerializedName("out_product_no") 283 public String outProductNo; 284 285 @SerializedName("state") 286 public ProductCouponState state; 287 288 @SerializedName("deactivate_request_no") 289 public String deactivateRequestNo; 290 291 @SerializedName("deactivate_time") 292 public String deactivateTime; 293 294 @SerializedName("deactivate_reason") 295 public String deactivateReason; 296 } 297 298 public static class StockEntity { 299 @SerializedName("product_coupon_id") 300 public String productCouponId; 301 302 @SerializedName("stock_id") 303 public String stockId; 304 305 @SerializedName("remark") 306 public String remark; 307 308 @SerializedName("coupon_code_mode") 309 public CouponCodeMode couponCodeMode; 310 311 @SerializedName("coupon_code_count_info") 312 public CouponCodeCountInfo couponCodeCountInfo; 313 314 @SerializedName("stock_send_rule") 315 public StockSendRule stockSendRule; 316 317 @SerializedName("single_usage_rule") 318 public SingleUsageRule singleUsageRule; 319 320 @SerializedName("sequential_usage_rule") 321 public SequentialUsageRule sequentialUsageRule; 322 323 @SerializedName("usage_rule_display_info") 324 public UsageRuleDisplayInfo usageRuleDisplayInfo; 325 326 @SerializedName("coupon_display_info") 327 public CouponDisplayInfo couponDisplayInfo; 328 329 @SerializedName("notify_config") 330 public NotifyConfig notifyConfig; 331 332 @SerializedName("store_scope") 333 public StockStoreScope storeScope; 334 335 @SerializedName("sent_count_info") 336 public StockSentCountInfo sentCountInfo; 337 338 @SerializedName("state") 339 public StockState state; 340 341 @SerializedName("deactivate_request_no") 342 public String deactivateRequestNo; 343 344 @SerializedName("deactivate_time") 345 public String deactivateTime; 346 347 @SerializedName("deactivate_reason") 348 public String deactivateReason; 349 } 350 351 public enum UserProductCouponTag { 352 @SerializedName("MEMBER") 353 MEMBER 354 } 355 356 public static class MemberTagInfo { 357 @SerializedName("member_card_id") 358 public String memberCardId; 359 } 360 361 public static class UserProductCouponAssociatedOrderInfo { 362 @SerializedName("transaction_id") 363 public String transactionId; 364 365 @SerializedName("out_trade_no") 366 public String outTradeNo; 367 368 @SerializedName("mchid") 369 public String mchid; 370 371 @SerializedName("sub_mchid") 372 public String subMchid; 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_brand_utility" // 引用微信支付工具库,参考 https://pay.weixin.qq.com/doc/brand/4015826866 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/brand/4015415289 16 config, err := wxpay_brand_utility.CreateBrandConfig( 17 "xxxxxxxx", // 品牌ID,是由微信支付系统生成并分配给每个品牌方的唯一标识符,品牌ID获取方式参考 https://pay.weixin.qq.com/doc/brand/4015415289 18 "1DDE55AD98Exxxxxxxxxx", // 品牌API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015407570 19 "/path/to/apiclient_key.pem", // 品牌API证书私钥文件路径,本地文件路径 20 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015453439 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_brand_utility.String("oh-394z-6CGkNoJrsDLTTUKiAnp4"), 30 ProductCouponId: wxpay_brand_utility.String("200000001"), 31 StockId: wxpay_brand_utility.String("100232301"), 32 CouponCode: wxpay_brand_utility.String("123446565767"), 33 Appid: wxpay_brand_utility.String("wx233544546545989"), 34 SendRequestNo: wxpay_brand_utility.String("34657_20250101_123456"), 35 Attach: wxpay_brand_utility.String("example_attach"), 36 CouponTagInfo: &CouponTagInfo{ 37 CouponTagList: []UserProductCouponTag{USERPRODUCTCOUPONTAG_MEMBER}, 38 MemberTagInfo: &MemberTagInfo{ 39 MemberCardId: wxpay_brand_utility.String("MemberCardId_1234567890"), 40 }, 41 }, 42 } 43 44 response, err := SendUserProductCoupon(config, request) 45 if err != nil { 46 fmt.Printf("请求失败: %+v\n", err) 47 // TODO: 请求失败,根据状态码执行不同的处理 48 return 49 } 50 51 // TODO: 请求成功,继续业务逻辑 52 fmt.Printf("请求成功: %+v\n", response) 53} 54 55func SendUserProductCoupon(config *wxpay_brand_utility.BrandConfig, request *SendUserProductCouponRequest) (response *UserProductCouponEntity, err error) { 56 const ( 57 host = "https://api.mch.weixin.qq.com" 58 method = "POST" 59 path = "/brand/marketing/product-coupon/users/{openid}/coupons" 60 ) 61 62 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 63 if err != nil { 64 return nil, err 65 } 66 reqUrl.Path = strings.Replace(reqUrl.Path, "{openid}", url.PathEscape(*request.Openid), -1) 67 reqBody, err := json.Marshal(request) 68 if err != nil { 69 return nil, err 70 } 71 httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody)) 72 if err != nil { 73 return nil, err 74 } 75 httpRequest.Header.Set("Accept", "application/json") 76 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 77 httpRequest.Header.Set("Content-Type", "application/json") 78 authorization, err := wxpay_brand_utility.BuildAuthorization(config.BrandId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), reqBody) 79 if err != nil { 80 return nil, err 81 } 82 httpRequest.Header.Set("Authorization", authorization) 83 84 client := &http.Client{} 85 httpResponse, err := client.Do(httpRequest) 86 if err != nil { 87 return nil, err 88 } 89 respBody, err := wxpay_brand_utility.ExtractResponseBody(httpResponse) 90 if err != nil { 91 return nil, err 92 } 93 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 94 // 2XX 成功,验证应答签名 95 err = wxpay_brand_utility.ValidateResponse( 96 config.WechatPayPublicKeyId(), 97 config.WechatPayPublicKey(), 98 &httpResponse.Header, 99 respBody, 100 ) 101 if err != nil { 102 return nil, err 103 } 104 response := &UserProductCouponEntity{} 105 if err := json.Unmarshal(respBody, response); err != nil { 106 return nil, err 107 } 108 109 return response, nil 110 } else { 111 return nil, wxpay_brand_utility.NewApiException( 112 httpResponse.StatusCode, 113 httpResponse.Header, 114 respBody, 115 ) 116 } 117} 118 119type SendUserProductCouponRequest struct { 120 ProductCouponId *string `json:"product_coupon_id,omitempty"` 121 StockId *string `json:"stock_id,omitempty"` 122 CouponCode *string `json:"coupon_code,omitempty"` 123 Appid *string `json:"appid,omitempty"` 124 Openid *string `json:"openid,omitempty"` 125 SendRequestNo *string `json:"send_request_no,omitempty"` 126 Attach *string `json:"attach,omitempty"` 127 CouponTagInfo *CouponTagInfo `json:"coupon_tag_info,omitempty"` 128} 129 130func (o *SendUserProductCouponRequest) MarshalJSON() ([]byte, error) { 131 type Alias SendUserProductCouponRequest 132 a := &struct { 133 Openid *string `json:"openid,omitempty"` 134 *Alias 135 }{ 136 // 序列化时移除非 Body 字段 137 Openid: nil, 138 Alias: (*Alias)(o), 139 } 140 return json.Marshal(a) 141} 142 143type UserProductCouponEntity struct { 144 CouponCode *string `json:"coupon_code,omitempty"` 145 CouponState *UserProductCouponState `json:"coupon_state,omitempty"` 146 ValidBeginTime *time.Time `json:"valid_begin_time,omitempty"` 147 ValidEndTime *time.Time `json:"valid_end_time,omitempty"` 148 ReceiveTime *string `json:"receive_time,omitempty"` 149 SendRequestNo *string `json:"send_request_no,omitempty"` 150 SendChannel *UserProductCouponSendChannel `json:"send_channel,omitempty"` 151 ConfirmRequestNo *string `json:"confirm_request_no,omitempty"` 152 ConfirmTime *time.Time `json:"confirm_time,omitempty"` 153 DeactivateRequestNo *string `json:"deactivate_request_no,omitempty"` 154 DeactivateTime *string `json:"deactivate_time,omitempty"` 155 DeactivateReason *string `json:"deactivate_reason,omitempty"` 156 SingleUsageDetail *SingleUsageDetail `json:"single_usage_detail,omitempty"` 157 SequentialUsageDetail *SequentialUsageDetail `json:"sequential_usage_detail,omitempty"` 158 ProductCoupon *ProductCouponEntity `json:"product_coupon,omitempty"` 159 Stock *StockEntity `json:"stock,omitempty"` 160 Attach *string `json:"attach,omitempty"` 161 ChannelCustomInfo *string `json:"channel_custom_info,omitempty"` 162 CouponTagInfo *CouponTagInfo `json:"coupon_tag_info,omitempty"` 163} 164 165type CouponTagInfo struct { 166 CouponTagList []UserProductCouponTag `json:"coupon_tag_list,omitempty"` 167 MemberTagInfo *MemberTagInfo `json:"member_tag_info,omitempty"` 168} 169 170type UserProductCouponState string 171 172func (e UserProductCouponState) Ptr() *UserProductCouponState { 173 return &e 174} 175 176const ( 177 USERPRODUCTCOUPONSTATE_CONFIRMING UserProductCouponState = "CONFIRMING" 178 USERPRODUCTCOUPONSTATE_PENDING UserProductCouponState = "PENDING" 179 USERPRODUCTCOUPONSTATE_EFFECTIVE UserProductCouponState = "EFFECTIVE" 180 USERPRODUCTCOUPONSTATE_USED UserProductCouponState = "USED" 181 USERPRODUCTCOUPONSTATE_EXPIRED UserProductCouponState = "EXPIRED" 182 USERPRODUCTCOUPONSTATE_DELETED UserProductCouponState = "DELETED" 183 USERPRODUCTCOUPONSTATE_DEACTIVATED UserProductCouponState = "DEACTIVATED" 184) 185 186type UserProductCouponSendChannel string 187 188func (e UserProductCouponSendChannel) Ptr() *UserProductCouponSendChannel { 189 return &e 190} 191 192const ( 193 USERPRODUCTCOUPONSENDCHANNEL_BRAND_MANAGE UserProductCouponSendChannel = "BRAND_MANAGE" 194 USERPRODUCTCOUPONSENDCHANNEL_API UserProductCouponSendChannel = "API" 195 USERPRODUCTCOUPONSENDCHANNEL_RECEIVE_COMPONENT UserProductCouponSendChannel = "RECEIVE_COMPONENT" 196) 197 198type SingleUsageDetail struct { 199 UseRequestNo *string `json:"use_request_no,omitempty"` 200 UseTime *time.Time `json:"use_time,omitempty"` 201 AssociatedOrderInfo *UserProductCouponAssociatedOrderInfo `json:"associated_order_info,omitempty"` 202 ReturnRequestNo *string `json:"return_request_no,omitempty"` 203 ReturnTime *time.Time `json:"return_time,omitempty"` 204} 205 206type SequentialUsageDetail struct { 207 TotalCount *int64 `json:"total_count,omitempty"` 208 UsedCount *int64 `json:"used_count,omitempty"` 209 DetailItemList []SequentialUsageDetailItem `json:"detail_item_list,omitempty"` 210} 211 212type ProductCouponEntity struct { 213 ProductCouponId *string `json:"product_coupon_id,omitempty"` 214 Scope *ProductCouponScope `json:"scope,omitempty"` 215 Type *ProductCouponType `json:"type,omitempty"` 216 UsageMode *UsageMode `json:"usage_mode,omitempty"` 217 SingleUsageInfo *SingleUsageInfo `json:"single_usage_info,omitempty"` 218 SequentialUsageInfo *SequentialUsageInfo `json:"sequential_usage_info,omitempty"` 219 DisplayInfo *ProductCouponDisplayInfo `json:"display_info,omitempty"` 220 OutProductNo *string `json:"out_product_no,omitempty"` 221 State *ProductCouponState `json:"state,omitempty"` 222 DeactivateRequestNo *string `json:"deactivate_request_no,omitempty"` 223 DeactivateTime *string `json:"deactivate_time,omitempty"` 224 DeactivateReason *string `json:"deactivate_reason,omitempty"` 225} 226 227type StockEntity struct { 228 ProductCouponId *string `json:"product_coupon_id,omitempty"` 229 StockId *string `json:"stock_id,omitempty"` 230 Remark *string `json:"remark,omitempty"` 231 CouponCodeMode *CouponCodeMode `json:"coupon_code_mode,omitempty"` 232 CouponCodeCountInfo *CouponCodeCountInfo `json:"coupon_code_count_info,omitempty"` 233 StockSendRule *StockSendRule `json:"stock_send_rule,omitempty"` 234 SingleUsageRule *SingleUsageRule `json:"single_usage_rule,omitempty"` 235 SequentialUsageRule *SequentialUsageRule `json:"sequential_usage_rule,omitempty"` 236 UsageRuleDisplayInfo *UsageRuleDisplayInfo `json:"usage_rule_display_info,omitempty"` 237 CouponDisplayInfo *CouponDisplayInfo `json:"coupon_display_info,omitempty"` 238 NotifyConfig *NotifyConfig `json:"notify_config,omitempty"` 239 StoreScope *StockStoreScope `json:"store_scope,omitempty"` 240 SentCountInfo *StockSentCountInfo `json:"sent_count_info,omitempty"` 241 State *StockState `json:"state,omitempty"` 242 DeactivateRequestNo *string `json:"deactivate_request_no,omitempty"` 243 DeactivateTime *time.Time `json:"deactivate_time,omitempty"` 244 DeactivateReason *string `json:"deactivate_reason,omitempty"` 245} 246 247type UserProductCouponTag string 248 249func (e UserProductCouponTag) Ptr() *UserProductCouponTag { 250 return &e 251} 252 253const ( 254 USERPRODUCTCOUPONTAG_MEMBER UserProductCouponTag = "MEMBER" 255) 256 257type MemberTagInfo struct { 258 MemberCardId *string `json:"member_card_id,omitempty"` 259} 260 261type UserProductCouponAssociatedOrderInfo struct { 262 TransactionId *string `json:"transaction_id,omitempty"` 263 OutTradeNo *string `json:"out_trade_no,omitempty"` 264 Mchid *string `json:"mchid,omitempty"` 265 SubMchid *string `json:"sub_mchid,omitempty"` 266} 267 268type SequentialUsageDetailItem struct { 269 DetailState *UserProductCouponUsageDetailItemState `json:"detail_state,omitempty"` 270 ValidBeginTime *time.Time `json:"valid_begin_time,omitempty"` 271 ValidEndTime *time.Time `json:"valid_end_time,omitempty"` 272 UseRequestNo *string `json:"use_request_no,omitempty"` 273 UseTime *time.Time `json:"use_time,omitempty"` 274 AssociatedOrderInfo *UserProductCouponAssociatedOrderInfo `json:"associated_order_info,omitempty"` 275 ReturnRequestNo *string `json:"return_request_no,omitempty"` 276 ReturnTime *time.Time `json:"return_time,omitempty"` 277 DeleteTime *time.Time `json:"delete_time,omitempty"` 278} 279 280type ProductCouponScope string 281 282func (e ProductCouponScope) Ptr() *ProductCouponScope { 283 return &e 284} 285 286const ( 287 PRODUCTCOUPONSCOPE_ALL ProductCouponScope = "ALL" 288 PRODUCTCOUPONSCOPE_SINGLE ProductCouponScope = "SINGLE" 289) 290 291type ProductCouponType string 292 293func (e ProductCouponType) Ptr() *ProductCouponType { 294 return &e 295} 296 297const ( 298 PRODUCTCOUPONTYPE_NORMAL ProductCouponType = "NORMAL" 299 PRODUCTCOUPONTYPE_DISCOUNT ProductCouponType = "DISCOUNT" 300 PRODUCTCOUPONTYPE_EXCHANGE ProductCouponType = "EXCHANGE" 301) 302 303type UsageMode string 304 305func (e UsageMode) Ptr() *UsageMode { 306 return &e 307} 308 309const ( 310 USAGEMODE_SINGLE UsageMode = "SINGLE" 311 USAGEMODE_SEQUENTIAL UsageMode = "SEQUENTIAL" 312) 313 314type SingleUsageInfo struct { 315 NormalCoupon *NormalCouponUsageRule `json:"normal_coupon,omitempty"` 316 DiscountCoupon *DiscountCouponUsageRule `json:"discount_coupon,omitempty"` 317} 318 319type SequentialUsageInfo struct { 320 Type *SequentialUsageType `json:"type,omitempty"` 321 Count *int64 `json:"count,omitempty"` 322 AvailableDays *int64 `json:"available_days,omitempty"` 323 IntervalDays *int64 `json:"interval_days,omitempty"` 324} 325 326type ProductCouponDisplayInfo struct { 327 Name *string `json:"name,omitempty"` 328 ImageUrl *string `json:"image_url,omitempty"` 329 BackgroundUrl *string `json:"background_url,omitempty"` 330 DetailImageUrlList []string `json:"detail_image_url_list,omitempty"` 331 OriginalPrice *int64 `json:"original_price,omitempty"` 332 ComboPackageList []ComboPackage `json:"combo_package_list,omitempty"` 333} 334 335type ProductCouponState string 336 337func (e ProductCouponState) Ptr() *ProductCouponState { 338 return &e 339} 340 341const ( 342 PRODUCTCOUPONSTATE_AUDITING ProductCouponState = "AUDITING" 343 PRODUCTCOUPONSTATE_EFFECTIVE ProductCouponState = "EFFECTIVE" 344 PRODUCTCOUPONSTATE_DEACTIVATED ProductCouponState = "DEACTIVATED" 345) 346 347type CouponCodeMode string 348 349func (e CouponCodeMode) Ptr() *CouponCodeMode { 350 return &e 351} 352 353const ( 354 COUPONCODEMODE_WECHATPAY CouponCodeMode = "WECHATPAY" 355 COUPONCODEMODE_UPLOAD CouponCodeMode = "UPLOAD" 356 COUPONCODEMODE_API_ASSIGN CouponCodeMode = "API_ASSIGN" 357) 358 359type CouponCodeCountInfo struct { 360 TotalCount *int64 `json:"total_count,omitempty"` 361 AvailableCount *int64 `json:"available_count,omitempty"` 362} 363 364type StockSendRule struct { 365 MaxCount *int64 `json:"max_count,omitempty"` 366 MaxCountPerDay *int64 `json:"max_count_per_day,omitempty"` 367 MaxCountPerUser *int64 `json:"max_count_per_user,omitempty"` 368} 369 370type SingleUsageRule struct { 371 CouponAvailablePeriod *SingleCouponAvailablePeriod `json:"coupon_available_period,omitempty"` 372 NormalCoupon *NormalCouponUsageRule `json:"normal_coupon,omitempty"` 373 DiscountCoupon *DiscountCouponUsageRule `json:"discount_coupon,omitempty"` 374 ExchangeCoupon *ExchangeCouponUsageRule `json:"exchange_coupon,omitempty"` 375} 376 377type SequentialUsageRule struct { 378 CouponAvailablePeriod *SequentialCouponAvailablePeriod `json:"coupon_available_period,omitempty"` 379 NormalCouponList []NormalCouponUsageRule `json:"normal_coupon_list,omitempty"` 380 DiscountCouponList []DiscountCouponUsageRule `json:"discount_coupon_list,omitempty"` 381 ExchangeCouponList []ExchangeCouponUsageRule `json:"exchange_coupon_list,omitempty"` 382 SpecialFirst *bool `json:"special_first,omitempty"` 383} 384 385type UsageRuleDisplayInfo struct { 386 CouponUsageMethodList []CouponUsageMethod `json:"coupon_usage_method_list,omitempty"` 387 MiniProgramAppid *string `json:"mini_program_appid,omitempty"` 388 MiniProgramPath *string `json:"mini_program_path,omitempty"` 389 AppPath *string `json:"app_path,omitempty"` 390 UsageDescription *string `json:"usage_description,omitempty"` 391 CouponAvailableStoreInfo *CouponAvailableStoreInfo `json:"coupon_available_store_info,omitempty"` 392} 393 394type CouponDisplayInfo struct { 395 CodeDisplayMode *CouponCodeDisplayMode `json:"code_display_mode,omitempty"` 396 BackgroundColor *string `json:"background_color,omitempty"` 397 EntranceMiniProgram *EntranceMiniProgram `json:"entrance_mini_program,omitempty"` 398 EntranceOfficialAccount *EntranceOfficialAccount `json:"entrance_official_account,omitempty"` 399 EntranceFinder *EntranceFinder `json:"entrance_finder,omitempty"` 400} 401 402type NotifyConfig struct { 403 NotifyAppid *string `json:"notify_appid,omitempty"` 404} 405 406type StockStoreScope string 407 408func (e StockStoreScope) Ptr() *StockStoreScope { 409 return &e 410} 411 412const ( 413 STOCKSTORESCOPE_NONE StockStoreScope = "NONE" 414 STOCKSTORESCOPE_ALL StockStoreScope = "ALL" 415 STOCKSTORESCOPE_SPECIFIC StockStoreScope = "SPECIFIC" 416) 417 418type StockSentCountInfo struct { 419 TotalCount *int64 `json:"total_count,omitempty"` 420 TodayCount *int64 `json:"today_count,omitempty"` 421} 422 423type StockState string 424 425func (e StockState) Ptr() *StockState { 426 return &e 427} 428 429const ( 430 STOCKSTATE_AUDITING StockState = "AUDITING" 431 STOCKSTATE_SENDING StockState = "SENDING" 432 STOCKSTATE_PAUSED StockState = "PAUSED" 433 STOCKSTATE_STOPPED StockState = "STOPPED" 434 STOCKSTATE_DEACTIVATED StockState = "DEACTIVATED" 435) 436 437type UserProductCouponUsageDetailItemState string 438 439func (e UserProductCouponUsageDetailItemState) Ptr() *UserProductCouponUsageDetailItemState { 440 return &e 441} 442 443const ( 444 USERPRODUCTCOUPONUSAGEDETAILITEMSTATE_PENDING UserProductCouponUsageDetailItemState = "PENDING" 445 USERPRODUCTCOUPONUSAGEDETAILITEMSTATE_EFFECTIVE UserProductCouponUsageDetailItemState = "EFFECTIVE" 446 USERPRODUCTCOUPONUSAGEDETAILITEMSTATE_USED UserProductCouponUsageDetailItemState = "USED" 447 USERPRODUCTCOUPONUSAGEDETAILITEMSTATE_EXPIRED UserProductCouponUsageDetailItemState = "EXPIRED" 448 USERPRODUCTCOUPONUSAGEDETAILITEMSTATE_DELETED UserProductCouponUsageDetailItemState = "DELETED" 449 USERPRODUCTCOUPONUSAGEDETAILITEMSTATE_DEACTIVATED UserProductCouponUsageDetailItemState = "DEACTIVATED" 450) 451 452type NormalCouponUsageRule struct { 453 Threshold *int64 `json:"threshold,omitempty"` 454 DiscountAmount *int64 `json:"discount_amount,omitempty"` 455} 456 457type DiscountCouponUsageRule struct { 458 Threshold *int64 `json:"threshold,omitempty"` 459 PercentOff *int64 `json:"percent_off,omitempty"` 460} 461 462type SequentialUsageType string 463 464func (e SequentialUsageType) Ptr() *SequentialUsageType { 465 return &e 466} 467 468const ( 469 SEQUENTIALUSAGETYPE_INCREMENTAL SequentialUsageType = "INCREMENTAL" 470 SEQUENTIALUSAGETYPE_EQUAL SequentialUsageType = "EQUAL" 471) 472 473type ComboPackage struct { 474 Name *string `json:"name,omitempty"` 475 PickCount *int64 `json:"pick_count,omitempty"` 476 ChoiceList []ComboPackageChoice `json:"choice_list,omitempty"` 477} 478 479type SingleCouponAvailablePeriod struct { 480 AvailableBeginTime *string `json:"available_begin_time,omitempty"` 481 AvailableEndTime *string `json:"available_end_time,omitempty"` 482 AvailableDays *int64 `json:"available_days,omitempty"` 483 WaitDaysAfterReceive *int64 `json:"wait_days_after_receive,omitempty"` 484 WeeklyAvailablePeriod *FixedWeekPeriod `json:"weekly_available_period,omitempty"` 485 IrregularAvailablePeriodList []TimePeriod `json:"irregular_available_period_list,omitempty"` 486} 487 488type ExchangeCouponUsageRule struct { 489 Threshold *int64 `json:"threshold,omitempty"` 490 ExchangePrice *int64 `json:"exchange_price,omitempty"` 491} 492 493type SequentialCouponAvailablePeriod struct { 494 AvailableBeginTime *string `json:"available_begin_time,omitempty"` 495 AvailableEndTime *string `json:"available_end_time,omitempty"` 496 WaitDaysAfterReceive *int64 `json:"wait_days_after_receive,omitempty"` 497 WeeklyAvailablePeriod *FixedWeekPeriod `json:"weekly_available_period,omitempty"` 498 IrregularAvailablePeriodList []TimePeriod `json:"irregular_available_period_list,omitempty"` 499} 500 501type CouponUsageMethod string 502 503func (e CouponUsageMethod) Ptr() *CouponUsageMethod { 504 return &e 505} 506 507const ( 508 COUPONUSAGEMETHOD_OFFLINE CouponUsageMethod = "OFFLINE" 509 COUPONUSAGEMETHOD_MINI_PROGRAM CouponUsageMethod = "MINI_PROGRAM" 510 COUPONUSAGEMETHOD_APP CouponUsageMethod = "APP" 511 COUPONUSAGEMETHOD_PAYMENT_CODE CouponUsageMethod = "PAYMENT_CODE" 512) 513 514type CouponAvailableStoreInfo struct { 515 Description *string `json:"description,omitempty"` 516 MiniProgramAppid *string `json:"mini_program_appid,omitempty"` 517 MiniProgramPath *string `json:"mini_program_path,omitempty"` 518} 519 520type CouponCodeDisplayMode string 521 522func (e CouponCodeDisplayMode) Ptr() *CouponCodeDisplayMode { 523 return &e 524} 525 526const ( 527 COUPONCODEDISPLAYMODE_INVISIBLE CouponCodeDisplayMode = "INVISIBLE" 528 COUPONCODEDISPLAYMODE_BARCODE CouponCodeDisplayMode = "BARCODE" 529 COUPONCODEDISPLAYMODE_QRCODE CouponCodeDisplayMode = "QRCODE" 530) 531 532type EntranceMiniProgram struct { 533 Appid *string `json:"appid,omitempty"` 534 Path *string `json:"path,omitempty"` 535 EntranceWording *string `json:"entrance_wording,omitempty"` 536 GuidanceWording *string `json:"guidance_wording,omitempty"` 537} 538 539type EntranceOfficialAccount struct { 540 Appid *string `json:"appid,omitempty"` 541} 542 543type EntranceFinder struct { 544 FinderId *string `json:"finder_id,omitempty"` 545 FinderVideoId *string `json:"finder_video_id,omitempty"` 546 FinderVideoCoverImageUrl *string `json:"finder_video_cover_image_url,omitempty"` 547} 548 549type ComboPackageChoice struct { 550 Name *string `json:"name,omitempty"` 551 Price *int64 `json:"price,omitempty"` 552 Count *int64 `json:"count,omitempty"` 553 ImageUrl *string `json:"image_url,omitempty"` 554 MiniProgramAppid *string `json:"mini_program_appid,omitempty"` 555 MiniProgramPath *string `json:"mini_program_path,omitempty"` 556} 557 558type FixedWeekPeriod struct { 559 DayList []WeekEnum `json:"day_list,omitempty"` 560 DayPeriodList []PeriodOfTheDay `json:"day_period_list,omitempty"` 561} 562 563type TimePeriod struct { 564 BeginTime *string `json:"begin_time,omitempty"` 565 EndTime *string `json:"end_time,omitempty"` 566} 567 568type WeekEnum string 569 570func (e WeekEnum) Ptr() *WeekEnum { 571 return &e 572} 573 574const ( 575 WEEKENUM_MONDAY WeekEnum = "MONDAY" 576 WEEKENUM_TUESDAY WeekEnum = "TUESDAY" 577 WEEKENUM_WEDNESDAY WeekEnum = "WEDNESDAY" 578 WEEKENUM_THURSDAY WeekEnum = "THURSDAY" 579 WEEKENUM_FRIDAY WeekEnum = "FRIDAY" 580 WEEKENUM_SATURDAY WeekEnum = "SATURDAY" 581 WEEKENUM_SUNDAY WeekEnum = "SUNDAY" 582) 583 584type PeriodOfTheDay struct { 585 BeginTime *int64 `json:"begin_time,omitempty"` 586 EndTime *int64 `json:"end_time,omitempty"` 587} 588
应答参数
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(128)
【发券请求单号】 发券时传入的请求流水号
send_channel 必填 string
【发券渠道】 描述用户商品券是经由什么渠道发送的
可选取值
BRAND_MANAGE: 摇一摇有优惠,通过摇一摇有优惠渠道发放API: 品牌方自主发券,品牌方通过发券接口自主发券到商家名片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 【失效原因】 当且仅当 |
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 【失效原因】 当且仅当 |
attach 选填 string
【自定义附加信息】 调用发券接口时品牌方使用 attach 字段主动设置的附加信息。微信支付不会解析该信息,仅在查询用户商品券和回调中原样返回。
注: 发券渠道多样,只有品牌方通过发券接口发放以及通过预发券接口预发放并使用领券组件发放的券才会在查询和回调中携带此字段,其他渠道发放的券 attach 为空。
channel_custom_info 选填 string(1000)
【渠道自定义信息】 使用微信支付提供的其他渠道(比如「摇一摇有优惠」)发放商品券时,渠道可能会设置该渠道特定的自定义信息,请根据 send_channel 字段判断如何解析本字段。不同渠道的自定义信息格式不同,请根据对应渠道的文档解析。
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" : "BRAND_MANAGE", 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 }, 100 "stock" : { 101 "product_coupon_id" : "200000001", 102 "stock_id" : "123456789", 103 "remark" : "满减券", 104 "coupon_code_mode" : "UPLOAD", 105 "coupon_code_count_info" : { 106 "total_count" : 10000, 107 "available_count" : 999 108 }, 109 "stock_send_rule" : { 110 "max_count" : 10000000, 111 "max_count_per_day" : 10000, 112 "max_count_per_user" : 1 113 }, 114 "single_usage_rule" : { 115 "coupon_available_period" : { 116 "available_begin_time" : "2025-01-01T00:00:00+08:00", 117 "available_end_time" : "2025-10-01T00:00:00+08:00", 118 "available_days" : 10, 119 "wait_days_after_receive" : 1, 120 "weekly_available_period" : { 121 "day_list" : [ 122 "MONDAY" 123 ], 124 "day_period_list" : [ 125 { 126 "begin_time" : 60, 127 "end_time" : 86399 128 } 129 ] 130 }, 131 "irregular_available_period_list" : [ 132 { 133 "begin_time" : "2025-01-01T00:00:00+08:00", 134 "end_time" : "2025-10-01T00:00:00+08:00" 135 } 136 ] 137 }, 138 "normal_coupon" : { 139 "threshold" : 10000, 140 "discount_amount" : 100 141 }, 142 "discount_coupon" : { 143 "threshold" : 10000, 144 "percent_off" : 30 145 }, 146 "exchange_coupon" : { 147 "threshold" : 10000, 148 "exchange_price" : 100 149 } 150 }, 151 "sequential_usage_rule" : { 152 "coupon_available_period" : { 153 "available_begin_time" : "2025-01-01T00:00:00+08:00", 154 "available_end_time" : "2025-10-01T00:00:00+08:00", 155 "wait_days_after_receive" : 1, 156 "weekly_available_period" : { 157 "day_list" : [ 158 "MONDAY" 159 ], 160 "day_period_list" : [ 161 { 162 "begin_time" : 60, 163 "end_time" : 86399 164 } 165 ] 166 }, 167 "irregular_available_period_list" : [ 168 { 169 "begin_time" : "2025-01-01T00:00:00+08:00", 170 "end_time" : "2025-10-01T00:00:00+08:00" 171 } 172 ] 173 }, 174 "normal_coupon_list" : [ 175 { 176 "threshold" : 10000, 177 "discount_amount" : 100 178 } 179 ], 180 "discount_coupon_list" : [ 181 { 182 "threshold" : 10000, 183 "percent_off" : 30 184 } 185 ], 186 "exchange_coupon_list" : [ 187 { 188 "threshold" : 10000, 189 "exchange_price" : 100 190 } 191 ], 192 "special_first" : false 193 }, 194 "usage_rule_display_info" : { 195 "coupon_usage_method_list" : [ 196 "MINI_PROGRAM" 197 ], 198 "mini_program_appid" : "wx1234567890", 199 "mini_program_path" : "/pages/index/product", 200 "app_path" : "https://www.example.com/jump-to-app", 201 "usage_description" : "全场可用", 202 "coupon_available_store_info" : { 203 "description" : "可在上海市区的所有门店使用,详细列表参考小程序内信息为准", 204 "mini_program_appid" : "wx1234567890", 205 "mini_program_path" : "/pages/index/store-list" 206 } 207 }, 208 "coupon_display_info" : { 209 "code_display_mode" : "QRCODE", 210 "background_color" : "Color010", 211 "entrance_mini_program" : { 212 "appid" : "wx1234567890", 213 "path" : "/pages/index/product", 214 "entrance_wording" : "欢迎选购", 215 "guidance_wording" : "获取更多优惠" 216 }, 217 "entrance_official_account" : { 218 "appid" : "wx1234567890" 219 }, 220 "entrance_finder" : { 221 "finder_id" : "gh_12345678", 222 "finder_video_id" : "UDFsdf24df34dD456Hdf34", 223 "finder_video_cover_image_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx" 224 } 225 }, 226 "notify_config" : { 227 "notify_appid" : "wx4fd12345678" 228 }, 229 "store_scope" : "SPECIFIC", 230 "sent_count_info" : { 231 "total_count" : 100, 232 "today_count" : 10 233 }, 234 "state" : "SENDING", 235 "deactivate_request_no" : "1002600620019090123143254436", 236 "deactivate_time" : "2025-01-01T00:00+08:00", 237 "deactivate_reason" : "批次信息有误,重新创建" 238 }, 239 "attach" : "example_attach", 240 "channel_custom_info" : "example_channel_custom_info", 241 "coupon_tag_info" : { 242 "coupon_tag_list" : [ 243 "MEMBER" 244 ], 245 "member_tag_info" : { 246 "member_card_id" : "MemberCardId_1234567890" 247 } 248 } 249} 250
错误码
以下是本接口返回的错误码列表。详细错误码规则,请参考微信支付接口规则-错误码和错误提示
状态码 | 错误码 | 描述 | 解决方案 |
|---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
400 | INVALID_REQUEST | 单券使用模式的商品券批次,应该在「单券使用规则」中包含对应类型的优惠规则。对于文档中标记不应填写的优惠规则应删除。 | 请在「单券使用规则」中包含对应类型的优惠规则,并删除文档中标记不应填写的优惠规则。 |
400 | INVALID_REQUEST | 多次优惠使用模式的商品券批次,应该在「多次优惠使用规则」中包含对应类型的优惠规则,且数量与多次优惠的优惠次数相等 | 在「多次优惠使用规则」中包含对应类型的优惠规则,且数量与多次优惠的优惠次数相等 |
400 | INVALID_REQUEST | 单品满减券或单品折扣券不应在商品券中设置「满减券使用规则」或「折扣券使用规则」,而是应该在商品券批次中设置 | 请删除商品券中的「满减券使用规则」或「折扣券使用规则」,并在商品券批次中设置对应的优惠规则 |
403 | NO_AUTH | 品牌没有此接口权限 | 品牌没有此接口权限 |
400 | INVALID_REQUEST | 商品券支持APP核销时,必须提供「APP跳转路径」 | 请提供「APP跳转路径」参数 |
400 | PARAM_ERROR | 分页大小超出限制,请根据接口文档调整到允许的范围 | 请调整分页大小到规定范围 |
400 | INVALID_REQUEST | 商品券支持小程序核销时,必须提供「小程序AppID」 | 请提供「小程序AppID」 |
400 | INVALID_REQUEST | 单品券必须提供商品原价,请补充 | 请补充商品原价 |
400 | INVALID_REQUEST | 商品券支持小程序核销时,必须提供「小程序跳转路径」 | 请提供提供「小程序跳转路径」 |
400 | INVALID_REQUEST | 单品券必须提供商品券套餐组合信息,请补充 | 请提供商品券套餐组合信息 |
400 | PARAM_ERROR | 时间字符串格式错误,请使用 RFC3339 标准格式 | 请使用 RFC3339 标准格式 |
400 | INVALID_REQUEST | 单券模式下,全场折扣券应在商品券中提供折扣券使用规则信息 | 请在商品券中提供「折扣券使用规则信息」 |
400 | INVALID_REQUEST | 单券模式下,全场满减券应在商品券中提供满减券使用规则信息 | 请在商品券中提供「满减券使用规则信息」 |
400 | INVALID_REQUEST | 每周固定可用时间(weekly_available_period)中提供当天可用时间段时(day_period_list),每周可用星期数(day_list)必填 | 请补充 每周可用星期数(day_list) |
400 | INVALID_REQUEST | 单券模式下,全场券需要提供「单券模式信息(single_usage_info)」 | 请提供单券模式信息(single_usage_info) |
400 | INVALID_REQUEST | 多次优惠模式下必须提供「多次优惠模式信息(sequential_usage_info)」 | 请填写 多次优惠模式信息(sequential_usage_info) |
400 | INVALID_REQUEST | 传入的OpenID不合法 | 请使用参数 AppID 对应的的OpenID |


