请求分账回退

更新时间:2023.09.25

订单已经分账,在退款时,可以先调此接口,将已分账的资金从分账接收方的账户回退给分账方,再发起退款。

注意:

  1. 分账回退以原分账单为依据,支持多次回退,申请回退总金额不能超过原分账单分给该接收方的金额。
  2. 此接口采用同步处理模式,即在接收到商户请求后,会实时返回处理结果。
  3. 商户类型的接收方,自动开通了分账回退,可以直接调接口回退。
  4. 分账订单的退款与分账回退并无强耦合。是否需要分账回退,可由平台决定。在二级商户余额充足的情况下,可以不发起回退,直接发起退款。
  5. 对同一笔分账单最多能发起20次分账回退请求。
  6. 分账回退不支持回退给个人。
  7. 分账回退的时限是180天。

# 接口说明

支持商户:
【平台商户】
请求方式:
【POST】/v3/ecommerce/profitsharing/returnorders
请求域名:
【主域名】
https://api.mch.weixin.qq.com
使用该域名将访问就近的接入点
【备域名】
https://api2.mch.weixin.qq.com
使用该域名将访问异地的接入点 ,指引点击查看

# 请求参数

    Header HTTP头参数
  • Authorization 必填 string
    请参考 签名认证 生成认证信息
  • Accept 必填 string
    请设置为 application/json
  • Content-Type 必填 string
    请设置为 application/json
    Body 包体参数
  • sub_mchid 必填 string
    【电商平台二级商户号】 分账回退的接收商户,对应原分账出资的电商平台二级商户,填写微信支付分配的商户号
  • order_id 选填 string(64)
    【微信分账单号】 微信分账单号,微信系统返回的唯一标识。微信分账单号和商户分账单号二选一填写
  • out_order_no 选填 string
    【商户分账单号】 商户系统内部的分账单号,在商户系统内部唯一(单次分账、多次分账、完结分账应使用不同的商户分账单号),同一分账单号多次请求等同一次。只能是数字、大小写字母_-|*@ 。微信分账单号和商户分账单号二选一填写
  • out_return_no 必填 string
    【商户回退单号】 此回退单号是商户在自己后台生成的一个新的回退单号,在商户后台唯一 只能是数字、大小写字母_-|*@ ,同一回退单号多次请求等同一次。
  • return_mchid 必填 string
    【回退商户号】 只能对原分账请求中成功分给商户接收方进行回退
  • amount 必填 integer
    【回退金额】 需要从分账接收方回退的金额,单位为分,只能为整数,不能超过原始分账单分出给该接收方的金额
  • description 必填 string(80)
    【回退描述】 分账回退的原因描述
  • transaction_id 选填 string(32)
    【微信订单号】 微信支付订单号,大于6个月的订单,必填

请求示例

POST

# 应答参数

    200OK
  • sub_mchid 必填 string
    【电商平台二级商户号】 分账回退的接收商户,对应原分账出资的电商平台二级商户,填写微信支付分配的商户号
  • order_id 必填 string
    【微信分账单号】 原发起分账请求时,微信返回的微信分账单号,与商户分账单号一一对应。 微信分账单号与商户分账单号二选一填写
  • out_order_no 必填 string
    【商户分账单号】 原发起分账请求时使用的商户后台系统的分账单号。 微信分账单号与商户分账单号二选一填写
  • out_return_no 必填 string
    【商户回退单号】 此回退单号是商户在自己后台生成的一个新的回退单号,在商户后台唯一 只能是数字、大小写字母_-|*@ ,同一回退单号多次请求等同一次。
  • return_mchid 必填 string
    【回退商户号】 只能对原分账请求中成功分给商户接收方进行回退
  • amount 必填 integer
    【回退金额】 需要从分账接收方回退的金额,单位为分,只能为整数,不能超过原始分账单分出给该接收方的金额
  • return_no 必填 string(64)
    【微信回退单号】 微信分账回退单号,微信系统返回的唯一标识
  • result 必填 string
    【回退结果】 如果请求返回为处理中,则商户可以通过调用回退结果查询接口获取请求的最终处理结果
    枚举值:
    PROCESSING:处理中
    SUCCESS:已成功
    FAILED:已失败
    注意:如果返回为处理中,请勿变更商户回退单号,使用相同的参数再次发起分账回退,否则会出现资金风险 在处理中状态的回退单如果5天没有成功,会因为超时被设置为已失败
  • fail_reason 选填 string
    【失败原因】 失败原因。包含以下枚举值:
    1. ACCOUNT_ABNORMAL : 原分账接收方账户异常
    2. TIME_OUT_CLOSED : 超时关单
    3. PAYER_ACCOUNT_ABNORMAL : 原分账分出方账户异常
  • finish_time 必填 string
    【完成时间】 分账回退完成时间,遵循RFC3339标准格式
  • transaction_id 必填 string(32)
    【微信订单号】 微信支付订单号

应答示例

200 OK

# 错误码

# 公共错误码

状态码 错误码 描述 解决方案
400 PARAM_ERROR 参数错误 请根据错误提示正确传入参数
400 INVALID_REQUEST HTTP 请求不符合微信支付 APIv3 接口规则 请参阅 接口规则
401 SIGN_ERROR 验证不通过 请参阅 签名常见问题
500 SYSTEM_ERROR 系统异常,请稍后重试 请稍后重试

# 业务错误码

状态码 错误码 描述 解决方案
400 INVALID_REQUEST 回退方不存在 请根据返回的错误信息确认违反的业务规则
400 INVALID_REQUEST 超过分账回退最大周期 请根据返回的错误信息确认违反的业务规则
400 PARAM_ERROR 订单号格式不正确 请使用正确的参数重新调用
403 NO_AUTH 回退方未开通分账回退功能 请先让回退方开通分账回退功能
403 NOT_ENOUGH 剩余可回退的金额不足 调整回退金额
429 FREQUENCY_LIMITED 商户发起分账回退的频率过高 请降低频率后重试
500 SYSTEM_ERROR 系统错误 系统异常,请使用相同参数稍后重新调用
反馈
咨询
目录