Sign in

v3

latestOpenAPI 3.0.3UNLICENSED2026-07-2796235396.3 KB
ledger-sub-accounts

Fetch sub-account details by sub-account ID.

This endpoint returns sub-account details by sub-account ID.

get/ledger/subaccounts/{subAccountIdRef}

Path parameters

subAccountIdRefstring required

The unique onboard sub-account ID or reference

Response

Sub-account fetched Successfully

idstring uuid required

Unique sub-account ID

accountIdstring uuid required

The main account ID to which this sub-account belongs.

displayNamestring

An optional name for the sub-account.

referencestring required

A unique reference for the sub-account.

currencystring required

Currency of the sub-account

frozenboolean required

Indicates if the sub-account is frozen (locked) or not.

createdDatestring date-time required

The date the sub-account was created.

Example response

{
  "currency": "USD",
  "accountBalance": {
    "balance": 1000,
    "availableBalance": 1000
  }
}