查询二级商户账户日终余额
更新时间:2024.11.04收付通平台可通过该接口查询二级商户指定日期当天24点的账户余额。
注意:
可查询90天内的日终余额。
当日日终余额在次日生成,建议商户在上午 10 点以后查询。
接口说明
支持商户:【平台商户】
请求方式:【GET】/v3/ecommerce/fund/enddaybalance/{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 查询参数
date 必填 string(10)
【日期】日期,格式YYYY-MM-DD
account_type 选填 string
【账户类型】账户类型,不填默认BASIC
可选取值:
BASIC
: 基本账户
DEPOSIT
: 保证金账户
请求示例
GET
1curl -X GET \ 2 https://api.mch.weixin.qq.com/v3/ecommerce/fund/enddaybalance/1900000109?date=2019-08-17&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 QueryECommerceDayEndBalance { 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/enddaybalance/{sub_mchid}"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 32 QueryECommerceDayEndBalance client = new QueryECommerceDayEndBalance( 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 QueryECommerceDayEndBalanceRequest request = new QueryECommerceDayEndBalanceRequest(); 41 request.subMchid = "1900000109"; 42 request.date = "2019-08-17"; 43 request.accountType = QueryEcommerceDayEndBalanceAccountType.BASIC; 44 try { 45 ECommerceDayEndBalance 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 ECommerceDayEndBalance run(QueryECommerceDayEndBalanceRequest request) { 55 String uri = PATH; 56 uri = uri.replace("{sub_mchid}", WXPayUtility.urlEncode(request.subMchid)); 57 Map<String, Object> args = new HashMap<>(); 58 args.put("date", request.date); 59 args.put("account_type", request.accountType); 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, ECommerceDayEndBalance.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 QueryECommerceDayEndBalance(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 QueryECommerceDayEndBalanceRequest { 106 @SerializedName("sub_mchid") 107 @Expose(serialize = false) 108 public String subMchid; 109 110 @SerializedName("date") 111 @Expose(serialize = false) 112 public String date; 113 114 @SerializedName("account_type") 115 @Expose(serialize = false) 116 public QueryEcommerceDayEndBalanceAccountType accountType; 117 } 118 119 public static class ECommerceDayEndBalance { 120 @SerializedName("sub_mchid") 121 public String subMchid; 122 123 @SerializedName("available_amount") 124 public Long availableAmount; 125 126 @SerializedName("pending_amount") 127 public Long pendingAmount; 128 129 @SerializedName("account_type") 130 public QueryEcommerceDayEndBalanceAccountType accountType; 131 } 132 133 public enum QueryEcommerceDayEndBalanceAccountType { 134 @SerializedName("BASIC") 135 BASIC, 136 @SerializedName("DEPOSIT") 137 DEPOSIT 138 } 139 140} 141
需配合微信支付工具库 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 := &QueryECommerceDayEndBalanceRequest{ 27 SubMchid: wxpay_utility.String("1900000109"), 28 Date: wxpay_utility.String("2019-08-17"), 29 AccountType: QUERYECOMMERCEDAYENDBALANCEACCOUNTTYPE_BASIC.Ptr(), 30 } 31 32 response, err := QueryECommerceDayEndBalance(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 QueryECommerceDayEndBalance(config *wxpay_utility.MchConfig, request *QueryECommerceDayEndBalanceRequest) (response *ECommerceDayEndBalance, err error) { 44 const ( 45 host = "https://api.mch.weixin.qq.com" 46 method = "GET" 47 path = "/v3/ecommerce/fund/enddaybalance/{sub_mchid}" 48 ) 49 50 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 51 if err != nil { 52 return nil, err 53 } 54 reqUrl.Path = strings.Replace(reqUrl.Path, "{sub_mchid}", url.PathEscape(*request.SubMchid), -1) 55 query := reqUrl.Query() 56 if request.Date != nil { 57 query.Add("date", *request.Date) 58 } 59 if request.AccountType != nil { 60 query.Add("account_type", fmt.Sprintf("%v", *request.AccountType)) 61 } 62 reqUrl.RawQuery = query.Encode() 63 httpRequest, err := http.NewRequest(method, reqUrl.String(), nil) 64 if err != nil { 65 return nil, err 66 } 67 httpRequest.Header.Set("Accept", "application/json") 68 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 69 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), nil) 70 if err != nil { 71 return nil, err 72 } 73 httpRequest.Header.Set("Authorization", authorization) 74 75 client := &http.Client{} 76 httpResponse, err := client.Do(httpRequest) 77 if err != nil { 78 return nil, err 79 } 80 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 81 if err != nil { 82 return nil, err 83 } 84 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 85 // 2XX 成功,验证应答签名 86 err = wxpay_utility.ValidateResponse( 87 config.WechatPayPublicKeyId(), 88 config.WechatPayPublicKey(), 89 &httpResponse.Header, 90 respBody, 91 ) 92 if err != nil { 93 return nil, err 94 } 95 response := &ECommerceDayEndBalance{} 96 if err := json.Unmarshal(respBody, response); err != nil { 97 return nil, err 98 } 99 100 return response, nil 101 } else { 102 return nil, wxpay_utility.NewApiException( 103 httpResponse.StatusCode, 104 httpResponse.Header, 105 respBody, 106 ) 107 } 108} 109 110type QueryECommerceDayEndBalanceRequest struct { 111 SubMchid *string `json:"sub_mchid,omitempty"` 112 Date *string `json:"date,omitempty"` 113 AccountType *QueryEcommerceDayEndBalanceAccountType `json:"account_type,omitempty"` 114} 115 116func (o *QueryECommerceDayEndBalanceRequest) MarshalJSON() ([]byte, error) { 117 type Alias QueryECommerceDayEndBalanceRequest 118 a := &struct { 119 SubMchid *string `json:"sub_mchid,omitempty"` 120 Date *string `json:"date,omitempty"` 121 AccountType *QueryEcommerceDayEndBalanceAccountType `json:"account_type,omitempty"` 122 *Alias 123 }{ 124 // 序列化时移除非 Body 字段 125 SubMchid: nil, 126 Date: nil, 127 AccountType: nil, 128 Alias: (*Alias)(o), 129 } 130 return json.Marshal(a) 131} 132 133type ECommerceDayEndBalance struct { 134 SubMchid *string `json:"sub_mchid,omitempty"` 135 AvailableAmount *int64 `json:"available_amount,omitempty"` 136 PendingAmount *int64 `json:"pending_amount,omitempty"` 137 AccountType *QueryEcommerceDayEndBalanceAccountType `json:"account_type,omitempty"` 138} 139 140type QueryEcommerceDayEndBalanceAccountType string 141 142func (e QueryEcommerceDayEndBalanceAccountType) Ptr() *QueryEcommerceDayEndBalanceAccountType { 143 return &e 144} 145 146const ( 147 QUERYECOMMERCEDAYENDBALANCEACCOUNTTYPE_BASIC QueryEcommerceDayEndBalanceAccountType = "BASIC" 148 QUERYECOMMERCEDAYENDBALANCEACCOUNTTYPE_DEPOSIT QueryEcommerceDayEndBalanceAccountType = "DEPOSIT" 149) 150
应答参数
|
sub_mchid 必填 string(32)
【二级商户号】收付通平台二级商户号,由微信支付生成并下发。
available_amount 必填 integer
【可用余额(单位:分)】可用余额(单位:分),此余额可做提现操作
pending_amount 选填 integer
【不可用余额(单位:分)】不可用余额(单位:分)
account_type 选填 string
【账户类型】
可选取值:
BASIC
: 基本账户
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 | 该账户在指定时间不存在 | 请检查date输入是否正确,修改后重新调用 |
403 | NO_AUTH | 你无权查询该商户余额 | 请确认电商平台商户号和二级商户商户号是否存在受理关系 |
403 | NO_AUTH | 你无接口权限 | 请确认是否已经开通相关权限 |
403 | NO_AUTH | 受理关系无效 | 请检查电商平台和二级商户号的受理关系是否正常 |