Skip to main content

How to get balances for a specific account

Overview​

Use Account API to get balances for a merchant account.

This method returns the account ID, account name, company owner ID, and balances grouped by currency.

Request​

Use [POST] account.

FieldTypeRequiredDescription
accountstringYesMerchant account ID for which balances should be returned.
timestampnumberYesCurrent Unix UTC timestamp in milliseconds. The value must not be less than 3 minutes in the past or greater than 3 minutes in the future.

Request example​

{
"account": "0x0000000000000000000000000000000000000000",
"timestamp": 1761650432438
}

Response fields​

FieldTypeDescription
accountstringMerchant account ID.
namestringAccount display name.
ownerIdstringCompany ID associated with the account.
balancesarrayAccount balances grouped by currency.

Balance object​

FieldTypeDescription
currencystringCurrency ticker, for example USDT_TRX, BTC, or ETH.
amountnumberBalance amount for the currency.

Response example​

{
"account": "0x0000000000000000000000000000000000000000",
"name": "Main account",
"ownerId": "123e4567-e89b-12d3-a456-426614174000",
"balances": [
{
"currency": "USDT_TRX",
"amount": 1500.75
},
{
"currency": "BTC",
"amount": 0.025
}
]
}
CaseRecommendation
Balance is shown in UIUse recommendedDisplayScale from Currency API when formatting crypto amounts.
Balance is used for payoutsCheck that the account has enough funds in the payout currency before creating a payout.
Account is unavailableVerify current user permissions with [POST] user/current.
DocumentLink
Current API userHow to get information about the current API user
Available currenciesHow to get available currencies
Account API referenceAccount API