请求分账回退API
更新时间:2023.08.16如果订单已经分账,在退款时,可以先调此接口,将已分账的资金从分账接收方的账户回退给分账方,再发起退款。
- 分账回退以原分账单为依据,支持多次回退,申请回退总金额不能超过原分账单分给该接收方的金额
- 此接口采用同步处理模式,即在接收到商户请求后,会实时返回处理结果
- 对同一笔分账单最多能发起20次分账回退请求
- 退款和分账回退没有耦合,分账回退可以先于退款请求,也可以后于退款请求
- 此功能需要接收方在商户平台-交易中心-分账-分账接收设置下,开启同意分账回退后,才能使用
- 不支持针对“分账到零钱”的分账单发起分账回退。
- 分账回退的时限是180天。
# 接口说明
支持商户:
【普通服务商】
请求方式:
【POST】/v3/profitsharing/return-orders
请求域名:
【主域名】
https://api.mch.weixin.qq.com
使用该域名将访问就近的接入点【备域名】
https://api2.mch.weixin.qq.com
使用该域名将访问异地的接入点 ,指引点击查看
# 请求参数
- Authorization 必填请参考 签名认证 生成认证信息
- Accept 必填请设置为
application/json
- Content-Type 必填请设置为
application/json
Header HTTP头参数
- sub_mchid 选填【子商户号】 分账回退的接收商户,对应原分账出资的分账方商户,填写微信支付分配的商户号。(直连商户不需要,服务商需要)
- order_id 选填【微信分账单号】 微信分账单号,微信系统返回的唯一标识。微信分账单号和商户分账单号二选一填写
- out_order_no 选填【商户分账单号】 商户系统内部的分账单号,在商户系统内部唯一,同一分账单号多次请求等同一次。微信分账单号和商户分账单号二选一填写 取值范围:[0-9a-zA-Z_*@-]
- out_return_no 必填【商户回退单号】 此回退单号是商户在自己后台生成的一个新的回退单号,在商户后台唯一
- return_mchid 必填【回退商户号】 分账回退的出资商户,只能对原分账请求中成功分给商户接收方进行回退
- amount 必填【回退金额】 需要从分账接收方回退的金额,单位为分,只能为整数,不能超过原始分账单分出给该接收方的金额
- description 必填【回退描述】 分账回退的原因描述
Body 包体参数
请求示例
POST
# 应答参数
- sub_mchid 选填【子商户号】 参考请求参数
- order_id 必填【微信分账单号】 微信分账单号,微信系统返回的唯一标识
- out_order_no 必填【商户分账单号】 商户系统内部的分账单号,在商户系统内部唯一,同一分账单号多次请求等同一次
- out_return_no 必填【商户回退单号】 调用回退接口提供的商户系统内部的回退单号
- return_id 必填【微信回退单号】 微信分账回退单号,微信系统返回的唯一标识
- return_mchid 必填【回退商户号】 只能对原分账请求中成功分给商户接收方进行回退
- amount 必填【回退金额】 需要从分账接收方回退的金额,单位为分,只能为整数
- description 必填【回退描述】 分账回退的原因描述
- result 必填【回退结果】 如果请求返回为处理中,则商户可以通过调用回退结果查询接口获取请求的最终处理结果。如果查询到回退结果在处理中,请勿变更商户回退单号,使用相同的参数再次发起分账回退,否则会出现资金风险。在处理中状态的回退单如果5天没有成功,会因为超时被设置为已失败
可选取值:PROCESSING
: 处理中SUCCESS
: 已成功FAILED
: 已失败
- fail_reason 选填【失败原因】 失败原因
可选取值:ACCOUNT_ABNORMAL
: 原分账接收方账户异常BALANCE_NOT_ENOUGH
: 余额不足TIME_OUT_CLOSED
: 超时关单PAYER_ACCOUNT_ABNORMAL
: 原分账分出方账户异常INVALID_REQUEST
: 描述参数设置失败
- create_time 必填【创建时间】 分账回退创建时间,遵循RFC3339标准格式
- finish_time 必填【完成时间】 分账回退完成时间,遵循RFC3339标准格式
200OK
应答示例
200 OK
# 错误码
# 公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
# 业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | INVALID_REQUEST | 回退方不存在 | 请根据返回的错误信息确认违反的业务规则 |
400 | PARAM_ERROR | 订单号格式不正确 | 请使用正确的参数重新调用 |
403 | NO_AUTH | 回退方未开通分账回退功能 | 请先让回退方开通分账回退功能 |
429 | FREQUENCY_LIMITED | 商户发起分账回退的频率过高 | 请降低频率后重试 |
500 | SYSTEM_ERROR | 系统错误 | 系统异常,请使用相同参数稍后重新调用 |
文档是否有帮助