商户进件
特约商户进件
基础支付
JSAPI支付
APP支付
H5支付
Native支付
小程序支付
合单支付
付款码支付
经营能力
支付即服务
点金计划
行业方案
电商收付通(商户进件)
电商收付通(普通支付)
电商收付通(合单支付)
电商收付通(分账)
电商收付通(补差)
电商收付通(退款)
电商收付通(余额查询)
电商收付通(商户提现)
电商收付通(下载账单)
智慧商圈
微信支付分停车服务
营销工具
代金券
商家券
委托营销
支付有礼
小程序发券插件
H5发券
图片上传(营销专用)
现金红包
资金应用
分账
连锁品牌分账
风险合规
商户开户意愿确认
消费者投诉2.0
其他能力
图片上传
视频上传

请求分账API

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


微信订单支付成功后,由服务商发起分账请求,将结算后的资金分给分账接收方。


注意:

• 微信订单支付成功后,服务商代特约商户发起分账请求,将结算后的钱分到分账接收方。

• 对同一笔订单最多能发起20次分账请求,每次请求最多分给5个接收方。

• 此接口采用异步处理模式,即在接收到商户请求后,会先受理请求再异步处理,最终的分账结果可以通过查询分账接口获取。

接口说明

适用对象:服务商

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

请求方式:POST


path指该参数为路径参数

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

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


请求参数

参数名 变量 类型[长度限制] 必填 描述
品牌主商户号 brand_mchid string[1,32] body 品牌主商户号,填写微信支付分配的商户号。
示例值:1900000108
子商户号 sub_mchid string[1,32] body 订单收款方商户号,可以是品牌主商户号,也可以是门店商户号,填写微信支付分配的商户号。
示例值:1900000109
公众账号ID appid string[1,32] body 微信分配的公众账号ID,这里指服务商的appid
示例值: wx8888888888888888
子商户公众账号ID sub_appid string[1,32] body 微信分配的子商户公众账号ID,分账接收方类型包含PERSONAL_SUB_OPENID时必填。这里指的是品牌主的appid
示例值:wx8888888888888889
微信订单号 transaction_id string[1,32] body 微信支付订单号
示例值:4208450740201411110007820472
商户分账单号 out_order_no string[1,64] body 商户系统内部的分账单号,在商户系统内部唯一(单次分账、多次分账、完结分账应使用不同的商户分账单号),同一分账单号多次请求等同一次,只能是数字、大小写字母_-|*@。
示例值:P20150806125346
+ 分账接收方列表 receivers array body 分账接收方列表,支持设置出资商户作为分账接收方,单次分账最多可有5个分账接收方。
参数名 变量 类型[长度限制] 必填 描述
分账接收方类型 type string[1,32] 枚举值:
MERCHANT_ID:商户号(mch_id或者sub_mch_id)
PERSONAL_OPENID:个人openid(由服务商的APPID转换得到)
PERSONAL_SUB_OPENID:个人sub_openid(由品牌主的APPID转换得到)
示例值:MERCHANT_ID
分账接收方账号 account string[1,64] 1、分账接收方类型为MERCHANT_ID时,分账接收方账号为商户号(mch_id或者sub_mch_id)
2、分账接收方类型为PERSONAL_OPENID时,分账接收方账号为个人openid
3、分账接收方类型为
PERSONAL_SUB_OPENID时,分账接收方账号为个人sub_openid
示例值:1900000109
分账金额 amount int 分账金额,单位为分,只能为整数,不能超过原订单支付金额及最大分账比例金额
示例值:190
分账描述 description string[1,80] 分账的原因描述,将体现在商户资金账单和分账账单中
示例值:1900000109分给商户1900000110
分账个人接收方姓名 name string[1, 10240] 可选项,在接收方类型为个人的时可选填,若有值,会检查与 name 是否实名匹配,不匹配会拒绝分账请求
1、分账接收方类型是PERSONAL_OPENID时,是个人姓名的密文(选传,传则校验) 此字段的加密的方式为:
2、使用微信支付平台证书中的公钥
3、使用RSAES-OAEP算法进行加密
4、将请求中HTTP头部的Wechatpay-Serial设置为微信支付平台证书序列号
示例值:hu89ohu89ohu89o
是否分账完成 finish boolean body 是否完成分账
1、如果为true,该笔订单剩余未分账的金额会解冻回分账方商户;
2、如果为false,该笔订单剩余未分账的金额不会解冻回分账方商户,可以对该笔订单再次进行分账。
示例值:true

请求示例


{
"brand_mchid": "1900000108",
"sub_mchid": "1900000109",
"appid": "wx8888888888888888",
"sub_appid": "wx8888888888888889",
"transaction_id": "4208450740201411110007820472",
"out_order_no": "P20150806125346",
"receivers": [
   {
	 "type": "MERCHANT_ID",
	 "account": "1900000110",
	 "amount": 100,
	 "description": "1900000109分给商户1900000110"
   }
 ],
 "finish": true
}
    
{
JAVA示例代码
}
    

返回参数

参数名 变量 类型[长度限制] 必填 描述
品牌主商户号 brand_mchid string[1,32] 品牌主商户号,填写微信支付分配的商户号。
示例值:1900000108
子商户号 sub_mchid string[1,32] 订单收款方商户号,可以是品牌主商户号,也可以是门店商户号,填写微信支付分配的商户号。
示例值:1900000109
微信订单号 transaction_id string[1,32] 微信支付订单号
示例值: 4208450740201411110007820472
商户分账单号 out_order_no string[1,64] 商户系统内部的分账单号,在商户系统内部唯一(单次分账、多次分账、完结分账应使用不同的商户分账单号),同一分账单号多次请求等同一次,只能是数字、大小写字母_-|*@。
示例值:P20150806125346
微信分账单号 order_id string[1,64] 微信分账单号,微信系统返回的唯一标识
示例值: 6754760740201411110007865434
分账单状态 status string[1,32] 分账单状态,枚举值:
PROCESSING:处理中
FINISHED:处理完成
示例值:FINISHED
+ 分账接收方列表 receivers array query 分账接收方列表,支持设置出资商户作为分账接收方,单次分账最多可有5个分账接收方。
参数名 变量 类型[长度限制] 必填 描述
分账接收方类型 type string[1,32] 枚举值:
MERCHANT_ID:商户号(mch_id或者sub_mch_id)
PERSONAL_OPENID:个人openid(由服务商的APPID转换得到)
PERSONAL_SUB_OPENID:个人sub_openid(由品牌主的APPID转换得到)
示例值:MERCHANT_ID
分账接收方账号 account string[1,64] 1、分账接收方类型为MERCHANT_ID时,分账接收方账号为商户号(mch_id或者sub_mch_id)。
2、分账接收方类型为PERSONAL_OPENID时,分账接收方账号为个人openid。
3、分账接收方类型为PERSONAL_SUB_OPENID时,分账接收方账号为个人sub_openid。
示例值:1900000109
分账金额 amount int 分账金额,单位为分,只能为整数,不能超过原订单支付金额及最大分账比例金额。
示例值:10
分账描述 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年05月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 : 高风险接收方
RECEIVER_REAL_NAME_NOT_VERIFIED : 接收方未实名
示例值:NO_RELATION
分账明细单号 detail_id string[1,64] 微信分账明细单号,每笔分账业务执行的明细单号,可与资金账单对账使用
示例值:36011111111111111111111

返回示例


200 Response
{
 "sub_mchid": "1900000109",
 "brand_mchid": "1900000108",
 "transaction_id": "4208450740201411110007820472",
 "out_order_no": "P20150806125346",
 "order_id": "6754760740201411110007865434"
}
                                

    http://2323weixin.qq.com
                                

错误码公共错误码

状态码 错误码 描述 解决方案
500 SYSTEM_ERROR 系统错误 系统异常,请使用相同参数稍后重新调用
400 INVALID_REQUEST 请求参数符合参数格式,但不符合业务规则 请根据返回的错误信息确认违反的业务规则
429 FREQUENCY_LIMITED 对同笔订单分账频率过高 请降低频率后重试
403 NO_AUTH 商户无权限 请开通商户号分账权限


技术咨询

文档反馈