Skip to main content

Get Transactions for Cards with Filtering Options

GET 
/api/v1/cards/transactions

Retrieves a list of transactions for a specified card or for all cards associated with the client. The function allows filtering transactions based on the card ID.

  • If 'card_id' is specified, it fetches transactions only for that card.
  • If 'card_id' is not specified, it fetches transactions for all cards under the client's account. Transaction statuses include:
  • 'CLEARED': Transactions that were authorized but not captured by a follow-up capture transaction. The reserved funds are released back to the wallet. For 'CLEARED' transactions, the amount is deducted as paramount in capture transactions.
  • 'REVERSED': Transactions that were reversed upon an authorization reversal request. This results in the release of reserved funds back to the wallet. 'REVERSED' transactions also encompass 'CLEARED' and 'EXPIRED' statuses.
  • 'EXPIRED': Transactions where the authorization expires after 7 days without a capture or reversal. The reserved funds are released back to the wallet in such cases.

Request​

Query Parameters

    card_id Card Id

    The unique identifier of the card for which transactions are being retrieved. If not specified, transactions for all cards are retrieved.

    from_created_at From Created At

    Default value: 1970-01-01

    The start date for filtering transactions, in ISO8601 format (inclusive).

    to_created_at To Created At

    The end date for filtering transactions, in ISO8601 format (inclusive).

    skip Skip

    The offset from where to start listing the transactions.

    limit Limit

    Default value: 2000

    The maximum number of transactions to return.

Responses​

Successful Response

Schema
  • Array [
    • id object required

    The unique identifier of the transaction.

    anyOf

    string

    bin Binrequired

    The Bank Identification Number associated with the transaction.

    card_id object

    The identifier of the card involved in the transaction.

    anyOf

    string

    mask_number Mask Numberrequired

    The masked number of the card for privacy.

    card_memo Card Memo

    A memo or card name associated with the card.

    card_status Card Statusrequired

    The current status of the card used in the transaction. 'ACTIVE' for cards that are currently in use and can be freely used for transactions, 'INACTIVE' for cards that cannot be used at the moment, and 'CLOSED' for cards that have been permanently deactivated and can no longer be used.

    card_user emailrequired

    The email address of the card user.

    date Daterequired

    The date of the transaction.

    billing_amount Billing Amount

    The billed amount in the transaction currency.

    billing_currency Billing Currency

    The currency of the billed amount.

    amount Amountrequired

    The transaction amount.

    currency Currencyrequired

    The currency of the transaction amount.

    charge Charge

    Charge is equal Fee

    status Statusrequired

    The status of the transaction.

    merchant_name Merchant Namerequired

    The name of the merchant where the transaction occurred.

    type Typerequired

    The type of transaction. Possible types include 'AUTHORIZATION' for initial holds on funds, 'CLEARING' for the settlement of funds, 'REVERSAL' for canceling an authorization before it settles, 'REFUND' for returning funds to the cardholder, and 'ORIGINAL_CREDIT' for transactions crediting funds back to a card without a preceding debit.

    previous_tx Previous Txrequired

    If applicable, details of the previous transaction state, typically in cases of 'REVERSAL' and 'SUCCESS' transactions. It references the transaction that initially authorized the payment, usually when the state is 'PENDING AUTHORIZATION'.

    failure_reason Failure Reason

    The reason for transaction failure, if any.

    decline_description Decline Description

    A detailed description of the reason for the transaction's decline, if applicable.

  • ]
Loading...