# 请求分账回退
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:refundProfitSharing
已分账订单,在完成退款后,通过调用此接口,可将已分账的资金从分账接收方的账户回退给分账方。单笔退款单对单个分账接收方只能回退一次。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/retail/B2b/refundprofitsharing?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
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| out_trade_no | string | 是 | 订单 id。在B2b小程序中下单的订单 id |
| out_refund_no | string | 是 | 退款单 id。在B2b小程序中下单的退款单 id |
| payee_type | string | 是 | 退款分账方类型。同添加分账方时填入的内容 |
| payee_id | string | 是 | 退款分账方 id。同添加分账方时填入的内容 |
| mchid | string | 是 | 商户号 id。发起这笔订单的商户号 |
| refund_amt | number | 是 | 退款金额。退款金额,单位为分 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
# 4. 注意事项
- 目前单笔退款单,对单个收款方(之前分账时的分账接收方),只支持发起一次回退。
- 不支持回退给自己,分账回退出资商户不允许和接收商户相同
- 不支持“分账给个人”的分账单发起分账回退。
# 发起分账的支付单的退款规则说明
| 订单分账状态 | 申请退款金额 | 退款前提 | 退款出款账户 |
|---|---|---|---|
| 订单标记为需要分账 | 申请全额退款 | 1、需要先调“完成分账”接口,将订单剩余冻结资金从“待结算金额”账户全部解冻至“可提现金额”账户 2、“可提现金额”账户余额≥申请退款金额,支付单扣除手续费将在退款成功后返还 | “可提现金额”账户 |
| 申请部分退款 | 当申请退款金额≤订单未分账冻结金额,直接可退 | “待结算金额”账户 | |
| 1、当申请退款金额>订单未分账冻结金额,需要先调“完成分账”接口,将订单剩余冻结资金从“待结算金额”账户全部解冻至“可提现金额”账户 2、“可提现金额”账户余额≥申请退款金额,支付单扣除手续费将在退款成功后返还 | “可提现金额”账户 | ||
| 订单已完结分账 | 申请全额/部分退款 | “可提现金额”账户余额≥申请退款金额,支付单扣除手续费将在退款成功后返还 | “可提现金额”账户 |
# 5. 代码示例
请求示例
{
"out_trade_no": "40012891249207515929",
"out_refund_no": "4001289124357515929",
"payee_type": "PAYEE_TYPE_EXTERNAL_MERCHANT",
"payee_id": "165406451",
"mchid": "166321431"
}
返回示例
{
"errcode": 0,
"errmsg": "ok"
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 |
|---|---|
| 10044 | 分账回退金额超过分账时金额 |
| 10045 | 该退款单已发起过第三方分账回退 |
# 7. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请以实际调用情况为准。