# 请求分账
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:createProfitSharingOrder
通过此接口发起分账请求,将结算后的资金分给分账接收方。(注意:结算完成的订单才能分账,而沙箱环境不走结算环境,建议用正式环境测试。)
单笔订单,单个分账接收方只允许发起一次。单笔订单只允许最多 45 个接收方,总分账比例金额不超过单笔订单总额的29%。
分账资金的冻结期默认是180天。从订单支付成功之日起,180天内需要发起分账,若180天内未发起分账,待分账资金将会自动解冻给分账方。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/retail/B2b/createprofitsharingorder?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用。
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:158
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| mchid | string | 是 | 子商户id。在B2b小程序中进件完成返回的子商户 id |
| out_trade_no | string | 是 | 支付单 id。在B2b小程序中下单的订单 id |
| profit_fee | number | 是 | 分账费用。单位:分,不超过支付单本身的金额 |
| receiver_type | string | 是 | 分账接收方类型。同添加分账方时填入的内容 |
| receiver_account | string | 是 | 分账接收方账号。同添加分账方时填入的内容 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 示例 | 说明 |
|---|---|---|---|
| errmsg | string | 错误码 | |
| errcode | number | ok | 错误信息 |
# 4. 注意事项
# 发起分账的支付单的退款规则说明
| 订单分账状态 | 申请退款金额 | 退款前提 | 退款出款账户 |
|---|---|---|---|
| 订单标记为需要分账 | 申请全额退款 | 1、需要先调“完成分账”接口,将订单剩余冻结资金从“待结算金额”账户全部解冻至“可提现金额”账户 2、“可提现金额”账户余额≥申请退款金额,支付单扣除手续费将在退款成功后返还 | “可提现金额”账户 |
| 申请部分退款 | 当申请退款金额≤订单未分账冻结金额,直接可退 | “待结算金额”账户 | |
| 1、当申请退款金额>订单未分账冻结金额,需要先调“完成分账”接口,将订单剩余冻结资金从“待结算金额”账户全部解冻至“可提现金额”账户 2、“可提现金额”账户余额≥申请退款金额,支付单扣除手续费将在退款成功后返还 | “可提现金额”账户 | ||
| 订单已完结分账 | 申请全额/部分退款 | “可提现金额”账户余额≥申请退款金额,支付单扣除手续费将在退款成功后返还 | “可提现金额”账户 |
# 5. 代码示例
请求示例
{
"mchid": "1654806452",
"out_trade_no": "400128912435668818922107515929",
"profit_fee": 100,
"receiver_type": "PAYEE_TYPE_EXTERNAL_MERCHANT",
"receiver_account": "1654806451"
}
返回示例
{
"errcode": 0,
"errmsg": "OK"
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| 10031 | 不存在对应的账单执行第三方分账 | 检查out_trade_no是否为对应商户号下交易成功的订单 |
| 10032 | 分账比例超过账单最大限制 | |
| 10034 | 请等待后重试 | |
| 10037 | 重复发起分账 |
# 7. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请以实际调用情况为准。