查询绑定多笔立减活动的代金券详情

更新时间:2025.05.13

通过此接口可查询绑定多笔立减活动的代金券信息,包括代金券的基础信息、状态等。

接口说明

支持商户:【普通商户】

请求方式:【GET】/v3/marketing/bank-favor/users/{openid}/coupons/{coupon_id}

请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点

     【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看

请求参数

Header HTTP头参数

Authorization  必填 string

请参考签名认证生成认证信息


Accept  必填 string

请设置为application/json


path 路径参数

coupon_id  必填 string(20)

【代金券ID】 优惠券的主键,唯一定义此资源的标识


openid  必填 string(128)

【用户标识ID】 用户标识ID是微信用户在公众账号ID下的唯一用户标识(公众账号ID不同,则获取到的用户标识ID就不同),可用于永久标记一个用户。获取用户标识ID的方式


query 查询参数

appid  必填 string(128)

【公众账号ID】 微信为调用商户分配的公众账号ID,接口传入的appid应该为公众号的appid和小程序的appid(在微信公众平台申请)或APP的appid(在微信开发平台申请)。校验规则:1、该appid需要与接口传入中的openid有对应关系;2、该appid需要与调用接口的商户号(即请求头中的商户号)有绑定关系,若未绑定,可参考该指引完成绑定 (商家商户号与AppID账号关联管理

请求示例

GET

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/marketing/bank-favor/users/oUpF8uMuAJO_M2pxb1Q9zNjWeS6o/coupons/9856888?appid=wx57849631bb367f52 \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" 
5

应答参数

200 OK

stock_creator_mchid  必填 string

【创建批次的商户号】 微信为创建方商户分配的商户号


stock_id  必填 string

【批次ID】 微信为每个代金券批次分配的唯一ID。


coupon_id  必填 string

【代金券ID】 微信为代金券唯一分配的ID


coupon_name  必填 string

【券名称】 券名称


coupon_state  必填 string

【券状态】 券状态

可选取值

  • COUPON_STATE_UNKNOW: 未知状态

  • COUPON_STATE_SEND: 可用

  • COUPON_STATE_USED: 已实扣

  • COUPON_STATE_EXPIRED: 已过期


receive_time  必填 string

【领券时间】 领券时间,遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。


available_begin_time  必填 string

【可用开始时间】 可用开始时间,遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。


available_end_time  必填 string

【可用结束时间】 可用结束时间,遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。


activity_id  必填 string

【活动ID】 多笔立减活动ID


max_use_number  必填 integer

【最大使用次数】 券的最大使用次数


available_number  必填 integer

【可用次数】 券的剩余可用次数


used_number  必填 integer

【已使用次数】 券的已使用次数


use_amount_list  选填 object

【已用金额列表】 券的已使用金额列表,列表中的元素代表该次使用的金额

属性

openid  选填 string

【用户标识ID】 用户标识ID是微信用户在公众账号ID下的唯一用户标识(公众账号ID不同,则获取到的用户标识ID就不同),可用于永久标记一个用户。获取用户标识ID的方式

应答示例

200 OK

1{
2  "stock_creator_mchid" : "9800064",
3  "stock_id" : "9865888",
4  "coupon_id" : "98674556",
5  "coupon_name" : "微信支付代金券",
6  "coupon_state" : "COUPON_STATE_UNKNOW",
7  "receive_time" : "2015-05-20T13:29:35.120+08:00",
8  "available_begin_time" : "2015-05-20T13:29:35.120+08:00",
9  "available_end_time" : "2015-05-20T13:29:35.120+08:00",
10  "activity_id" : "186745560",
11  "max_use_number" : 5,
12  "available_number" : 3,
13  "used_number" : 2,
14  "use_amount_list" : {
15    "used_amounts" : [
16      "200"
17    ]
18  },
19  "openid" : "oUpF8uMuAJO_M2pxb1Q9zNjWeS6o"
20}
21

 

错误码

公共错误码

状态码

错误码

描述

解决方案

400

PARAM_ERROR

参数错误

请根据错误提示正确传入参数

400

INVALID_REQUEST

HTTP 请求不符合微信支付 APIv3 接口规则

请参阅 接口规则

401

SIGN_ERROR

验证不通过

请参阅 签名常见问题

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后重试

业务错误码

状态码

错误码

描述

解决方案

400

PARAM_ERROR

券ID必填

请填写券ID

400

INVALID_REQUEST

非法的券ID

清检查券ID的准确性

400

INVALID_REQUEST

查询的商户非创建方商户

请检查商户号准确性

400

PARAM_ERROR

OpenID必填

请输入OpenID

400

PARAM_ERROR

AppID必填

请输入AppID

400

INVALID_REQUEST

OpenID与AppID不匹配

OpenID与AppID需有对应关系

400

APPID_MCHID_NOT_MATCH

商户号与AppID不匹配

调用接口的商户号需与接口传入的AppID有绑定关系

429

FREQUENCY_LIMIT_EXCEED

接口限频

请降低调用频率

 

反馈
咨询
目录
置顶