Skip to main content
POST
/
api
/
service
/
balance
/
retrieve
JavaScript
import Ivy from '@getivy/node-sdk';

const client = new Ivy({
  apiKey: process.env['IVY_API_KEY'], // This is the default and can be omitted
});

const balance = await client.balance.retrieve();

console.log(balance.balances);
{
  "balances": [
    {
      "currency": "USD",
      "available": 123
    }
  ]
}

Authorizations

​
X-Ivy-Api-Key
string
header
required

API key for authentication

Body

application/json
​
currency
enum<string>

The currency to retrieve the balance for. Default account balance for that currency will be retrieved

Available options:
USD,
EUR,
GBP,
PLN,
SEK,
DKK,
USDC
​
accountId
string<uuid>

The account id to retrieve the balance for. You can find it in the Merchant Dashboard -> Accounts -> Details. If currency is provided it will be ignored.

Response

200 - application/json

The account balance

​
balances
object[]
required

Array of balance information for different currencies