文档中心 > API类目 > 支付宝账单查询

alipay.user.accountreport.get (获取支付宝对账单记录)

获取支付宝对账单记录

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
fields String 必须 create_time,type,business_type,balance,in_amount,out_amount,alipay_order_no,merchant_order_no,self_user_id,opt_user_id,memo 需要返回的字段列表。create_time:创建时间,type:账务类型,business_type:子业务类型,balance:当时支付宝账户余额,in_amount:收入金额,out_amount:支出金额,alipay_order_no:支付宝订单号,merchant_order_no:商户订单号,self_user_id:自己的支付宝ID,opt_user_id:对方的支付宝ID,memo:账号备注
start_time Date 必须 2000-01-01 00:00:00 对账单开始时间。最近一个月内的日期。
end_time Date 必须 2000-01-02 00:00:00 对账单结束时间,其中end_time - start_time <= 1天,对于对账记录比较多的情况,强烈建议按天查询,否则会出现超时的情况。
type String 可选 PAYMENT 账务类型。多个类型是,用逗号分隔,不传则查询所有类型的。PAYMENT:在线支付,TRANSFER:转账,DEPOSIT:充值,WITHDRAW:提现,CHARGE:收费,PREAUTH:预授权,OTHER:其它。
page_no Number 可选 1
  • 默认值:1
  • 最小值:1
  • 要获取的对账单页码
    page_size Number 可选 40
  • 默认值:100
  • 最小值:1
  • 最大值:200
  • 每次查询获取对账记录数量

    响应参数

    名称 类型 示例值 描述
    alipay_records AlipayRecord [] 对账记录列表 对账记录列表
    • └ balance
    • String
    • 100.00
    • 当时支付宝账户余额
    • └ memo
    • String
    • hello world
    • 账号备注
    • └ alipay_order_no
    • String
    • 2014081021001001540010396144
    • 支付宝订单号
    • └ opt_user_id
    • String
    • 20880063000888880133
    • 对方的支付宝ID
    • └ merchant_order_no
    • String
    • T200P765216671818695
    • 支付宝订单号
    • └ create_time
    • String
    • 2014-08-20 20:40:03
    • 创建时间
    • └ self_user_id
    • String
    • 20880063000888880122
    • 自己的支付宝ID
    • └ business_type
    • String
    • PAYMENT
    • 子业务类型
    • └ out_amount
    • String
    • 50.00
    • 支出金额
    • └ type
    • String
    • PAYMENT
    • 账务类型
    • └ in_amount
    • String
    • 50.00
    • 收入金额
    total_pages Number 100 总页数
    total_results Number 1000 总记录数

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    AlipayUserAccountreportGetRequest req = new AlipayUserAccountreportGetRequest();
    req.setFields("create_time,type,business_type,balance,in_amount,out_amount,alipay_order_no,merchant_order_no,self_user_id,opt_user_id,memo");
    req.setStartTime(StringUtils.parseDateTime("2000-01-01 00:00:00"));
    req.setEndTime(StringUtils.parseDateTime("2000-01-02 00:00:00"));
    req.setType("PAYMENT");
    req.setPageNo(1L);
    req.setPageSize(40L);
    AlipayUserAccountreportGetResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <alipay_user_accountreport_get_response>
        <alipay_records>
            <alipay_record>
                <balance>100.00</balance>
                <memo>hello world</memo>
                <alipay_order_no>2014081021001001540010396144</alipay_order_no>
                <opt_user_id>20880063000888880133</opt_user_id>
                <merchant_order_no>T200P765216671818695</merchant_order_no>
                <create_time>2014-08-20 20:40:03</create_time>
                <self_user_id>20880063000888880122</self_user_id>
                <business_type>PAYMENT</business_type>
                <out_amount>50.00</out_amount>
                <type>PAYMENT</type>
                <in_amount>50.00</in_amount>
            </alipay_record>
        </alipay_records>
        <total_pages>100</total_pages>
        <total_results>1000</total_results>
    </alipay_user_accountreport_get_response>

    异常示例

    • XML示例
    • JSON示例
    <error_response>
        <code>50</code>
        <msg>Remote service error</msg>
        <sub_code>isv.invalid-parameter</sub_code>
        <sub_msg>非法参数</sub_msg>
    </error_response>

    错误码解释

    错误码 错误描述 解决方案
    isv.starttime-or-endtime-invalid 开始和结束时间格式必须为yyyy-MM-dd HH:mm:ss 调整开始时间或结束时间格式
    isv.starttime-is-after-endtime 开始时间不能晚于结束时间 调整开始时间或结束时间
    isv.starttime-is-too-early 必须是近1个月内的时间,请调整开始时间 调整开始时间
    isv.type-is-invalid 查询类型不正确,可选值deposit|withdraw|transfer|payment|charge|preauth|other,用半角逗号,分割 调整查询类型
    isv.invalid-subscribe-relations 未订购支付宝服务 把错误信息中的URL输入浏览器,按照提示进行订购
    isp.query-result-count-out-limit 查询结果超过最大数量限制 缩小查询范围,减少一次返回的数量
    isp.http-read-timeout 后端服务读取超时 适当重试
    isp.unknow-error 未知错误 联系TOP技术支持
    isv.time-scope-is-too-long 查询时间范围过大 缩短查询时间到1天以内

    API工具

    如何获得此API

    FAQ

    返回
    顶部