Skip to main content
GET
Get a single transaction activity
Fetches a single main-account activity by ID.

Authorizations

x-api-key
string
header
required

Requires authentication via API key and HMAC signature.

  • x-api-key: Your API key generated from your Onboard Business dashboard.
  • x-timestamp: Unix epoch timestamp (seconds) used in signature, allowed skew is 30 seconds
  • x-signature: SHA256 HMAC HEX signature calculated over t={x-timestamp}&{requestBody} using your API Secret.

Path Parameters

accountId
string<uuid>
required

the unique onboard account ID

activityId
string<uuid>
required

The unique transaction activity ID

Response

Activity fetched successfully

A single entry in the aggregated account activity feed. The concrete subtype is determined by the activityType discriminator; the type field carries the semantic category for filtering and display.

activityData
object
required

Details of a cash deposit transaction.

id
string<uuid>
required
activityType
string
required

Discriminator; the concrete activity model name, e.g. CashDepositActivity.

type
enum<string>
required

Semantic category of a transaction activity feed entry.

Available options:
CASH_DEPOSIT,
CASH_PAYMENT,
ACCOUNT_NUMBER_DEPOSIT,
CRYPTO_WITHDRAWAL,
CRYPTO_DEPOSIT,
INTERNAL_TRANSFER,
OFFRAMP_DEPOSIT
direction
enum<string>
required
Available options:
CREDIT,
DEBIT
amount
number
required

Always positive; see direction for credit/debit.

Example:

100

currency
string
required
Example:

"USD"

status
enum<string>
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.
Available options:
PENDING,
IN_PROGRESS,
FAILED,
SUCCESS
accountId
string<uuid>
required
accountType
enum<string>
required

The kind of account a transaction activity occurred on.

Available options:
MAIN,
SUB_ACCOUNT,
OFFRAMP_ACCOUNT
activityAt
string<date-time>
required
reference
string

Customer-facing reference of the source transaction.

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