接口说明
接口英文名称:alipay.data.dataservice.bill.downloadurl.query
请求url:https://openapi.alipay.com/v3/alipay/data/dataservice/bill/downloadurl/query
请求方式:get
path指该参数为路径参数
query指该参数需在请求url传参
body指该参数需在请求json传参
通用场景
为方便商户快速查账,支持商户通过本接口获取商户离线账单下载地址
公共请求参数
业务请求参数
query参数
bill_type必选string(20)
【描述】账单类型,商户通过接口或商户经开放平台授权后其所属服务商通过接口可以获取以下账单类型。
【枚举值】
商户基于支付宝交易收单的业务账单: trade
基于商户支付宝余额收入及支出等资金变动的账务账单: signcustomer
营销活动账单,包含营销活动的发放,核销记录: merchant_act
【示例值】trade
bill_date必选string(15)
【描述】账单时间:
* 日账单格式为yyyy-mm-dd,最早可下载2016年1月1日开始的日账单。不支持下载当日账单,只能下载前一日24点前的账单数据(t 1),当日数据一般于次日 9 点前生成,特殊情况可能延迟。
* 月账单格式为yyyy-mm,最早可下载2016年1月开始的月账单。不支持下载当月账单,只能下载上一月账单数据,当月账单一般在次月 3 日生成,特殊情况可能延迟。
* 当biz_type为settlementmerge时候,时间为汇总批次结算资金到账的日期,日期格式为yyyy-mm-dd,最早可下载2023年4月17日及以后的账单。
【示例值】2016-04-05
smid可选string(20)
【描述】二级商户smid,这个参数只在bill_type是trade_zft_merchant时才能使用
【示例值】2088123412341234
常见请求示例
默认示例
curl -x get \
https://openapi.alipay.com/v3/alipay/data/dataservice/bill/downloadurl/query?smid=2088123412341234&bill_date=2016-04-05&bill_type=trade \
-h "authorization: alipay-sha256withrsa app_id=${appid},timestamp=${now},nonce=${uuid},expired_seconds=600,sign=${sign}" \
-h "alipay-request-id: ${requestid}" \
-h "content-type: application/json" \
-d ''
说明:本示例仅供参考。
公共响应参数
业务响应参数
bill_download_url必选string(2048)
【描述】账单下载地址链接,获取连接后30秒后未下载,链接地址失效。
【示例值】http://dwbillcenter.alipay.com/downloadbillfile.resource?biztype=x&pid=x&filetype=x&bizdates=x&downloadfilename=x&fileid=x
bill_file_code|账单文件结果说明必选string(64)
【描述】描述本次申请的账单文件状态。
empty_data_with_bill_file:当天无账单业务数据&&可以获取到空数据账单文件。
【枚举值】
空账单数据文件:当前周期无数据时候产生的账单文件: empty_data_with_bill_file
【注意事项】目前仅对默认配置用户生效,主动配置的不会返回当前字段。
【示例值】empty_data_with_bill_file
响应示例
正常示例
异常示例
{
"bill_download_url":"http://dwbillcenter.alipay.com/downloadbillfile.resource?biztype=x&pid=x&filetype=x&bizdates=x&downloadfilename=x&fileid=x",
"bill_file_code":"empty_data_with_bill_file"
}
说明:本示例仅供参考。
公共错误码
业务错误码
状态码 | 错误码 | 错误描述 | 凯发app官方网站的解决方案 |
---|---|---|---|
400 | bill_not_exist | 账单不存在 | 确认参数后重新查询 |
400 | invailid_arguments | 入参不合法 | 确认参数后重新查询 |
400 | unknown_error | 未知错误 | 稍后重试或联系小二排查问题 |