Sign in
ledger-account activity

Get a single sub-account transaction activity

This operation allows the client to fetch a specific transaction activity by its ID.

get/ledger/subaccounts/{subAccountIdRef}/activities/{activityId}

Path parameters

subAccountIdRefstring required

The unique onboard sub-account ID or reference

activityIdstring uuid required

The unique transaction activity ID

Response

Activity fetched successfully

idstring uuid required
activityTypestring 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' required

Semantic category of a transaction activity feed entry.

direction'CREDIT' | 'DEBIT' required
amountnumber required

Always positive; see direction for credit/debit.

currencystring 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.
referencestring

Customer-facing reference of the source transaction.

accountIdstring uuid required
accountType'MAIN' | 'SUB_ACCOUNT' | 'OFFRAMP_ACCOUNT' | 'CARD_ACCOUNT' required

The kind of account a transaction activity occurred on.

subAccountIdstring uuid

Set when accountType is SUB_ACCOUNT.

accountTransactionIdstring

Identifier of the transaction on the ledger account, when available.

groupIdstring uuid

Links related activities together, e.g. the two legs of an internal transfer, or an offramp deposit and its refund.

narrationstring
activityAtstring date-time required

Example response

{
  "amount": 100,
  "currency": "USD"
}

Changes

Changed in 2 of the 7 revisions of this API.12

  • 1805362fe2201See the full diff
    • ●

      added the new CARD_ACCOUNT enum value to the response property for the response status

      response-property-enum-value-added

  • a3c4e27426152See the full diff
    • ○

      the endpoint scheme security HMACAuth was added to the API

      api-security-added

    • ○

      the endpoint scheme security authToken was removed from the API

      api-security-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog