通用场景
为支付宝商家提供支付宝账户的账务流水信息,供对账使用。
公共请求参数
业务请求参数
以下参数 可选 传入
bill_user_idstring(20)
【描述】指定用户做账单查询
新商户建议使用open_id替代该字段。对于新商户,bill_user_id字段未来计划逐步回收,存量商户可继续使用。如使用open_id,请确认 应用-开发配置-openid配置管理 已启用。无该配置项,可查看openid配置申请。
【示例值】2088123456789012
open_id|支付宝openidstring(128)
【描述】用于标记支付宝用户在应用下的唯一标识 详情可查看 openid简介
【示例值】074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5
start_time可选string(23)
【描述】账务流水创建时间的起始范围。只能查询一年内的记录。精确查询不需要指定
【示例值】2019-01-01 00:00:00
end_time可选string(23)
【描述】账务流水创建时间的结束范围。与起始时间间隔不超过31天。查询结果为起始时间至结束时间的左闭右开区间。精确查询不需要指定
【示例值】2019-01-02 00:00:00
alipay_order_no可选string(255)
【描述】支付宝订单号,通过支付宝订单号精确查询相关的流水明细。支付宝订单号和商户订单号互斥。选择支付宝订单号时,不可选商户订单号。
【示例值】20190101***
merchant_order_no可选string(255)
【描述】商户订单号,通过商户订单号精确查询相关的流水明细。支付宝订单号和商户订单号互斥。选择商户订单号时,不可选支付宝订单号。
【示例值】tx***
page_no可选string(8)
【描述】分页号,从1开始
【示例值】1
page_size可选string(8)
【描述】分页大小1000-2000,默认2000
【示例值】2000
trans_code可选string(128)
【描述】账务的类型代码,特殊场景下使用
【示例值】101101,301101
agreement_no可选string(32)
【描述】协议授权码,特殊场景下使用
【示例值】20215606000635888888
agreement_product_code可选string(64)
【描述】协议产品码。特殊场景下使用
【枚举值】
协议产品码: fund_sign_withholding
【示例值】fund_sign_withholding
常见请求示例
默认示例
curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.data.bill.accountlog.query&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=rsa2×tamp=${now}' \
-f 'biz_content={
"start_time":"2019-01-01 00:00:00",
"end_time":"2019-01-02 00:00:00",
"alipay_order_no":"20190101***",
"merchant_order_no":"tx***",
"page_no":"1",
"page_size":"2000",
"trans_code":"101101,301101",
"agreement_no":"20215606000635888888",
"agreement_product_code":"fund_sign_withholding",
"bill_user_id":"2088123456789012",
"open_id":"074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5"
}' 说明:本示例仅供参考。
公共响应参数
业务响应参数
page_no必选string(8)
【描述】分页号,从1开始
【示例值】1
page_size必选string(8)
【描述】分页大小1000-2000
【示例值】2000
total_size必选string(20)
【描述】账务明细总数。返回满足查询条件的明细的数量
【示例值】10000
detail_list可选accountlogitemresult[]
【描述】账务明细返回结果。
当查询为空的时候,不返回,有结果的时候才会返回。
trans_dt必选string(20)
【描述】入账时间
【示例值】2019-01-01 00:00:00
account_log_id必选string(256)
【描述】支付宝账务流水号。对账使用,不脱敏
【示例值】1***
alipay_order_no必选string(255)
【描述】支付宝订单号。对账使用,不脱敏
【示例值】20190101***
trans_amount必选string(20)
【描述】金额,单位元
【示例值】1000.00
balance必选string(20)
【描述】余额,单位元,仅供参考。由于架构原因,余额变动并不保证连续。也就是余额不一定等于上一笔余额减去当笔金额。但是会保证最终一致。
【示例值】10000.00
other_account必选string(255)
【描述】对方账户
【示例值】张*(a*@alipay.com)
direction必选string(2)
【描述】收入/支出。表示收支。amount是正数,返回“收入”。amount是负数,返回“支出”
【枚举值】
收入: 收入
支出: 支出
【示例值】收入
merchant_order_no可选string(255)
【描述】商户订单号,创建支付宝交易时传入的信息。对账使用,不脱敏
【示例值】tx***
type可选string(20)
【描述】账务记录的类型,仅供参考(可能会变化)
【枚举值】
交易: 交易
交易退款: 交易退款
服务费: 服务费
【示例值】交易
trans_memo可选string(1000)
【描述】账务备注。由上游业务决定,不可依赖此字段进行对账
【示例值】备注1
bill_source可选string(1000)
【描述】业务账单来源,资金收支对应的上游业务订单数据来源,确认业务订单出处。此字段供商户对账使用,不脱敏。
【示例值】商家中心
biz_nos可选string(1000)
【描述】业务订单号,资金收支相关的业务场景订单号明细,字母大写;m:平台交易主单号,s:平台交易子单号,o:业务系统单据号(如退款订单号)。此字段供商户对账使用,不脱敏。
【示例值】m{330***}|s{330***}|o{192***}
biz_orig_no可选string(1000)
【描述】业务基础订单号,资金收支对应的原始业务订单唯一识别编号。此字段供商户对账使用,不脱敏。
【示例值】330***
biz_desc可选string(1000)
【描述】业务描述,资金收支对应的详细业务场景信息。此字段供商户对账使用,不脱敏。
【示例值】002***|交易退款
merchant_out_refund_no可选string(255)
【描述】支付宝交易商户退款请求号。对应商户在调用收单退款接口openapi请求传入的outrequestno参数值
【示例值】20211119***
complement_info可选string(255)
【描述】账单的补全信息,用于特殊场景,普通商户不需要传值,对账时可忽略。
【示例值】商家中心
store_name可选string(256)
【描述】门店信息
【示例值】杭州一店
响应示例
正常示例
异常示例
{
"alipay_data_bill_accountlog_query_response": {
"code": "10000",
"msg": "success",
"page_no": "1",
"page_size": "2000",
"total_size": "10000",
"detail_list": [
{
"trans_dt": "2019-01-01 00:00:00",
"account_log_id": "1***",
"alipay_order_no": "20190101***",
"merchant_order_no": "tx***",
"trans_amount": "1000.00",
"balance": "10000.00",
"type": "交易",
"other_account": "张*(a*@alipay.com)",
"trans_memo": "备注1",
"direction": "收入",
"bill_source": "商家中心",
"biz_nos": "m{330***}|s{330***}|o{192***}",
"biz_orig_no": "330***",
"biz_desc": "002***|交易退款",
"merchant_out_refund_no": "20211119***",
"complement_info": "商家中心",
"store_name": "杭州一店"
}
]
},
"sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}说明:本示例仅供参考。
公共错误码
业务错误码
| 错误码 | 错误描述 | 凯发app官方网站的解决方案 |
|---|---|---|
| system_error | 系统繁忙 | 服务器异常 可能发生了网络或者系统异常,导致服务调用失败,商户可以用同样的请求发起重试 |
| invalid_parameter | 参数有误 | 请根据接口返回的参数非法的具体错误信息,修改参数后进行重试 |
| agreement_check_fail | 协议授权检查失败,从检查用户的签约或者协议关系。 | 从检查用户的签约或者协议关系,重新签约授权后发起 |
| illegal_argument | 授权协议参数检查失败 | 授权查询的情况下,请保证授权协议号和产品码都非空 |
| isv_business_failed | 数据量过大查询超时,请缩小查询时间范围 | 业务查询超时,一般是由于数据量过大造成的,请缩小查询时间范围 |
| system_busy | 业务繁忙 | 请稍后重试 |
| system_rate_limit | 系统当前负载较高,请求被限流,请稍后重试 | 间隔1分钟后重试 |
| user_agreement_check_fail | 用户授权协议检查不通过。 | 联系用户重新使用正确的支付宝账户进行授权,确认授权完成后发起重试 |
| user_rate_limit | 调用频率超限 | 间隔1分钟后重试,查看 调用频率限制 中新增的2.4请求频次 |