商户进件
特约商户进件
基础支付
JSAPI支付
APP支付
H5支付
Native支付
小程序支付
合单支付
付款码支付
经营能力
支付即服务
点金计划
行业方案
电商收付通(商户进件)
电商收付通(普通支付)
电商收付通(合单支付)
电商收付通(分账)
电商收付通(补差)
电商收付通(退款)
电商收付通(余额查询)
电商收付通(商户提现)
电商收付通(跨境付款)
电商收付通(下载账单)
智慧商圈
微信支付分停车服务
营销工具
代金券
商家券
委托营销
支付有礼
小程序发券插件
H5发券
图片上传(营销专用)
现金红包
资金应用
分账
连锁品牌分账
风险合规
商户开户意愿确认
消费者投诉2.0
商户违规通知回调
其他能力
图片上传
视频上传
微信支付平台证书

下载账单API

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


下载账单API为通用接口,交易/资金账单都可以通过该接口获取到对应的账单。


注意:

• 账单文件的下载地址的有效时间为30s。

• 强烈建议商户将实际账单文件的哈希值和之前从接口获取到的哈希值进行比对,以确认数据的完整性。

• 该接口响应的信息请求头中不包含微信接口响应的签名值,因此需要跳过验签的流程。

• 微信在次日9点启动生成前一天的对账单,建议商户10点后再获取。

接口说明

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

请求URL:通过申请账单接口获取到“download_url”,URL有效期30s

请求方式:GET

前置条件:调用申请账单接口并获取到“download_url”


请求参数

当获取到账单文件资源的下载地址信息后,如:

{
 "hash_type": "SHA1",
 "hash_value": "79bb0f45fc4c42234a918000b2668d689e2bde04",
 "download_url": " https://api.mch.weixin.qq.com/v3/billdownload/file?token=xxx"
}

可以通过微信支付API v3标准对download_url进行签名,并发起请求,即可下载到账单文件的数据流。



$ curl https://api.mch.weixin.qq.com/v3/billdownload/file?token=xxx -H '
Authorization:WECHATPAY2-SHA256-RSA2048mchid="1900009191",
nonce_str="593BEC0C930BF1AFEB40B4A08C8FB242",
signature="uOVRnA4qG/MNnYzdQxJanN+zU+lTgIcnU9BxGw5dKjK+VdEUz2FeIoC+D5sB/LN+nGzX3hfZg6r5
wT1pl2ZobmIc6p0ldN7J6yDgUzbX8Uk3sD4a4eZVPTBvqNDoUqcYMlZ9uuDdCvNv4TM3c1WzsXUrExwVkI
1XO5jCNbgDJ25nkT/c1gIFvqoogl7MdSFGc4W4xZsqCItnqbypR3RuGIlR9h9vlRsy7zJR9PBI83X8al
LDIfR1ukt1P7tMnmogZ0cuDY8cZsd8ZlCgLadmvej58SLsIkVxFJ8XyUgx9FmutKSYTmYtWBZ0+tNvfGmbXU7cob8H/
4nLBiCwIUFluw==",timestamp="1554208460",serial_no="1DDE55AD98ED71D6EDD4A4A16996DE7B47773A8C"'

返回参数

交易账单格式说明

1. 交易账单介绍

微信支付每天提供前一天的交易账单文件,用于商户核对订单、退款、营销、手续费等信息。账单内的数据包括:

(1)当天支付成功的订单,下单成功但用户未支付的订单不会出账。

(2)当天发起退款成功的退款单,退款发起成功就会出账,出账后退款状态不会更新。如果需要获取最新退款状态,请使用查询单笔退款API查询。

微信支付提供了3份不同类型的账单文件:

• ALL,包含了当天支付成功的订单和发起成功的退款单

• SUCCESS,仅包含支付成功的订单

• REFUND,仅包含发起成功的退款单

2. 交易账单的文件格式

交易账单文件内包含:明细数据表头、明细数据内容、汇总数据表头、汇总数据四个部分,每个字段使用英文逗号 , 间隔,明细数据内容每个字段前会增加1个字符 ` 用于避免获取的内容被excel展示为科学计数法的格式、丢失数据细节。3份不同类型的账单文件字段内容略有差异。

2.1. ALL类型账单文件具体字段

字段名 描述 示例值
明细数据
交易时间 指该笔交易的支付成功时间或发起退款成功时间(注:不是退款成功时间),格式为yyyy-MM-DD HH:MM:SS 2015-01-01 10:00:00
公众账号ID 发起该笔交易时使用的appid,appid是由微信给公众号或app等分配的唯一标识 wxab8acb865bb11234
商户号 发起该笔交易下单的微信支付商户号,8~10位数字 1234567890
特约商户号 如果是普通受理模式下的交易,展示特约商户的商户号,8~10位数字
如果是普通直连模式交易,则展示成数字0
1234567890
设备号 对应在下单时传入的device_info字段,没填写则留空 casher001
微信订单号 微信支付为该笔订单(或该笔退款对应的订单)分配的订单号 4200000008201712143733500001
商户订单号 商户传入的该笔订单(或该笔退款对应的订单)的商户订单号,对应下单接口里的out_trade_no字段 outtradeno001
用户标识 微信为支付用户在公众账号ID(appid)下分配的唯一标识(openid) testxt08c-XB5-QD208X1Aid0Cbs
交易类型 该笔订单(或该笔退款单对应的订单)的类型,使用英文缩写展示,包括但不限于(后续可能新增):
MICROPAY,付款码支付
JSAPI,JSAPI支付、小程序支付
NATIVE,Native支付
APP,APP支付
FACE,刷脸支付
NATIVE
交易状态 标识该笔明细数据的类型:
SUCCESS,支付成功,说明该行数据为一笔支付成功的订单
REFUND,转入退款,说明该行数据为一笔发起退款成功的退款单
REVOKED,已撤销,说明该行数据为一笔在用户支付成功后发起撤销的退款单
SUCCESS
付款银行 用户支付时使用的付款方式,包括但不限于(后续可能新增):
XXX_CREDIT,用户使用了XXX银行的一张信用卡付款
XXX_DEBIT,用户使用了XXX银行的一张储蓄卡付款
OTHERS,用户使用了零钱/零钱通等其他付款方式
CMB_CREDIT
货币种类 货币类型,符合ISO 4217标准的三位字母代码 CNY
应结订单金额 该笔订单参与计费的应结算金额(=订单金额-用户使用的免充值券金额),如果该行数据为退款或撤销则展示0.00,单位元,保留到小数点后2位 8.88
代金券金额 该笔订单中使用的微信支付代金券金额(包括充值券和免充值券),如果未使用代金券、或该行数据为退款或撤销则展示0.00,单位元,保留到小数点后2位 0.88
微信退款单号 微信支付为该笔退款分配的退款单号,如果该行数据为订单(交易状态SUCCESS)则展示0 50401010122021000000038202001
商户退款单号 商户发起退款时填入的商户退款单号,如果该行数据为订单(交易状态SUCCESS)则展示0 refundno001
退款金额 该笔退款单参与计费的应结算金额(申请退款金额-免充值券退款金额),如果该行数据为订单则展示为0.00,非负数、单位元,保留到小数点后2位 6.66
充值券退款金额 退款金额中包含的充值券退款金额,如果该行数据为订单或没有充值券退款则展示为0.00,非负数、单位元,保留到小数点后2位 0.66
退款类型 ORIGINAL—原路退款
BALANCE—转退到用户的微信支付零钱
如果该行数据为订单(交易状态SUCCESS)则留空
ORIGINAL
退款状态 生成账单文件时该笔退款的状态、出账后不会更新,如果该行数据为订单(交易状态SUCCESS),则留空
SUCCESS,退款成功
PROCESSING,退款处理中
FAIL,退款失败
CHANGE,退款异常
SUCCESS
商品名称 商户传入的该笔订单(或该笔退款对应的订单)的商品名称,对应下单接口里的body字段 零食
商户数据包 商户传入的该笔订单(或该笔退款对应的订单)的商户数据包,对应下单接口里的attach字段,不传时留空 交易收款
手续费 该笔订单/退款对应的手续费金额,订单对应正数、退款对应负数,单位元,保留小数点后2位 0.01
费率 该笔交易计费所使用的费率,百分数 0.60%
订单金额 该笔订单的金额,包括用户支付金额、充值券金额、免充值券金额,如果该行数据为退款或撤销则填0.00,单位元,保留到小数点后2位 9.76
申请退款金额 商户发起退款的金额,包括退给用户的金额、充值券退款金额、免充值券退款金额,如果该行数据订单则填0.00,单位元,保留到小数点后2位 6.66
费率备注 对计费费率的补充说明,如入驻结算规则ID、优惠费率活动ID等,可为空 726
汇总数据
总交易单数 该份账单内明细数据的笔数 200
应结订单总金额 账单内所有应结订单金额字段之和,保留小数点后2位 888.00
退款总金额 账单内所有退款金额字段之和,保留小数点后2位 666.00
充值券退款总金额 账单内所有充值券退款金额字段之和,保留小数点后2位 6.60
手续费总金额 账单内所有交易手续费字段之和,保留小数点后2位 10.00
订单总金额 账单内所有交易订单金额字段之和,保留小数点后2位 976.00
申请退款总金额 账单内所有申请退款金额字段之和,保留小数点后2位 666.00

2.2. SUCCESS和REFUND账单

SUCCESS和REFUND账单的字段和ALL账单内略有不同

SUCCESS账单字段:交易时间,公众账号ID,商户号,特约商户号,设备号,微信订单号,商户订单号,用户标识,交易类型,交易状态,付款银行,货币种类,应结订单金额,代金券金额,商品名称,商户数据包,手续费,费率,订单金额,费率备注

REFUND账单字段:交易时间,公众账号ID,商户号,特约商户号,设备号,微信订单号,商户订单号,用户标识,交易类型,交易状态,付款银行,货币种类,应结订单金额,代金券金额,退款申请时间,退款成功时间,微信退款单号,商户退款单号,退款金额,充值券退款金额,退款类型,退款状态,商品名称,商户数据包,手续费,费率,订单金额,申请退款金额,费率备注

2.3. 特殊字符转义

账单处理过程会对商品名称、商户数据包、设备号等商户自定义字段进行特殊字符转义,具体规则包括:

'转换成为\'

"转换成为\"

`转换成为\`

,转换成为\ (\+空格)

\r转换成为\\r

\t转换成为\\t

2.4. 补充说明

少部分商户目前的账单格式停留在历史早期版本,具体表现为:没有应结算订单金额字段、对应的是总金额字段,没有代金券金额字段、对应的是企业红包金额字段。如需调整为最新格式的账单,可以通过在产品中心中开通免充值优惠券功能,次日开始的账单格式即会完成变更。

3. 账单样例

《ALL.xlsx》《REFUND.xlsx》《SUCCESS.xlsx》

资金流水账单

《资金账单.xlsx》

分账账单

《 分账账单.xlsx》

错误码公共错误码

状态码 错误码 描述 解决方案
500 SYSTEM_ERROR 系统错误 系统异常,请使用相同参数稍后重新调用
400 PARAM_ERROR 参数错误 请使用正确的参数重新调用
400 INVALID_REQUEST 参数错误 请按第一步申请账单的API指引,重新获取账单地址后再请求
403 NO_AUTH 权限异常 请检查本次请求的商户是否与第一步申请账单API的请求商户一致


技术咨询

文档反馈