申请退券
更新时间:2023.08.16商户可以在退款之后调用退券API,调用了该接口后,券在用户卡包内正常展示,用户可在有效期内正常使用该优惠券。
若券过期状态下退款,可不用调用该退券API。
前置条件:券的状态为USED
# 接口说明
支持商户:
【普通服务商】【渠道商】
请求方式:
【POST】/v3/marketing/busifavor/coupons/return
请求域名:
【主域名】
https://api.mch.weixin.qq.com
使用该域名将访问就近的接入点【备域名】
https://api2.mch.weixin.qq.com
使用该域名将访问异地的接入点 ,指引点击查看
# 请求参数
- Authorization 必填请参考 签名认证 生成认证信息
- Accept 必填请设置为
application/json
- Content-Type 必填请设置为
application/json
Header HTTP头参数
- coupon_code 必填【券code】 券的唯一标识
- stock_id 必填【批次号】 券的所属批次号
- return_request_no 必填【退券请求单据号】 每次退券请求的唯一标识,商户需保证唯一
Body 包体参数
请求示例
POST
# 应答参数
- wechatpay_return_time 必填【系统退券成功的时间】 微信退券成功的时间,遵循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秒。
200OK
应答示例
200 OK
# 错误码
# 公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
# 业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | RESOURCE_ALREADY_EXISTS | 已使用过此单号退券 | 请更换单号重试 |
403 | NOAUTH | 商户无权限操作该券 | 请确认调用API商户号 |
403 | RULELIMIT | 券当前是可用的 | 请查询券详情确认券当前状态 |
403 | RULELIMIT | 券已不在使用有效期 | 券已不在使用有效期,不可退 |
404 | RESOURCE_NOT_EXISTS | 券不存在 | 请检查券code |
404 | RESOURCE_NOT_EXISTS | 券已被删除 | 请查询券详情确认券当前状态 |
文档是否有帮助