NEnestechops
ledger-account activity

Get a single sub-account transaction activity

Changed on

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

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

Request

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' | 'DEPOSIT_REVERSAL' 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
underReviewboolean

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.

Example response

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

Changes

  • 5da9ec1b2573Revision changes
    • info

      added the optional property to the response with the status

  • f177db874250Revision changes
    • warning

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

    • info

      added DepositReversalActivity mapping keys to the response discriminator for the response status