當(dāng)交易發(fā)生之后一段時(shí)間內(nèi),由于買家或者賣家的原因需要退款時(shí),賣家可以通過退款接口將支付款退還給買家,微信支付將在收到退款請求并且驗(yàn)證成功之后,按照退款規(guī)則將支付款按原路退到買家?guī)ぬ柹稀?/p>
注意:
- 交易時(shí)間超過一年的訂單無法提交退款(按支付成功時(shí)間+365天計(jì)算)
- 微信支付退款支持單筆交易分多次退款,多次退款需要提交原支付訂單的商戶訂單號和設(shè)置不同的退款單號。申請退款總金額不能超過訂單金額。 一筆退款失敗后重新提交,請不要更換退款單號,請使用原商戶退款單號
- 請求頻率限制:150qps,即每秒鐘正常的申請退款請求次數(shù)不超過150次
- 每個(gè)支付訂單的部分退款次數(shù)不能超過50次
- 如果同一個(gè)用戶有多筆退款,建議分不同批次進(jìn)行退款,避免并發(fā)退款導(dǎo)致退款失敗
- 申請退款接口的返回僅代表業(yè)務(wù)的受理情況,具體退款是否成功,需要通過退款查詢接口獲取結(jié)果
- 錯(cuò)誤或無效請求頻率限制:6qps,即每秒鐘異常或錯(cuò)誤的退款申請請求不超過6次
- 一個(gè)月之前的訂單申請退款頻率限制為:5000/min
- 同一筆訂單多次退款的請求需相隔1分鐘
# 接口說明
支持商戶:
【普通服務(wù)商】
請求方式:
【POST】/v3/refund/domestic/refunds
請求域名:
【主域名】
https://api.mch.weixin.qq.com
使用該域名將訪問就近的接入點(diǎn)【備域名】
https://api2.mch.weixin.qq.com
使用該域名將訪問異地的接入點(diǎn) ,指引點(diǎn)擊查看
# 請求參數(shù)
- Authorization 必填 string請參考 簽名認(rèn)證 生成認(rèn)證信息
- Accept 必填 string請?jiān)O(shè)置為
application/json
- Content-Type 必填 string請?jiān)O(shè)置為
application/json
Header HTTP頭參數(shù)
- sub_mchid 選填 string(32)【子商戶號】 子商戶的商戶號,由微信支付生成并下發(fā)。服務(wù)商模式下必須傳遞此參數(shù)
- transaction_id 選填 string(32)【微信支付訂單號】 原支付交易對應(yīng)的微信訂單號,與out_trade_no二選一
- out_trade_no 選填 string(32)【商戶訂單號】 原支付交易對應(yīng)的商戶訂單號,與transaction_id二選一
- out_refund_no 必填 string(64)【商戶退款單號】 商戶系統(tǒng)內(nèi)部的退款單號,商戶系統(tǒng)內(nèi)部唯一,只能是數(shù)字、大小寫字母_-|*@ ,同一退款單號多次請求只退一筆。
- reason 選填 string(80)【退款原因】 若商戶傳入,會(huì)在下發(fā)給用戶的退款消息中體現(xiàn)退款原因
- notify_url 選填 string(256)【退款結(jié)果回調(diào)url】 異步接收微信支付退款結(jié)果通知的回調(diào)地址,通知url必須為外網(wǎng)可訪問的url,不能攜帶參數(shù)。 如果參數(shù)中傳了notify_url,則商戶平臺(tái)上配置的回調(diào)地址將不會(huì)生效,優(yōu)先回調(diào)當(dāng)前傳的這個(gè)地址。
- funds_account 選填 string【退款資金來源】 若傳遞此參數(shù)則使用對應(yīng)的資金賬戶退款,否則默認(rèn)使用未結(jié)算資金退款(僅對老資金流商戶適用)
可選取值:AVAILABLE
: 僅對老資金流商戶適用,指定從可用余額賬戶出資
- amount 必填 AmountReq【金額信息】 訂單金額信息
- 屬性
- goods_detail 選填 array[GoodsDetail]【退款商品】 指定商品退款需要傳此參數(shù),其他場景無需傳遞
- 屬性
Body 包體參數(shù)
請求示例
POST
# 應(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)【退款入賬賬戶】 取當(dāng)前退款單的退款入賬方,有以下幾種情況:
1)退回銀行卡:{銀行名稱}{卡類型}{卡尾號}
2)退回支付用戶零錢:支付用戶零錢
3)退還商戶:商戶基本賬戶商戶結(jié)算銀行賬戶
4)退回支付用戶零錢通:支付用戶零錢通
5)退回支付用戶銀行電子賬戶:支付用戶銀行電子賬戶
6)退回支付用戶零花錢:支付用戶零花錢
7)退回用戶經(jīng)營賬戶:用戶經(jīng)營賬戶
8)退回支付用戶來華零錢包:支付用戶來華零錢包
9)退回企業(yè)支付商戶:企業(yè)支付商戶 - 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元素的開頭,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元素的開頭,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【退款狀態(tài)】 退款到銀行發(fā)現(xiàn)用戶的卡作廢或者凍結(jié)了,導(dǎo)致原路退款銀行卡失敗,可前往商戶平臺(tái)(www.tg885.com)-交易中心,手動(dòng)處理此筆退款。
可選取值:SUCCESS
: 退款成功CLOSED
: 退款關(guān)閉PROCESSING
: 退款處理中ABNORMAL
: 退款異常
- funds_account 選填 string【資金賬戶】 退款所使用資金對應(yīng)的資金賬戶類型
可選取值:UNSETTLED
: 未結(jié)算資金AVAILABLE
: 可用余額UNAVAILABLE
: 不可用余額OPERATION
: 運(yùn)營戶BASIC
: 基本賬戶(含可用余額和不可用余額)ECNY_BASIC
: 數(shù)字人民幣基本賬戶
- amount 必填 Amount【金額信息】 金額詳細(xì)信息
- 屬性
- promotion_detail 選填 array[Promotion]【優(yōu)惠退款信息】 優(yōu)惠退款信息
- 屬性
200OK
應(yīng)答示例
200 OK
# 錯(cuò)誤碼
# 公共錯(cuò)誤碼
狀態(tài)碼 | 錯(cuò)誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | PARAM_ERROR | 參數(shù)錯(cuò)誤 | 請根據(jù)錯(cuò)誤提示正確傳入?yún)?shù) |
400 | INVALID_REQUEST | HTTP 請求不符合微信支付 APIv3 接口規(guī)則 | 請參閱 接口規(guī)則 |
401 | SIGN_ERROR | 驗(yàn)證不通過 | 請參閱 簽名常見問題 |
500 | SYSTEM_ERROR | 系統(tǒng)異常,請稍后重試 | 請稍后重試 |
# 業(yè)務(wù)錯(cuò)誤碼
狀態(tài)碼 | 錯(cuò)誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | INVALID_REQUEST | 請求參數(shù)符合參數(shù)格式,但不符合業(yè)務(wù)規(guī)則 | 此狀態(tài)代表退款申請失敗,商戶可根據(jù)具體的錯(cuò)誤提示做相應(yīng)的處理。 |
401 | SIGN_ERROR | 簽名錯(cuò)誤 | 請檢查簽名參數(shù)和方法是否都符合簽名算法要求 |
403 | NO_AUTH | 沒有退款權(quán)限 | 此狀態(tài)代表退款申請失敗,請檢查是否有該筆訂單的退款權(quán)限 |
403 | NOT_ENOUGH | 余額不足 | 此狀態(tài)代表退款申請失敗,商戶可根據(jù)具體的錯(cuò)誤提示做相應(yīng)的處理。 |
403 | USER_ACCOUNT_ABNORMAL | 退款請求失敗 | 此狀態(tài)代表退款申請失敗,商戶可自行處理退款。 |
404 | MCH_NOT_EXISTS | MCHID不存在 | 請檢查MCHID是否正確 |
404 | RESOURCE_NOT_EXISTS | 訂單號不存在 | 請檢查你的訂單號是否正確且是否已支付,未支付的訂單不能發(fā)起退款 |
429 | FREQUENCY_LIMITED | 頻率限制 | 該筆退款未受理,請降低頻率后重試 |
500 | SYSTEM_ERROR | 系統(tǒng)超時(shí) | 請不要更換商戶退款單號,請使用相同參數(shù)再次調(diào)用API。 |