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