alipay.data.bill.accountlog.query(支付宝商家账户账务明细查询) 在线调试(沙箱环境)

为支付宝商家提供支付宝账户的账务流水信息,供对账使用。

公共参数

请求地址

环境HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.data.bill.accountlog.query
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 344 商户请求参数的签名串,详见签名 详见示例
timestamp String 19 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 3 调用的接口版本,固定为:1.0 1.0
app_auth_token String 40 详见应用授权概述
biz_content String 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
start_time String 必选 20 账务流水创建时间的起始范围 2019-01-01 00:00:00
end_time String 必选 20 账务流水创建时间的结束范围。与起始时间间隔不超过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

响应参数

参数 类型 是否必填 最大长度 描述 示例值
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***
merchant_order_no String 必填 255 商户订单号,创建支付宝交易时传入的信息。对账使用,不脱敏 TX***
trans_amount String 必填 20 金额 1000.00
balance String 必填 20 余额,仅供参考。由于架构原因,余额变动并不保证连续。也就是余额不一定等于上一笔余额减去当笔金额。但是会保证最终一致。 10000.00
type String 必填 255 账务记录的类型,仅供参考 交易
other_account String 必填 255 对方账户 张*(a*@******.com)
trans_memo String 可选 1000 账务备注。由上游业务决定,不可依赖此字段进行对账 备注1
direction String 必填 20 收入/支出。表示收支。amount是正数,返回“收入”。amount是负数,返回“支出” 收入
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***|交易退款

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayDataBillAccountlogQueryRequest request = new AlipayDataBillAccountlogQueryRequest();
request.setBizContent("{" +
"\"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\"" +
"  }");
AlipayDataBillAccountlogQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "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*@******.com)",
                "trans_memo": "备注1",
                "direction": "收入",
                "bill_source": "商家中心",
                "biz_nos": "M{330***}|S{330***}|O{192***}",
                "biz_orig_no": "330***",
                "biz_desc": "002***|交易退款"
            }
        ]
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

{
    "alipay_data_bill_accountlog_query_response": {
        "code": "20000",
        "msg": "Service Currently Unavailable",
        "sub_code": "isp.unknow-error",
        "sub_msg": "系统繁忙"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

公共错误码

错误码错误描述解决方案
SYSTEM_ERROR 系统繁忙 稍后重试或联系小二排查问题
INVALID_PARAMETER 参数有误,返回错误的具体描述。如:查询范围不能超过31天 根据错误描述进行修改后,重新查询
SYSTEM_BUSY 业务繁忙 请稍后重试
onlineServer