查询渠道额度
更新时间:2025.09.11接口限频:单查询渠道额度目标商户号100qps
接口说明
支持商户:【普通商户】
请求方式:【GET】/v3/aggracct-bc/wb-channel/account/balance
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
Wechatpay-Serial 必填 string
【微信支付公钥ID】或【微信支付平台证书序列号】 请求参数中的敏感字段,需要使用微信支付公钥加密(推荐),请参考获取微信支付公钥ID说明以及微信支付公钥加密敏感信息指引;也可以使用微信支付平台证书公钥加密,参考获取平台证书序列号、平台证书加密敏感信息指引
query 查询参数
mchid 必填 string(64)
【微信支付商户号】 微信支付商户号
bal_account_no 选填 string(1024)
【额度台账号】 【加密】额度台账号(req_scene=SJT_CONVENIENT_SETTLEMENT_SERVICE_MERCHANT时必传)
card_no 选填 string
【卡号】 【加密】二类卡卡号(req_scene=SJT_MICRO_MERCHANT时必传)
sgn_no 选填 string
【商户子账户协议号】 商户子账户协议号(req_scene=SJT_MICRO_MERCHANT时必传)
req_scene 选填 string
【请求场景】 不填默认按SJT_CONVENIENT_SETTLEMENT_SERVICE_MERCHANT处理
可选取值
SJT_CONVENIENT_SETTLEMENT_SERVICE_MERCHANT: 经营账户-结算便利服务商户SJT_MICRO_MERCHANT: 经营账户-微商户WX_SHOP_CONVENIENT_SETTLEMENT_SERVICE_MERCHANT: 微信小店-结算便利服务商户
请求示例
GET
1curl -X GET \ 2 https://api.mch.weixin.qq.com/v3/aggracct-bc/wb-channel/account/balance?mchid=1900016681&bal_account_no=8609cb22e1774a50a930e414cc71eca06121bcd266335cda230d24a7886a8d9f&card_no=card_no_example&sgn_no=sgn_no_example&req_scene=SJT_CONVENIENT_SETTLEMENT_SERVICE_MERCHANT \ 3 -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \ 4 -H "Accept: application/json" \ 5 -H "Wechatpay-Serial: 5157F09EFDC096DE15EBE81A47057A7232F1B8E1" 6
需配合微信支付工具库 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 QueryAccountBalance { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "GET"; 28 private static String PATH = "/v3/aggracct-bc/wb-channel/account/balance"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/merchant/4013070756 32 QueryAccountBalance client = new QueryAccountBalance( 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 QueryAccountBalanceRequest request = new QueryAccountBalanceRequest(); 41 request.mchid = "1900016681"; 42 request.balAccountNo = "8609cb22e1774a50a930e414cc71eca06121bcd266335cda230d24a7886a8d9f"; 43 request.cardNo = "cardNo_example"; 44 request.sgnNo = "sgnNo_example"; 45 request.reqScene = RequestScene.SJT_CONVENIENT_SETTLEMENT_SERVICE_MERCHANT; 46 try { 47 AccountBalance response = client.run(request); 48 // TODO: 请求成功,继续业务逻辑 49 System.out.println(response); 50 } catch (WXPayUtility.ApiException e) { 51 // TODO: 请求失败,根据状态码执行不同的逻辑 52 e.printStackTrace(); 53 } 54 } 55 56 public AccountBalance run(QueryAccountBalanceRequest request) { 57 String uri = PATH; 58 Map<String, Object> args = new HashMap<>(); 59 args.put("mchid", request.mchid); 60 args.put("bal_account_no", request.balAccountNo); 61 args.put("card_no", request.cardNo); 62 args.put("sgn_no", request.sgnNo); 63 args.put("req_scene", request.reqScene); 64 String queryString = WXPayUtility.urlEncode(args); 65 if (!queryString.isEmpty()) { 66 uri = uri + "?" + queryString; 67 } 68 69 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 70 reqBuilder.addHeader("Accept", "application/json"); 71 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 72 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo, privateKey, METHOD, uri, null)); 73 reqBuilder.method(METHOD, null); 74 Request httpRequest = reqBuilder.build(); 75 76 // 发送HTTP请求 77 OkHttpClient client = new OkHttpClient.Builder().build(); 78 try (Response httpResponse = client.newCall(httpRequest).execute()) { 79 String respBody = WXPayUtility.extractBody(httpResponse); 80 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 81 // 2XX 成功,验证应答签名 82 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 83 httpResponse.headers(), respBody); 84 85 // 从HTTP应答报文构建返回数据 86 return WXPayUtility.fromJson(respBody, AccountBalance.class); 87 } else { 88 throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 89 } 90 } catch (IOException e) { 91 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 92 } 93 } 94 95 private final String mchid; 96 private final String certificateSerialNo; 97 private final PrivateKey privateKey; 98 private final String wechatPayPublicKeyId; 99 private final PublicKey wechatPayPublicKey; 100 101 public QueryAccountBalance(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 102 this.mchid = mchid; 103 this.certificateSerialNo = certificateSerialNo; 104 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 105 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 106 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 107 } 108 109 public String encrypt(String plainText) { 110 return WXPayUtility.encrypt(this.wechatPayPublicKey, plainText); 111 } 112 113 public static class QueryAccountBalanceRequest { 114 @SerializedName("mchid") 115 @Expose(serialize = false) 116 public String mchid; 117 118 @SerializedName("bal_account_no") 119 @Expose(serialize = false) 120 public String balAccountNo; 121 122 @SerializedName("card_no") 123 @Expose(serialize = false) 124 public String cardNo; 125 126 @SerializedName("sgn_no") 127 @Expose(serialize = false) 128 public String sgnNo; 129 130 @SerializedName("req_scene") 131 @Expose(serialize = false) 132 public RequestScene reqScene; 133 } 134 135 public static class AccountBalance { 136 @SerializedName("in_transit_reduction_exist") 137 public Boolean inTransitReductionExist; 138 139 @SerializedName("balance") 140 public Long balance; 141 } 142 143 public enum RequestScene { 144 @SerializedName("SJT_CONVENIENT_SETTLEMENT_SERVICE_MERCHANT") 145 SJT_CONVENIENT_SETTLEMENT_SERVICE_MERCHANT, 146 @SerializedName("SJT_MICRO_MERCHANT") 147 SJT_MICRO_MERCHANT, 148 @SerializedName("WX_SHOP_CONVENIENT_SETTLEMENT_SERVICE_MERCHANT") 149 WX_SHOP_CONVENIENT_SETTLEMENT_SERVICE_MERCHANT 150 } 151 152} 153
需配合微信支付工具库 wxpay_utility 使用,请参考Go
1package main 2 3import ( 4 "demo/wxpay_utility" // 引用微信支付工具库,参考 https://pay.weixin.qq.com/doc/v3/merchant/4015119334 5 "encoding/json" 6 "fmt" 7 "net/http" 8 "net/url" 9) 10 11func main() { 12 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/merchant/4013070756 13 config, err := wxpay_utility.CreateMchConfig( 14 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/merchant/4013070756 15 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/merchant/4013053053 16 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 17 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/merchant/4013038816 18 "/path/to/wxp_pub.pem", // 微信支付公钥文件路径,本地文件路径 19 ) 20 if err != nil { 21 fmt.Println(err) 22 return 23 } 24 25 request := &QueryAccountBalanceRequest{ 26 Mchid: wxpay_utility.String("1900016681"), 27 BalAccountNo: wxpay_utility.String("8609cb22e1774a50a930e414cc71eca06121bcd266335cda230d24a7886a8d9f"), 28 CardNo: wxpay_utility.String("CardNo_example"), 29 SgnNo: wxpay_utility.String("SgnNo_example"), 30 ReqScene: REQUESTSCENE_SJT_CONVENIENT_SETTLEMENT_SERVICE_MERCHANT.Ptr(), 31 } 32 33 response, err := QueryAccountBalance(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 QueryAccountBalance(config *wxpay_utility.MchConfig, request *QueryAccountBalanceRequest) (response *AccountBalance, err error) { 45 const ( 46 host = "https://api.mch.weixin.qq.com" 47 method = "GET" 48 path = "/v3/aggracct-bc/wb-channel/account/balance" 49 ) 50 51 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 52 if err != nil { 53 return nil, err 54 } 55 query := reqUrl.Query() 56 if request.Mchid != nil { 57 query.Add("mchid", *request.Mchid) 58 } 59 if request.BalAccountNo != nil { 60 query.Add("bal_account_no", *request.BalAccountNo) 61 } 62 if request.CardNo != nil { 63 query.Add("card_no", *request.CardNo) 64 } 65 if request.SgnNo != nil { 66 query.Add("sgn_no", *request.SgnNo) 67 } 68 if request.ReqScene != nil { 69 query.Add("req_scene", fmt.Sprintf("%v", *request.ReqScene)) 70 } 71 reqUrl.RawQuery = query.Encode() 72 httpRequest, err := http.NewRequest(method, reqUrl.String(), nil) 73 if err != nil { 74 return nil, err 75 } 76 httpRequest.Header.Set("Accept", "application/json") 77 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 78 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), nil) 79 if err != nil { 80 return nil, err 81 } 82 httpRequest.Header.Set("Authorization", authorization) 83 84 client := &http.Client{} 85 httpResponse, err := client.Do(httpRequest) 86 if err != nil { 87 return nil, err 88 } 89 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 90 if err != nil { 91 return nil, err 92 } 93 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 94 // 2XX 成功,验证应答签名 95 err = wxpay_utility.ValidateResponse( 96 config.WechatPayPublicKeyId(), 97 config.WechatPayPublicKey(), 98 &httpResponse.Header, 99 respBody, 100 ) 101 if err != nil { 102 return nil, err 103 } 104 response := &AccountBalance{} 105 if err := json.Unmarshal(respBody, response); err != nil { 106 return nil, err 107 } 108 109 return response, nil 110 } else { 111 return nil, wxpay_utility.NewApiException( 112 httpResponse.StatusCode, 113 httpResponse.Header, 114 respBody, 115 ) 116 } 117} 118 119type QueryAccountBalanceRequest struct { 120 Mchid *string `json:"mchid,omitempty"` 121 BalAccountNo *string `json:"bal_account_no,omitempty"` 122 CardNo *string `json:"card_no,omitempty"` 123 SgnNo *string `json:"sgn_no,omitempty"` 124 ReqScene *RequestScene `json:"req_scene,omitempty"` 125} 126 127func (o *QueryAccountBalanceRequest) MarshalJSON() ([]byte, error) { 128 type Alias QueryAccountBalanceRequest 129 a := &struct { 130 Mchid *string `json:"mchid,omitempty"` 131 BalAccountNo *string `json:"bal_account_no,omitempty"` 132 CardNo *string `json:"card_no,omitempty"` 133 SgnNo *string `json:"sgn_no,omitempty"` 134 ReqScene *RequestScene `json:"req_scene,omitempty"` 135 *Alias 136 }{ 137 // 序列化时移除非 Body 字段 138 Mchid: nil, 139 BalAccountNo: nil, 140 CardNo: nil, 141 SgnNo: nil, 142 ReqScene: nil, 143 Alias: (*Alias)(o), 144 } 145 return json.Marshal(a) 146} 147 148type AccountBalance struct { 149 InTransitReductionExist *bool `json:"in_transit_reduction_exist,omitempty"` 150 Balance *int64 `json:"balance,omitempty"` 151} 152 153type RequestScene string 154 155func (e RequestScene) Ptr() *RequestScene { 156 return &e 157} 158 159const ( 160 REQUESTSCENE_SJT_CONVENIENT_SETTLEMENT_SERVICE_MERCHANT RequestScene = "SJT_CONVENIENT_SETTLEMENT_SERVICE_MERCHANT" 161 REQUESTSCENE_SJT_MICRO_MERCHANT RequestScene = "SJT_MICRO_MERCHANT" 162 REQUESTSCENE_WX_SHOP_CONVENIENT_SETTLEMENT_SERVICE_MERCHANT RequestScene = "WX_SHOP_CONVENIENT_SETTLEMENT_SERVICE_MERCHANT" 163) 164
应答参数
200 OK
in_transit_reduction_exist 选填 boolean
【是否存在在途减额指令】 是否存在在途减额指令
balance 选填 integer
【额度台账号额度】 额度台账号额度
应答示例
200 OK
1{ 2 "in_transit_reduction_exist" : false, 3 "balance" : 1 4} 5
错误码
以下是本接口返回的错误码列表。详细错误码规则,请参考微信支付接口规则-错误码和错误提示
