商戶需要核實回退結果,可調用此接口查詢回退結果。如果分賬回退接口返回狀態(tài)為處理中,可調用此接口查詢回退結果。
# 接口說明
支持商戶:
【平臺商戶】
請求方式:
【GET】/v3/ecommerce/profitsharing/returnorders
請求域名:
【主域名】
https://api.mch.weixin.qq.com
使用該域名將訪問就近的接入點【備域名】
https://api2.mch.weixin.qq.com
使用該域名將訪問異地的接入點 ,指引點擊查看
# 請求參數(shù)
- Authorization 必填 string請參考 簽名認證 生成認證信息
- Accept 必填 string請設置為
application/json
Header HTTP頭參數(shù)
- sub_mchid 必填 string【電商平臺二級商戶號】 分賬回退的接收商戶,對應原分賬出資的電商平臺二級商戶,填寫微信支付分配的商戶號
- out_return_no 必填 string【商戶回退單號】 調用回退接口提供的商戶系統(tǒng)內(nèi)部的回退單號
- order_id 選填 string(32)【微信分賬單號】 原發(fā)起分賬請求時,微信返回的微信分賬單號,與商戶分賬單號一一對應。 微信分賬單號與商戶分賬單號二選一填寫
- out_order_no 選填 string【商戶分賬單號】 原發(fā)起分賬請求時使用的商戶系統(tǒng)內(nèi)部的分賬單號。微信分賬單號與商戶分賬單號二選一填寫
Query 查詢參數(shù)
請求示例
GET
# 應答參數(shù)
- sub_mchid 必填 string【電商平臺二級商戶號】 分賬回退的接收商戶,對應原分賬出資的電商平臺二級商戶,填寫微信支付分配的商戶號
- order_id 必填 string【微信分賬單號】 微信分賬單號,微信系統(tǒng)返回的唯一標識
- out_order_no 必填 string【商戶分賬單號】 商戶系統(tǒng)內(nèi)部的分賬單號,在商戶系統(tǒng)內(nèi)部唯一(單次分賬、多次分賬、完結分賬應使用不同的商戶分賬單號),同一分賬單號多次請求等同一次。只能是數(shù)字、大小寫字母_-|*@
- out_return_no 必填 string【商戶回退單號】 此回退單號是商戶在自己后臺生成的一個新的回退單號,在商戶后臺唯一 只能是數(shù)字、大小寫字母_-|*@ ,同一回退單號多次請求等同一次。
- return_no 必填 string(64)【微信回退單號】 微信分賬回退單號,微信系統(tǒng)返回的唯一標識
- return_mchid 必填 string【回退商戶號】 只能對原分賬請求中成功分給商戶接收方進行回退
- amount 必填 integer【回退金額】 需要從分賬接收方回退的金額,單位為分,只能為整數(shù),不能超過原始分賬單分出給該接收方的金額
- result 必填 string【回退結果】 如果請求返回為處理中,則商戶可以通過調用回退結果查詢接口獲取請求的最終處理結果
枚舉值:
PROCESSING:處理中
SUCCESS:已成功
FAILED:已失敗
注意:如果返回為處理中,請勿變更商戶回退單號,使用相同的參數(shù)再次發(fā)起分賬回退,否則會出現(xiàn)資金風險 在處理中狀態(tài)的回退單如果5天沒有成功,會因為超時被設置為已失敗 - fail_reason 選填 string【失敗原因】 失敗原因。包含以下枚舉值:
1. ACCOUNT_ABNORMAL : 原分賬接收方賬戶異常
2. TIME_OUT_CLOSED : 超時關單
3. PAYER_ACCOUNT_ABNORMAL : 原分賬分出方賬戶異常
4. INVALID_REQUEST : 描述參數(shù)設置失敗 - finish_time 必填 string【完成時間】 分賬回退完成時間,遵循RFC3339標準格式
- transaction_id 必填 string(32)【微信訂單號】 微信支付訂單號
200OK
應答示例
200 OK
# 錯誤碼
# 公共錯誤碼
狀態(tài)碼 | 錯誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | PARAM_ERROR | 參數(shù)錯誤 | 請根據(jù)錯誤提示正確傳入?yún)?shù) |
400 | INVALID_REQUEST | HTTP 請求不符合微信支付 APIv3 接口規(guī)則 | 請參閱 接口規(guī)則 |
401 | SIGN_ERROR | 驗證不通過 | 請參閱 簽名常見問題 |
500 | SYSTEM_ERROR | 系統(tǒng)異常,請稍后重試 | 請稍后重試 |
# 業(yè)務錯誤碼
狀態(tài)碼 | 錯誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | PARAM_ERROR | 商戶號未設置 | 請使用正確的參數(shù)重新調用 |
404 | RESOURCE_NOT_EXISTS | 記錄不存在 | 請檢查請求的單號是否正確 |
429 | FREQUENCY_LIMITED | 頻率限制 | 請降低頻率后重試 |
500 | SYSTEM_ERROR | 系統(tǒng)錯誤 | 系統(tǒng)異常,請使用相同參數(shù)稍后重新調用 |