适用对象:服务商
请求URL:https://api.mch.weixin.qq.com/v3/profitsharing/return-orders/{out_return_no}
请求方式:GET
path 指该参数为路径参数
query 指该参数为URL参数
body 指该参数需在请求JSON传参
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
子商户号 | sub_mchid | string[1,32] | 是 | query分账回退的接收商户,对应原分账出资的分账方商户,填写微信支付分配的商户号 示例值:1900000109 |
商户回退单号 | out_return_no | string[1,64] | 是 | path调用回退接口提供的商户系统内部的回退单号 示例值:R20190516001 |
商户分账单号 | out_order_no | string[1,64] | 是 | query原发起分账请求时使用的商户系统内部的分账单号 示例值:P20190806125346 |
https://api.mch.weixin.qq.com/v3/profitsharing/return-orders/R20190516001?sub_mchid=1900000109&out_order_no=P20190806125346
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
子商户号 | 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_id | string[1, 64] | 是 | 微信分账回退单号,微信支付系统返回的唯一标识 示例值:3008450740201411110007820472 |
回退商户号 | return_mchid | string[1, 32] | 是 | 只能对原分账请求中成功分给商户接收方进行回退 示例值:86693852 |
回退金额 | amount | int | 是 | 需要从分账接收方回退的金额,单位为分,只能为整数 示例值:10 |
回退描述 | description | string[1, 80] | 是 | 分账回退的原因描述 示例值:用户退款 |
回退结果 | result | string[1, 32] | 是 | 如果请求返回为处理中,则商户可以通过调用回退结果查询接口获取请求的最终处理结果。如果查询到回退结果在处理中,请勿变更商户回退单号,使用相同的参数再次发起分账回退,否则会出现资金风险。在处理中状态的回退单如果5天没有成功,会因为超时被设置为已失败。 枚举值: PROCESSING:处理中 SUCCESS:已成功 FAILED:已失败 示例值:SUCCESS |
失败原因 | fail_reason | string[1, 64] | 否 | 失败原因。包含以下枚举值: ACCOUNT_ABNORMAL:原分账接收方账户异常 TIME_OUT_CLOSED:超时关单 PAYER_ACCOUNT_ABNORMAL:原分账分出方账户异常 INVALID_REQUEST: 描述参数设置失败 示例值:TIME_OUT_CLOSED |
创建时间 | create_time | string[1, 64] | 是 | 分账回退创建时间,遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2015-05-20T13:29:35+08:00 |
完成时间 | finish_time | string[1, 64] | 是 | 分账回退完成时间,遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2015-05-20T13:29:35+08:00 |
{
"sub_mchid": "1900000109",
"order_id": "3008450740201411110007820472",
"out_order_no": "P20150806125346",
"out_return_no": "R20190516001",
"return_id": "3008450740201411110007820472",
"return_mchid": "86693852",
"amount": 10,
"description": "用户退款",
"result": "SUCCESS",
"fail_reason": "TIME_OUT_CLOSED",
"create_time": "2015-05-20T13:29:35+08:00",
"finish_time": "2015-05-20T13:29:35+08:00"
}
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
500 | SYSTEM_ERROR | 系统错误 | 系统异常,请使用相同参数稍后重新调用 |
400 | PARAM_ERROR | 商户号未设置 | 请使用正确的参数重新调用 |
429 | RATELIMIT_EXCEED | 商户发起分账回退查询的频率过高 | 请降低频率后重试 |
404 | RESOURCE_NOT_EXISTS | 记录不存在 | 请检查请求的单号是否正确 |