查询二级商户账户实时余额
更新时间:2024.11.04收付通平台通过此接口可以查询二级商户账户余额信息。
接口说明
支持商户:【平台商户】
请求方式:【GET】/v3/ecommerce/fund/balance/{sub_mchid}
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
path 路径参数
sub_mchid 必填 string(32)
【二级商户号】收付通平台二级商户号,由微信支付生成并下发
query 查询参数
account_type 选填 string
【二级商户账户类型】二级商户账户类型
可选取值:
BASIC
: 基本账户
FEES
: 手续费账户
OPERATION
: 运营账户
DEPOSIT
: 保证金账户
请求示例
GET
1curl -X GET \ 2 https://api.mch.weixin.qq.com/v3/ecommerce/fund/balance/1900000109?account_type=BASIC \ 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 * 查询二级商户账户实时余额API 24 */ 25public class QueryECommerceBalance { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "GET"; 28 private static String PATH = "/v3/ecommerce/fund/balance/{sub_mchid}"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 32 QueryECommerceBalance client = new QueryECommerceBalance( 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 QueryECommerceBalanceRequest request = new QueryECommerceBalanceRequest(); 41 request.subMchid = "1900000109"; 42 request.accountType = QueryEcommerceBalanceAccountType.BASIC; 43 try { 44 ECommerceBalance response = client.run(request); 45 // TODO: 请求成功,继续业务逻辑 46 System.out.println(response); 47 } catch (WXPayUtility.ApiException e) { 48 // TODO: 请求失败,根据状态码执行不同的逻辑 49 e.printStackTrace(); 50 } 51 } 52 53 public ECommerceBalance run(QueryECommerceBalanceRequest request) { 54 String uri = PATH; 55 uri = uri.replace("{sub_mchid}", WXPayUtility.urlEncode(request.subMchid)); 56 Map<String, Object> args = new HashMap<>(); 57 args.put("account_type", request.accountType); 58 String queryString = WXPayUtility.urlEncode(args); 59 if (!queryString.isEmpty()) { 60 uri = uri + "?" + queryString; 61 } 62 63 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 64 reqBuilder.addHeader("Accept", "application/json"); 65 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 66 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo, privateKey, METHOD, uri, null)); 67 reqBuilder.method(METHOD, null); 68 Request httpRequest = reqBuilder.build(); 69 70 // 发送HTTP请求 71 OkHttpClient client = new OkHttpClient.Builder().build(); 72 try (Response httpResponse = client.newCall(httpRequest).execute()) { 73 String respBody = WXPayUtility.extractBody(httpResponse); 74 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 75 // 2XX 成功,验证应答签名 76 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 77 httpResponse.headers(), respBody); 78 79 // 从HTTP应答报文构建返回数据 80 return WXPayUtility.fromJson(respBody, ECommerceBalance.class); 81 } else { 82 throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 83 } 84 } catch (IOException e) { 85 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 86 } 87 } 88 89 private final String mchid; 90 private final String certificateSerialNo; 91 private final PrivateKey privateKey; 92 private final String wechatPayPublicKeyId; 93 private final PublicKey wechatPayPublicKey; 94 95 public QueryECommerceBalance(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 96 this.mchid = mchid; 97 this.certificateSerialNo = certificateSerialNo; 98 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 99 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 100 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 101 } 102 103 public static class QueryECommerceBalanceRequest { 104 @SerializedName("sub_mchid") 105 @Expose(serialize = false) 106 public String subMchid; 107 108 @SerializedName("account_type") 109 @Expose(serialize = false) 110 public QueryEcommerceBalanceAccountType accountType; 111 } 112 113 public static class ECommerceBalance { 114 @SerializedName("sub_mchid") 115 public String subMchid; 116 117 @SerializedName("available_amount") 118 public Long availableAmount; 119 120 @SerializedName("pending_amount") 121 public Long pendingAmount; 122 123 @SerializedName("account_type") 124 public QueryEcommerceBalanceAccountType accountType; 125 } 126 127 public enum QueryEcommerceBalanceAccountType { 128 @SerializedName("BASIC") 129 BASIC, 130 @SerializedName("FEES") 131 FEES, 132 @SerializedName("OPERATION") 133 OPERATION, 134 @SerializedName("DEPOSIT") 135 DEPOSIT 136 } 137 138} 139
需配合微信支付工具库 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 "strings" 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 := &QueryECommerceBalanceRequest{ 27 SubMchid: wxpay_utility.String("1900000109"), 28 AccountType: QUERYECOMMERCEBALANCEACCOUNTTYPE_BASIC.Ptr(), 29 } 30 31 response, err := QueryECommerceBalance(config, request) 32 if err != nil { 33 fmt.Printf("请求失败: %+v\n", err) 34 // TODO: 请求失败,根据状态码执行不同的处理 35 return 36 } 37 38 // TODO: 请求成功,继续业务逻辑 39 fmt.Printf("请求成功: %+v\n", response) 40} 41 42func QueryECommerceBalance(config *wxpay_utility.MchConfig, request *QueryECommerceBalanceRequest) (response *ECommerceBalance, err error) { 43 const ( 44 host = "https://api.mch.weixin.qq.com" 45 method = "GET" 46 path = "/v3/ecommerce/fund/balance/{sub_mchid}" 47 ) 48 49 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 50 if err != nil { 51 return nil, err 52 } 53 reqUrl.Path = strings.Replace(reqUrl.Path, "{sub_mchid}", url.PathEscape(*request.SubMchid), -1) 54 query := reqUrl.Query() 55 if request.AccountType != nil { 56 query.Add("account_type", fmt.Sprintf("%v", *request.AccountType)) 57 } 58 reqUrl.RawQuery = query.Encode() 59 httpRequest, err := http.NewRequest(method, reqUrl.String(), nil) 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 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), nil) 66 if err != nil { 67 return nil, err 68 } 69 httpRequest.Header.Set("Authorization", authorization) 70 71 client := &http.Client{} 72 httpResponse, err := client.Do(httpRequest) 73 if err != nil { 74 return nil, err 75 } 76 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 77 if err != nil { 78 return nil, err 79 } 80 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 81 // 2XX 成功,验证应答签名 82 err = wxpay_utility.ValidateResponse( 83 config.WechatPayPublicKeyId(), 84 config.WechatPayPublicKey(), 85 &httpResponse.Header, 86 respBody, 87 ) 88 if err != nil { 89 return nil, err 90 } 91 response := &ECommerceBalance{} 92 if err := json.Unmarshal(respBody, response); err != nil { 93 return nil, err 94 } 95 96 return response, nil 97 } else { 98 return nil, wxpay_utility.NewApiException( 99 httpResponse.StatusCode, 100 httpResponse.Header, 101 respBody, 102 ) 103 } 104} 105 106type QueryECommerceBalanceRequest struct { 107 SubMchid *string `json:"sub_mchid,omitempty"` 108 AccountType *QueryEcommerceBalanceAccountType `json:"account_type,omitempty"` 109} 110 111func (o *QueryECommerceBalanceRequest) MarshalJSON() ([]byte, error) { 112 type Alias QueryECommerceBalanceRequest 113 a := &struct { 114 SubMchid *string `json:"sub_mchid,omitempty"` 115 AccountType *QueryEcommerceBalanceAccountType `json:"account_type,omitempty"` 116 *Alias 117 }{ 118 // 序列化时移除非 Body 字段 119 SubMchid: nil, 120 AccountType: nil, 121 Alias: (*Alias)(o), 122 } 123 return json.Marshal(a) 124} 125 126type ECommerceBalance struct { 127 SubMchid *string `json:"sub_mchid,omitempty"` 128 AvailableAmount *int64 `json:"available_amount,omitempty"` 129 PendingAmount *int64 `json:"pending_amount,omitempty"` 130 AccountType *QueryEcommerceBalanceAccountType `json:"account_type,omitempty"` 131} 132 133type QueryEcommerceBalanceAccountType string 134 135func (e QueryEcommerceBalanceAccountType) Ptr() *QueryEcommerceBalanceAccountType { 136 return &e 137} 138 139const ( 140 QUERYECOMMERCEBALANCEACCOUNTTYPE_BASIC QueryEcommerceBalanceAccountType = "BASIC" 141 QUERYECOMMERCEBALANCEACCOUNTTYPE_FEES QueryEcommerceBalanceAccountType = "FEES" 142 QUERYECOMMERCEBALANCEACCOUNTTYPE_OPERATION QueryEcommerceBalanceAccountType = "OPERATION" 143 QUERYECOMMERCEBALANCEACCOUNTTYPE_DEPOSIT QueryEcommerceBalanceAccountType = "DEPOSIT" 144) 145
应答参数
|
sub_mchid 必填 string(32)
【二级商户号】收付通平台二级商户号,由微信支付生成并下发。
available_amount 必填 integer
【可用余额(单位:分)】可用余额(单位:分),此余额可做提现操作
pending_amount 选填 integer
【不可用余额(单位:分)】不可用余额(单位:分)
account_type 选填 string
【二级商户账户类型】二级商户账户类型
可选取值:
BASIC
: 基本账户
FEES
: 手续费账户
OPERATION
: 运营账户
DEPOSIT
: 保证金账户
应答示例
200 OK
1{ 2 "sub_mchid" : "1900000109", 3 "available_amount" : 10000, 4 "pending_amount" : 1, 5 "account_type" : "BASIC" 6} 7
错误码
公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | INVALID_REQUEST | 输入账户类型未开通 | 请检查account_type,并重新调用 |
403 | NO_AUTH | 你无权查询该商户余额 | 请确认电商平台商户号和二级商户商户号是否存在受理关系 |
403 | NO_AUTH | 你无权调用此接口 | 请确认是否已经开通相关权限 |
403 | NO_AUTH | 受理关系无效 | 请检查电商平台和二级商户号的受理关系是否正常 |