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.
| Field | Type | Required | Description |
|---|---|---|---|
| account | string | Yes | Merchant account ID for which balances should be returned. |
| timestamp | number | Yes | Current 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
| Field | Type | Description |
|---|---|---|
| account | string | Merchant account ID. |
| name | string | Account display name. |
| ownerId | string | Company ID associated with the account. |
| balances | array | Account balances grouped by currency. |
Balance object
| Field | Type | Description |
|---|---|---|
| currency | string | Currency ticker, for example USDT_TRX, BTC, or ETH. |
| amount | number | Balance 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
}
]
}
Recommended handling
| Case | Recommendation |
|---|---|
| Balance is shown in UI | Use recommendedDisplayScale from Currency API when formatting crypto amounts. |
| Balance is used for payouts | Check that the account has enough funds in the payout currency before creating a payout. |
| Account is unavailable | Verify current user permissions with [POST] user/current. |
Related docs
| Document | Link |
|---|---|
| Current API user | How to get information about the current API user |
| Available currencies | How to get available currencies |
| Account API reference | Account API |