Antom, leading provider of tailored payment solutions

inquireCardTransactionEvent

POST /v1/aba/cards/inquireCardTransactionEvent

此 API 用于以扁平列表的形式查询卡交易事件,其中每一行代表一个事件。它旨在让商户能够逐行核对卡交易记录,而已入账账户余额的对账仍由账单 API 完成。

结构

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

注意:将每个参数(除数组外)的数据类型设置为字符串,即参数的值必须使用英文双引号(" ")包裹起来。例如:

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


入参

startTime Datetime  

开始时间。作为 transactionTime 的可选下限。

注意:

  • 如果只提供 startTime,则从 startTime 开始查询记录。
  • 如果未提供,则不设时间下线。
  • 如果日期时间无效,或超出最大 100 天范围,则返回错误码 ​PARAM_ILLEGAL。

更多信息:

  • 最大长度:32 字符
  • 值遵循 ISO 8601 标准格式。例如,“2019-11-27T12:01:01+08:00”。

endTime Datetime  

结束时间。作为 transactionTime 的可选上线。

注意:

  • 如果仅提供 endTime,则查询至 endTime 为止的记录。
  • 如果未提供,则不设时间上线。
  • 如果日期时间无效,或超出最大 100 天范围,则返回错误码 PARAM_ILLEGAL。

更多信息:

  • 最大长度:32 字符
  • 值遵循 ISO 8601 标准格式。例如,“2019-11-27T12:01:01+08:00”。

assetIdList Array<String>  

传入该参数以按卡资产 ID 筛选列表。

最大数量:20,每个 ≤ 32

注意:如果未提供,该参数将显示所有卡资产 ID。

更多信息:

  • 最大长度:32 字符
  • 最多可包含元素个数:20

eventIdList Array<String>  

传入该参数以按特定事件筛选列表。

最大数量:20,每个 ≤ 64

注意:如果未提供,该参数将显示所有事件 ID。

lifecycleIdList Array<String>  

传入该参数以按消费组 ID 筛选列表。

最大数量:20,每个 ≤ 64

注意:如果未提供,该参数将显示所有生命周期 ID。

transactionCurrencyList Array<String>  

订单币种。该值为 3 字母货币代码,遵循 ISO 4217 标准。

最大数量:20,每个 = 3

注意:

  • 如果未提供,该参数将显示所有币种。
  • 如果超过 20 个元素,或某个元素不是受支持的 3 字母 ISO 4217 代码,则返回错误码 ​PARAM_ILLEGAL​。

eventTypeList Array<String>  

事件类型。有效值为:

  • AUTH:授权事件。在当前流程中,授权成功即完成账单扣款。
  • AUTH_CANCEL:在请款前释放或撤销的授权。
  • CAPTURE:请款或清算确认。其对应的授权事件已完成账单扣款,因此请款不会再次移除金额。
  • REFUND:退回到卡的资金。
  • CHARGEBACK:因争议而从消费中撤销的金额。
  • REPAYMENT: 对先前使用 Antom 资金账户支付的订单进行的卡支付。

注意:

  • 如果未提供,该参数将显示所有事件类型。
  • 如果超过 6 个元素,或存在无法识别的值,则返回错误码 ​PARAM_ILLEGAL​。

更多信息:

  • 最多可包含元素个数:6

statusList Array<String>  

事件状态。有效值为:

  • SUCCESS:事件成功完成。
  • FAIL:事件未完成(拒绝或出错)。
  • PROCESSING:事件处理中。

注意:

  • 如果未提供,该参数将显示所有状态。
  • 如果超过三个元素,或存在无法识别的值,则返回错误码 ​PARAM_ILLEGAL​。
  • 成功的取消定义为 statusList 的值为 SUCCESS(当 eventTypeList 为 AUTH_CANCEL 时在事件载荷中传达,而非通过 statusList 为 FAIL 的事件来定义)。

更多信息:

  • 最多可包含元素个数:3

pageSize Integer  REQUIRED

每页显示条数。

注意:该参数无默认值。如果该值缺失、为空或超出范围,则返回错误码 ​PARAM_ILLEGAL​。

更多信息:

  • 值范围: [1, 100]

pageNumber Integer  REQUIRED

从 1 开始的页码。

注意:该参数无默认值。如果该值缺失、为空或超出范围,则返回错误码 PARAM_ILLEGAL。

更多信息:

  • 值范围: [1, 10000]

出参

result Result  REQUIRED

接口调用的结果。

Show child parameters

events Array<Event>  

卡交易事件。

注意:

  • 当且仅当 resultStatus 的值为 ​S​ 时,才返回此参数。
  • 此参数在查询无匹配结果时返回空数组。
  • 每个返回项均包含必填子参数。

更多信息:

  • 最多可包含元素个数:100
Show child parameters

totalCount Integer  

请求处理时匹配的记录总数。

注意:

  • 此参数在 resultStatus 的值为 S 时返回。
  • 无匹配记录时,此值为 0。

更多信息:

  • 值范围: [0, +∞)

totalPageNumber Integer  

总页数,计算方式为 ​ceil(totalCount / pageSize)​。

注意:

  • 此参数在 resultStatus 的值为 S 时返回。
  • 当无匹配记录时,此值为 0。

更多信息:

  • 值范围: [0, +∞)

currentPageNumber Integer  

当前页码(从 1 开始),与请求的 pageNumber一致。

注意:此参数在 resultStatus 的值为 S 时返回。

更多信息:

  • 值范围: [1, 10000]
API Explorer

请求

URL
Method
POST
请求体

响应

Case
Refund
响应体

失败原因码

代码

值

消息

CARD_BALANCE_NOT_ENOUGH

F

账户余额不足。

CARD_OVER_LIMIT

F

日/月额度不足。

CARD_AVS_RESULT

F

AVS 验证失败。

CARD_ASSERT_ERROR

F

卡已过期。

CARD_SECURITY_REJECT

F

风控拒绝。

CARD_INVALID_MERCHANT

F

无效商户。

UNKNOWN_EXCEPTION

F

未知原因。

CARD_INVALID_AMOUNT

F

无效支付金额。

CARD_INVALID_CARD_NUMBER

F

无效卡号。

CARD_EXPIRED_CARD

F

卡已过期。

CARD_INCORRECT_PIN

F

PIN 错误。

CARD_INVALID_TRANSACTION

F

异常交易。

CARD_EXCEED_WITHDRAW_AMOUNT_LIMIT

F

超出取款金额限制。

CARD_EXCEED_WITHDRAW_FREQUENCY_LIMIT

F

超出取款频率限制。

CARD_VERIFICATION_FAILED

F

验证失败。

CARD_EXCEED_PIN_ALLOW_NUMBER

F

超出允许的 PIN 尝试次数。

CARD_AUTHENTICATION_REQUIRED

F

需要认证。

CARD_CVV2_FAILURE

F

CVV2 验证失败。

CARD_INVALID_CARD

F

无效卡。

CARD_STATUS_FROZEN

F

卡已冻结。

BALANCE_ACCOUNT_NOT_AVAILABLE

F

账户状态异常。

SYSTEM_ERROR

F

系统错误。


结果码

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

无需进一步操作。

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

检查并验证请求参数(包括头参数和请求体参数)是否正确有效。有关各接口的参数详情,请参见相应的接口结构章节。

ACCESS_TOKEN_EXPIREDF访问令牌已过期。

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

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

服务可能不可用,请稍后重试。如果问题持续存在,请联系 Antom 技术支持团队。

PROCESS_FAILF发生了常见的业务失败。

请勿重试。通常需要人工干预。建议您联系 Antom 技术支持团队解决问题。

CONTRACT_NOT_EXISTF合约检查失败。

请确保合作方已签署合约且输入正确。

USER_NOT_EXISTF用户不存在。

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