完結(jié)分賬
應用場景
- 1、不需要進行分賬的訂單,可直接調(diào)用本接口將訂單的金額全部解凍給本商戶
- 2、調(diào)用多次分賬接口后,需要解凍剩余資金時,調(diào)用本接口將剩余的分賬金額全部解凍給本商戶
- 3、已調(diào)用請求單次分賬后,剩余待分賬金額為零,不需要再調(diào)用此接口。
接口限頻:
1、單個分賬接收方商戶(分賬完結(jié)) 60QPS,如果超過頻率限制,會報錯FREQUENCY_LIMITED,請降低頻率請求。同時,建議拆分多個分賬接收方商戶號進行分賬收款,避免集中分賬到單個商戶。
接口說明
請求Url | https://api.mch.weixin.qq.com/secapi/pay/profitsharingfinish |
---|---|
是否需要證書 | 請求需要雙向證書。 詳見證書使用 |
請求方式 | post |
簽名方式 | HMAC-SHA256 |
請求參數(shù)
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
商戶號 | mch_id | 是 | string(32) | 1900000100 | 微信支付分配的商戶號 |
公眾賬號ID | appid | 是 | string(32) | wx8888888888888888 | 微信分配的公眾賬號ID |
隨機字符串 | nonce_str | 是 | string(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 隨機字符串,不長于32位。推薦隨機數(shù)生成算法 |
簽名 | sign | 是 | string(64) | C380BEC2BFD727A4B6845133519F3AD6C380BEC2BFD727A4B6845133519F3AD6 | 簽名,詳見簽名生成算法 |
簽名類型 | sign_type | 否 | string(32) | HMAC-SHA256 | 簽名類型,目前只支持HMAC-SHA256 |
微信訂單號 | transaction_id | 是 | string(32) | 4208450740201411110007820472 | 微信支付訂單號 |
商戶分賬單號 | out_order_no | 是 | string(64) | P20150806125346 | 商戶系統(tǒng)內(nèi)部的分賬單號,在商戶系統(tǒng)內(nèi)部唯一(單次分賬、多次分賬、完結(jié)分賬應使用不同的商戶分賬單號),同一分賬單號多次請求等同一次。只能是數(shù)字、大小寫字母_-|*@? |
分賬完結(jié)描述 | description | 是 | string(80) | 分賬已完成 | 分賬完結(jié)的原因描述 |
舉例如下:
<xml>
???
<appid>wx2421b1c4370ec43b</appid>
???
<mch_id>10000100</mch_id>
???
<nonce_str>6cefdb308e1e2e8aabd48cf79e546a02</nonce_str>?
???
<out_order_no>P20150806125346</out_order_no>
???
<transaction_id>4006252001201705123297353072</transaction_id>
???
<sign>FE56DD4AA85C0EECA82C35595A69E153</sign>
<sign_type>HMAC-SHA256</sign_type>
<description>分賬已完成</description>
</xml>
返回結(jié)果
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回狀態(tài)碼 | return_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL 此字段是通信標識,非交易標識 |
返回信息 | return_msg | 是 | String(128) | 參數(shù)格式校驗錯誤 | 返回信息,如非空,為錯誤原因 |
以下字段在return_code為SUCCESS的時候有返回
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
業(yè)務結(jié)果 | result_code | 是 | string(32) | SUCCESS | SUCCESS:分賬完結(jié)請求接收成功,結(jié)果通過分賬查詢接口查詢 FAIL :提交業(yè)務失敗 |
錯誤代碼 | err_code | 否 | string(32) | SYSTEMERROR | 列表詳見錯誤碼列表 |
錯誤代碼描述 | err_code_des | 否 | String(128) | 系統(tǒng)超時 | 結(jié)果信息描述 |
商戶號 | mch_id | 是 | string(32) | 1900000100 | 調(diào)用接口時提供的商戶號 |
公眾賬號ID | appid | 是 | string(32) | wx8888888888888888 | 調(diào)用接口提供的公眾賬號ID |
隨機字符串 | nonce_str | 是 | string(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 微信返回的隨機字符串 |
簽名 | sign | 是 | string(64) | C380BEC2BFD727A4B6845133519F3AD6 | 微信返回的簽名,詳見簽名算法 |
以下字段在return_code 和result_code都為SUCCESS的時候有返回
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
微信訂單號 | transaction_id | 是 | string(32) | 4208450740201411110007820472 | 微信支付訂單號 |
商戶分賬單號 | out_order_no | 是 | string(64) | P20150806125346 | 商戶系統(tǒng)內(nèi)部的分賬單號,在商戶系統(tǒng)內(nèi)部唯一(單次分賬、多次分賬、完結(jié)分賬應使用不同的商戶分賬單號),同一分賬單號多次請求等同一次。只能是數(shù)字、大小寫字母_-|*@? |
微信分賬單號 | order_id | 是 | string(64) | 3008450740201411110007820472 | 微信分賬單號,微信支付系統(tǒng)返回的唯一標識 |
舉例如下:
<xml>
<return_code><![CDATA[SUCCESS]]></return_code>
?
<return_msg><![CDATA[OK]]></return_msg>
<result_code><![CDATA[SUCCESS]]></result_code>
??
<mch_id>10000100</mch_id>
<appid>wx2421b1c4370ec43b</appid>
<nonce_str>6cefdb308e1e2e8aabd48cf79e546a02</nonce_str>?
<out_order_no>P20150806125346</out_order_no>
<transaction_id>4006252001201705123297353072</transaction_id>
<order_id>3008450740201411110007820472</order_id>
<sign>FE56DD4AA85C0EECA82C35595A69E153</sign>
</xml>
錯誤碼
名稱 | 描述 | 原因 | 解決方案 |
---|---|---|---|
SYSTEMERROR | 接口返回錯誤 | 系統(tǒng)超時 | 請不要更換商戶分賬單號,請使用相同參數(shù)再次調(diào)用API。否則可能造成資金損失 |
INVALID_TRANSACTIONID | 無效的微信支付訂單號 | 請求參數(shù)未按指引進行填寫 | 請求參數(shù)錯誤,檢查原交易號是否存在或發(fā)起支付交易接口返回失敗 |
PARAM_ERROR | 參數(shù)錯誤 | 請求參數(shù)未按指引進行填寫 | 請求參數(shù)錯誤,請重新檢查再調(diào)用分賬完結(jié)接口 |
INVALID_REQUEST | 請求不合法 | 參數(shù)中APPID或 MCHID不存在等 | 請檢查請求參數(shù) |
FREQUENCY_LIMITED | 頻率限制 | 請求過多被頻率限制 | 該筆請求未受理,請降低頻率后原單重試,請勿更換商戶分賬單號 |
ORDER_NOT_READY | 訂單處理中 | 訂單處理中,暫時無法處理分賬完結(jié)請求 | 訂單處理中,暫時無法處理分賬完結(jié)請求,請稍后再試 |
OPENID_MISMATCH | openid錯誤 | openid與appid不匹配 | 請檢查openid是否正確 |
NOT_SHARE_ORDER | 非分賬訂單 | 不是分賬訂單?無法分賬 | 下單時請用分賬的合適參數(shù) |
AMOUNT_OVERDUE | 可分余額不足 | 訂單剩余可分賬金額為零 | 請檢查請求參數(shù) |