---
title: "List transactions by account"
method: GET
path: "/accounts/{accountId}/transactions"
tags: ["Transactions"]
---

# List transactions by account

`GET /accounts/{accountId}/transactions`

Retrieve a list of all transactions for a specific account. The returned
list is [paginated](#pagination) and can be scrolled by following the
`next` and `prev` links where present. To narrow the results to a
specific date range pass one or both of `filter[since]` and
`filter[until]` in the query string. These filter parameters
**should not** be used for pagination. Results are ordered newest first
to oldest last.

## Path parameters

- `accountId` string, required

## Query parameters

- `page[size]` integer
- `filter[status]` 'HELD' | 'SETTLED' — Specifies which stage of processing a transaction is currently at. Currently returned values are `HELD` and `SETTLED`. When a transaction is held, its account’s `availableBalance` is affected. When a transaction is settled, its account’s `currentBalance` is affected.
- `filter[since]` string, date-time
- `filter[until]` string, date-time
- `filter[category]` string
- `filter[tag]` string

## Response `200`

Successful Response

- ListTransactionsResponse — Successful response to get all transactions. This returns a paginated list of transactions, which can be scrolled by following the `prev` and `next` links if present.
  - `data` TransactionResource[], required — The list of transactions returned in this response.
    - `type` string, required — The type of this resource: `transactions`
    - `id` string, required — The unique identifier for this transaction.
    - `attributes` object, required
      - `status` 'HELD' | 'SETTLED', required — Specifies which stage of processing a transaction is currently at. Currently returned values are `HELD` and `SETTLED`. When a transaction is held, its account’s `availableBalance` is affected. When a transaction is settled, its account’s `currentBalance` is affected.
      - `rawText` string, nullable, required — The original, unprocessed text of the transaction. This is often not a perfect indicator of the actual merchant, but it is useful for reconciliation purposes in some cases.
      - `description` string, required — A short description for this transaction. Usually the merchant name for purchases.
      - `message` string, nullable, required — Attached message for this transaction, such as a payment message, or a transfer note.
      - `isCategorizable` boolean, required — Boolean flag set to true on transactions that support the use of categories.
      - `holdInfo` HoldInfoObject, required — Provides information about the amount at which a transaction was in the `HELD` status.
        - `amount` MoneyObject, required — Provides information about a value of money.
          - `currencyCode` string, required — The ISO 4217 currency code.
          - `value` string, required — The amount of money, formatted as a string in the relevant currency. For example, for an Australian dollar value of $10.56, this field will be `"10.56"`. The currency symbol is not included in the string.
          - `valueInBaseUnits` integer, required — The amount of money in the smallest denomination for the currency, as a 64-bit integer. For example, for an Australian dollar value of $10.56, this field will be `1056`.
        - `foreignAmount` MoneyObject, required — Provides information about a value of money.
          - `currencyCode` string, required — The ISO 4217 currency code.
          - `value` string, required — The amount of money, formatted as a string in the relevant currency. For example, for an Australian dollar value of $10.56, this field will be `"10.56"`. The currency symbol is not included in the string.
          - `valueInBaseUnits` integer, required — The amount of money in the smallest denomination for the currency, as a 64-bit integer. For example, for an Australian dollar value of $10.56, this field will be `1056`.
      - `roundUp` RoundUpObject, required — Provides information about how a Round Up was applied, such as whether or not a boost was included in the Round Up.
        - `amount` MoneyObject, required — Provides information about a value of money.
          - `currencyCode` string, required — The ISO 4217 currency code.
          - `value` string, required — The amount of money, formatted as a string in the relevant currency. For example, for an Australian dollar value of $10.56, this field will be `"10.56"`. The currency symbol is not included in the string.
          - `valueInBaseUnits` integer, required — The amount of money in the smallest denomination for the currency, as a 64-bit integer. For example, for an Australian dollar value of $10.56, this field will be `1056`.
        - `boostPortion` MoneyObject, required — Provides information about a value of money.
          - `currencyCode` string, required — The ISO 4217 currency code.
          - `value` string, required — The amount of money, formatted as a string in the relevant currency. For example, for an Australian dollar value of $10.56, this field will be `"10.56"`. The currency symbol is not included in the string.
          - `valueInBaseUnits` integer, required — The amount of money in the smallest denomination for the currency, as a 64-bit integer. For example, for an Australian dollar value of $10.56, this field will be `1056`.
      - `cashback` CashbackObject, required — Provides information about an instant reimbursement in the form of cashback.
        - `description` string, required — A brief description of why this cashback was paid.
        - `amount` MoneyObject, required — Provides information about a value of money.
          - `currencyCode` string, required — The ISO 4217 currency code.
          - `value` string, required — The amount of money, formatted as a string in the relevant currency. For example, for an Australian dollar value of $10.56, this field will be `"10.56"`. The currency symbol is not included in the string.
          - `valueInBaseUnits` integer, required — The amount of money in the smallest denomination for the currency, as a 64-bit integer. For example, for an Australian dollar value of $10.56, this field will be `1056`.
      - `amount` MoneyObject, required — Provides information about a value of money.
        - `currencyCode` string, required — The ISO 4217 currency code.
        - `value` string, required — The amount of money, formatted as a string in the relevant currency. For example, for an Australian dollar value of $10.56, this field will be `"10.56"`. The currency symbol is not included in the string.
        - `valueInBaseUnits` integer, required — The amount of money in the smallest denomination for the currency, as a 64-bit integer. For example, for an Australian dollar value of $10.56, this field will be `1056`.
      - `foreignAmount` MoneyObject, required — Provides information about a value of money.
        - `currencyCode` string, required — The ISO 4217 currency code.
        - `value` string, required — The amount of money, formatted as a string in the relevant currency. For example, for an Australian dollar value of $10.56, this field will be `"10.56"`. The currency symbol is not included in the string.
        - `valueInBaseUnits` integer, required — The amount of money in the smallest denomination for the currency, as a 64-bit integer. For example, for an Australian dollar value of $10.56, this field will be `1056`.
      - `cardPurchaseMethod` CardPurchaseMethodObject, required — Provides information about the card used for a transaction.
        - `method` 'BAR_CODE' | 'OCR' | 'CARD_PIN' | 'CARD_DETAILS' | 'CARD_ON_FILE' | 'ECOMMERCE' | 'MAGNETIC_STRIPE' | 'CONTACTLESS', required — Specifies the type of card charge.
        - `cardNumberSuffix` string, nullable, required — The last four digits of the card used for the purchase, if applicable.
      - `settledAt` string, date-time, nullable, required — The date-time at which this transaction settled. This field will be `null` for transactions that are currently in the `HELD` status.
      - `createdAt` string, date-time, required — The date-time at which this transaction was first encountered.
      - `transactionType` string, nullable, required — A description of the transaction method used e.g. Purchase, BPAY Payment.
      - `note` NoteObject, required — Provides information about the note and attachement.
        - `text` string, required — A text note about the transaction.
      - `performingCustomer` CustomerObject, required — Provides information about the customer who initiated a transaction
        - `displayName` string, required — The Upname or preferred name of the customer
    - `relationships` object, required
      - `account` object, required
        - `data` object, required
          - `type` string, required — The type of this resource: `accounts`
          - `id` string, required — The unique identifier of the resource within its type.
        - `links` object
          - `related` string, required — The link to retrieve the related resource(s) in this relationship.
      - `transferAccount` object, required — If this transaction is a transfer between accounts, this relationship will contain the account the transaction went to/came from. The `amount` field can be used to determine the direction of the transfer.
        - `data` object, nullable, required
          - `type` string, required — The type of this resource: `accounts`
          - `id` string, required — The unique identifier of the resource within its type.
        - `links` object
          - `related` string, required — The link to retrieve the related resource(s) in this relationship.
      - `category` object, required
        - `data` object, nullable, required
          - `type` string, required — The type of this resource: `categories`
          - `id` string, required — The unique identifier of the resource within its type.
        - `links` object
          - `self` string, required — The link to retrieve or modify linkage between this resources and the related resource(s) in this relationship.
          - `related` string — The link to retrieve the related resource(s) in this relationship.
      - `parentCategory` object, required
        - `data` object, nullable, required
          - `type` string, required — The type of this resource: `categories`
          - `id` string, required — The unique identifier of the resource within its type.
        - `links` object
          - `related` string, required — The link to retrieve the related resource(s) in this relationship.
      - `tags` object, required
        - `data` object[], required
          - `type` string, required — The type of this resource: `tags`
          - `id` string, required — The label of the tag, which also acts as the tag’s unique identifier.
        - `links` object
          - `self` string, required — The link to retrieve or modify linkage between this resources and the related resource(s) in this relationship.
      - `attachment` object, required
        - `data` object, nullable, required
          - `type` string, required — The type of this resource: `attachments`
          - `id` string, required — The unique identifier of the resource within its type.
        - `links` object
          - `related` string, required — The link to retrieve the related resource(s) in this relationship.
    - `links` object
      - `self` string, required — The canonical link to this resource within the API.
  - `links` object, required
    - `prev` string, nullable, required — The link to the previous page in the results. If this value is `null` there is no previous page.
    - `next` string, nullable, required — The link to the next page in the results. If this value is `null` there is no next page.

---

[API](https://skmtc.net/up-banking/apis/up-api.md) · [All operations](https://skmtc.net/up-banking/apis/up-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/up-banking/up-api/versions/cc6a5e6d809d/schema)