Sign in
ledger-sub-accounts

Update sub-account details by sub-account ID.

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

put/ledger/subaccounts/{subAccountIdRef}

Path parameters

subAccountIdRefstring required

The unique onboard sub-account ID or reference

Request body

displayNamestring

An optional name for the sub-account.

frozenboolean required

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

Response

Sub-account updated 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
  }
}

Changes

Changed in 1 of the 6 revisions of this API.2

  • 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