提交退款申請后,通過調(diào)用該接口查詢退款狀態(tài)。退款有一定延時,建議查詢退款狀態(tài)在提交退款申請后1分鐘發(fā)起,一般來說零錢支付的退款5分鐘內(nèi)到賬,銀行卡支付的退款1-3個工作日到賬。
# 接口說明
支持商戶:
【普通服務(wù)商】
請求方式:
【GET】/v3/refund/domestic/refunds/{out_refund_no}
請求域名:
【主域名】
https://api.mch.weixin.qq.com
使用該域名將訪問就近的接入點【備域名】
https://api2.mch.weixin.qq.com
使用該域名將訪問異地的接入點 ,指引點擊查看
# 請求參數(shù)
- Authorization 必填 string請參考 簽名認證 生成認證信息
- Accept 必填 string請設(shè)置為
application/json
Header HTTP頭參數(shù)
- out_refund_no 必填 string(64)【商戶退款單號】 商戶系統(tǒng)內(nèi)部的退款單號,商戶系統(tǒng)內(nèi)部唯一,只能是數(shù)字、大小寫字母_-|*@ ,同一退款單號多次請求只退一筆。
Path 路徑參數(shù)
- sub_mchid 選填 string(32)【子商戶號】 子商戶的商戶號,由微信支付生成并下發(fā)。服務(wù)商模式下必須傳遞此參數(shù)
Query 查詢參數(shù)
請求示例
GET
# 應(yīng)答參數(shù)
- refund_id 必填 string(32)【微信支付退款號】 微信支付退款號
- out_refund_no 必填 string(64)【商戶退款單號】 商戶系統(tǒng)內(nèi)部的退款單號,商戶系統(tǒng)內(nèi)部唯一,只能是數(shù)字、大小寫字母_-|*@ ,同一退款單號多次請求只退一筆。
- transaction_id 必填 string(32)【微信支付訂單號】 微信支付交易訂單號
- out_trade_no 必填 string(32)【商戶訂單號】 原支付交易對應(yīng)的商戶訂單號
- channel 必填 string【退款渠道】 退款渠道
可選取值:ORIGINAL
: 原路退款BALANCE
: 退回到余額OTHER_BALANCE
: 原賬戶異常退到其他余額賬戶OTHER_BANKCARD
: 原銀行卡異常退到其他銀行卡
- user_received_account 必填 string(64)【退款入賬賬戶】 取當前退款單的退款入賬方,有以下幾種情況:
1)退回銀行卡:{銀行名稱}{卡類型}{卡尾號}
2)退回支付用戶零錢:支付用戶零錢
3)退還商戶:商戶基本賬戶商戶結(jié)算銀行賬戶
4)退回支付用戶零錢通:支付用戶零錢通
5)退回支付用戶銀行電子賬戶:支付用戶銀行電子賬戶
6)退回支付用戶零花錢:支付用戶零花錢
7)退回用戶經(jīng)營賬戶:用戶經(jīng)營賬戶
8)退回支付用戶來華零錢包:支付用戶來華零錢包
9)退回企業(yè)支付商戶:企業(yè)支付商戶 - success_time 選填 string(64)【退款成功時間】 退款成功時間,退款狀態(tài)status為SUCCESS(退款成功)時,返回該字段。遵循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秒。
- create_time 必填 string(64)【退款創(chuà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秒。
- status 必填 string【退款狀態(tài)】 退款到銀行發(fā)現(xiàn)用戶的卡作廢或者凍結(jié)了,導致原路退款銀行卡失敗,可前往商戶平臺(www.tg885.com)-交易中心,手動處理此筆退款。
可選取值:SUCCESS
: 退款成功CLOSED
: 退款關(guān)閉PROCESSING
: 退款處理中ABNORMAL
: 退款異常
- funds_account 選填 string【資金賬戶】 退款所使用資金對應(yīng)的資金賬戶類型
可選取值:UNSETTLED
: 未結(jié)算資金AVAILABLE
: 可用余額UNAVAILABLE
: 不可用余額OPERATION
: 運營戶BASIC
: 基本賬戶(含可用余額和不可用余額)ECNY_BASIC
: 數(shù)字人民幣基本賬戶
- amount 必填 Amount【金額信息】 金額詳細信息
- 屬性
- promotion_detail 選填 array[Promotion]【優(yōu)惠退款信息】 優(yōu)惠退款信息
- 屬性
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)碼 | 錯誤碼 | 描述 | 解決方案 |
---|---|---|---|
401 | SIGN_ERROR | 簽名錯誤 | 請檢查簽名參數(shù)和方法是否都符合簽名算法要求 |
404 | MCH_NOT_EXISTS | MCHID不存在 | 請檢查MCHID是否正確 |
404 | RESOURCE_NOT_EXISTS | 退款單查詢失敗 | 請檢查退款單號是否有誤以及訂單狀態(tài)是否正確,如:未支付、已支付未退款 |
500 | SYSTEM_ERROR | 系統(tǒng)超時 | 請不要更換商戶退款單號,請使用相同參數(shù)再次調(diào)用API。 |