查询分账结果
更新时间:2024.11.13应用场景
发起分账请求后,可调用此接口查询分账结果;发起分账完结请求后,可调用此接口查询分账完结的执行结果。
接口频率:80QPS
接口说明
请求Url | https://api.mch.weixin.qq.com/pay/profitsharingquery |
---|---|
是否需要证书 | 否 |
请求方式 | post |
签名方式 | HMAC-SHA256 |
请求参数
名称 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mch_id | 是 | string(32) | 1900000100 | 微信支付分配的服务商商户号 |
子商户号 | sub_mch_id | 是 | string(32) | 1900000109 | 微信支付分配的子商户号,即分账的出资商户号。 |
微信订单号 | transaction_id | 是 | string(32) | 4208450740201411110007820472 | 微信支付订单号 |
商户分账单号 | out_order_no | 是 | string(64) | P20150806125346 | 查询分账结果,输入申请分账时的商户分账单号; 查询分账完结的执行结果,输入发起分账完结时的商户分账单号 |
随机字符串 | nonce_str | 是 | string(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 随机字符串,不长于32位。推荐随机数生成算法 |
签名 | sign | 是 | string(64) | C380BEC2BFD727A4B6845133519F3AD6 | 签名,详见签名生成算法 |
签名类型 | sign_type | 否 | string(32) | HMAC-SHA256 | 签名类型,目前只支持HMAC-SHA256 |
举例如下:
返回结果
名称 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回状态码 | return_code | 是 | string(32) | SUCCESS | SUCCESS/FAIL 此字段是通信标识,非交易标识 |
返回信息 | return_msg | 否 | string(256) | 参数格式校验错误 | 返回信息,如非空,为错误原因 |
以下字段在return_code为SUCCESS的时候有返回
名称 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
业务结果 | result_code | 是 | string(32) | SUCCESS | SUCCESS:分账申请接收成功,结果通过分账查询接口查询 |
错误代码 | err_code | 否 | string(32) | SYSTEMERROR | 列表详见错误码列表 |
错误代码描述 | err_code_des | 否 | String(128) | 系统超时 | 结果信息描述 |
商户号 | mch_id | 是 | string(32) | 1900000100 | 调用接口时提供的商户号 |
子商户号 | sub_mch_id | 是 | string(32) | 1900000109 | 微信支付分配的子商户号,即分账的出资商户号。 |
随机字符串 | 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 | 商户系统内部的分账单号,商户系统内部唯一,只能是数字、大小写字母_-|*@ ,同一分账单号多次请求等同一次。 | |||
微信分账单号 | order_id | 是 | string(64) | 3008450740201411110007820472 | 微信分账单号 | |||
分账单状态 | status | 是 | string(16) | FINISHED | 分账单状态: | |||
分账接收方列表 | receivers | 是 | String(10240) | 内容见下方示例 | 分账接收方列表,json对象详细说明见下文,仅当查询分账请求结果时,存在本字段 点击下行的>展开字段详情 | |||
|
举例如下:
错误码列表
名称 | 描述 | 原因 | 解决方案 |
---|---|---|---|
SYSTEMERROR | 接口返回错误 | 系统超时 | 请尝试再次掉调用API。 |
ORDERNOTEXIST | 分账单不存在 | 订单号错误或分账单号错误 | 请检查订单号或分账单号是否有误 |
INVALID_TRANSACTIONID | 无效transaction_id | 请求参数未按指引进行填写 | 请求参数错误,检查原交易号是否存在或发起支付交易接口返回失败 |
PARAM_ERROR | 参数错误 | 请求参数未按指引进行填写 | 请求参数错误,请检查参数再调用分账申请 |
INVALID_REQUEST | 请求不合法 | 参数中APPID或 MCHID不存在等 | 请检查请求参数 |