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


