View balances
Last updated: February 26, 2025
You can view the different balances you hold with Checkout.com in the Dashboard or using the API. Optionally, you can configure email notifications for certain balance triggers.
The Dashboard helps you visualize your balance activity over time, or within a specific time frame.
To view balances and balance activity in the Dashboard, ensure that you have one of the following user roles:
- Administrator
- A custom role with the
View balances
permission
- Sign in to the Dashboard.
- Go to Business account > Balances.
- In the business entity selector, select the client view or entity view.
- Client view – See all sub-accounts of all entities.
- Entity view – See all sub-accounts of a specific entity.
If an entity has multiple sub-accounts, the Consolidated available balance is the total of their Available balances.
If a sub-account does not have enough Available balance for payouts, you can top up or enable Funds Pooling.
To see the breakdown of balances in your sub-accounts, call the Retrieve entity balances endpoint, and provide the entity ID as the {id}
path parameter.
get
https://balances.checkout.com/balances/{id}
1{2"data": [3{4"descriptor": "Revenue Account 1",5"holding_currency": "EUR",6"balances": {7"available": 50000,8"collateral": 6000,9"operational": 7000,10"payable": 2700,11"pending": 2300012}13}14]15}
You can be notified whenever a sub-account is topped up, or its balance falls below a specified threshold. The threshold can be any positive or negative number.
Information
Your sub-account settings determine the threshold currency.
To configure Balances notification types in the Dashboard:
- Sign in to the Dashboard.
- In the business entity selector, select the entity to configure notifications for. Alternatively, to configure notifications across all entities, use the client view.
- Select your profile icon.
- Select Notifications.
- Open the Balances tab.
- Select the global Enable balance notifications toggle. You will not receive any notifications if this is not enabled.
- If you're using the client view, select the toggle for each entity you want to enable notifications for.
- Select the notification types you want to enable for the entity's sub-accounts.