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