Skip to main content

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

    accountId stringrequired

    accountId linked to transactions

Query Parameters

    limit number

    amount of records to return (max 1000)

    cursor string

    cursor to retrieve the next page

    fromUTC string

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

    toUTC string

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

Responses​

Successful operation

Schema

    items

    object[]

  • Array [

    • id stringrequired

    The transaction ID

    description stringrequired

    A description of the transaction

    accountId stringrequired

    Which account this transaction belongs to

    status stringrequired

    Possible values: [init, holding, cleared, failed]

    The status of the transaction

    cardId stringrequired

    Which card this transaction belongs to

    amount stringrequired

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

    currency stringrequired

    The billing currency of the transaction

    acquirerAmount stringrequired

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

    acquirerCurrency stringrequired

    The acquirer currency of the transaction

    feeAmount stringrequired

    The fee amount of the transaction

    transactionDate date-timerequired

    The created date formatted in ISO of the transactions

    processedDate date-time

    The cleared date formatted in ISO of the transactions

    reference stringrequired

    The reference used when making an enquiry through customer support

    cardAcceptor

    object

    required

    city stringrequired

    The city of the card acceptor

    countryCode stringrequired

    The country code of the card acceptor

    name stringrequired

    The name of the card acceptor

    creditDebitIndicator string

    Possible values: [credit, debit]

    Indicates if the transaction was a credit or debit

  • ]

    • pageInfo

    object

    Page info for paginated results, undefined if no page info

    nextCursor string

    Cursor for next page, undefined if no more pages

Loading...