最新更新時(shí)間:2019.09.11 版本說(shuō)明
訂單已經(jīng)分賬,在退款時(shí),可以先調(diào)此接口,將已分賬的資金從分賬接收方的賬戶回退給分賬方,再發(fā)起退款。
? 分賬回退以原分賬單為依據(jù),支持多次回退,申請(qǐng)回退總金額不能超過(guò)原分賬單分給該接收方的金額。
? 此接口采用同步處理模式,即在接收到商戶請(qǐng)求后,會(huì)實(shí)時(shí)返回處理結(jié)果。
? 商戶類型的接收方,自動(dòng)開通了分賬回退,可以直接調(diào)接口回退。
? 分賬訂單的退款與分賬回退并無(wú)強(qiáng)耦合。是否需要分賬回退,可由平臺(tái)決定。在二級(jí)商戶余額充足的情況下,可以不發(fā)起回退,直接發(fā)起退款。
? 對(duì)同一筆分賬單最多能發(fā)起20次分賬回退請(qǐng)求。
適用對(duì)象:電商平臺(tái)
請(qǐng)求URL:https://api.mch.weixin.qq.com/v3/ecommerce/profitsharing/returnorders
請(qǐng)求方式:POST
接口規(guī)則:http://www.tg885.com/wiki/doc/apiv3/wechatpay/wechatpay-1.shtml
path指該參數(shù)為路徑參數(shù)
query指該參數(shù)需在請(qǐng)求URL傳參
body指該參數(shù)需在請(qǐng)求JSON傳參
參數(shù)名 | 變量 | 類型[長(zhǎng)度限制] | 必填 | 描述 |
---|---|---|---|---|
二級(jí)商戶號(hào) | sub_mchid | string[1,32] | 是 | body 分賬出資的電商平臺(tái)二級(jí)商戶,填寫微信支付分配的商戶號(hào)。 示例值:1900000109 |
微信分賬單號(hào) | order_id | string[1,64] | 二選一 | body 微信分賬單號(hào),微信支付系統(tǒng)返回的唯一標(biāo)識(shí)。微信分賬單號(hào)和商戶分賬單號(hào)二選一填寫。 示例值:3008450740201411110007820472 |
商戶分賬單號(hào) | out_order_no | string[1,64] | body 商戶系統(tǒng)內(nèi)部的分賬單號(hào),在商戶系統(tǒng)內(nèi)部唯一(單次分賬、多次分賬、完結(jié)分賬應(yīng)使用不同的商戶分賬單號(hào)),同一分賬單號(hào)多次請(qǐng)求等同一次。
示例值:P20150806125346 |
|
商戶回退單號(hào) | out_return_no | string[1,64] | 是 | body 此回退單號(hào)是商戶在自己后臺(tái)生成的一個(gè)新的回退單號(hào),在商戶后臺(tái)唯一。 示例值:R20190516001 |
回退商戶號(hào) | return_mchid | string[1,32] | 是 | body 只能對(duì)原分賬請(qǐng)求中成功分給商戶接收方進(jìn)行回退。 示例值:86693852 |
回退金額 | amount | int | 是 | body 需要從分賬接收方回退的金額,單位為分,只能為整數(shù),不能超過(guò)原始分賬單分出給該接收方的金額。 示例值:10 |
回退描述 | description | string[1,80] | 是 | body 分賬回退的原因描述 示例值:分賬回退 |
{
"sub_mchid": "1900000109",
"order_id": "3008450740201411110007820472",
"out_order_no": "P20150806125346",
"out_return_no": "R20190516001",
"return_mchid": "86693852",
"amount": 10,
"description": "分賬回退"
}
參數(shù)名 | 變量 | 類型[長(zhǎng)度限制] | 必填 | 描述 |
---|---|---|---|---|
二級(jí)商戶號(hào) | sub_mchid | string[1,32] | 是 | 分賬出資的電商平臺(tái)二級(jí)商戶,填寫微信支付分配的商戶號(hào)。 示例值:1900000109 |
微信分賬單號(hào) | order_id | string[1,64] | 是 | 原發(fā)起分賬請(qǐng)求時(shí),微信返回的微信分賬單號(hào),與商戶分賬單號(hào)一一對(duì)應(yīng)。 微信分賬單號(hào)與商戶分賬單號(hào)二選一填寫。 示例值: 3008450740201411110007820472 |
商戶分賬單號(hào) | out_order_no | string[1,64] | 是 | 商戶系統(tǒng)內(nèi)部的分賬單號(hào),在商戶系統(tǒng)內(nèi)部唯一(單次分賬、多次分賬、完結(jié)分賬應(yīng)使用不同的商戶分賬單號(hào)),同一分賬單號(hào)多次請(qǐng)求等同一次。 示例值:P20150806125346 |
商戶回退單號(hào) | out_return_no | string[1,64] | 是 | 此回退單號(hào)是商戶在自己后臺(tái)生成的一個(gè)新的回退單號(hào),在商戶后臺(tái)唯一 只能是數(shù)字、大小寫字母_-*@ ,同一回退單號(hào)多次請(qǐng)求等同一次。 示例值:R20190516001 |
回退商戶號(hào) | return_mchid | string[1,32] | 是 | 只能對(duì)原分賬請(qǐng)求中成功分給商戶接收方進(jìn)行回退。 示例值:86693852 |
回退金額 | amount | int | 是 | 需要從分賬接收方回退的金額,單位為分,只能為整數(shù),不能超過(guò)原始分賬單分出給該接收方的金額。 示例值:10 |
微信回退單號(hào) | return_no | string[1,64] | 是 | 微信分賬回退單號(hào),微信支付系統(tǒng)返回的唯一標(biāo)識(shí)。 示例值: 3008450740201411110007820472 |
回退結(jié)果 | result | string[1,32] | 是 | 如果請(qǐng)求返回為處理中,則商戶可以通過(guò)調(diào)用回退結(jié)果查詢接口獲取請(qǐng)求的最終處理結(jié)果,枚舉值: PROCESSING:處理中 SUCCESS:已成功 FAILED:已失敗 注意:如果返回為處理中,請(qǐng)勿變更商戶回退單號(hào),使用相同的參數(shù)再次發(fā)起分賬回退,否則會(huì)出現(xiàn)資金風(fēng)險(xiǎn) 在處理中狀態(tài)的回退單如果5天沒有成功,會(huì)因?yàn)槌瑫r(shí)被設(shè)置為已失敗 示例值:SUCCESS |
失敗原因 | fail_reason | string[1,32] | 否 | 回退失敗的原因,此字段僅回退結(jié)果為FAIL時(shí)存在,枚舉值: ACCOUNT_ABNORMAL:分賬接收方賬戶異常 TIME_OUT_CLOSED::超時(shí)關(guān)單 示例值:TIME_OUT_CLOSED |
完成時(shí)間 | finish_time | string[1,64] | 是 | 分賬回退完成時(shí)間,遵循rfc3339標(biāo)準(zhǔn)格式 格式為yyyy-MM-DDTHH:mm:ss.sss+TIMEZONE,yyyy-MM-DD表示年月日,T出現(xiàn)在字符串中,表示time元素的開頭,HH:mm:ss.sss表示時(shí)分秒毫秒,TIMEZONE表示時(shí)區(qū)(+08:00表示東八區(qū)時(shí)間,領(lǐng)先UTC 8小時(shí),即北京時(shí)間)。例如:2015-05-20T13:29:35.120+08:00表示,北京時(shí)間2015年5月20日 13點(diǎn)29分35秒。 示例值:2015-05-20T13:29:35.120+08:00 |
{
"sub_mchid": "1900000109",
"order_id": "3008450740201411110007820472",
"out_order_no": "P20150806125346",
"out_return_no": "R20190516001",
"return_mchid": "86693852",
"amount": 10,
"return_no": "3008450740201411110007820472",
"result": "SUCCESS",
"fail_reason": "TIME_OUT_CLOSED",
"finish_time": "2015-05-20T13:29:35.120+08:00"
}
狀態(tài)碼 | 錯(cuò)誤碼 | 描述 | 解決方案 |
---|---|---|---|
500 | SYSTEM_ERROR | 系統(tǒng)錯(cuò)誤 | 系統(tǒng)異常,請(qǐng)使用相同參數(shù)稍后重新調(diào)用 |
403 | NOT_ENOUGH | 剩余可回退的金額不足 | 調(diào)整回退金額 |
400 | PARAM_ERROR | 訂單號(hào)格式不正確 | 請(qǐng)使用正確的參數(shù)重新調(diào)用 |
400 | INVALID_REQUEST | 回退方不存在 | 請(qǐng)根據(jù)返回的錯(cuò)誤信息確認(rèn)違反的業(yè)務(wù)規(guī)則 |
429 | FREQUENCY_LIMITED | 商戶發(fā)起分賬回退的頻率過(guò)高 | 請(qǐng)降低頻率后重試 |
403 | NO_AUTH | 回退方未開通分賬回退功能 | 請(qǐng)先讓回退方開通分賬回退功能 |