适用对象：直连商户
接口频率：不区分来源 1000/s， 单ip 500/s
接口耗时：1S
幂等规则：接口支持幂等重入
请求URL：https://api.mch.weixin.qq.com/v3/marketing/favor/users/{openid}/coupons/{coupon_id}
请求方式：GET
path指该参数为路径参数
query 指该参数需在请求URL传参
body 指该参数需在请求JSON传参
| 参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 代金券id | coupon_id | string[1,20] | 是 | path 微信为代金券唯一分配的id。 发放代金券API返回的数据 示例值：9856888 |
| 公众账号ID | appid | string[1,128] | 是 | query微信为调用商户分配的公众账号ID，接口传入的appid应该为公众号的appid和小程序的appid（在微信公众平台申请）或APP的appid（在微信开发平台申请）。 校验规则： 1、该appid需要与接口传入中的openid有对应关系； 2、该appid需要与调用接口的商户号（即请求头中的商户号）有绑定关系，若未绑定，可参考该指引完成绑定 （商家商户号与AppID账号关联管理） 示例值：wx233544546545989 |
| 用户openid | openid | string[1,128] | 是 | pathopenid是微信用户在appid下的唯一用户标识（appid不同，则获取到的openid就不同），可用于永久标记一个用户。 获取openid的方式 示例值：2323dfsdf342342 |
https://api.mch.weixin.qq.com/v3/marketing/favor/users/2323dfsdf342342/coupons/985688?appid=wx233544546545989
| 参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 创建批次的商户号 | stock_creator_mchid | string[1,20] | 是 | 批次创建方商户号 示例值：9800064 |
| 批次号 | stock_id | string[1,20] | 是 | 微信为每个代金券批次分配的唯一id。 示例值：9865888 |
| 代金券id | coupon_id | string[1,20] | 是 | 微信为代金券唯一分配的id。 示例值：98674556 |
| + 单品优惠特定信息 | cut_to_message | object |
否 | 单品优惠特定信息。 |
| 代金券名称 | coupon_name | string[1,20] | 是 | 代金券名称 示例值：微信支付代金券 |
| 代金券状态 | status | string[1,16] |
是 | 代金券状态： SENDED：可用 USED：已实扣 EXPIRED：已过期 示例值：EXPIRED |
| 使用说明 | description | string[1,3000] | 是 | 代金券描述说明字段。 示例值：微信支付营销 |
| 领券时间 | create_time | string[1,32] | 是 | 领券时间，遵循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秒。 示例值: 2015-05-20T13:29:35+08:00 |
| 券类型 | coupon_type | string[1,16] |
是 | 券类型： NORMAL：满减券 CUT_TO：减至券 示例值：CUT_TO |
| 是否无资金流 | no_cash | bool | 是 | 枚举值： true：是 false：否 示例值：true |
| 可用开始时间 | available_begin_time | string[1,32] | 是 | 可用开始时间，遵循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秒。 示例值: 2015-05-20T13:29:35+08:00 |
| 可用结束时间 | available_end_time | string[1,32] | 是 | 可用结束时间，遵循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秒。 示例值: 2015-05-20T13:29:35+08:00 |
| 是否单品优惠 | singleitem | bool | 是 | 枚举值： true：是 false：否 示例值：true |
| + 满减券信息 | normal_coupon_information | object |
否 | 普通满减券面额、门槛信息。 |
{
"stock_creator_mchid": "9800064",
"stock_id": "9865888",
"coupon_id": "98674556",
"cut_to_message": {
"single_price_max": 100,
"cut_to_price":100
},
"coupon_name": "微信支付代金券",
"status": "EXPIRED",
"description": "微信支付营销",
"create_time": "2015-05-20T13:29:35+08:00",
"coupon_type": "CUT_TO",
"no_cash": true,
"available_begin_time": "2015-05-20T13:29:35+08:00",
"available_end_time": "2015-05-20T13:29:35+08:00",
"singleitem": true,
"normal_coupon_information": {
"coupon_amount": 100,
"transaction_minimum": 100
}
}
| 状态码 | 错误码 | 描述 | 解决方案 |
|---|---|---|---|
| 400 | PARAM_ERROR | 回调url不能为空 | 请填写回调url |
| PARAM_ERROR | 回调商户不能为空 | 请填写回调商户 | |
| PARAM_ERROR | 券id必填 | 请填写券id | |
| PARAM_ERROR | appid必填 | 请输入appid | |
| PARAM_ERROR | openid必填 | 请输入openid | |
| PARAM_ERROR | 页大小超过阈值 | 请不要超过最大的页大小 | |
| PARAM_ERROR | 输入时间格式错误 | 请输入正确的时间格式 | |
| PARAM_ERROR | 批次号必填 | 请输入批次号 | |
| PARAM_ERROR | 商户号必填 | 请输入商户号 | |
| PARAM_ERROR | 非法的批次状态 | 请检查批次状态 | |
| 400 | MCH_NOT_EXISTS | 商户号不合法 | 请输入正确的商户号 |
| 400 | INVALID_REQUEST | openid与appid不匹配 | 请使用appid下的openid |
| INVALID_REQUEST | 活动已结束或未激活 | 请检查批次状态 | |
| INVALID_REQUEST | 非法的商户号 | 请检查商户号是否正确 | |
| 400 | APPID_MCHID_NOT_MATCH | 商户号与appid不匹配 | 请绑定调用接口的商户号和appid后重试 |
| 403 | USER_ACCOUNT_ABNORMAL | 用户非法 | 该用户账号异常，无法领券。商家可联系微信支付或让用户联系微信支付客服处理。 |
| 403 | NOT_ENOUGH | 批次预算不足 | 请补充预算 |
| 403 | REQUEST_BLOCKED | 调用商户无权限 | 请开通产品权限后再调用该接口 |
| REQUEST_BLOCKED | 商户无权发券 | 调用接口的商户号无权发券，请检查是否是自己的批次或是已授权的批次。 | |
| REQUEST_BLOCKED | 批次不支持跨商户发券 | 该批次未做跨商户号的授权，请授权后再发放 | |
| REQUEST_BLOCKED | 用户被限领拦截 | 用户领取已经达到上限，请调高上限或停止发放。 | |
| 404 | RESOURCE_NOT_EXISTS | 批次不存在 | 请检查批次ID是否正确 |
| 429 | FREQUENCY_LIMIT_EXCEED | 接口限频 | 请降低调用频率 |
| 429 | FREQUENCY_LIMITED | 请求过于频繁 | 稍后重试 |