查询分账结果API

最新更新时间:2020.11.06 版本说明


发起分账请求后,可调用此接口查询分账结果 ;发起分账完结请求后,可调用此接口查询分账完结的结果

接口说明

适用对象:电商平台

请求URL:https://api.mch.weixin.qq.com/v3/ecommerce/profitsharing/orders

请求方式:GET

接口规则:https://wechatpay-api.gitbook.io/wechatpay-api-v3


path指该参数需在请求URL传参

query指该参数需在请求URL传参

body指该参数需在请求JSON传参


请求参数

参数名 变量 类型[长度限制] 必填 描述
二级商户号 sub_mchid string[1,32] query 分账出资的电商平台二级商户,填写微信支付分配的商户号。
示例值:1900000109
微信订单号 transaction_id string[1,32] query 微信支付订单号。
示例值: 4208450740201411110007820472
商户分账单号 out_order_no string[1,64] query 商户系统内部的分账单号,在商户系统内部唯一(单次分账、多次分账、完结分账应使用不同的商户分账单号),同一分账单号多次请求等同一次。
示例值:P20150806125346

请求示例


https://api.mch.weixin.qq.com/v3/ecommerce/profitsharing/orders?sub_mchid=1900000109&transaction_id=4208450740201411110007820472&out_order_no=P20150806125346
    
{
JAVA示例代码
}
    

返回参数

参数名 变量 类型[长度限制] 必填 描述
二级商户号 sub_mchid string[1,32] 分账出资的电商平台二级商户,填写微信支付分配的商户号。
示例值:1900000109
微信订单号 transaction_id string[1,32] 微信支付订单号。
示例值: 4208450740201411110007820472
商户分账单号 out_order_no string[1,64] 商户系统内部的分账单号,在商户系统内部唯一(单次分账、多次分账、完结分账应使用不同的商户分账单号),同一分账单号多次请求等同一次。
示例值:P20150806125346
微信分账单号 order_id string[1,64] 微信分账单号,微信系统返回的唯一标识
示例值: 008450740201411110007820472
分账单状态 status string[1,32] 分账单状态,枚举值:
PROCESSING:处理中
FINISHED:处理完成
示例值:FINISHED
+分账接收方列表 receivers array 分账接收方列表。当查询分账完结的执行结果时,不返回该字段
参数名 变量 类型[长度限制] 必填 描述
分账接收商户号 receiver_mchid string[1,32] 填写微信支付分配的商户号,仅支持通过添加分账接收方接口添加的接收方;电商平台商户已默认添加到分账接收方,无需重复添加。
示例值:1900000109
分账金额 amount int 分账金额,单位为分,只能为整数,不能超过原订单支付金额及最大分账比例金额。
示例值: 4208450740201411110007820472
分账描述 description string[1,80] 分账的原因描述,分账账单中需要体现。
示例值:分帐1900000110
分账结果 result string[1,32]

分账结果,枚举值:
PENDING:待分账
SUCCESS:分账成功
CLOSED:分账失败已关闭
示例值:SUCCESS

完成时间 finish_time string[1,64] 分账完成时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss.sss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.sss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.120+08:00表示,北京时间2015年5月20日 13点29分35秒。
示例值: 2015-05-20T13:29:35.120+08:00
分账失败原因 fail_reason string[1,32] 分账失败原因,当分账结果result为RETURNED(已转回分账方)或CLOSED(已关闭)时,返回该字段
枚举值:
ACCOUNT_ABNORMAL:分账接收账户异常
NO_RELATION:分账关系已解除
RECEIVER_HIGH_RISK:高风险接收方
示例值:NO_RELATION
分账接收方类型 type string[1,32] 分账接收方类型,枚举值:
MERCHANT_ID:商户
PERSONAL_OPENID:个人
示例值:MERCHANT_ID
分账接收方账号 receiver_account string[1,64] 分账接收方账号:
类型是MERCHANT_ID时,是商户号(mch_id或者sub_mch_id)
类型是PERSONAL_OPENID时,是个人openid
示例值:1900000109
关单原因 close_reason string[1,32] 关单原因描述,当分账单状态status为CLOSED(处理失败,已关单)时,返回该字段。
枚举值:
NO_AUTH:分账授权已解除
示例值:NO_AUTH
分账完结金额 finish_amount int 分账完结的分账金额,单位为分, 仅当查询分账完结的执行结果时,存在本字段。
示例值:100
分账完结描述 finish_description string[1,80] 分账完结的原因描述,仅当查询分账完结的执行结果时,存在本字段。
示例值:分账完结

返回示例


{
 "sub_mchid": "1900000109",
 "transaction_id": "4208450740201411110007820472",
 "out_order_no": "P20150806125346",
 "order_id": "3008450740201411110007820472",
 "status": "FINISHED",
 "receivers": [
{
   "receiver_mchid": "1900000110",
   "amount": 100,
   "description": "分给商户1900000110",
   "result": "SUCCESS",
   "finish_time": "2015-05-20T13:29:35.120+08:00",
   "fail_reason": "ACCOUNT_ABNORMAL"
  }
],
 "close_reason": "NO_AUTH",
 "finish_amount": 100,
 "finish_description": "分账完结"
}
                                

    http://2323weixin.qq.com
                                

错误码公共错误码

状态码 错误码 描述 解决方案
500 SYSTEM_ERROR 系统错误 系统异常,请使用相同参数稍后重新调用
400 PARAM_ERROR 商户号未设置 请使用正确的参数重新调用
429 FREQUENCY_LIMITED 频率限制 请降低频率后重试
404 RESOURCE_NOT_EXISTS 记录不存在 请检查请求的单号是否正确

版本说明

关闭
V1.5
2020.11.06
1. 分账单状态(status)字段枚举值调整为:
PROCESSING:处理中
FINISHED:处理完成
2. 分账结果(result)字段枚举值调整为:
PENDING: 待分账
SUCEESS: 分账成功
CLOSED: 分账失败已关闭
V1.4
2020.09.14
1.返回参数receivers、fail_reason、close_reason新增返回说明
V1.3
2020.04.30
1. 新增返回参数type(分账接收方类型,支持:商户、个人两种接收方类型)、receiver_account(分账接收方账号)字段,错误码:RESOURCE_NOT_EXISTS
V1.2
2020.04.01
1. 新增分账失败原因(fail_reason)枚举值:RECEIVER_HIGH_RISK
V1.1
2020.2.27
1. 修改分账接受方描述
V1.0
2019.09.11
1. 查询分账结果接口上线

技术咨询

反馈有奖