Account Balances

An accounts balance can be queried at anytime. This useful for front end display or checking before an actionable item is going to take place:

GET /api/trust/v1/custodial-accounts/{custodialAccountId}/balances

// response:
{
  "data": [
    {
      "assetType": "fiatCurrency",
      "assetFiatType": "usd",
      "disbursable": 0,
      "locked": 0,
      "pending": 0,
      "total": 0
    }
  ]
}

Key

Description

disbursable

Fiat or crypto amount that can be withdrawn or acted upon at a time.

locked

Fiat or crypto balance that is not available for activity to the user because it is pending another activity

pending

Fiat or crypto balance that is pending settlement or transfer (locked amount)

total

Fiat or crypto amount that might have pending activity on the account


Did this page help you?