申请交易账单API

最新更新时间:2019.09.16 版本说明


微信支付按天提供交易账单文件,服务商可以通过该接口获取账单文件的下载地址。文件内包含交易相关的金额、时间、营销等信息,供商户核对订单、退款、银行到账等情况。


注意:

• 微信侧未成功下单的交易不会出现在对账单中。支付成功后撤销的交易会出现在对账单中,跟原支付单订单号一致;

• 对账单中涉及金额的字段单位为“元”;

• 对账单接口只能下载三个月以内的账单;

• 小微商户不单独提供对账单下载,如有需要,可在调用“下载对账单”API接口时不传sub_mchid,获取服务商下全量电商二级商户(包括小微商户和非小微商户)的对账单。

接口说明

适用对象: 服务商 电商平台

请求URL:https://api.mch.weixin.qq.com/v3/bill/tradebill

请求方式:GET


path指该参数为路径参数

query指该参数需在请求URL传参

body指该参数需在请求JSON传参


请求参数

参数名 变量 类型[长度限制] 必填 描述
账单日期 bill_date string[1,10] query 格式YYYY-MM-DD
仅支持三个月内的账单下载申请。
示例值:2019-06-11
子商户号 sub_mchid string[8,32] query 商户是服务商:
● 不填则默认返回服务商下的交易或退款数据。
● 如需下载某个子商户下的交易或退款数据,则该字段必填。
示例值:1900000001
账单类型 bill_type string[1,32] query 不填则默认是ALL
枚举值:
ALL:返回当日所有订单信息(不含充值退款订单)
SUCCESS:返回当日成功支付的订单(不含充值退款订单)
REFUND:返回当日退款订单(不含充值退款订单)
示例值:ALL
压缩类型 tar_type string[1,32] query 不填则默认是数据流
枚举值:
GZIP:返回格式为.gzip的压缩包账单
示例值:GZIP

请求示例


https://api.mch.weixin.qq.com/v3/bill/tradebill?bill_date=2019-06-11&sub_mchid=1900000001&bill_type=ALL
    
{
JAVA示例代码
}
    

返回参数

参数名 变量 类型[长度限制] 必填 描述
哈希类型 hash_type string[1,32] 原始账单(gzip需要解压缩)的摘要值,用于校验文件的完整性。
示例值:SHA1
哈希值 hash_value string[1,1024] 原始账单(gzip需要解压缩)的摘要值,用于校验文件的完整性。
示例值:79bb0f45fc4c42234a918000b2668d689e2bde04
账单下载地址 download_url string[1,2048] 供下一步请求账单文件的下载地址,该地址30s内有效。
示例值:https://api.mch.weixin.qq.com/v3/billdownload/file?token=xxx

返回示例


{
	"download_url": "https://api.mch.weixin.qq.com/v3/billdownload/file?token=E-bFy6HgY_ffEOQutOpiFXX-SHI3EWhUQtPKAUd1iDGBGUA6Bfbzmcc-CWdJE23-",
	"hash_type": "SHA1",
	"hash_value": "8257296d67cd621531ddb3f6d3ed10d3ea45dd09"
}
                                

    http://2323weixin.qq.com
                                

错误码公共错误码

状态码 错误码 描述 解决方案
500 SYSTEM_ERROR 系统错误 系统异常,请使用相同参数稍后重新调用
400 PARAM_ERROR 参数错误 请使用正确的参数重新调用
400 INVALID_REQUEST 参数错误 请检查bill_date,并重新调用
参数错误 请检查sub_mchid,并重新调用
403 NO_AUTH 权限异常(无该子商户账单的权限) 请使用正确的sub_mchid再重新调用
权限异常,小微商户不单独提供对账单下载 可以不传sub_mchid,以获取服务商下全量电商二级商户(包括小微商户和非小微商户)的对账单
400 NO_STATEMENT_EXIST 账单文件不存在 请检查当前商户号是否在指定日期有交易或退款发生
400 STATEMENT_CREATING 账单生成中 请先检查当前商户号在指定日期内是否有成功的交易或退款,若有,则在T+1日上午8点后再重新下载
400 INVALID_REQUEST 参数错误 请按第一步申请账单的API指引,重新获取账单地址后再请求
403 NO_AUTH 权限异常 请检查本次请求的商户是否与第一步申请账单API的请求商户一致


技术咨询

文档反馈