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