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


