查询分账回退结果

更新时间:2024.11.05

商户需要核实回退结果,可调用此接口查询回退结果。

注意

  1. 如果分账回退接口返回状态为处理中,可调用此接口查询回退结果

接口说明

支持商户:【普通服务商】

请求方式:【GET】/v3/profitsharing/return-orders/{out_return_no}

请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点

     【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看

请求参数

Header HTTP头参数

Authorization  必填 string

请参考签名认证生成认证信息


Accept  必填 string

请设置为application/json


path 路径参数

out_return_no  必填 string(64)

【商户回退单号】调用回退接口提供的商户系统内部的回退单号


query 查询参数

sub_mchid  选填 string(32)

【子商户号】分账回退的接收商户,对应原分账出资的分账方商户,填写微信支付分配的商户号。(直连商户不需要,服务商需要)


out_order_no  必填 string(64)

【商户分账单号】原发起分账请求时使用的商户系统内部的分账单号

请求示例

GET

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/profitsharing/return-orders/R20190516001?sub_mchid=1900000109&out_order_no=P20190806125346 \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" 
5

应答参数

200 OK

sub_mchid  选填 string(32)

【子商户号】参考请求参数


order_id  必填 string(64)

【微信分账单号】微信分账单号,微信系统返回的唯一标识


out_order_no  必填 string(64)

【商户分账单号】商户系统内部的分账单号,在商户系统内部唯一,同一分账单号多次请求等同一次


out_return_no  必填 string(64)

【商户回退单号】调用回退接口提供的商户系统内部的回退单号


return_id  必填 string(64)

【微信回退单号】微信分账回退单号,微信系统返回的唯一标识


return_mchid  必填 string(32)

【回退商户号】只能对原分账请求中成功分给商户接收方进行回退


amount  必填 integer

【回退金额】需要从分账接收方回退的金额,单位为分,只能为整数


description  必填 string(80)

【回退描述】分账回退的原因描述


result  必填 string

【回退结果】如果请求返回为处理中,则商户可以通过调用回退结果查询接口获取请求的最终处理结果。如果查询到回退结果在处理中,请勿变更商户回退单号,使用相同的参数再次发起分账回退,否则会出现资金风险。在处理中状态的回退单如果5天没有成功,会因为超时被设置为已失败

可选取值:

  • PROCESSING: 处理中

  • SUCCESS: 已成功

  • FAILED: 已失败


fail_reason  选填 string

【失败原因】失败原因

可选取值:

  • ACCOUNT_ABNORMAL: 原分账接收方账户异常

  • BALANCE_NOT_ENOUGH: 余额不足

  • TIME_OUT_CLOSED: 超时关单

  • PAYER_ACCOUNT_ABNORMAL: 原分账分出方账户异常

  • INVALID_REQUEST: 描述参数设置失败


create_time  必填 string

【创建时间】分账回退创建时间,遵循RFC3339标准格式


finish_time  必填 string

【完成时间】分账回退完成时间,遵循RFC3339标准格式

应答示例

200 OK

1{
2  "sub_mchid" : "1900000109",
3  "order_id" : "3008450740201411110007820472",
4  "out_order_no" : "P20150806125346",
5  "out_return_no" : "R20190516001",
6  "return_id" : "3008450740201411110007820472",
7  "return_mchid" : "86693852",
8  "amount" : 10,
9  "description" : "用户退款",
10  "result" : "PROCESSING",
11  "fail_reason" : "ACCOUNT_ABNORMAL",
12  "create_time" : "2015-05-20T13:29:35.120+08:00",
13  "finish_time" : "2015-05-20T13:29:35.120+08:00"
14}
15

 

错误码

公共错误码

状态码

错误码

描述

解决方案

400

PARAM_ERROR

参数错误

请根据错误提示正确传入参数

400

INVALID_REQUEST

HTTP 请求不符合微信支付 APIv3 接口规则

请参阅 接口规则

401

SIGN_ERROR

验证不通过

请参阅 签名常见问题

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后重试

业务错误码

状态码

错误码

描述

解决方案

400

PARAM_ERROR

商户号未设置

请使用正确的参数重新调用

404

RESOURCE_NOT_EXISTS

记录不存在

请检查请求的单号是否正确

429

FREQUENCY_LIMITED

商户发起分账回退查询的频率过高

请降低频率后重试

500

SYSTEM_ERROR

系统错误

系统异常,请使用相同参数稍后重新调用

 

 

反馈
咨询
目录
置顶