當(dāng)交易發(fā)生之后一年內(nèi)(按支付成功時(shí)間+365天計(jì)算),由于用戶或者商戶原因需要退款時(shí),商戶可以通過申請(qǐng)退款接口將支付款退全額或部分還給用戶。
注意:
1.一筆訂單最多部分退款50次(多次部分退款需更換商戶退款單號(hào),間隔1分鐘再調(diào)用)。
2.申請(qǐng)退款失敗重試時(shí)請(qǐng)使用原商戶退款單號(hào),避免重復(fù)退款造成資損。
3.商戶號(hào)維度調(diào)用成功頻率限制150qps,錯(cuò)誤或無效請(qǐng)求頻率限制6qps。
4.申請(qǐng)退款接口返回成功僅代表退款單受理成功,具體退款結(jié)果以退款結(jié)果通知和查單退款返回為準(zhǔn)。
5.一個(gè)月之前的訂單申請(qǐng)退款如果返回報(bào)錯(cuò)"頻率限制,1個(gè)月之前的訂單請(qǐng)降低申請(qǐng)頻率再重試",原參重試即可。
# 接口說明
支持商戶:
【普通商戶】
請(qǐng)求方式:
【POST】/v3/refund/domestic/refunds
請(qǐng)求域名:
【主域名】
https://api.mch.weixin.qq.com
使用該域名將訪問就近的接入點(diǎn)【備域名】
https://api2.mch.weixin.qq.com
使用該域名將訪問異地的接入點(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
- Content-Type 必填 string請(qǐng)?jiān)O(shè)置為
application/json
Header HTTP頭參數(shù)
- transaction_id 選填 string(32)【微信交易訂單號(hào)】 微信支付分扣款單的唯一標(biāo)識(shí),非0元結(jié)單且支付分渠道扣款成功后支付成功回調(diào)和查詢支付分訂單返回的收款信息明細(xì)collection.details中包含該字段。transaction_id和out_trade_no二選一填寫,建議商戶都通過transaction_id申請(qǐng)退款。
- out_trade_no 選填 string(32)【商戶訂單號(hào)】 支付分輪詢扣款時(shí)生成的商戶訂單號(hào),只能通過使用transaction_id調(diào)用基礎(chǔ)支付查單接口獲取。 transaction_id和out_trade_no二選一填寫,建議商戶都通過transaction_id申請(qǐng)退款。
- out_refund_no 必填 string(64)【商戶退款單號(hào)】 商戶系統(tǒng)內(nèi)部的退款單號(hào),商戶系統(tǒng)內(nèi)部唯一,只能是數(shù)字、大小寫字母_-|*@ ,同一退款單號(hào)多次請(qǐng)求只退一筆。
- reason 選填 string(80)【退款原因】 若商戶傳入了退款原因,該字段將顯示在用戶接收到的退款消息通知中。 注意:若訂單部分退款且退款金額≤1元,則不會(huì)在退款消息中體現(xiàn)退款原因。
- notify_url 選填 string(256)【退款結(jié)果回調(diào)url】 商戶異步接收退款結(jié)果通知的回調(diào)地址,通知url必須為外網(wǎng)可訪問的url,不能攜帶參數(shù),如果申請(qǐng)退款參數(shù)中傳了notify_url,則商戶平臺(tái)上配置的退款回調(diào)地址將不會(huì)生效,優(yōu)先回調(diào)當(dāng)前傳的這個(gè)地址。需按照notify-url填寫注意事項(xiàng)
規(guī)范填寫。 - funds_account 選填 string【退款資金來源】 若傳遞此參數(shù)則使用對(duì)應(yīng)的資金賬戶退款,否則默認(rèn)使用未結(jié)算資金退款(僅對(duì)老資金流商戶適用)
可選取值:AVAILABLE
: 僅對(duì)老資金流商戶適用,指定從可用余額賬戶出資
- amount 必填 AmountReq【金額信息】 訂單金額信息
- 屬性
- goods_detail 選填 array[GoodsDetail]【退款商品】 指定商品退款需要傳此參數(shù),其他場(chǎng)景無需傳遞
- 屬性
Body 包體參數(shù)
請(qǐng)求示例
POST
# 應(yīng)答參數(shù)
- refund_id 必填 string(32)【微信支付退款號(hào)】 微信側(cè)返回的退款單唯一標(biāo)識(shí),由數(shù)字組成,50或52開頭。
- out_refund_no 必填 string(64)【商戶退款單號(hào)】 商戶系統(tǒng)內(nèi)部的退款單號(hào),商戶系統(tǒng)內(nèi)部唯一,只能是數(shù)字、大小寫字母_-|*@ ,同一退款單號(hào)多次請(qǐng)求只退一筆。
- transaction_id 必填 string(32)【微信支付訂單號(hào)】 微信支付分扣款單的唯一標(biāo)識(shí),非0元結(jié)單且支付分渠道扣款成功后支付成功回調(diào)和查詢支付分訂單返回的收款信息明細(xì)collection.details中包含該字段。
- out_trade_no 必填 string(32)【商戶訂單號(hào)】 支付分輪詢扣款時(shí)生成的商戶訂單號(hào)。
- channel 必填 string【退款渠道】 本單資金實(shí)際的退款渠道。
可選取值:ORIGINAL
: 原路退款BALANCE
: 退回到余額OTHER_BALANCE
: 原賬戶異常退到其他余額賬戶OTHER_BANKCARD
: 原銀行卡異常退到其他銀行卡
- user_received_account 必填 string(64)【退款入賬賬戶】
退款單入賬方。
取值有以下幾種情況
退回銀行卡:{銀行名稱}{卡類型}{卡尾號(hào)}
退回支付用戶零錢:支付用戶零錢
退還商戶:商戶基本賬戶商戶結(jié)算銀行賬戶
退回支付用戶零錢通:支付用戶零錢通
退回支付用戶銀行電子賬戶:支付用戶銀行電子賬戶
退回支付用戶零花錢:支付用戶零花錢
退回用戶經(jīng)營賬戶:用戶經(jīng)營賬戶
退回支付用戶來華零錢包:支付用戶來華零錢包
退回企業(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)】 退款單狀態(tài)。
可選取值:SUCCESS
: 退款成功CLOSED
: 退款關(guān)閉PROCESSING
: 退款處理中ABNORMAL
: 退款異常,需商戶平臺(tái)手動(dòng)處理,參考交易退款方法介紹。
- funds_account 選填 string【資金賬戶】 退款所使用資金對(duì)應(yīng)的資金賬戶類型
可選取值:UNSETTLED
: 未結(jié)算資金AVAILABLE
: 可用余額UNAVAILABLE
: 不可用余額OPERATION
: 運(yùn)營戶BASIC
: 基本賬戶(含可用余額和不可用余額)ECNY_BASIC
: 數(shù)字人民幣基本賬戶
- amount 必填 Amount【金額信息】 金額詳細(xì)信息
- 屬性
- promotion_detail 選填 array[Promotion]【優(yōu)惠退款信息】 代金券信息,當(dāng)訂單支付時(shí),有使用代金券時(shí),該字段將返回所使用的代金券信息。
- 屬性
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)證不通過 | 請(qǐng)參閱 簽名常見問題 |
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)失敗,商戶可根據(jù)具體的錯(cuò)誤提示做相應(yīng)的處理。 |
401 | SIGN_ERROR | 簽名錯(cuò)誤 | 請(qǐng)檢查簽名參數(shù)和方法是否都符合簽名算法要求 |
403 | NO_AUTH | 沒有退款權(quán)限 | 此狀態(tài)代表退款申請(qǐng)失敗,請(qǐng)檢查是否有該筆訂單的退款權(quán)限 |
403 | NOT_ENOUGH | 余額不足 | 此狀態(tài)代表退款申請(qǐng)失敗,商戶可根據(jù)具體的錯(cuò)誤提示做相應(yīng)的處理。 |
403 | USER_ACCOUNT_ABNORMAL | 退款請(qǐng)求失敗 | 此狀態(tài)代表退款申請(qǐng)失敗,商戶可自行處理退款。 |
404 | MCH_NOT_EXISTS | MCHID不存在 | 請(qǐng)檢查MCHID是否正確 |
404 | RESOURCE_NOT_EXISTS | 訂單號(hào)不存在 | 請(qǐng)檢查你的訂單號(hào)是否正確且是否已支付,未支付的訂單不能發(fā)起退款 |
429 | FREQUENCY_LIMITED | 頻率限制 | 該筆退款未受理,請(qǐng)降低頻率后重試 |
500 | SYSTEM_ERROR | 系統(tǒng)超時(shí) | 請(qǐng)不要更換商戶退款單號(hào),請(qǐng)使用相同參數(shù)再次調(diào)用API。 |