如果訂單已經(jīng)分賬,在退款時,可以先調(diào)此接口,將已分賬的資金從分賬接收方的賬戶回退給分賬方,再發(fā)起退款。
- 分賬回退以原分賬單為依據(jù),支持多次回退,申請回退總金額不能超過原分賬單分給該接收方的金額
- 此接口采用同步處理模式,即在接收到商戶請求后,會實時返回處理結(jié)果
- 對同一筆分賬單最多能發(fā)起20次分賬回退請求
- 退款和分賬回退沒有耦合,分賬回退可以先于退款請求,也可以后于退款請求
- 此功能需要接收方在商戶平臺-交易中心-分賬-分賬接收設(shè)置下,開啟同意分賬回退后,才能使用
- 不支持針對“分賬到零錢”的分賬單發(fā)起分賬回退。
- 分賬回退的時限是180天。
# 接口說明
支持商戶:
【普通服務(wù)商】
請求方式:
【POST】/v3/profitsharing/return-orders
請求域名:
【主域名】
https://api.mch.weixin.qq.com
使用該域名將訪問就近的接入點【備域名】
https://api2.mch.weixin.qq.com
使用該域名將訪問異地的接入點 ,指引點擊查看
# 請求參數(shù)
- Authorization 必填 string請參考 簽名認證 生成認證信息
- Accept 必填 string請設(shè)置為
application/json
- Content-Type 必填 string請設(shè)置為
application/json
Header HTTP頭參數(shù)
- sub_mchid 選填 string(32)【子商戶號】 分賬回退的接收商戶,對應(yīng)原分賬出資的分賬方商戶,填寫微信支付分配的商戶號。(直連商戶不需要,服務(wù)商需要)
- order_id 選填 string(64)【微信分賬單號】 微信分賬單號,微信系統(tǒng)返回的唯一標(biāo)識。微信分賬單號和商戶分賬單號二選一填寫
- out_order_no 選填 string【商戶分賬單號】 商戶系統(tǒng)內(nèi)部的分賬單號,在商戶系統(tǒng)內(nèi)部唯一,同一分賬單號多次請求等同一次。微信分賬單號和商戶分賬單號二選一填寫 取值范圍:[0-9a-zA-Z_*@-]
- out_return_no 必填 string【商戶回退單號】 此回退單號是商戶在自己后臺生成的一個新的回退單號,在商戶后臺唯一
- return_mchid 必填 string【回退商戶號】 分賬回退的出資商戶,只能對原分賬請求中成功分給商戶接收方進行回退
- amount 必填 integer【回退金額】 需要從分賬接收方回退的金額,單位為分,只能為整數(shù),不能超過原始分賬單分出給該接收方的金額
- description 必填 string(80)【回退描述】 分賬回退的原因描述
Body 包體參數(shù)
請求示例
POST
# 應(yīng)答參數(shù)
- sub_mchid 選填 string(32)【子商戶號】 參考請求參數(shù)
- order_id 必填 string(64)【微信分賬單號】 微信分賬單號,微信系統(tǒng)返回的唯一標(biāo)識
- out_order_no 必填 string(64)【商戶分賬單號】 商戶系統(tǒng)內(nèi)部的分賬單號,在商戶系統(tǒng)內(nèi)部唯一,同一分賬單號多次請求等同一次
- out_return_no 必填 string(64)【商戶回退單號】 調(diào)用回退接口提供的商戶系統(tǒng)內(nèi)部的回退單號
- return_id 必填 string(64)【微信回退單號】 微信分賬回退單號,微信系統(tǒng)返回的唯一標(biāo)識
- return_mchid 必填 string(32)【回退商戶號】 只能對原分賬請求中成功分給商戶接收方進行回退
- amount 必填 integer【回退金額】 需要從分賬接收方回退的金額,單位為分,只能為整數(shù)
- description 必填 string(80)【回退描述】 分賬回退的原因描述
- result 必填 string【回退結(jié)果】 如果請求返回為處理中,則商戶可以通過調(diào)用回退結(jié)果查詢接口獲取請求的最終處理結(jié)果。如果查詢到回退結(jié)果在處理中,請勿變更商戶回退單號,使用相同的參數(shù)再次發(fā)起分賬回退,否則會出現(xiàn)資金風(fēng)險。在處理中狀態(tài)的回退單如果5天沒有成功,會因為超時被設(shè)置為已失敗
可選取值:PROCESSING
: 處理中SUCCESS
: 已成功FAILED
: 已失敗
- fail_reason 選填 string【失敗原因】 失敗原因
可選取值:ACCOUNT_ABNORMAL
: 原分賬接收方賬戶異常BALANCE_NOT_ENOUGH
: 余額不足TIME_OUT_CLOSED
: 超時關(guān)單PAYER_ACCOUNT_ABNORMAL
: 原分賬分出方賬戶異常INVALID_REQUEST
: 描述參數(shù)設(shè)置失敗
- create_time 必填 string【創(chuàng)建時間】 分賬回退創(chuàng)建時間,遵循RFC3339標(biāo)準格式
- finish_time 必填 string【完成時間】 分賬回退完成時間,遵循RFC3339標(biāo)準格式
200OK
應(yīng)答示例
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è)務(wù)錯誤碼
狀態(tài)碼 | 錯誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | INVALID_REQUEST | 回退方不存在 | 請根據(jù)返回的錯誤信息確認違反的業(yè)務(wù)規(guī)則 |
400 | PARAM_ERROR | 訂單號格式不正確 | 請使用正確的參數(shù)重新調(diào)用 |
403 | NO_AUTH | 回退方未開通分賬回退功能 | 請先讓回退方開通分賬回退功能 |
429 | FREQUENCY_LIMITED | 商戶發(fā)起分賬回退的頻率過高 | 請降低頻率后重試 |
500 | SYSTEM_ERROR | 系統(tǒng)錯誤 | 系統(tǒng)異常,請使用相同參數(shù)稍后重新調(diào)用 |