Immersve Docs
GithubX

List Transactions

get/api/accounts/{accountId}/transactions

List card purchase transactions by account

This API uses cursor-based pagination. Start by making a request without a cursor to get the first page. Use the nextCursor from the pageInfo in the response as the cursor for subsequent requests to retrieve further pages. Continue until nextCursor is undefined, indicating no more data.

Request

Path Parameters

  • accountIdstringrequired

    accountId linked to transactions

Query Parameters

  • limitnumber

    amount of records to return (max 1000)

  • cursorstring

    cursor to retrieve the next page

  • fromUTCstring

    Filter for transactions from this date (inclusive). Value should be a ISO 8601 string or RFC 2822 string

  • toUTCstring

    Filter for transactions up to this date (inclusive). Value should be a ISO 8601 string or RFC 2822 string

  • statusesstring
    Allowed values:all

    Filter for transaction status groups. By default the endpoint will return "holding" and "cleared" transactions. Passing "all" includes all statuses.

Response

Successful operation.

Body application/json

  • itemsobject[]

    Items

    • idstringrequired

      The transaction ID

    • descriptionstringrequired

      A description of the transaction

    • accountIdstringrequired

      Which account this transaction belongs to

    • statusstringrequired
      Allowed values:initholdingclearedreversed

      The status of the transaction

    • cashOperationstring

      Indicates that the transaction was cash-based and of which kind. Known values: atm-withdrawal, manual-cash-disbursement. New values may be added; clients must tolerate unknown values.

    • cardIdstringrequired

      Which card this transaction belongs to

    • cardTypestring
      Allowed values:virtualphysical

      Whether the card was issued as physical or virtual.

    • amountstringrequired

      The billing amount of the transaction, an integer in the smallest denomination for the given currency

    • currencystringrequired

      The billing currency of the transaction

    • acquirerAmountstringrequired

      The acquirer amount of the transaction, an integer in the smallest denomination for the given currency

    • acquirerCurrencystringrequired

      The acquirer currency of the transaction

    • feeAmountstringrequired

      The fee amount of the transaction, an integer in the smallest denomination for the given currency

    • transactionDatestring<date-time>required

      The created date formatted in ISO of the transactions

    • processedDatestring<date-time>

      The cleared date formatted in ISO of the transactions

    • referencestringrequired

      The reference used when making an enquiry through customer support

    • cardAcceptorobjectrequired
      • citystringrequired

        The city of the card acceptor

      • countryCodestringrequired

        The country code of the card acceptor

      • namestringrequired

        The name of the card acceptor

    • creditDebitIndicatorstring
      Allowed values:creditdebit

      Indicates if the transaction was a credit or debit

    • paymentTypestringrequired
      Allowed values:purchaserefundadjustment

      The type of payment

    • relatedPaymentIdstring

      The ID of the related payment transaction, if applicable

    • cardPresentboolean

      Whether the card was at the point of sale when the payment was authorized, as classified by the payment network. true for a card inserted, swiped, or tapped at a terminal, including a phone or watch tap and a manually keyed card at an attended terminal. false for e-commerce, in-app, mail order, and telephone order payments, and for a merchant charging a card it has stored on file.

    • tokenobject

      Present when the payment was made with a network token instead of the card's own PAN, for example from a digital wallet or a merchant's stored credential. Absent when the card itself was used.

      • requestorstringrequired

        Who the token was issued to: apple-pay, google-pay, merchant for a card the merchant has stored on file, or other for a token requestor Immersve does not name. Clients must tolerate unknown values.

    • securityChallengeobject

      Object containing security challenge information, if applicable.

      • refstring

        3DS challenge identifier. This can be used to correlate with the 'ref' in the payload of the webhook Payment 3DS OTP.

      • outcomestring

        3DS challenge outcome. May include the following values: challenge-confirmed, challenge-exempt, challenge-failed, challenge-timeout, challenge-denied.

    • failureReasonstring

      The reason for transaction failure, if applicable

  • pageInfoobject

    Page info for paginated results, undefined if no page info

    • nextCursorstring

      Cursor for next page, undefined if no more pages