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


