---
title: "Get account transaction activities"
method: GET
path: "/ledger/accounts/{accountId}/activities"
tags: ["ledger-account activity"]
---

# Get account transaction activities

`GET /ledger/accounts/{accountId}/activities`

## Request

- Base URL: `https://external.dev.onboardpay.co`
- URL: `https://external.dev.onboardpay.co/ledger/accounts/{accountId}/activities`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/nestechops/apis/onboard-external-api-gateway/docs/ledger/accounts/:accountId/activities/get.ts> (a function with typed inputs; its response is checked against the schema)

This operation allows the client to fetch a paginated, aggregated feed of all
transaction activity for an account (cash deposits/payments, account-number
deposits, crypto deposits/withdrawals, internal transfers, offramp deposits),
each with type-specific details in activityData.

## Path parameters

- `accountId` string, uuid, required

## Query parameters

- `type` TransactionActivityType[]
- `direction` 'CREDIT' | 'DEBIT'
- `startDate` string, date-time
- `endDate` string, date-time
- `page` integer
- `size` integer

## Response `200`

Activities fetched successfully

- TransactionActivityList: Base object for paginated list
  - `name` string: Descriptive name for the list
  - `size` integer: Positive integer
  - `totalItems` integer: Positive integer
  - `nextPage` integer: Positive integer
  - `previousPage` integer: Positive integer
  - `content` TransactionActivity[]: List of transaction activities
    - `id` string, uuid, required
    - `activityType` string, required: Discriminator; the concrete activity model name, e.g. CashDepositActivity.
    - `type` 'CASH_DEPOSIT' | 'CASH_PAYMENT' | 'ACCOUNT_NUMBER_DEPOSIT' | 'CRYPTO_WITHDRAWAL' | 'CRYPTO_DEPOSIT' | 'INTERNAL_TRANSFER' | 'OFFRAMP_DEPOSIT' | 'DEPOSIT_REVERSAL', required: Semantic category of a transaction activity feed entry.
    - `direction` 'CREDIT' | 'DEBIT', required
    - `amount` number, required: Always positive; see direction for credit/debit.
    - `currency` string, required
    - `status` 'PENDING' | 'IN_PROGRESS' | 'FAILED' | 'SUCCESS', required: Status of the transaction, indicating its current state in the processing lifecycle. - PENDING: The transaction has been created but not yet processed. - IN_PROGRESS: The transaction is currently being processed. - FAILED: The transaction processing has failed. - SUCCESS: The transaction has been successfully processed.
    - `reference` string: Customer-facing reference of the source transaction.
    - `accountId` string, uuid, required
    - `accountType` 'MAIN' | 'SUB_ACCOUNT' | 'OFFRAMP_ACCOUNT' | 'CARD_ACCOUNT', required: The kind of account a transaction activity occurred on.
    - `subAccountId` string, uuid: Set when accountType is SUB_ACCOUNT.
    - `accountTransactionId` string: Identifier of the transaction on the ledger account, when available.
    - `groupId` string, uuid: Links related activities together, e.g. the two legs of an internal transfer, or an offramp deposit and its refund.
    - `narration` string
    - `activityAt` string, date-time, required
    - `underReview` boolean: True while the funds of this deposit are held for review: they can't be used until the review is complete. Absent for activities that are not under review.

## Other responses

- `400`: Request could not be validated
- `401`: Client is not authorized to make request
- `403`: Expected permission is not available.
- `default`: Internal Server Error

## Changes

- **2026-10-29** `5da9ec1b2573`: 1 info
  - added the optional property `allOf[subschema #2]/content/items/underReview` to the response with the `200` status
- **2026-10-26** `f177db874250`: 1 warning, 2 info
  - added the new `DEPOSIT_REVERSAL` enum value to the `allOf[subschema #2]/content/items/type` response property for the response status `200`
  - added the enum value `DEPOSIT_REVERSAL` to the property `items/` of the `query` request parameter `type`
  - added `DepositReversalActivity` discriminator mapping keys to the `allOf[subschema #2]/content/items/` response property for the response status `200`
- **2026-09-03** `1805362fe220`: 1 warning
  - added the new `CARD_ACCOUNT` enum value to the `allOf[subschema #2]/content/items/accountType` response property for the response status `200`
- **2026-07-26** `a3c4e2742615`: 2 info
  - the endpoint scheme security `HMACAuth` was added to the API
  - the endpoint scheme security `authToken` was removed from the API
- **2026-07-13** `fc790ea4deb6`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/nestechops/apis/onboard-external-api-gateway/changes/ledger/accounts/:accountId/activities/get.md)

---

[API](https://skmtc.dev/nestechops/apis/onboard-external-api-gateway.md) - [All operations](https://skmtc.dev/nestechops/apis/onboard-external-api-gateway/llms.txt) - [OpenAPI document](https://skmtc.dev/nestechops/apis/onboard-external-api-gateway/revisions/5da9ec1b2573?raw)