申请服务商资金账单
更新时间:2025.01.16微信支付按天提供服务商各账户的资金流水账单文件,服务商可以通过该接口获取账单文件的下载地址。账单文件详细记录了服务商账户资金操作的相关信息,包括业务单号、收支金额及记账时间等,以便服务商进行核对与确认。详细介绍参考:下载账单-产品介绍。
注意:
资金账单中的数据反映的是服务商微信账户资金变动情况;
当日账单将在次日上午9点开始生成,建议服务商在次日上午10点以后获取;
资金账单中所有涉及金额的字段均以“元”为单位。
文件格式说明
账单文件主要由明细数据和汇总数据两大部分构成,每部分均包含一行表头以及多行详细数据。
明细数据的每一行都代表一笔具体的资金操作。为防止数据在Excel中被自动转换为科学计数法,每项数据前均添加了字符`
。若需汇总计算金额等数据,可以批量移除该字符。
接口说明
支持商户:【普通服务商】【平台商户】
请求方式:【GET】/v3/bill/fundflowbill
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
query 查询参数
bill_date 必填 string(10)
【账单日期】 账单日期,格式yyyy-MM-DD,仅支持三个月内的账单下载申请。
account_type 选填 string
【资金账户类型】 资金账户类型,不填默认是BASIC
可选取值:
BASIC
: 基本账户OPERATION
: 运营账户FEES
: 手续费账户
tar_type 选填 string
【压缩类型】 压缩类型,不填则以不压缩的方式返回账单文件流。
可选取值:GZIP
: 下载账单时返回.gzip格式的压缩文件流
请求示例
需配合微信支付工具库 WXPayUtility 使用,请参考 Java
1package com.java.demo; 2 3import com.google.gson.annotations.Expose; 4import com.google.gson.annotations.SerializedName; 5import com.java.utils.WXPayUtility; // 引用微信支付工具库 参考:https://pay.weixin.qq.com/doc/v3/partner/4014985777 6import java.io.IOException; 7import java.io.UncheckedIOException; 8import java.security.PrivateKey; 9import java.security.PublicKey; 10import java.util.ArrayList; 11import java.util.HashMap; 12import java.util.List; 13import java.util.Map; 14import okhttp3.MediaType; 15import okhttp3.OkHttpClient; 16import okhttp3.Request; 17import okhttp3.RequestBody; 18import okhttp3.Response; 19 20/** 21 * 申请资金账单API 22 */ 23public class GetFundFlowBill { 24 private static String HOST = "https://api.mch.weixin.qq.com"; 25 private static String METHOD = "GET"; 26 private static String PATH = "/v3/bill/fundflowbill"; 27 28 public static void main(String[] args) { 29 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 30 GetFundFlowBill client = new GetFundFlowBill( 31 "填入 商户号", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考https://pay.weixin.qq.com/doc/v3/partner/4013080340 32 "填入 商户API证书序列号", // 商户API证书序列号,如何获取请参考https://pay.weixin.qq.com/doc/v3/partner/4013058924 33 "填入 商户API证书私钥文件路径", // 商户API证书私钥文件路径,本地文件路径 34 "填入 微信支付公钥ID", // 微信支付公钥ID,如何获取请参考https://pay.weixin.qq.com/doc/v3/partner/4013038589 35 "填入 微信支付公钥文件路径" // 微信支付公钥文件路径,本地文件路径 36 ); 37 38 GetFundFlowBillRequest request = new GetFundFlowBillRequest(); 39 request.billDate = "2019-06-11"; 40 request.accountType = FundFlowBillAccountType.BASIC; 41 request.tarType = TarType.GZIP; 42 try { 43 QueryBillEntity response = client.run(request); 44 45 // TODO: 请求成功,继续业务逻辑 46 System.out.println(response); 47 } catch (WXPayUtility.ApiException e) { 48 // TODO: 请求失败,根据状态码执行不同的逻辑 49 e.printStackTrace(); 50 } 51 } 52 53 public QueryBillEntity run(GetFundFlowBillRequest request) { 54 String uri = PATH; 55 Map<String, Object> args = new HashMap<>(); 56 args.put("bill_date", request.billDate); 57 args.put("account_type", request.accountType); 58 args.put("tar_type", request.tarType); 59 uri = uri + "?" + WXPayUtility.urlEncode(args); 60 61 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 62 reqBuilder.addHeader("Accept", "application/json"); 63 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 64 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo, privateKey, METHOD, uri, null)); 65 reqBuilder.method(METHOD, null); 66 Request httpRequest = reqBuilder.build(); 67 68 // 发送HTTP请求 69 OkHttpClient client = new OkHttpClient.Builder().build(); 70 try (Response httpResponse = client.newCall(httpRequest).execute()) { 71 String respBody = WXPayUtility.extractBody(httpResponse); 72 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 73 // 2XX 成功,验证应答签名 74 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 75 httpResponse.headers(), respBody); 76 77 // 从HTTP应答报文构建返回数据 78 return WXPayUtility.fromJson(respBody, QueryBillEntity.class); 79 } else { 80 throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 81 } 82 } catch (IOException e) { 83 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 84 } 85 } 86 87 private final String mchid; 88 private final String certificateSerialNo; 89 private final PrivateKey privateKey; 90 private final String wechatPayPublicKeyId; 91 private final PublicKey wechatPayPublicKey; 92 93 public GetFundFlowBill(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 94 this.mchid = mchid; 95 this.certificateSerialNo = certificateSerialNo; 96 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 97 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 98 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 99 } 100 101 public static class QueryBillEntity { 102 @SerializedName("hash_type") 103 public HashType hashType; 104 105 @SerializedName("hash_value") 106 public String hashValue; 107 108 @SerializedName("download_url") 109 public String downloadUrl; 110 } 111 112 public static class GetFundFlowBillRequest { 113 @SerializedName("bill_date") 114 @Expose(serialize = false) 115 public String billDate; 116 117 @SerializedName("account_type") 118 @Expose(serialize = false) 119 public FundFlowBillAccountType accountType; 120 121 @SerializedName("tar_type") 122 @Expose(serialize = false) 123 public TarType tarType; 124 } 125 126 public enum HashType { 127 @SerializedName("SHA1") 128 SHA1 129 } 130 131 public enum FundFlowBillAccountType { 132 @SerializedName("BASIC") 133 BASIC, 134 @SerializedName("OPERATION") 135 OPERATION, 136 @SerializedName("FEES") 137 FEES 138 } 139 140 public enum TarType { 141 @SerializedName("GZIP") 142 GZIP 143 } 144}
需配合微信支付工具库 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) 10 11func main() { 12 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 13 config, err := wxpay_utility.CreateMchConfig( 14 "填入 商户号", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考https://pay.weixin.qq.com/doc/v3/partner/4013080340 15 "填入 商户API证书序列号", // 商户API证书序列号,如何获取请参考https://pay.weixin.qq.com/doc/v3/partner/4013058924 16 "填入 商户API证书私钥文件路径", // 商户API证书私钥文件路径,本地文件路径 17 "填入 微信支付公钥ID", // 微信支付公钥ID,如何获取请参考https://pay.weixin.qq.com/doc/v3/partner/4013038589 18 "填入 微信支付公钥文件路径", // 微信支付公钥文件路径,本地文件路径 19 ) 20 if err != nil { 21 fmt.Println(err) 22 return 23 } 24 25 request := &GetFundFlowBillRequest{ 26 BillDate: wxpay_utility.String("2019-06-11"), 27 AccountType: FUNDFLOWBILLACCOUNTTYPE_BASIC.Ptr(), 28 TarType: TARTYPE_GZIP.Ptr(), 29 } 30 31 response, err := GetFundFlowBill(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 GetFundFlowBill(config *wxpay_utility.MchConfig, request *GetFundFlowBillRequest) (response *QueryBillEntity, err error) { 43 const ( 44 host = "https://api.mch.weixin.qq.com" 45 method = "GET" 46 path = "/v3/bill/fundflowbill" 47 ) 48 49 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 50 if err != nil { 51 return nil, err 52 } 53 query := reqUrl.Query() 54 query.Add("bill_date", *request.BillDate) 55 query.Add("account_type", fmt.Sprintf("%v", *request.AccountType)) 56 query.Add("tar_type", fmt.Sprintf("%v", *request.TarType)) 57 reqUrl.RawQuery = query.Encode() 58 httpRequest, err := http.NewRequest(method, reqUrl.String(), nil) 59 if err != nil { 60 return nil, err 61 } 62 httpRequest.Header.Set("Accept", "application/json") 63 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 64 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), nil) 65 if err != nil { 66 return nil, err 67 } 68 httpRequest.Header.Set("Authorization", authorization) 69 70 client := &http.Client{} 71 httpResponse, err := client.Do(httpRequest) 72 if err != nil { 73 return nil, err 74 } 75 76 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 77 if err != nil { 78 return nil, err 79 } 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 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.ApiException{ 100 StatusCode: httpResponse.StatusCode, 101 Header: httpResponse.Header, 102 Body: respBody, 103 } 104 } 105} 106 107type QueryBillEntity struct { 108 HashType *HashType `json:"hash_type,omitempty"` 109 HashValue *string `json:"hash_value,omitempty"` 110 DownloadUrl *string `json:"download_url,omitempty"` 111} 112 113type GetFundFlowBillRequest struct { 114 BillDate *string `json:"bill_date,omitempty"` 115 AccountType *FundFlowBillAccountType `json:"account_type,omitempty"` 116 TarType *TarType `json:"tar_type,omitempty"` 117} 118 119func (o *GetFundFlowBillRequest) MarshalJSON() ([]byte, error) { 120 type Alias GetFundFlowBillRequest 121 a := &struct { 122 BillDate *string `json:"bill_date,omitempty"` 123 AccountType *FundFlowBillAccountType `json:"account_type,omitempty"` 124 TarType *TarType `json:"tar_type,omitempty"` 125 *Alias 126 }{ 127 // 序列化时移除非 Body 字段 128 BillDate: nil, 129 AccountType: nil, 130 TarType: nil, 131 Alias: (*Alias)(o), 132 } 133 return json.Marshal(a) 134} 135 136type HashType string 137 138func (e HashType) Ptr() *HashType { 139 return &e 140} 141 142const ( 143 HASHTYPE_SHA1 HashType = "SHA1" 144) 145 146type FundFlowBillAccountType string 147 148func (e FundFlowBillAccountType) Ptr() *FundFlowBillAccountType { 149 return &e 150} 151 152const ( 153 FUNDFLOWBILLACCOUNTTYPE_BASIC FundFlowBillAccountType = "BASIC" 154 FUNDFLOWBILLACCOUNTTYPE_OPERATION FundFlowBillAccountType = "OPERATION" 155 FUNDFLOWBILLACCOUNTTYPE_FEES FundFlowBillAccountType = "FEES" 156) 157 158type TarType string 159 160func (e TarType) Ptr() *TarType { 161 return &e 162} 163 164const ( 165 TARTYPE_GZIP TarType = "GZIP" 166)
GET
1curl -X GET \ 2 https://api.mch.weixin.qq.com/v3/bill/fundflowbill?bill_date=2019-06-11&account_type=BASIC&tar_type=GZIP \ 3 -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \ 4 -H "Accept: application/json" 5
应答参数
|
hash_type 必填 string
【哈希类型】 哈希类型,固定为SHA1。
hash_value 必填 string(1024)
【哈希值】 账单文件的SHA1摘要值,用于服务商侧校验文件的一致性。
download_url 必填 string(2048)
【下载地址】 供下一步请求账单文件的下载地址,该地址5min内有效。参考下载账单
应答示例
200 OK
1{ 2 "hash_type" : "SHA1", 3 "hash_value" : "79bb0f45fc4c42234a918000b2668d689e2bde04", 4 "download_url" : "https://api.mch.weixin.qq.com/v3/bill/downloadurl?token=xxx" 5} 6
错误码
公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | INVALID_REQUEST | 参数错误 | 请根据接口返回的错误描述检查参数,参数需按文档要求进行填写 |
400 | NO_STATEMENT_EXIST | 账单文件不存在 | 请检查当前服务商商户号是否在指定日期有资金变动 |
400 | STATEMENT_CREATING | 账单生成中 | 请先检查当前商户号在指定日期内是否有成功的交易或退款,若有,则在T+1日上午10点后再重新下载 |
429 | FREQUENCY_LIMITED | 请求过于频繁 | 请降低调用频率 |