解冻剩余资金
更新时间:2025.09.29不需要进行分账的订单,可直接调用本接口将订单的金额全部解冻给本商户
调用分账接口后,需要解冻剩余资金时,调用本接口将剩余的分账金额全部解冻给本商户
此接口采用异步处理模式,即在接收到商户请求后,优先受理请求再异步处理,最终的分账结果可以通过查询分账接口获取
接口说明
支持商户:【普通商户】
请求方式:【POST】/v3/profitsharing/orders/unfreeze
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
Content-Type 必填 string
请设置为application/json
body 包体参数
transaction_id 必填 string(32)
【微信订单号】 微信支付订单号
out_order_no 必填 string(64)
【商户分账单号】 商户系统内部的分账单号,在商户系统内部唯一,同一分账单号多次请求等同一次。只能是数字、大小写字母_-|*@
description 必填 string(80)
【解冻剩余资金描述】 描述解冻剩余资金的原因
请求示例
POST
1curl -X POST \ 2 https://api.mch.weixin.qq.com/v3/profitsharing/orders/unfreeze \ 3 -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \ 4 -H "Accept: application/json" \ 5 -H "Content-Type: application/json" \ 6 -d '{ 7 "transaction_id" : "4208450740201411110007820472", 8 "out_order_no" : "P20150806125346", 9 "description" : "解冻全部剩余资金" 10 }' 11
需配合微信支付工具库 WXPayUtility 使用,请参考Java
1package com.java.demo; 2 3import com.java.utils.WXPayUtility; // 引用微信支付工具库,参考:https://pay.weixin.qq.com/doc/v3/merchant/4014931831 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 UnfreezeOrder { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "POST"; 28 private static String PATH = "/v3/profitsharing/orders/unfreeze"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/merchant/4013070756 32 UnfreezeOrder client = new UnfreezeOrder( 33 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/merchant/4013070756 34 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/merchant/4013053053 35 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 36 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/merchant/4013038816 37 "/path/to/wxp_pub.pem" // 微信支付公钥文件路径,本地文件路径 38 ); 39 40 UnfreezeOrderRequest request = new UnfreezeOrderRequest(); 41 request.transactionId = "4208450740201411110007820472"; 42 request.outOrderNo = "P20150806125346"; 43 request.description = "解冻全部剩余资金"; 44 try { 45 OrdersEntity 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 OrdersEntity run(UnfreezeOrderRequest request) { 55 String uri = PATH; 56 String reqBody = WXPayUtility.toJson(request); 57 58 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 59 reqBuilder.addHeader("Accept", "application/json"); 60 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 61 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo,privateKey, METHOD, uri, reqBody)); 62 reqBuilder.addHeader("Content-Type", "application/json"); 63 RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody); 64 reqBuilder.method(METHOD, requestBody); 65 Request httpRequest = reqBuilder.build(); 66 67 // 发送HTTP请求 68 OkHttpClient client = new OkHttpClient.Builder().build(); 69 try (Response httpResponse = client.newCall(httpRequest).execute()) { 70 String respBody = WXPayUtility.extractBody(httpResponse); 71 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 72 // 2XX 成功,验证应答签名 73 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 74 httpResponse.headers(), respBody); 75 76 // 从HTTP应答报文构建返回数据 77 return WXPayUtility.fromJson(respBody, OrdersEntity.class); 78 } else { 79 throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 80 } 81 } catch (IOException e) { 82 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 83 } 84 } 85 86 private final String mchid; 87 private final String certificateSerialNo; 88 private final PrivateKey privateKey; 89 private final String wechatPayPublicKeyId; 90 private final PublicKey wechatPayPublicKey; 91 92 public UnfreezeOrder(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 93 this.mchid = mchid; 94 this.certificateSerialNo = certificateSerialNo; 95 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 96 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 97 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 98 } 99 100 public static class UnfreezeOrderRequest { 101 @SerializedName("transaction_id") 102 public String transactionId; 103 104 @SerializedName("out_order_no") 105 public String outOrderNo; 106 107 @SerializedName("description") 108 public String description; 109 } 110 111 public static class OrdersEntity { 112 @SerializedName("transaction_id") 113 public String transactionId; 114 115 @SerializedName("out_order_no") 116 public String outOrderNo; 117 118 @SerializedName("order_id") 119 public String orderId; 120 121 @SerializedName("state") 122 public OrderStatus state; 123 124 @SerializedName("receivers") 125 public List<OrderReceiverDetail> receivers = new ArrayList<OrderReceiverDetail>(); 126 } 127 128 public enum OrderStatus { 129 @SerializedName("PROCESSING") 130 PROCESSING, 131 @SerializedName("FINISHED") 132 FINISHED 133 } 134 135 public static class OrderReceiverDetail { 136 @SerializedName("amount") 137 public Long amount; 138 139 @SerializedName("description") 140 public String description; 141 142 @SerializedName("type") 143 public ReceiverType type; 144 145 @SerializedName("account") 146 public String account; 147 148 @SerializedName("result") 149 public DetailStatus result; 150 151 @SerializedName("fail_reason") 152 public DetailFailReason failReason; 153 154 @SerializedName("create_time") 155 public String createTime; 156 157 @SerializedName("finish_time") 158 public String finishTime; 159 160 @SerializedName("detail_id") 161 public String detailId; 162 } 163 164 public enum ReceiverType { 165 @SerializedName("MERCHANT_ID") 166 MERCHANT_ID, 167 @SerializedName("PERSONAL_OPENID") 168 PERSONAL_OPENID 169 } 170 171 public enum DetailStatus { 172 @SerializedName("PENDING") 173 PENDING, 174 @SerializedName("SUCCESS") 175 SUCCESS, 176 @SerializedName("CLOSED") 177 CLOSED 178 } 179 180 public enum DetailFailReason { 181 @SerializedName("ACCOUNT_ABNORMAL") 182 ACCOUNT_ABNORMAL, 183 @SerializedName("NO_RELATION") 184 NO_RELATION, 185 @SerializedName("RECEIVER_HIGH_RISK") 186 RECEIVER_HIGH_RISK, 187 @SerializedName("RECEIVER_REAL_NAME_NOT_VERIFIED") 188 RECEIVER_REAL_NAME_NOT_VERIFIED, 189 @SerializedName("NO_AUTH") 190 NO_AUTH, 191 @SerializedName("RECEIVER_RECEIPT_LIMIT") 192 RECEIVER_RECEIPT_LIMIT, 193 @SerializedName("PAYER_ACCOUNT_ABNORMAL") 194 PAYER_ACCOUNT_ABNORMAL, 195 @SerializedName("INVALID_REQUEST") 196 INVALID_REQUEST 197 } 198 199} 200
需配合微信支付工具库 wxpay_utility 使用,请参考Go
1package main 2 3import ( 4 "bytes" 5 "demo/wxpay_utility" // 引用微信支付工具库,参考 https://pay.weixin.qq.com/doc/v3/merchant/4015119334 6 "encoding/json" 7 "fmt" 8 "net/http" 9 "net/url" 10 "time" 11) 12 13func main() { 14 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/merchant/4013070756 15 config, err := wxpay_utility.CreateMchConfig( 16 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/merchant/4013070756 17 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/merchant/4013053053 18 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 19 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/merchant/4013038816 20 "/path/to/wxp_pub.pem", // 微信支付公钥文件路径,本地文件路径 21 ) 22 if err != nil { 23 fmt.Println(err) 24 return 25 } 26 27 request := &UnfreezeOrderRequest{ 28 TransactionId: wxpay_utility.String("4208450740201411110007820472"), 29 OutOrderNo: wxpay_utility.String("P20150806125346"), 30 Description: wxpay_utility.String("解冻全部剩余资金"), 31 } 32 33 response, err := UnfreezeOrder(config, request) 34 if err != nil { 35 fmt.Printf("请求失败: %+v\n", err) 36 // TODO: 请求失败,根据状态码执行不同的处理 37 return 38 } 39 40 // TODO: 请求成功,继续业务逻辑 41 fmt.Printf("请求成功: %+v\n", response) 42} 43 44func UnfreezeOrder(config *wxpay_utility.MchConfig, request *UnfreezeOrderRequest) (response *OrdersEntity, err error) { 45 const ( 46 host = "https://api.mch.weixin.qq.com" 47 method = "POST" 48 path = "/v3/profitsharing/orders/unfreeze" 49 ) 50 51 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 52 if err != nil { 53 return nil, err 54 } 55 reqBody, err := json.Marshal(request) 56 if err != nil { 57 return nil, err 58 } 59 httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody)) 60 if err != nil { 61 return nil, err 62 } 63 httpRequest.Header.Set("Accept", "application/json") 64 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 65 httpRequest.Header.Set("Content-Type", "application/json") 66 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), reqBody) 67 if err != nil { 68 return nil, err 69 } 70 httpRequest.Header.Set("Authorization", authorization) 71 72 client := &http.Client{} 73 httpResponse, err := client.Do(httpRequest) 74 if err != nil { 75 return nil, err 76 } 77 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 78 if err != nil { 79 return nil, err 80 } 81 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 82 // 2XX 成功,验证应答签名 83 err = wxpay_utility.ValidateResponse( 84 config.WechatPayPublicKeyId(), 85 config.WechatPayPublicKey(), 86 &httpResponse.Header, 87 respBody, 88 ) 89 if err != nil { 90 return nil, err 91 } 92 response := &OrdersEntity{} 93 if err := json.Unmarshal(respBody, response); err != nil { 94 return nil, err 95 } 96 97 return response, nil 98 } else { 99 return nil, wxpay_utility.NewApiException( 100 httpResponse.StatusCode, 101 httpResponse.Header, 102 respBody, 103 ) 104 } 105} 106 107type UnfreezeOrderRequest struct { 108 TransactionId *string `json:"transaction_id,omitempty"` 109 OutOrderNo *string `json:"out_order_no,omitempty"` 110 Description *string `json:"description,omitempty"` 111} 112 113type OrdersEntity struct { 114 TransactionId *string `json:"transaction_id,omitempty"` 115 OutOrderNo *string `json:"out_order_no,omitempty"` 116 OrderId *string `json:"order_id,omitempty"` 117 State *OrderStatus `json:"state,omitempty"` 118 Receivers []OrderReceiverDetail `json:"receivers,omitempty"` 119} 120 121type OrderStatus string 122 123func (e OrderStatus) Ptr() *OrderStatus { 124 return &e 125} 126 127const ( 128 ORDERSTATUS_PROCESSING OrderStatus = "PROCESSING" 129 ORDERSTATUS_FINISHED OrderStatus = "FINISHED" 130) 131 132type OrderReceiverDetail struct { 133 Amount *int64 `json:"amount,omitempty"` 134 Description *string `json:"description,omitempty"` 135 Type *ReceiverType `json:"type,omitempty"` 136 Account *string `json:"account,omitempty"` 137 Result *DetailStatus `json:"result,omitempty"` 138 FailReason *DetailFailReason `json:"fail_reason,omitempty"` 139 CreateTime *time.Time `json:"create_time,omitempty"` 140 FinishTime *time.Time `json:"finish_time,omitempty"` 141 DetailId *string `json:"detail_id,omitempty"` 142} 143 144type ReceiverType string 145 146func (e ReceiverType) Ptr() *ReceiverType { 147 return &e 148} 149 150const ( 151 RECEIVERTYPE_MERCHANT_ID ReceiverType = "MERCHANT_ID" 152 RECEIVERTYPE_PERSONAL_OPENID ReceiverType = "PERSONAL_OPENID" 153) 154 155type DetailStatus string 156 157func (e DetailStatus) Ptr() *DetailStatus { 158 return &e 159} 160 161const ( 162 DETAILSTATUS_PENDING DetailStatus = "PENDING" 163 DETAILSTATUS_SUCCESS DetailStatus = "SUCCESS" 164 DETAILSTATUS_CLOSED DetailStatus = "CLOSED" 165) 166 167type DetailFailReason string 168 169func (e DetailFailReason) Ptr() *DetailFailReason { 170 return &e 171} 172 173const ( 174 DETAILFAILREASON_ACCOUNT_ABNORMAL DetailFailReason = "ACCOUNT_ABNORMAL" 175 DETAILFAILREASON_NO_RELATION DetailFailReason = "NO_RELATION" 176 DETAILFAILREASON_RECEIVER_HIGH_RISK DetailFailReason = "RECEIVER_HIGH_RISK" 177 DETAILFAILREASON_RECEIVER_REAL_NAME_NOT_VERIFIED DetailFailReason = "RECEIVER_REAL_NAME_NOT_VERIFIED" 178 DETAILFAILREASON_NO_AUTH DetailFailReason = "NO_AUTH" 179 DETAILFAILREASON_RECEIVER_RECEIPT_LIMIT DetailFailReason = "RECEIVER_RECEIPT_LIMIT" 180 DETAILFAILREASON_PAYER_ACCOUNT_ABNORMAL DetailFailReason = "PAYER_ACCOUNT_ABNORMAL" 181 DETAILFAILREASON_INVALID_REQUEST DetailFailReason = "INVALID_REQUEST" 182) 183
应答参数
200 OK
transaction_id 必填 string(32)
【微信订单号】 微信支付订单号
out_order_no 必填 string(64)
【商户分账单号】 请求分账时的商户分账单号
order_id 必填 string(64)
【微信分账单号】 微信分账单号,微信系统返回的唯一标识
state 必填 string
【分账单状态】 分账单状态(每个接收方的分账结果请查看receivers中的result字段)
可选取值
PROCESSING
: 处理中,非终态,分账结果存在非终态,可稍后再次查询,直到状态为FINISHED。FINISHED
: 分账完成,终态,仅代表分账动账执行完毕,每个接收方的分账结果请查看receivers中的result字段
receivers 必填 array[object]
【分账接收方列表】 分账接收方列表
属性 | |
amount 必填 integer 【分账金额】 分账金额,单位为分,只能为整数,不能超过原订单支付金额及最大分账比例金额 description 必填 string(80) 【解冻剩余资金描述】 描述解冻剩余资金的原因 type 必填 string 【接收方类型】 接收方类型 可选取值
account 必填 string(64) 【接收方账号】
result 必填 string 【分账结果】 分账结果 可选取值
fail_reason 选填 string 【分账失败原因】 分账失败原因,当分账结果result为CLOSED(已关闭)时,返回该字段,具体处理方案请参考分账失败处理指引。 可选取值
create_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秒。 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秒。 detail_id 必填 string(64) 【分账明细单号】 微信分账明细单号,每笔分账业务执行的明细单号,可与资金账单对账使用,对应资金账单中的“业务凭证号” |
应答示例
200 OK
1{ 2 "transaction_id" : "4208450740201411110007820472", 3 "out_order_no" : "P20150806125346", 4 "order_id" : "3008450740201411110007820472", 5 "state" : "FINISHED", 6 "receivers" : [ 7 { 8 "amount" : 100, 9 "description" : "分给商户1900000110", 10 "type" : "MERCHANT_ID", 11 "account" : "1900000109", 12 "result" : "SUCCESS", 13 "fail_reason" : "ACCOUNT_ABNORMAL", 14 "create_time" : "2015-05-20T13:29:35.120+08:00", 15 "finish_time" : "2015-05-20T13:29:35.120+08:00", 16 "detail_id" : "36011111111111111111111" 17 } 18 ] 19} 20
错误码
以下是本接口返回的错误码列表。详细错误码规则,请参考微信支付接口规则-错误码和错误提示