查询分账结果
更新时间:2025.09.29发起分账请求后,可调用此接口查询分账结果 。发起分账完结请求后,可调用此接口查询分账完结的结果。
接口说明
支持商户:【普通服务商】
请求方式:【GET】/v3/brand/profitsharing/orders
请求域名:【主域名】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)
【特约商户号】 订单收款方商户号,填写微信支付分配的商户号,可以是品牌主商户号,也可以是门店商户号
transaction_id 必填 string(32)
【微信订单号】 微信支付订单号
out_order_no 必填 string(64)
【商户分账单号】 请求分账时的商户分账单号
请求示例
GET
1curl -X GET \ 2 https://api.mch.weixin.qq.com/v3/brand/profitsharing/orders?sub_mchid=1900000109&transaction_id=4208450740201411110007820472&out_order_no=P20150806125346 \ 3 -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \ 4 -H "Accept: application/json" 5
需配合微信支付工具库 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 QueryOrder { 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/orders"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 32 QueryOrder client = new QueryOrder( 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 QueryOrderRequest request = new QueryOrderRequest(); 41 request.subMchid = "1900000109"; 42 request.transactionId = "4208450740201411110007820472"; 43 request.outOrderNo = "P20150806125346"; 44 try { 45 QueryOrderResponse response = client.run(request); 46 // TODO: 请求成功,继续业务逻辑 47 System.out.println(response); 48 } catch (WXPayUtility.ApiException e) { 49 // TODO: 请求失败,根据状态码执行不同的逻辑 50 e.printStackTrace(); 51 } 52 } 53 54 public QueryOrderResponse run(QueryOrderRequest request) { 55 String uri = PATH; 56 Map<String, Object> args = new HashMap<>(); 57 args.put("sub_mchid", request.subMchid); 58 args.put("transaction_id", request.transactionId); 59 args.put("out_order_no", request.outOrderNo); 60 String queryString = WXPayUtility.urlEncode(args); 61 if (!queryString.isEmpty()) { 62 uri = uri + "?" + queryString; 63 } 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, QueryOrderResponse.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 QueryOrder(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 QueryOrderRequest { 106 @SerializedName("sub_mchid") 107 @Expose(serialize = false) 108 public String subMchid; 109 110 @SerializedName("transaction_id") 111 @Expose(serialize = false) 112 public String transactionId; 113 114 @SerializedName("out_order_no") 115 @Expose(serialize = false) 116 public String outOrderNo; 117 } 118 119 public static class QueryOrderResponse { 120 @SerializedName("sub_mchid") 121 public String subMchid; 122 123 @SerializedName("transaction_id") 124 public String transactionId; 125 126 @SerializedName("out_order_no") 127 public String outOrderNo; 128 129 @SerializedName("order_id") 130 public String orderId; 131 132 @SerializedName("status") 133 public String status; 134 135 @SerializedName("receivers") 136 public List<ReceiverResultEntity> receivers = new ArrayList<ReceiverResultEntity>(); 137 138 @SerializedName("finish_amount") 139 public Long finishAmount; 140 141 @SerializedName("finish_description") 142 public String finishDescription; 143 } 144 145 public static class ReceiverResultEntity { 146 @SerializedName("type") 147 public String type; 148 149 @SerializedName("account") 150 public String account; 151 152 @SerializedName("amount") 153 public Long amount; 154 155 @SerializedName("description") 156 public String description; 157 158 @SerializedName("result") 159 public String result; 160 161 @SerializedName("finish_time") 162 public String finishTime; 163 164 @SerializedName("fail_reason") 165 public String failReason; 166 167 @SerializedName("detail_id") 168 public String detailId; 169 } 170 171} 172
需配合微信支付工具库 wxpay_utility 使用,请参考Go
1package main 2 3import ( 4 "demo/wxpay_utility" // 引用微信支付工具库,参考 https://pay.weixin.qq.com/doc/v3/partner/4015119446 5 "encoding/json" 6 "fmt" 7 "net/http" 8 "net/url" 9 "time" 10) 11 12func main() { 13 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 14 config, err := wxpay_utility.CreateMchConfig( 15 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340 16 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924 17 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 18 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589 19 "/path/to/wxp_pub.pem", // 微信支付公钥文件路径,本地文件路径 20 ) 21 if err != nil { 22 fmt.Println(err) 23 return 24 } 25 26 request := &QueryOrderRequest{ 27 SubMchid: wxpay_utility.String("1900000109"), 28 TransactionId: wxpay_utility.String("4208450740201411110007820472"), 29 OutOrderNo: wxpay_utility.String("P20150806125346"), 30 } 31 32 response, err := QueryOrder(config, request) 33 if err != nil { 34 fmt.Printf("请求失败: %+v\n", err) 35 // TODO: 请求失败,根据状态码执行不同的处理 36 return 37 } 38 39 // TODO: 请求成功,继续业务逻辑 40 fmt.Printf("请求成功: %+v\n", response) 41} 42 43func QueryOrder(config *wxpay_utility.MchConfig, request *QueryOrderRequest) (response *QueryOrderResponse, err error) { 44 const ( 45 host = "https://api.mch.weixin.qq.com" 46 method = "GET" 47 path = "/v3/brand/profitsharing/orders" 48 ) 49 50 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 51 if err != nil { 52 return nil, err 53 } 54 query := reqUrl.Query() 55 if request.SubMchid != nil { 56 query.Add("sub_mchid", *request.SubMchid) 57 } 58 if request.TransactionId != nil { 59 query.Add("transaction_id", *request.TransactionId) 60 } 61 if request.OutOrderNo != nil { 62 query.Add("out_order_no", *request.OutOrderNo) 63 } 64 reqUrl.RawQuery = query.Encode() 65 httpRequest, err := http.NewRequest(method, reqUrl.String(), nil) 66 if err != nil { 67 return nil, err 68 } 69 httpRequest.Header.Set("Accept", "application/json") 70 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 71 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), nil) 72 if err != nil { 73 return nil, err 74 } 75 httpRequest.Header.Set("Authorization", authorization) 76 77 client := &http.Client{} 78 httpResponse, err := client.Do(httpRequest) 79 if err != nil { 80 return nil, err 81 } 82 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 83 if err != nil { 84 return nil, err 85 } 86 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 87 // 2XX 成功,验证应答签名 88 err = wxpay_utility.ValidateResponse( 89 config.WechatPayPublicKeyId(), 90 config.WechatPayPublicKey(), 91 &httpResponse.Header, 92 respBody, 93 ) 94 if err != nil { 95 return nil, err 96 } 97 response := &QueryOrderResponse{} 98 if err := json.Unmarshal(respBody, response); err != nil { 99 return nil, err 100 } 101 102 return response, nil 103 } else { 104 return nil, wxpay_utility.NewApiException( 105 httpResponse.StatusCode, 106 httpResponse.Header, 107 respBody, 108 ) 109 } 110} 111 112type QueryOrderRequest struct { 113 SubMchid *string `json:"sub_mchid,omitempty"` 114 TransactionId *string `json:"transaction_id,omitempty"` 115 OutOrderNo *string `json:"out_order_no,omitempty"` 116} 117 118func (o *QueryOrderRequest) MarshalJSON() ([]byte, error) { 119 type Alias QueryOrderRequest 120 a := &struct { 121 SubMchid *string `json:"sub_mchid,omitempty"` 122 TransactionId *string `json:"transaction_id,omitempty"` 123 OutOrderNo *string `json:"out_order_no,omitempty"` 124 *Alias 125 }{ 126 // 序列化时移除非 Body 字段 127 SubMchid: nil, 128 TransactionId: nil, 129 OutOrderNo: nil, 130 Alias: (*Alias)(o), 131 } 132 return json.Marshal(a) 133} 134 135type QueryOrderResponse struct { 136 SubMchid *string `json:"sub_mchid,omitempty"` 137 TransactionId *string `json:"transaction_id,omitempty"` 138 OutOrderNo *string `json:"out_order_no,omitempty"` 139 OrderId *string `json:"order_id,omitempty"` 140 Status *string `json:"status,omitempty"` 141 Receivers []ReceiverResultEntity `json:"receivers,omitempty"` 142 FinishAmount *int64 `json:"finish_amount,omitempty"` 143 FinishDescription *string `json:"finish_description,omitempty"` 144} 145 146type ReceiverResultEntity struct { 147 Type *string `json:"type,omitempty"` 148 Account *string `json:"account,omitempty"` 149 Amount *int64 `json:"amount,omitempty"` 150 Description *string `json:"description,omitempty"` 151 Result *string `json:"result,omitempty"` 152 FinishTime *time.Time `json:"finish_time,omitempty"` 153 FailReason *string `json:"fail_reason,omitempty"` 154 DetailId *string `json:"detail_id,omitempty"` 155} 156
应答参数
200 OK
sub_mchid 必填 string(32)
【特约商户号】 订单收款方商户号,填写微信支付分配的商户号,可以是品牌主商户号,也可以是门店商户号
transaction_id 必填 string(32)
【微信订单号】 微信支付订单号
out_order_no 必填 string(64)
【商户分账单号】 请求分账时的商户分账单号
order_id 必填 string(64)
【微信分账单号】 微信分账单号,微信系统返回的唯一标识
status 必填 string(32)
【分账单状态】 可选取值:
PROCESSING: 处理中,非终态,分账结果存在非终态,可稍后再次查询,直到状态为FINISHED。
FINISHED: 分账完成,终态,仅代表分账动账执行完毕,每个接收方的分账结果请查看receivers中的result字段
receivers 必填 array[object]
【分账接收方列表】 分账接收方列表
属性 | |
type 必填 string(32) 【接收方类型】
account 必填 string(64) 【接收方账号】
amount 必填 integer 【分账金额】 分账金额,单位为分,只能为整数 description 必填 string(80) 【分账描述】 分账的原因描述,会在查询分账结果接口和分账账单中原样返回 result 必填 string(32) 【分账结果】
finish_time 必填 string 【分账完成时间】 分账完成时间,需遵循 RFC3339标准格式:yyyy-MM-DDTHH:mm:ss+TIMEZONE。yyyy-MM-DD 表示年月日;T 字符用于分隔日期和时间部分;HH:mm:ss 表示具体的时分秒;TIMEZONE 表示时区(例如,+08:00 对应东八区时间,即北京时间)。示例:2015-05-20T13:29:35+08:00 表示北京时间2015年5月20日13点29分35秒。 fail_reason 选填 string(64) 【分账失败原因】 分账失败原因,当分账结果result为CLOSED(已关闭)时,返回该字段,具体处理方案请参考分账失败处理指引。
detail_id 必填 string(64) 【分账明细单号】 微信分账明细单号,每笔分账业务执行的明细单号,可与资金账单对账使用,对应资金账单中的“业务凭证号” |
finish_amount 选填 integer
【分账完结金额】 分账完结的分账金额,单位为分, 仅当查询分账完结的执行结果时,存在本字段
finish_description 选填 string(80)
【分账完结描述】 分账完结的原因描述,仅当查询分账完结的执行结果时,存在本字段
应答示例
200 OK
1{ 2 "sub_mchid" : "1900000109", 3 "transaction_id" : "4208450740201411110007820472", 4 "out_order_no" : "P20150806125346", 5 "order_id" : "3008450740201411110007820472", 6 "status" : "FINISHED", 7 "receivers" : [ 8 { 9 "type" : "MERCHANT_ID", 10 "account" : "1900000109", 11 "amount" : 10, 12 "description" : "分帐1900000110", 13 "result" : "SUCCESS", 14 "finish_time" : "2015-05-20T13:29:35.120+08:00", 15 "fail_reason" : "NO_RELATION", 16 "detail_id" : "36011111111111111111111" 17 } 18 ], 19 "finish_amount" : 100, 20 "finish_description" : "分账完结" 21} 22
错误码
以下是本接口返回的错误码列表。详细错误码规则,请参考微信支付接口规则-错误码和错误提示