申请所有/单个子商户交易账单

更新时间:2024.11.25

下载接口说明

微信支付在每日10点后生成昨日交易账单文件,服务商可通过该接口获取账单下载链接。账单包含交易金额、时间及营销信息,利于订单核对、退款审查及银行到账确认。

注意:

  • 仅支付成功的订单包含在账单内。

  • 账单金额单位为人民币“元”。

  • 此接口仅可下载三个月内的账单。

接口说明

支持商户:【服务商】

请求方式:【GET】/v3/bill/tradebill

请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点

     【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看

请求参数

Header HTTP头参数

Authorization  必填 string

请参考签名认证生成认证信息


Accept  必填 string

请设置为application/json


Content-Type  必填 string

请设置为application/json


query 查询参数

bill_date  必填 string(10)

【账单日期】 账单日期,格式yyyy-MM-DD,仅支持三个月内的账单下载申请。


sub_mchid  选填 string(12)

【子商户号(也叫特约商户号)】服务商可通过该参数指定获取某个子商户的账单,不填则返回服务商下所有子商户的全量账单。

注:该参数无法用于指定获取小微商户账单,小微商户的账单数据只能通过全量账单获取。


bill_type  选填 string

【账单类型】 账单类型,不填则默认是ALL

可选取值:

  • ALL: 返回当日所有订单信息(不含充值退款订单)

  • SUCCESS: 返回当日成功支付的订单(不含充值退款订单)

  • REFUND: 返回当日退款订单(不含充值退款订单)


tar_type  选填 string

【压缩类型】 压缩类型,不填则以不压缩的方式返回账单文件流。
可选取值:
GZIP: 下载账单时返回.gzip格式的压缩文件流

请求示例

GET

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/bill/tradebill?bill_date=2019-06-11&sub_mchid=19000000001&bill_type=ALL&tar_type=GZIP \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" 
5

应答参数

200 OK

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

请求过于频繁

请降低调用频率

 

反馈
咨询
目录
置顶