下载对账单
通过接口请求指定日期的对账单,成功返回下载链接后,下载对账单压缩文件。 ::: tip 注意:
- 对账单只包含成功支付与成功退款订单,未支付或支付过程中关闭的订单不会包含在对账单中
- 对账单中涉及金额的字段单位为“元”
- 对账单接口只能下载三个月以内的账单
- 此接口需提前开通权限
- 对账单在每天10点后生成,建议在12点后下载 :::
请求接口
/openapi/pay/downloadbill
公共参数
请求参数
申请对账单,获取下载链接
| 参数 | 必填 | 类型 | 说明 |
|---|---|---|---|
| bill_date | 是 | String(64) | 对账单日期,格式:yyyy-MM-dd,例如:2021-09-01 |
| bill_type | 否 | String(64) | 对账单类型。ALL,返回当日所有订单信息,默认值 PAY,返回当日成功支付的订单 REFUND,返回当日退款订单 |
响应参数
| 名称 | 必填 | 类型 | 说明 |
|---|---|---|---|
| download_url | 是 | string(2048) | 对账单下载地址 |
| md5_value | 是 | String(32) | 对账单源文件MD5值 |
| expire_time | 否 | Long | 下载地址有效时间,单位秒 |
源文件下载
在响应成功后一定时间内(expire_time)内,通过download_url下载对账单压缩文件(.gz),解压后获取到账单源文件(.csv)。 对源文件做MD5,可以匹对md5_value是否一致。
对账单字段说明
账单文件包括明细数据和汇总数据两部分,每一部分都包含一行表头和若干行具体数据。 明细数据每一行对应所下载账单的一条具体数据,同时明细数据中每一个字段前都加入了 ` 字符(重音符,为标准键盘1左边键的字符),以避免数据被Excel按科学计数法处理。如需汇总金额等数据,可以批量替换掉该字符。 汇总数据在倒数两行。
- 明细数据表头
::: tip 请根据返回文件中第一行表头的列名顺序获取明细字段,列名的顺序非一直固定的 :::
| 字段(仅作参考) | 列名 | 非空 | 说明 |
|---|---|---|---|
| trade_time | 交易时间 | 是 | 交易订单完成时间;退款订单表示为退款订单完成时间 |
| pay_no | 订单号 | 是 | 聚合支付订单号;退款订单表示为原订单的单号,600开头 |
| out_trade_no | 业务系统订单号 | 是 | 业务系统订单号,退款订单表示为原订单的业务系统订单号 |
| payment | 支付方式 | 是 | 支付方式 ,指交易平台,微信,支付宝等, |
| transaction_id | 交易平台单号 | 否 | 支付平台交易流水号。微信、支付宝、云闪付等用户支付使用的平台返回流水号 |
| app_id | 平台应用ID | 否 | 交易平台的APPID,比如微信的公众账号appid,退款订单时该字段值与原交易订单一致 (暂无返回) |
| user_id | 平台用户ID | 否 | 支付宝user_id,微信open_id,退款订单时该字段值与原交易订单一致 (暂无返回) |
| channel | 交易渠道 | 否 | 比如微信官方,威富通,智付等等,退款订单时该字段值与原交易订单一致 |
| channel_mch_id | 渠道商户号 | 否 | 服务商的商户号、普通商户的商户号,退款订单时该字段值与原交易订单一致 |
| channel_sub_mch_id | 渠道二级商户号 | 否 | 比如微信的特约商户号,农行的二级商户号,退款订单时该字段值与原交易订单一致 |
| channel_transaction_id | 渠道交易单号 | 否 | 实际交易渠道的单号(间连渠道交易流水号),退款订单时该字段值与原交易订单一致 |
| trade | 用户支付类型 | 否 | (暂无返回) |
| status | 交易状态 | 是 | SUCCESS:支付成功,表示支付成功的订单 REFUND:转入退款,表示此行记录为退款订单 |
| bank | 付款银行 | 否 | 银行卡类型,微信支付有返回,支付宝等其他平台无返回则用默认值OTHERS |
| fee_type | 货币类型 | 否 | 人民币CNY,暂时不支持外币 |
| settlement_fee | 应结订单金额 | 否 | 商户应结算到账的金额,不含手续费 |
| coupon_fee | 代金券金额 | 否 | 非充值代金券的金额,退款订单该字段为0 |
| refund_no | 退款单号 | 否 | 聚合支付退款订单号,620开头 |
| out_refund_no | 业务系统退款订单号 | 否 | |
| refund_id | 平台退款单号 | 否 | |
| channel_refund_id | 渠道退款单号 | 否 | |
| refund_fee | 申请退款金额 | 否 | 申请退款金额 = 退回金额 + 充值券退款金额 |
| refund_settlement_fee | 退回金额 | 否 | 退回给顾客的金额 |
| refund_coupon_fee | 充值券退款金额 | 否 | 退款订单信息,退回给充值券出资方的金额 |
| refund_type | 退款类型 | 否 | ORIGINAL:原路退款【默认状态】 BALANCE:退回到余额 OTHER_BALANCE:原账户异常退到其他余额账户 OTHER_BANKCARD:原银行卡异常退到其他银行卡 |
| refund_status | 退款状态 | 否 | |
| body | 商品名称 | 是 | 支付简要描述 |
| fee | 订单金额 | 是 | 交易总额,订单金额 - 代金券金额 = 应结订单金额;退款订单金额为0 |
| service_fee | 手续费 | 是 | 交易的手续费,退款时显示退还的手续费,记为负数 |
| rate | 费率 | 是 | 交易时的当时的配置数值,或被渠道对账单修正后的实际费率数值 |
| rate_remark | 费率备注 | 否 | |
| shop_id | 门店编号 | 否 | 支付时传的门店编号 |
| device_id | 设备编号 | 否 | 支付时传的设备编号 |
- 汇总数据表头
| 字段(仅供参考) | 列名 | 非空 | 说明 |
|---|---|---|---|
| sum_total_count | 总交易单数 | 是 | 含支付与退款单数 |
| sum_pay_count | 总支付单数 | 是 | |
| sum_refund_count | 总退款单数 | 是 | |
| sum_pay_fee | 订单总金额 | 是 | |
| sum_settlement_fee | 应结订单总金额 | 是 | |
| sum_service_fee | 手续费总金额 | 是 | |
| sum_refund_fee | 申请退款总金额 | 是 | |
| sum_refund_settlement_fee | 退款回用户总金额 | 是 | |
| sum_refund_coupon_fee | 充值券退款总金额 | 是 |