商戶可以在退款之后調(diào)用退券API,調(diào)用了該接口后,券在用戶卡包內(nèi)正常展示,用戶可在有效期內(nèi)正常使用該優(yōu)惠券。
若券過期狀態(tài)下退款,可不用調(diào)用該退券API。
前置條件:券的狀態(tài)為USED
# 接口說明
支持商戶:
【普通商戶】
請求方式:
【POST】/v3/marketing/busifavor/coupons/return
請求域名:
【主域名】
https://api.mch.weixin.qq.com
使用該域名將訪問就近的接入點【備域名】
https://api2.mch.weixin.qq.com
使用該域名將訪問異地的接入點 ,指引點擊查看
# 請求參數(shù)
- Authorization 必填 string請參考 簽名認證 生成認證信息
- Accept 必填 string請設(shè)置為
application/json
- Content-Type 必填 string請設(shè)置為
application/json
Header HTTP頭參數(shù)
- coupon_code 必填 string【券code】 券的唯一標識
- stock_id 必填 string【批次號】 券的所屬批次號
- return_request_no 必填 string(128)【退券請求單據(jù)號】 每次退券請求的唯一標識,商戶需保證唯一
Body 包體參數(shù)
請求示例
POST
# 應(yīng)答參數(shù)
- wechatpay_return_time 必填 string【系統(tǒng)退券成功的時間】 微信退券成功的時間,遵循rfc3339
標準格式,格式為yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出現(xiàn)在字符串中,表示time元素的開頭,HH:mm:ss表示時分秒,TIMEZONE表示時區(qū)(+08:00表示東八區(qū)時間,領(lǐng)先UTC 8小時,即北京時間)。例如:2015-05-20T13:29:35+08:00表示,北京時間2015年5月20日 13點29分35秒。
200OK
應(yīng)答示例
200 OK
# 錯誤碼
# 公共錯誤碼
狀態(tài)碼 | 錯誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | PARAM_ERROR | 參數(shù)錯誤 | 請根據(jù)錯誤提示正確傳入?yún)?shù) |
400 | INVALID_REQUEST | HTTP 請求不符合微信支付 APIv3 接口規(guī)則 | 請參閱 接口規(guī)則 |
401 | SIGN_ERROR | 驗證不通過 | 請參閱 簽名常見問題 |
500 | SYSTEM_ERROR | 系統(tǒng)異常,請稍后重試 | 請稍后重試 |
# 業(yè)務(wù)錯誤碼
狀態(tài)碼 | 錯誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | RESOURCE_ALREADY_EXISTS | 已使用過此單號退券 | 請更換單號重試 |
403 | NOAUTH | 商戶無權(quán)限操作該券 | 請確認調(diào)用API商戶號 |
403 | RULELIMIT | 券當前是可用的 | 請查詢?nèi)斍榇_認券當前狀態(tài) |
403 | RULELIMIT | 券已不在使用有效期 | 券已不在使用有效期,不可退 |
404 | RESOURCE_NOT_EXISTS | 券不存在 | 請檢查券code |
404 | RESOURCE_NOT_EXISTS | 券已被刪除 | 請查詢?nèi)斍榇_認券當前狀態(tài) |