查询订单待分账金额
应用场景
服务商可通过调用此接口查询订单剩余待分金额。
接口频率:30QPS
接口说明
请求Url | https://api.mch.weixin.qq.com/pay/profitsharingorderamountquery |
---|---|
是否需要证书 | 否 |
请求方式 | post |
签名方式 | HMAC-SHA256 |
请求参数
名称 |
变量名 |
必填 |
类型 |
示例值 |
描述 |
---|---|---|---|---|---|
商户号 |
mch_id |
是 |
string(32) |
1900000100 |
微信支付分配的服务商户号 |
微信订单号 |
transaction_id |
是 |
string(32) |
4208450740201411110007820472 |
微信支付订单号 |
随机字符串 |
nonce_str |
是 |
string(32) |
5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
随机字符串,不长于32位。推荐随机数生成算法 |
签名 |
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>
返回结果
名称 |
变量名 |
必填 |
类型 |
示例值 |
描述 |
---|---|---|---|---|---|
返回状态码 |
return_code |
是 |
string(32) |
SUCCESS |
枚举值: SUCCESS:分账回退处理成功 FAIL:分账回退处理失败 |
错误代码 |
err_code |
否 |
string(32) |
SYSTEMERROR |
如果返回状态码为FAIL,则本字段存在,且为失败的错误码 详见错误码列表 |
返回信息 |
err_msg |
否 |
string(256) |
参数格式校验错误 |
如果返回状态码为FAIL,则本字段存在,且为失败的错误信息 |
以下字段在return_code为SUCCESS的时候有返回
名称 |
变量名 |
必填 |
类型 |
示例值 |
描述 |
---|---|---|---|---|---|
商户号 |
mch_id |
是 |
string(32) |
1900000100 |
调用接口时提供的服务商户号 |
微信订单号 |
transaction_id |
是 |
string(32) |
4208450740201411110007820472 |
微信支付订单号 |
订单剩余待分金额 |
unsplit_amount |
是 |
int |
1000 |
订单剩余待分金额,整数,单位为分 |
随机字符串 |
nonce_str |
是 |
string(32) |
5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
微信返回的随机字符串 |
签名 |
sign |
是 |
string(64) |
C380BEC2BFD727A4B6845133519F3AD6 |
微信返回的签名,详见签名算法 |
举例:
<xml>
<return_code><![CDATA[SUCCESS]]></return_code>
<mch_id><![CDATA[10000100]]></mch_id>
<transaction_id><![CDATA[4208450740201411110007820472]]></transaction_id>
<unsplit_amount><![CDATA[1000]]></unsplit_amount>
<nonce_str><![CDATA[6cefdb308e1e2e8aabd48cf79e546a02]]></nonce_str>
<sign><![CDATA[FE56DD4AA85C0EECA82C35595A69E153]]></sign>
</xml>
错误码列表
名称 |
描述 |
原因 |
解决方案 |
---|---|---|---|
SYSTEMERROR |
接口返回错误 |
系统超时 |
请使用相同参数再次调用API。 |
ORDERNOTEXIST |
分账单不存在 |
订单号错误或分账单号错误 |
请检查订单号或分账单号是否有误 |
INVALID_TRANSACTIONID |
无效transaction_id |
请求参数未按指引进行填写 |
请求参数错误,检查原交易号是否存在或发起支付交易接口返回失败 |
PARAM_ERROR |
参数错误 |
请求参数未按指引进行填写 |
请求参数错误,请检查参数再调用分账申请 |
INVALID_REQUEST |
请求不合法 |
非分账订单不支持此查询 |
请根据返回的错误信息确认违反的业务规则 |
非本商户的订单不支持查询 |
请根据返回的错误信息确认违反的业务规则 |