最新更新時間：2020.03.18 版本說明
商戶需要核實回退結(jié)果，可調(diào)用此接口查詢回退結(jié)果。如果分賬回退接口返回狀態(tài)為處理中，可調(diào)用此接口查詢回退結(jié)果?
適用對象：服務商
請求URL：https://api.mch.weixin.qq.com/v3/brand/profitsharing/returnorders
請求方式：GET
接口規(guī)則：http://www.tg885.com/wiki/doc/apiv3/wechatpay/wechatpay-1.shtml
path 指該參數(shù)為路徑參數(shù)
query 指該參數(shù)為URL參數(shù)
body 指該參數(shù)需在請求JSON傳參
| 參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 子商戶號 | sub_mchid | string[1,32] | 是 | query
分賬回退的接收商戶，對應原分賬出資的分賬方商戶，填寫微信支付分配的商戶號 示例值：1900000109 |
| 商戶回退單號 | out_return_no | string[1,64] | 是 | query
調(diào)用回退接口提供的商戶系統(tǒng)內(nèi)部的回退單號。 示例值：R20190516001 |
| 微信分帳單號 | order_id | string[1,64] | 二選一 | query
原發(fā)起分賬請求時，微信返回的微信分賬單號，與商戶分賬單號一一對應。 示例值： 4208450740201411110007820472 |
| 商戶分賬單號 | out_order_no | string[1,64] | query
原發(fā)起分賬請求時使用的商戶系統(tǒng)內(nèi)部的分賬單號。 示例值：P20190806125346 |
填寫微信分賬單號示例：
https://api.mch.weixin.qq.com/v3/brand/profitsharing/returnorders?sub_mchid=1900000109&out_return_no=R20190516001&order_id=4208450740201411110007820472
填寫商戶分賬單號示例：
https://api.mch.weixin.qq.com/v3/brand/profitsharing/returnorders?sub_mchid=1900000109&out_return_no=R20190516001&out_order_no=P20190806125346
| 參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 子商戶號 | sub_mchid | string[1,32] | 是 | 分賬回退的接收商戶，對應原分賬出資的分賬方商戶，填寫微信支付分配的商戶號 示例值：1900000109 |
| 微信分賬單號 | order_id | string[1,64] | 是 | 原發(fā)起分賬請求時，微信返回的微信分賬單號，與商戶分賬單號一一對應。 示例值： 3008450740201411110007820472 |
| 商戶分賬單號 | out_order_no | string[1,64] | 是 | 原發(fā)起分賬請求時使用的商戶后臺系統(tǒng)內(nèi)部的分賬單號。 示例值：P20150806125346 |
| 商戶回退單號 | out_return_no | string[1,64] | 是 | 調(diào)用回退接口提供的商戶系統(tǒng)內(nèi)部的回退單號 示例值：p86691234 |
| 回退商戶號 | return_mchid | string[1,32] | 是 | 只能對原分賬請求中成功接收分賬的商戶號進行回退。 示例值：86693852 |
| 微信回退單號 | return_no | string[1,64] | 是 | 微信分賬回退單號，微信支付系統(tǒng)返回的唯一標識 示例值： 3008450740201411110007820472 |
| 回退金額 | amount | int | 是 | 需要從分賬接收方回退的金額，單位為分，只能為整數(shù)，不能超過原始分賬單分出給該接收方的金額 示例值：10 |
| 回退結(jié)果 | result | string[1,32] | 是 | 如果請求返回為處理中，則商戶可以通過調(diào)用回退結(jié)果查詢接口獲取請求的最終處理結(jié)果。 枚舉值： PROCESSING：處理中 SUCCESS：已成功 FAILED：已失敗 注：如果查詢到回退結(jié)果在處理中，請勿變更商戶回退單號，使用相同的參數(shù)再次發(fā)起分賬回退，否則會出現(xiàn)資金風險。在處理中狀態(tài)的回退單如果5天沒有成功，會因為超時被設置為已失敗。 示例值：SUCCESS |
| 失敗原因 | fail_reason | string[1,32] | 否 | 回退失敗的原因，此字段僅回退結(jié)果為FAIL時存在。 枚舉值： ACCOUNT_ABNORMAL：分賬接收方賬戶異常 TIME_OUT_CLOSED: 超時關(guān)單 示例值：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ū)時間，領(lǐng)先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)異常，請使用相同參數(shù)稍后重新調(diào)用 |
| 400 | PARAM_ERROR | 商戶號未設置 | 請使用正確的參數(shù)重新調(diào)用 |
| 429 | FREQUENCY_LIMITED | 商戶發(fā)起分賬回退查詢的頻率過高 | 請降低頻率后重試 |
| 404 | RESOURCE_NOT_EXISTS | 記錄不存在 | 請檢查請求的單號是否正確 |