Skip to main content
GET
/
v1
/
accounts
/
{account_uuid}
/
balance
Get Account Balance
curl --request GET \
  --url https://api.dispersed.com/v1/accounts/{account_uuid}/balance
{
  "current_balance": 123,
  "available_balance": 123,
  "pending_authorizations": 123,
  "currency": "USD",
  "updated_at": "2023-11-07T05:31:56Z"
}

Path Parameters

account_uuid
string<uuid>
required

Response

Account balance retrieved successfully

current_balance
number
required

Total credits in account before any holds

available_balance
number
required

Credits available for immediate use (current minus holds)

pending_authorizations
number
required

Total amount of active holds on the account

currency
enum<string>
required
Available options:
USD
updated_at
string<date-time> | null
required