查询分账回退结果

更新时间:2025.08.21

商户需要核实回退结果,可调用此接口查询回退结果。如果分账回退接口返回状态为处理中,可调用此接口查询回退结果

接口说明

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

请求方式:【GET】/v3/brand/profitsharing/returnorders

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

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

请求参数

Header  HTTP头参数

 Authorization  必填 string

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


 Accept  必填 string

请设置为application/json


query  查询参数

 sub_mchid  必填   string(32)

【子商户号】 分账回退的接收商户,对应原分账出资的分账方商户,填写微信支付分配的商户号


 out_return_no  必填   string(64)

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


 order_id  选填   string(64)

【微信分账单号】 原发起分账请求时,微信返回的微信分账单号,与商户分账单号一一对应。 微信分账单号与商户分账单号二选一填写


 out_order_no  选填   string(64)

【商户分账单号】 原发起分账请求时使用的商户系统内部的分账单号。微信分账单号与商户分账单号二选一填写

请求示例

Java
Go
curl

需配合微信支付工具库 WXPayUtility 使用,请参考 Java 

1package com.java.demo;
2
3import com.java.utils.WXPayUtility; // 引用微信支付工具库,参考:https://pay.weixin.qq.com/doc/v3/partner/4014985777
4
5import com.google.gson.annotations.SerializedName;
6import com.google.gson.annotations.Expose;
7import okhttp3.MediaType;
8import okhttp3.OkHttpClient;
9import okhttp3.Request;
10import okhttp3.RequestBody;
11import okhttp3.Response;
12
13import java.io.IOException;
14import java.io.UncheckedIOException;
15import java.security.PrivateKey;
16import java.security.PublicKey;
17import java.util.ArrayList;
18import java.util.HashMap;
19import java.util.List;
20import java.util.Map;
21
22/**
23 * 查询分账回退结果
24 */
25public class QueryReturnOrder {
26  private static String HOST = "https://api.mch.weixin.qq.com";
27  private static String METHOD = "GET";
28  private static String PATH = "/v3/brand/profitsharing/returnorders";
29
30  public static void main(String[] args) {
31    // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340
32    QueryReturnOrder client = new QueryReturnOrder(
33      "19xxxxxxxx",                    // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340
34      "1DDE55AD98Exxxxxxxxxx",         // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924
35      "/path/to/apiclient_key.pem",    // 商户API证书私钥文件路径,本地文件路径
36      "PUB_KEY_ID_xxxxxxxxxxxxx",      // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589
37      "/path/to/wxp_pub.pem"           // 微信支付公钥文件路径,本地文件路径
38    );
39
40    QueryReturnOrderRequest request = new QueryReturnOrderRequest();
41    request.subMchid = "1900000109";
42    request.outReturnNo = "R20190516001";
43    request.orderId = "4208450740201411110007820472";
44    request.outOrderNo = "P20190806125346";
45    try {
46      QueryReturnOrderResponse response = client.run(request);
47
48      // TODO: 请求成功,继续业务逻辑
49      System.out.println(response);
50    } catch (WXPayUtility.ApiException e) {
51      // TODO: 请求失败,根据状态码执行不同的逻辑
52      e.printStackTrace();
53    }
54  }
55
56  public QueryReturnOrderResponse run(QueryReturnOrderRequest request) {
57    String uri = PATH;
58    Map<String, Object> args = new HashMap<>();
59    args.put("sub_mchid", request.subMchid);
60    args.put("out_return_no", request.outReturnNo);
61    args.put("order_id", request.orderId);
62    args.put("out_order_no", request.outOrderNo);
63    uri = uri + "?" + WXPayUtility.urlEncode(args);
64
65    Request.Builder reqBuilder = new Request.Builder().url(HOST + uri);
66    reqBuilder.addHeader("Accept", "application/json");
67    reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId);
68    reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo, privateKey, METHOD, uri, null));
69    reqBuilder.method(METHOD, null);
70    Request httpRequest = reqBuilder.build();
71
72    // 发送HTTP请求
73    OkHttpClient client = new OkHttpClient.Builder().build();
74    try (Response httpResponse = client.newCall(httpRequest).execute()) {
75      String respBody = WXPayUtility.extractBody(httpResponse);
76      if (httpResponse.code() >= 200 && httpResponse.code() < 300) {
77        // 2XX 成功,验证应答签名
78        WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey,
79            httpResponse.headers(), respBody);
80
81        // 从HTTP应答报文构建返回数据
82        return WXPayUtility.fromJson(respBody, QueryReturnOrderResponse.class);
83      } else {
84        throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers());
85      }
86    } catch (IOException e) {
87      throw new UncheckedIOException("Sending request to " + uri + " failed.", e);
88    }
89  }
90
91  private final String mchid;
92  private final String certificateSerialNo;
93  private final PrivateKey privateKey;
94  private final String wechatPayPublicKeyId;
95  private final PublicKey wechatPayPublicKey;
96
97  public QueryReturnOrder(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) {
98    this.mchid = mchid;
99    this.certificateSerialNo = certificateSerialNo;
100    this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath);
101    this.wechatPayPublicKeyId = wechatPayPublicKeyId;
102    this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath);
103  }
104
105  public static class QueryReturnOrderRequest {
106    @SerializedName("sub_mchid")
107    @Expose(serialize = false)
108    public String subMchid;
109  
110    @SerializedName("out_return_no")
111    @Expose(serialize = false)
112    public String outReturnNo;
113  
114    @SerializedName("order_id")
115    @Expose(serialize = false)
116    public String orderId;
117  
118    @SerializedName("out_order_no")
119    @Expose(serialize = false)
120    public String outOrderNo;
121  }
122  
123  public static class QueryReturnOrderResponse {
124    @SerializedName("sub_mchid")
125    public String subMchid;
126  
127    @SerializedName("order_id")
128    public String orderId;
129  
130    @SerializedName("out_order_no")
131    public String outOrderNo;
132  
133    @SerializedName("out_return_no")
134    public String outReturnNo;
135  
136    @SerializedName("return_no")
137    public String returnNo;
138  
139    @SerializedName("return_mchid")
140    public String returnMchid;
141  
142    @SerializedName("amount")
143    public Long amount;
144  
145    @SerializedName("result")
146    public String result;
147  
148    @SerializedName("fail_reason")
149    public String failReason;
150  
151    @SerializedName("finish_time")
152    public String finishTime;
153  }
154  
155}
156

应答参数

200 OK

 sub_mchid  必填   string

【子商户号】 分账回退的接收商户,对应原分账出资的分账方商户,填写微信支付分配的商户号


 order_id  必填   string

【微信分账单号】 原发起分账请求时,微信返回的微信分账单号,与商户分账单号一一对应。


 out_order_no  必填   string

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


 out_return_no  必填   string

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


 return_no  必填   string

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


 return_mchid  必填   string

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


 amount  必填   integer

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


 result  必填   string

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

  • PROCESSING:处理中 

  • SUCCESS:已成功 

  • FAIL:已失败 


 fail_reason  选填   string

【失败原因】 失败原因。包含以下枚举值:

  1. ACCOUNT_ABNORMAL : 原分账接收方账户异常

  2. TIME_OUT_CLOSED : 超时关单

  3. PAYER_ACCOUNT_ABNORMAL : 原分账分出方账户异常

  4. INVALID_REQUEST : 描述参数设置失败


 finish_time  必填   string

【完成时间】 分账回退完成时间,遵循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秒。

应答示例

200 OK

1{
2  "sub_mchid" : "1900000109",
3  "order_id" : "3008450740201411110007820472",
4  "out_order_no" : "P20150806125346",
5  "out_return_no" : "R20190516001",
6  "return_no" : "3008450740201411110007820472",
7  "return_mchid" : "86693852",
8  "amount" : 10,
9  "result" : "SUCCESS",
10  "fail_reason" : "TIME_OUT_CLOSED",
11  "finish_time" : "2015-05-20T13:29:35.120+08:00"
12}
13

 

错误码

公共错误码

状态码

错误码

描述

解决方案

400

PARAM_ERROR

参数错误

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

400

INVALID_REQUEST

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

请参阅 接口规则

401

SIGN_ERROR

验证不通过

请参阅 签名常见问题

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后重试

 

 

更多技术问题
技术咨询
反馈
咨询
目录
置顶