Antom, leading provider of tailored payment solutions

inquiryStatement

POST /v1/aba/accounts/inquiryStatement

调用此 API 获取交易账单。

结构

报文由报文头和报文体组成。本文主要介绍报文体结构信息,有关报文头的结构信息,请参阅:

注意:将每个字段(除数组外)的数据类型设置为字符串。这意味字段值必须使用双引号(" ")括起来。例如:

  • 如果字段的数据类型为整数属性,且其值为 20,设置为 "20"。
  • 如果字段的数据类型为布尔属性,且其值为 true,设置为 "true"。


入参

startTime Datetime  

查询的交易记录的开始时间。

注意:当 fuzzyName 字段为空时,startTime 和 endTime 计算的计费周期不能超过3个月(100天)。

更多信息:

  • 值遵循 ISO 8601 标准格式。例如,“2019-11-27T12:01:01+08:00”。

endTime Datetime  

查询的交易记录的结束时间。

注意:当 fuzzyName 字段为空时,startTime 和 endTime 计算的计费周期不能超过3个月(100天)。

更多信息:

  • 值遵循 ISO 8601 标准格式。例如,“2019-11-27T12:01:01+08:00”。

transactionTypeList Array<String>  

此接口请求的交易类型。支持的交易类型包括:

  • CHARGE: 发生在 ABA 的收费。
  • CHARGE_REFUND: 发生在 ABA 的收费退款。
  • CREDIT_LOAN: 发生在 ABA 的用户贷款资金。
  • CREDIT_REPAYMENT: 发生在 ABA 的用户贷款还款。
  • CREDIT_REPAY: 发生在 ABA 的用户贷款还款。
  • DIRECT_PAYMENT: 发生在 ABA 的直接支付。
  • DIRECT_PAYMENT_RECIPIENT: 发生在 ABA 的直接支付收款人。
  • DIRECT_REFUND: 发生在 ABA 的直接退款。
  • DIRECT_REFUND_DEDUCTION: 发生在 ABA 的直接退款扣款。
  • EXCHANGE: 在 ABA 进行资金兑换。
  • PAYMENT: 发生在 ABA 的支付。
  • PAYMENT_REFUND: 发生在 ABA 的退款。
  • SETTLEMENT: 发生在 ABA 的结算。
  • TOPUP: 发生在 ABA 的充值。
  • TRANSFER: 发生在 ABA 的转账(包括转账给第三方支付)。
  • TRANSFER_RECIPIENT: 发生在 ABA 的收款。
  • TRANSFER_RETURN: 发生在 ABA 的转账退款。
  • WITHDRAW: 发生在 ABA 的提现。
  • WITHDRAW_RETURN: 发生在 ABA 的提现退款。
  • CARD_PAYMENT: 发生在 ABA 的卡支付。
  • CARD_REFUND: 发生在 ABA 的卡退款。

注意:

  • 如果未提供任何值,将返回所有交易类型。
  • Antom 目前仅支持一次查询一种交易类型。

currencyList Array<String>  

该列表包含由三个字符组成的货币代码,用于表示商户查询所使用的货币,遵循 ISO 4217 标准。目前支持以下货币:

  • SGD
  • AUD
  • CAD
  • EUR
  • GBP
  • HKD
  • JPY
  • NZD
  • USD
  • CNY

注意:如果未提供任何值,将返回所有值。

pageSize Integer  REQUIRED

每页的条目数量。

更多信息:

  • 值范围: [0, 50]

pageNumber Integer  REQUIRED

表示包含交易信息当前页的索引。格式为:1, 2, 3,...

fuzzyName String  

用于使用模糊匹配过滤受益人的字符串。

assetId String  

银行卡的唯一标识符。

注意:当商户想要通过资产 ID 查询结果时请传入此字段。

更多信息:

  • 最大长度:32 字符

出参

result object  REQUIRED

表示该 API 调用是否成功。

Show child parameters

statementList Array<Statement>  

包含对账单信息的列表。

Show child parameters

totalCount Integer  

查询结果的条目总数。

注意:此字段仅在 result.resultStatus 为 ​S​ 时返回。

totalPageNumber Integer  

总页数。

注意:此字段仅在 result.resultStatus 为 S 时返回。

currentPageNumber Integer  

当前页码索引。

注意:此字段仅在 result.resultStatus 为 S 时返回。

API Explorer

请求

URL
Method
POST
请求体

响应

响应体

结果码

结果码值结果码信息行动建议
SUCCESSS成功。

接口调用成功,无需进一步操作。

PARAM_ILLEGALF存在非法参数。例如非数字输入或无效日期。

检查并验证请求字段(包括头部字段和正文字段)是否正确有效。

PROCESS_FAILF发生通用业务失败。请勿重试。

通常需要人工干预。建议联系Antom技术支持解决问题。

UNKNOWN_EXCEPTIONU接口调用因未知原因失败。

服务可能已下线,请稍后重试。若问题持续,请联系Antom技术支持。

REQUEST_TRAFFIC_EXCEED_LIMITU请求流量超过限制。

重新调用接口即可解决。若问题持续,请联系Antom技术支持。

OAUTH_FAILFOAuth流程失败。

请联系Antom技术支持获取详细原因。

INVALID_APIF调用的接口无效或未激活。

检查是否调用了正确的接口。

INVALID_CLIENTF客户端无效。

客户端ID不存在或无效。

INVALID_SIGNATUREF签名无效。

确保请求已使用有效签名正确签署。

METHOD_NOT_SUPPORTEDF服务器未实现请求的HTTP方法。

确保HTTP方法为POST。

USER_NOT_EXISTF用户不存在。

使用正确的用户信息重试。

SYSTEM_ERRORF系统错误。

请勿重试,并联系Antom技术支持获取更多详情。

SERVICE_NOT_ALLOWEDF服务不允许

使用正确的信息重试。若问题持续,请联系Antom技术支持。

CURRENCY_NOT_SUPPORTF不支持该货币。

确保货币输入正确后重试。

CONTRACT_CHECK_FAILF合同检查失败。

重试前检查合同状态。

AUTHORIZATION_NOT_EXISTF授权不存在。

确保输入正确。若问题持续,请联系Antom技术支持验证授权状态。

ACCESS_TOKEN_EXPIREDF访问令牌已过期。

刷新令牌以获取新的访问令牌,或联系Antom技术支持处理。