Antom, leading provider of tailored payment solutions
Contact Us
Log In

inquireCardTransactionEvent

POST /v1/aba/cards/inquireCardTransactionEvent

This API is used to retrieve card transaction events as a flat list, where each row represents a single event. It is designed for merchants to perform line-by-line verification of card activity, while the task of reconciling posted account balances remains with the statement APIs.

Request parameters

startTime Datetime  

The start time. Optional lower bound for transactionTime.

Notes:

  • If only startTime is provided, query records from startTime onward.
  • If omitted, no lower time bound is applied.
  • PARAM_ILLEGAL is returned if invalid date-time, or a value that violates the maximum 100-day range.

More information:

  • Maximum length: 32 characters
  • The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".

endTime Datetime  

The end time. Optional upper bound for transactionTime.

Notes:

  • If only endTime is provided, query records up to endTime.
  • If omitted, no upper time bound is applied.
  • PARAM_ILLEGAL is returned if invalid date-time, or a value that violates the maximum 100-day range.

More information:

  • Maximum length: 32 characters
  • The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".

assetIdList Array<String>  

Pass this parameter to filter the list by card asset IDs.

Maximum size: 20, each ≤ 32

Note: If omitted, this parameter displays all card asset IDs.

More information:

  • Maximum length: 32 characters
  • Maximum size: 20 elements

eventIdList Array<String>  

Pass in this parameter to filter the list by specific events.

Maximum size: 20, each ≤ 64

Note: If omitted, this parameter displays all event IDs.

lifecycleIdList Array<String>  

Pass in this parameter to filter the list by spend-group IDs.

Maximum size: 20, each ≤ 64

Note: If omitted, this parameter displays all lifecycle IDs.

transactionCurrencyList Array<String>  

The order currency. The value is a 3-letter currency code that follows the ISO 4217 standard.

Maximum size: 20, each = 3

Notes:

  • If omitted, this parameter displays all currencies.
  • PARAM_ILLEGAL is returned if more than 20 elements, or an element that is not a supported three-letter ISO 4217 code.

eventTypeList Array<String>  

Event types. Valid values are:

  • AUTH: Authorization event. In the current flow, a successful authorization also performs the billing deduction.
  • AUTH_CANCEL: Authorization released/reversed before capture.
  • CAPTURE: Capture or clearing confirmation. Its corresponding authorization event already handled the billing deduction, so capture does not move the amount again.
  • REFUND: Funds returned to the card.
  • CHARGEBACK: Disputed amount reversed off the spend.
  • REPAYMENT: A card payment for a previous order that was initially paid using the Antom fund account.

Notes:

  • If omitted, this parameter displays all event types.
  • PARAM_ILLEGAL is returned if more than 6 elements, or an unrecognized value.

More information:

  • Maximum size: 6 elements

statusList Array<String>  

Event status. Valid values are:

  • SUCCESS: Event completed successfully.
  • FAIL: Event did not complete (declined or errored).
  • PROCESSING: The event is in progress.

Notes:

  • If omitted, this parameter displays all statuses.
  • PARAM_ILLEGAL is returned if more than three elements, or an unrecognized value.
  • A successful cancellation is defined by the value of statusList being SUCCESS (as conveyed in the event payload when the value of eventTypeList is AUTH_CANCEL, not via an event where the value of statusList is FAIL).

More information:

  • Maximum size: 3 elements

pageSize Integer  REQUIRED

Items per page.

Note: There is no default value for this parameter. PARAM_ILLEGAL is returned if missing, empty, or out of range.

More information:

  • Value range: [1, 100]

pageNumber Integer  REQUIRED

One-based page number.

Note: There is no default value for this parameter. PARAM_ILLEGAL is returned if missing, empty, or out of range.

More information:

  • Value range: [1, 10000]

Response parameters

result Result  REQUIRED

The result of the API call.

Show child parameters

events Array<Event>  

Card transaction events.

Notes:

  • This parameter is returned only when the value of resultStatus is S.
  • This parameter returns an empty array when the query does not have a match.
  • Mandatory child parameters are present for every returned item.

More information:

  • Maximum size: 100 elements
Show child parameters

totalCount Integer  

Total number of matching records when the request is processed.

Notes:

  • This parameter is returned when the value of resultStatus is S.
  • This value is 0 if no records match.

More information:

  • Value range: [0, +∞)

totalPageNumber Integer  

Total number of pages, calculated as ​ceil(totalCount / pageSize)​.

Notes:

  • This parameter is returned when the value of resultStatus is S.
  • This value is 0 if no records match.

More information:

  • Value range: [0, +∞)

currentPageNumber Integer  

Current 1-based page number, matching the requested pageNumber.

Note: This parameter is returned when the value of resultStatus is S.

More information:

  • Value range: [1, 10000]
API Explorer

Request

URL

Method
POST
Request Body

Response

Case
Refund
Response Body

Failure Reason Code

Code

Value

Message

CARD_BALANCE_NOT_ENOUGH

F

Insufficient account balance.

CARD_OVER_LIMIT

F

Insufficient daily/monthly limit.

CARD_AVS_RESULT

F

AVS verification failed.

CARD_ASSERT_ERROR

F

The card has expired.

CARD_SECURITY_REJECT

F

Risk control rejection.

CARD_INVALID_MERCHANT

F

Invalid merchant.

UNKNOWN_EXCEPTION

F

Unknown reason.

CARD_INVALID_AMOUNT

F

Invalid payment amount.

CARD_INVALID_CARD_NUMBER

F

Invalid card number.

CARD_EXPIRED_CARD

F

Card expired.

CARD_INCORRECT_PIN

F

Incorrect PIN.

CARD_INVALID_TRANSACTION

F

Abnormal transaction.

CARD_EXCEED_WITHDRAW_AMOUNT_LIMIT

F

Withdrawal amount limit exceeded.

CARD_EXCEED_WITHDRAW_FREQUENCY_LIMIT

F

Withdrawal frequency limit exceeded.

CARD_VERIFICATION_FAILED

F

Verification failed.

CARD_EXCEED_PIN_ALLOW_NUMBER

F

Exceeded allowed PIN attempts.

CARD_AUTHENTICATION_REQUIRED

F

Authentication required.

CARD_CVV2_FAILURE

F

CVV2 verification failed.

CARD_INVALID_CARD

F

Invalid card.

CARD_STATUS_FROZEN

F

Card is frozen.

BALANCE_ACCOUNT_NOT_AVAILABLE

F

Account status abnormal.

SYSTEM_ERROR

F

System error.


Result/Error codes

CodeValueMessageFurther action
SUCCESSSSuccess

No further action is needed.

PARAM_ILLEGALFIllegal parameters exist. For example, a non-numeric input, or an invalid date.

Check and verify whether the request parameters, including the header parameters and body parameters, are correct and valid. For details on the parameters of each API, see the specific API Structure section.

ACCESS_TOKEN_EXPIREDFThe access token expired.

Refresh token to get a new access token or contact our Technical Support Team to address it.

UNKNOWN_EXCEPTIONUAPI failed due to unknown reason.

The service might be down, retry later. If the issue persists, contact our Technical Support Team.

PROCESS_FAILFA general business failure occurred.

Do not retry. Human intervention is usually needed. It is recommended that you contact Antom Technical Support Team to resolve the issue.

CONTRACT_NOT_EXISTFThe contract check has failed.

Ensure the Partner has already signed a contract and the input is correct.

USER_NOT_EXISTFThe user does not exist.

Retry with the correct user information.