查詢訂單待分賬金額
應(yīng)用場景
商戶可通過調(diào)用此接口查詢訂單剩余待分金額。
接口頻率：30QPS
接口說明
| 請求Url | https://api.mch.weixin.qq.com/pay/profitsharingorderamountquery |
|---|---|
| 是否需要證書 | 否 |
| 請求方式 | post |
| 簽名方式 | HMAC-SHA256 |
請求參數(shù)
名稱 |
變量名 |
必填 |
類型 |
示例值 |
描述 |
|---|---|---|---|---|---|
商戶號(hào) |
mch_id |
是 |
string(32) |
1900000100 |
微信支付分配的商戶號(hào) |
微信訂單號(hào) |
transaction_id |
是 |
string(32) |
4208450740201411110007820472 |
微信支付訂單號(hào) |
隨機(jī)字符串 |
nonce_str |
是 |
string(32) |
5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
隨機(jī)字符串，不長于32位。推薦隨機(jī)數(shù)生成算法 |
簽名 |
sign |
是 |
string(64) |
C380BEC2BFD727A4B6845133519F3AD6C380BEC2BFD727A4B6845133519F3AD6 |
簽名，詳見簽名生成算法 |
簽名類型 |
sign_type |
否 |
string(32) |
HMAC-SHA256 |
簽名類型，目前只支持HMAC-SHA256 |
舉例如下：
<xml>
<transaction_id>4208450740201411110007820472</transaction_id>
<mch_id>10000100</mch_id>
<nonce_str>6cefdb308e1e2e8aabd48cf79e546a02</nonce_str>
<sign_type>HMAC-SHA256</sign_type>
<sign>FE56DD4AA85C0EECA82C35595A69E153</sign>
</xml>
返回結(jié)果
名稱 |
變量名 |
必填 |
類型 |
示例值 |
描述 |
|---|---|---|---|---|---|
返回狀態(tài)碼 |
return_code |
是 |
string(32) |
SUCCESS |
枚舉值： SUCCESS：分賬回退處理成功 FAIL：分賬回退處理失敗 |
錯(cuò)誤代碼 |
error_code |
否 |
string(32) |
SYSTEMERROR |
如果返回狀態(tài)碼為FAIL，則本字段存在，且為失敗的錯(cuò)誤碼 詳見錯(cuò)誤碼列表 |
返回信息 |
error_msg |
否 |
string(256) |
參數(shù)格式校驗(yàn)錯(cuò)誤 |
如果返回狀態(tài)碼為FAIL，則本字段存在，且為失敗的錯(cuò)誤信息 |
以下字段在return_code為SUCCESS的時(shí)候有返回
名稱 |
變量名 |
必填 |
類型 |
示例值 |
描述 |
|---|---|---|---|---|---|
商戶號(hào) |
mch_id |
是 |
string(32) |
1900000100 |
調(diào)用接口時(shí)提供的商戶號(hào) |
微信訂單號(hào) |
transaction_id |
是 |
string(32) |
4208450740201411110007820472 |
微信支付訂單號(hào) |
訂單剩余待分金額 |
unsplit_amount |
是 |
int |
1000 |
訂單剩余待分金額，整數(shù)，單位為分 |
隨機(jī)字符串 |
nonce_str |
是 |
string(32) |
5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
微信返回的隨機(jī)字符串 |
簽名 |
sign |
是 |
string(64) |
C380BEC2BFD727A4B6845133519F3AD6 |
微信返回的簽名，詳見簽名算法 |
舉例：
<xml>
<return_code><![CDATA[SUCCESS]]></return_code>
<mch_id>10000100</mch_id>
<transaction_id>4208450740201411110007820472</transaction_id>
<unsplit_amount>1000</unsplit_amount>
<nonce_str>6cefdb308e1e2e8aabd48cf79e546a02</nonce_str>
<sign>FE56DD4AA85C0EECA82C35595A69E153</sign>
</xml>
錯(cuò)誤碼列表
名稱 |
描述 |
原因 |
解決方案 |
|---|---|---|---|
SYSTEMERROR |
接口返回錯(cuò)誤 |
系統(tǒng)超時(shí) |
請使用相同參數(shù)再次調(diào)用API。 |
ORDERNOTEXIST |
分賬單不存在 |
訂單號(hào)錯(cuò)誤或分賬單號(hào)錯(cuò)誤 |
請檢查訂單號(hào)或分賬單號(hào)是否有誤 |
INVALID_TRANSACTIONID |
無效transaction_id |
請求參數(shù)未按指引進(jìn)行填寫 |
請求參數(shù)錯(cuò)誤，檢查原交易號(hào)是否存在或發(fā)起支付交易接口返回失敗 |
PARAM_ERROR |
參數(shù)錯(cuò)誤 |
請求參數(shù)未按指引進(jìn)行填寫 |
請求參數(shù)錯(cuò)誤，請檢查參數(shù)再調(diào)用分賬申請 |
INVALID_REQUEST |
請求不合法 |
非分賬訂單不支持此查詢 |
請根據(jù)返回的錯(cuò)誤信息確認(rèn)違反的業(yè)務(wù)規(guī)則 |
非本商戶的訂單不支持查詢 |
請根據(jù)返回的錯(cuò)誤信息確認(rèn)違反的業(yè)務(wù)規(guī)則 |