最新更新时间:2020.11.04 版本说明
商户可以在退款之后调用退券api,调用了该接口后,券在用户卡包内正常展示,用户可在有效期内正常使用该优惠券。
若券过期状态下退款,可不用调用该退券api。
适用对象: 直连商户
请求URL:https://api.mch.weixin.qq.com/v3/marketing/busifavor/coupons/return
请求方式:POST
前置条件:券的状态为USED
path 指该参数为路径参数
query 指该参数为URL参数
body 指该参数需在请求JSON传参
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
券code | coupon_code | string[1,32] | 是 | body券的唯一标识 示例值:sxxe34343434 |
批次号 | stock_id | string[1,20] | 是 | body券的所属批次号 示例值:1234567891 |
退券请求单据号 | return_request_no | string[1, 128] | 是 | body每次退券请求的唯一标识,商户需保证唯一 示例值:1002600620019090123143254436 |
{
"coupon_code": "sxxe34343434",
"stock_id": "1234567891",
"return_request_no": "1002600620019090123143254436"
}
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
微信退券成功的时间 | wechatpay_return_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秒。 示例值:2020-05-20T13:29:35+08:00 |
{
"wechatpay_return_time": "2020-05-20T13:29:35.120+08:00"
}
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
404 | RESOURCE_NOT_EXISTS | 券不存在 | 请检查券code |
403 | NOAUTH | 商户无权限操作该券 | 请确认调用API商户号 |
404 | RESOURCE_NOT_EXISTS | 券已被删除 | 请查询券详情确认券当前状态 |
403 | RULELIMIT | 券当前是可用的 | 请查询券详情确认券当前状态 |
400 | RESOURCE_ALREADY_EXISTS | 已使用过此单号退券 | 请更换单号重试 |
403 | RULELIMIT | 券已不在使用有效期 | 券已不在使用有效期,不可退 |