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

请求分账回退API

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


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


注意:

• 分账回退以原分账单为依据,支持多次回退,申请回退总金额不能超过原分账单分给该接收方的金额。

• 此接口采用同步处理模式,即在接收到商户请求后,会实时返回处理结果。

• 退款和分账回退没有耦合,分账回退可以先于退款请求,也可以后于退款请求。

• 对同一个分账接收方最多能发起20次分账回退请求。

• 分账回退的时限是180天。

接口说明

适用对象:服务商

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

请求方式:POST


path 指该参数为路径参数

query 指该参数为URL参数

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


请求参数

参数名 变量 类型[长度限制] 必填 描述
子商户号 sub_mchid string[1,32] body 分账回退的接收商户,对应原分账出资的分账方商户,填写微信支付分配的商户号
示例值:1900000109
微信分账单号 order_id string[1,64] 二选一 body 微信分账单号,微信系统返回的唯一标识。
示例值: 3008450740201411110007820472
商户分账单号 out_order_no string[1,64] body 原发起分账请求时使用的商户系统内部的分账单号。微信分账单号与商户分账单号二选一填写。
示例值:P20150806125346
商户回退单号 out_return_no string[1,64] body 此回退单号是商户在自己后台生成的一个新的回退单号,在商户后台唯一,只能是数字、大小写字母_-|*@。
示例值:R20190516001
回退商户号 return_mchid string[1,32] body回退商户号只能填写原分账请求中接收分账的商户号
示例值:86693852
回退金额 amount int body 需要从分账接收方回退的金额,单位为分,只能为整数,不能超过原始分账单分出给该接收方的金额
示例值:10
回退描述 description string[1,80] body 分账回退的原因描述,将体现在资金账单和分账账单中
示例值:分账回退

请求示例


{
 "sub_mchid": "1900000109",
 "order_id": "3008450740201411110007820472",
 "out_return_no": "R20190516001",
 "return_mchid": "86693852",
 "amount": 10,
 "description": "分账回退"
}
    
{
JAVA示例代码
}
    

返回参数

参数名 变量 类型[长度限制] 必填 描述
子商户号 sub_mchid string[1,32] 分账回退的接收商户,对应原分账出资的分账方商户,填写微信支付分配的商户号。
示例值:1900000109
微信分账单号 order_id string[1,64] 微信分账单号,微信系统返回的唯一标识。
示例值: 3008450740201411110007820472
商户分账单号 out_order_no string[1,64] 商户系统内部的分账单号,在商户系统内部唯一(单次分账、多次分账、完结分账应使用不同的商户分账单号),同一分账单号多次请求等同一次,只能是数字、大小写字母_-|*@。
示例值:P20150806125346
商户回退单号 out_return_no string[1,64] 此回退单号是商户在自己后台生成的一个新的回退单号,在商户后台唯一 只能是数字、大小写字母_-*@ ,同一回退单号多次请求等同一次。
示例值:R20190516001
回退商户号 return_mchid string[1,32] 回退商户号只能填写原分账请求中接收分账的商户号。
示例值:86693852
回退金额 amount int 需要从分账接收方回退的金额,单位为分,只能为整数,不能超过原始分账单分出给该接收方的金额
示例值:10
微信回退单号 return_no string[1,64] 微信分账回退单号,微信系统返回的唯一标识
示例值:3008450740201411110007820472
回退结果 result string[1,32] 如果请求返回为处理中,则商户可以通过调用回退结果查询接口获取请求的最终处理结果,枚举值:
PROCESSING:处理中
SUCCESS:已成功
FAILED:已失败
如果返回为处理中,请勿变更商户回退单号,使用相同的参数再次发起分账回退,否则会出现资金风险 在处理中状态的回退单如果5天没有成功,会因为超时被设置为已失败
示例值:SUCCESS
失败原因 fail_reason string[1,32] 回退失败的原因,此字段仅回退结果为FAIL时存在,枚举值:
ACCOUNT_ABNORMAL:分账接收方账户异常
TIME_OUT_CLOSED:超时关单
示例值:TIME_OUT_CLOSED
完成时间 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

返回示例


200 Response
{
 "sub_mchid": "1900000109",
 "order_id": "3008450740201411110007820472",
 "out_order_no": "P20150806125346",
 "out_return_no": "R20190516001",
 "return_mchid": "86693852",
 "amount": 10,
 "return_no": "3008450740201411110007820472",
 "result": "SUCCESS",
 "fail_reason": "TIME_OUT_CLOSED",
 "finish_time": "2015-05-20T13:29:35.120+08:00"
}
                                

    http://2323weixin.qq.com
                                

错误码公共错误码

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


技术咨询

文档反馈