查询代金券详情

更新时间:2024.11.18

通过此接口可查询代金券信息,包括代金券的基础信息、状态。

注意:

  • 该接口支持批次创建商户号与批次发放商户调用

接口频率:不区分来源 1000/s, 单ip 500/s

接口耗时:1S

幂等规则:接口支持幂等重入

接口说明

支持商户:【普通服务商】 【从业机构(银行)】 【从业机构(支付机构)】 【渠道商】 【清算机构】

请求方式:【GET】/v3/marketing/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】微信为代金券或消费金唯一分配的id。发放代金券API返回的数据


openid  必填 string(128)

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


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/favor/users/openid_example/coupons/9856888?appid=appid_example \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" 
5

应答参数

200 OK

stock_creator_mchid  必填 string

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


stock_id  必填 string

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


coupon_id  必填 string

【代金券或消费金id】微信为代金券或消费金唯一分配的id


cut_to_message  选填 object

【单品优惠特定信息】单品优惠特定信息

属性

coupon_name  必填 string

【券或消费金名称】券或消费金名称


status  必填 string

【券或消费金状态】券或消费金状态:
SENDED:可用
USED:已实扣
EXPIRED:已过期


description  必填 string

【使用说明】券或消费金描述说明字段


create_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秒。


coupon_type  必填 string

【券或消费金类型】券或消费金类型:
NORMAL:满减券
CUT_TO:减至券


no_cash  必填 boolean

【是否无资金流】枚举值:
true:是
false:否


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秒。


singleitem  必填 boolean

【是否单品优惠】枚举值:
true:是
false:否


normal_coupon_information  选填 object

【满减券或消费金信息】普通满减券或消费金面额、门槛信息。

属性

out_request_no  选填 string

【商户单据号】商户此次发放凭据号


available_balance  选填 integer

【剩余金额】可用余额,单位:分。
仅有当business_type=MULTIUSE时,才会返回。


business_type  选填 string

【业务类型】细分业务类型,仅当business_type=MULTIUSE时才返回,枚举值:

可选取值:

  • MULTIUSE: 消费金类型

应答示例

200 OK

1{
2  "stock_creator_mchid" : "9800064",
3  "stock_id" : "9865888",
4  "coupon_id" : "98674556",
5  "cut_to_message" : {
6    "single_price_max" : 100,
7    "cut_to_price" : 80
8  },
9  "coupon_name" : "微信支付代金券",
10  "status" : "EXPIRED",
11  "description" : "微信支付营销",
12  "create_time" : "2015-05-20T13:29:35.120+08:00",
13  "coupon_type" : "CUT_TO",
14  "no_cash" : false,
15  "available_begin_time" : "2015-05-20T13:29:35.120+08:00",
16  "available_end_time" : "2015-05-20T13:29:35.120+08:00",
17  "singleitem" : false,
18  "normal_coupon_information" : {
19    "coupon_amount" : 100,
20    "transaction_minimum" : 100
21  },
22  "out_request_no" : "example_out_request_no",
23  "available_balance" : 10000,
24  "business_type" : "MULTIUSE"
25}
26

 

错误码

公共错误码

状态码

错误码

描述

解决方案

400

PARAM_ERROR

参数错误

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

400

INVALID_REQUEST

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

请参阅 接口规则

401

SIGN_ERROR

验证不通过

请参阅 签名常见问题

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后重试

业务错误码

状态码

错误码

描述

解决方案

400

APPID_MCHID_NOT_MATCH

商户号与AppID不匹配

请绑定调用接口的商户号和AppID后重试

400

INVALID_REQUEST

OpenID与AppID不匹配

请使用AppID下的OpenID

400

INVALID_REQUEST

活动已结束或未激活

请检查批次状态

400

INVALID_REQUEST

非法的商户号

请检查商户号是否正确

400

MCH_NOT_EXISTS

商户号不合法

请输入正确的商户号

400

PARAM_ERROR

回调URL不能为空

请填写回调URL

400

PARAM_ERROR

回调商户不能为空

请填写回调商户

400

PARAM_ERROR

券ID必填

请填写券ID

400

PARAM_ERROR

AppID必填

请输入AppID

400

PARAM_ERROR

OpenID必填

请输入OpenID

400

PARAM_ERROR

页大小超过阈值

请不要超过最大的页大小

400

PARAM_ERROR

输入时间格式错误

请输入正确的时间格式

400

PARAM_ERROR

批次号必填

请输入批次号

400

PARAM_ERROR

商户号必填

请输入商户号

400

PARAM_ERROR

非法的批次状态

请检查批次状态

403

NOT_ENOUGH

批次预算不足

请补充预算

403

REQUEST_BLOCKED

调用商户无权限

请开通产品权限后再调用该接口

403

REQUEST_BLOCKED

商户无权发券

调用接口的商户号无权发券,请检查是否是自己的批次或是已授权的批次。

403

REQUEST_BLOCKED

批次不支持跨商户发券

该批次未做跨商户号的授权,请授权后再发放

403

REQUEST_BLOCKED

用户被限领拦截

用户领取已经达到上限,请调高上限或停止发放。

403

USER_ACCOUNT_ABNORMAL

用户非法

该用户账号异常,无法领券。商家可联系微信支付或让用户联系微信支付客服处理。

404

RESOURCE_NOT_EXISTS

批次不存在

请检查批次ID是否正确

429

FREQUENCY_LIMIT_EXCEED

接口限频

请降低调用频率

429

FREQUENCY_LIMITED

请求过于频繁

稍后重试

 

 

反馈
咨询
目录
置顶