下载资金账单
更新时间:2024.11.13应用场景
商户可以通过该接口下载自2017年6月1日起的历史资金流水账单。
|
接口链接
https://api.mch.weixin.qq.com/pay/downloadfundflow
是否需要证书
请求需要双向证书。 详见证书使用
请求参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
公众账号ID | appid | 是 | String(32) | wx8888888888888888 | 微信分配的公众账号ID(企业号corpid即为此appId) |
商户号 | mch_id | 是 | String(32) | 1900000109 | 微信支付分配的商户号 |
随机字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 随机字符串,不长于32位。推荐随机数生成算法 |
签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名,详见签名生成算法 |
签名类型 | sign_type | 否 | String(32) | HMAC-SHA256 | 签名类型,目前仅支持HMAC-SHA256 |
资金账单日期 | bill_date | 是 | String(8) | 20140603 | 下载对账单的日期,格式:20140603 |
资金账户类型 | account_type | 是 | String(8) | Basic | 账单的资金来源账户: Basic 基本账户 Operation 运营账户 Fees 手续费账户 |
压缩账单 | tar_type | 否 | String(8) | GZIP | 非必传参数,固定值:GZIP,返回格式为.gzip的压缩包账单。不传则默认为数据流形式。 |
返回结果
接口请求成功时,数据以文本表格的方式返回
1、第一行为表头
记账时间,微信支付业务单号,资金流水单号,业务名称,业务类型,收支类型,收支金额(元),账户结余(元),资金变更提交申请人,备注,业务凭证号
2、从第二行起,为资金流水数据,各参数以逗号分隔,参数前增加`符号,为标准键盘1左边键的字符,字段顺序与表头一致
3、倒数第二行为资金账单统计标题
资金流水总笔数,收入笔数,收入金额,支出笔数,支出金额
4、最后一行为统计数据
账单示例如下:
5、header中Digest为完整性校验信息,内容格式为:签名类型=签名
举例如下:
注:当前仅支持sha1签名返回
接口请求时如有协议错误,将返回以下字段
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回状态码 | return_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL 此字段是通信标识,非交易标识,交易是否成功需要查看trade_state来判断 |
返回信息 | return_msg | 是 | String(128) | OK | 当return_code为FAIL时返回信息为错误原因 ,例如:签名失败、参数格式校验错误、请求频率过快,请稍后再试 |
当return_code为SUCCESS时,进一步返回以下字段指明业务失败的原因
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
业务结果 | result_code | 是 | string(16) | FAIL | FAIL |
错误代码 | err_code | 是 | String(16) | SYSTEMERROR | 见错误码列表 |
错误代码描述 | err_code_des | 否 | String(128) | 账单不存在 | 错误信息描述 |
请求协议错误示例:
错误码
错误码 | 描述 | 解决方案 |
---|---|---|
SYSTEMERROR | 微信支付内部错误 | 请稍后重试。 |
PARAM_ERROR | 参数错误 | 请对照文档的请求参数说明检查参数。 |
NO_BILL_EXIST | 账单不存在 | 请检查当前商户号在指定日期内是否有成功的交易。 |
BILL_CREATING | 账单未生成 | 请先检查当前商户号在指定日期内是否有成功的交易,如指定日期有交易则表示账单正在生成中,请在上午10点以后再下载。 |