提交退款申請(qǐng)后,通過(guò)調(diào)用該接口查詢(xún)退款狀態(tài)。
- 退款有一定延時(shí),用零錢(qián)支付的退款20分鐘內(nèi)到賬,銀行卡支付的退款3個(gè)工作日后重新查詢(xún)退款狀態(tài)。
# 接口說(shuō)明
支持商戶(hù):
【普通服務(wù)商】
請(qǐng)求方式:
【GET】/v3/ecommerce/refunds/out-refund-no/{out_refund_no}
請(qǐng)求域名:
【主域名】
https://api.mch.weixin.qq.com
使用該域名將訪(fǎng)問(wèn)就近的接入點(diǎn)【備域名】
https://api2.mch.weixin.qq.com
使用該域名將訪(fǎng)問(wèn)異地的接入點(diǎn) ,指引點(diǎn)擊查看
# 請(qǐng)求參數(shù)
- Authorization 必填 string請(qǐng)參考 簽名認(rèn)證 生成認(rèn)證信息
- Accept 必填 string請(qǐng)?jiān)O(shè)置為
application/json
Header HTTP頭參數(shù)
- out_refund_no 必填 string(64)【商戶(hù)退款單號(hào)】 商戶(hù)系統(tǒng)內(nèi)部的退款單號(hào),商戶(hù)系統(tǒng)內(nèi)部唯一,只能是數(shù)字、大小寫(xiě)字母_-|*@ ,同一退款單號(hào)多次請(qǐng)求只退一筆。
Path 路徑參數(shù)
- sub_mchid 必填 string(32)【二級(jí)商戶(hù)號(hào)】 微信支付分配給二級(jí)商戶(hù)的商戶(hù)號(hào)
Query 查詢(xún)參數(shù)
請(qǐng)求示例
GET
# 應(yīng)答參數(shù)
- refund_id 必填 string(32)【微信支付退款訂單號(hào)】 微信支付退款訂單訂單號(hào)
- out_refund_no 必填 string(64)【商戶(hù)退款單號(hào)】 商戶(hù)系統(tǒng)內(nèi)部的退款單號(hào),商戶(hù)系統(tǒng)內(nèi)部唯一,只能是數(shù)字、大小寫(xiě)字母_-|*@ ,同一退款單號(hào)多次請(qǐng)求只退一筆。
- transaction_id 必填 string(32)【微信支付交易訂單號(hào)】 微信支付交易訂單號(hào)
- out_trade_no 必填 string(32)【商戶(hù)原交易訂單號(hào)】 返回的原交易訂單號(hào)
- channel 選填 string(16)【退款渠道】 ORIGINAL—原路退款
BALANCE—退回到余額
OTHER_BALANCE—原賬戶(hù)異常退到其他余額賬戶(hù)
OTHER_BANKCARD—原銀行卡異常退到其他銀行卡 - user_received_account 選填 string(64)【退款入賬賬戶(hù)】 取當(dāng)前退款單的退款入賬方
1)退回銀行卡:
{銀行名稱(chēng)}{卡類(lèi)型}{卡尾號(hào)}
2)退回支付用戶(hù)零錢(qián):
支付用戶(hù)零錢(qián)
3)退還商戶(hù):
商戶(hù)基本賬戶(hù)
商戶(hù)結(jié)算銀行賬戶(hù)
4)退回支付用戶(hù)零錢(qián)通:
支付用戶(hù)零錢(qián)通
5)退回支付用戶(hù)銀行電子賬戶(hù):支付用戶(hù)銀行電子賬戶(hù)
6)退回支付用戶(hù)零花錢(qián):支付用戶(hù)零花錢(qián)
7)退回用戶(hù)經(jīng)營(yíng)賬戶(hù):用戶(hù)經(jīng)營(yíng)賬戶(hù)
8)退回支付用戶(hù)來(lái)華零錢(qián)包:支付用戶(hù)來(lái)華零錢(qián)包
9)退回企業(yè)支付商戶(hù):企業(yè)支付商戶(hù) - success_time 選填 string(64)【退款成功時(shí)間】 退款成功時(shí)間,退款狀態(tài)status為SUCCESS(退款成功)時(shí),返回該字段。遵循rfc3339標(biāo)準(zhǔn)格式,格式為YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出現(xiàn)在字符串中,表示time元素的開(kāi)頭,HH:mm:ss表示時(shí)分秒,TIMEZONE表示時(shí)區(qū)(+08:00表示東八區(qū)時(shí)間,領(lǐng)先UTC 8小時(shí),即北京時(shí)間)。例如:2015-05-20T13:29:35+08:00表示,北京時(shí)間2015年5月20日13點(diǎn)29分35秒。
- create_time 必填 string(64)【退款創(chuàng)建時(shí)間】 退款受理時(shí)間,遵循rfc3339標(biāo)準(zhǔn)格式,格式為YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出現(xiàn)在字符串中,表示time元素的開(kāi)頭,HH:mm:ss表示時(shí)分秒,TIMEZONE表示時(shí)區(qū)(+08:00表示東八區(qū)時(shí)間,領(lǐng)先UTC 8小時(shí),即北京時(shí)間)。例如:2015-05-20T13:29:35+08:00表示,北京時(shí)間2015年5月20日13點(diǎn)29分35秒。
- status 必填 string(16)【退款狀態(tài)】 退款狀態(tài):
SUCCESS—退款成功
CLOSED—退款關(guān)閉。
PROCESSING—退款處理中
ABNORMAL—退款異常,退款到銀行發(fā)現(xiàn)用戶(hù)的卡作廢或者凍結(jié)了,導(dǎo)致原路退款銀行卡失敗,可前往商戶(hù)平臺(tái)(www.tg885.com)-交易中心,手動(dòng)處理此筆退款。 - amount 必填 RefundAmount【退款金額】 退款金額信息
- 屬性
- promotion_detail 選填 array[PromotionDetail]【營(yíng)銷(xiāo)詳情】 優(yōu)惠退款信息
- 屬性
- refund_account 選填 string(32)【退款出資商戶(hù)】 REFUND_SOURCE_PARTNER_ADVANCE : 電商平臺(tái)墊付
REFUND_SOURCE_SUB_MERCHANT : 二級(jí)商戶(hù),默認(rèn)值
注意:申請(qǐng)退款時(shí)可能會(huì)出現(xiàn)暫未扣除退款資金的情況,此時(shí)不返回本字段,需繼續(xù)查單確認(rèn)。 - funds_account 選填 string(32)【資金賬戶(hù)】 UNSETTLED : 未結(jié)算資金
AVAILABLE : 可用余額
UNAVAILABLE : 不可用余額
OPERATION : 運(yùn)營(yíng)戶(hù)
BASIC : 基本賬戶(hù)(含可用余額和不可用余額)
ECNY_BASIC : 數(shù)字人民幣基本賬戶(hù)
200OK
應(yīng)答示例
200 OK
# 錯(cuò)誤碼
# 公共錯(cuò)誤碼
狀態(tài)碼 | 錯(cuò)誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | PARAM_ERROR | 參數(shù)錯(cuò)誤 | 請(qǐng)根據(jù)錯(cuò)誤提示正確傳入?yún)?shù) |
400 | INVALID_REQUEST | HTTP 請(qǐng)求不符合微信支付 APIv3 接口規(guī)則 | 請(qǐng)參閱 接口規(guī)則 |
401 | SIGN_ERROR | 驗(yàn)證不通過(guò) | 請(qǐng)參閱 簽名常見(jiàn)問(wèn)題 |
500 | SYSTEM_ERROR | 系統(tǒng)異常,請(qǐng)稍后重試 | 請(qǐng)稍后重試 |
# 業(yè)務(wù)錯(cuò)誤碼
狀態(tài)碼 | 錯(cuò)誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | INVALID_REQUEST | 請(qǐng)求參數(shù)符合參數(shù)格式,但不符合業(yè)務(wù)規(guī)則 | 此狀態(tài)代表退款申請(qǐng)失敗,商戶(hù)可根據(jù)具體的錯(cuò)誤提示做相應(yīng)的處理 |
400 | MCH_NOT_EXISTS | 商戶(hù)號(hào)不存在 | 請(qǐng)檢查商戶(hù)號(hào)是否正確 |
401 | SIGN_ERROR | 簽名錯(cuò)誤 | 請(qǐng)檢查簽名參數(shù)和方法是否都符合簽名算法要求 |
403 | NO_AUTH | 沒(méi)有退款權(quán)限 | 此狀態(tài)代表退款申請(qǐng)失敗,請(qǐng)檢查是否有退這筆訂單的權(quán)限 |
403 | REQUEST_BLOCKED | 請(qǐng)求受阻 | 此狀態(tài)代表退款申請(qǐng)失敗,商戶(hù)可根據(jù)具體的錯(cuò)誤提示做相應(yīng)的處理 |
404 | RESOURCE_NOT_EXISTS | 訂單不存在 | 請(qǐng)檢查訂單號(hào)是否正確且是否已支付,未支付的訂單不能發(fā)起退款 |
429 | FREQUENCY_LIMITED | 頻率限制 | 該筆退款未受理,請(qǐng)降低頻率后重試 |
500 | SYSTEM_ERROR | 接口返回錯(cuò)誤 | 請(qǐng)不要更換商戶(hù)退款單號(hào),請(qǐng)使用相同參數(shù)再次調(diào)用API |