View sub-entity balances
Beta
Last updated: May 6, 2022
Keep track of your sub-entities' funds using the Balances API directly, or through the Dashboard.
Before you begin
- To access balances, you must be on the
Full
account type. - Onboard your sub-entities to our Platforms solution.
- Make the first payment on behalf of your sub-entity.
View balances in the Dashboard
- From the Dashboard home page, go to Sub-entities
- Select a sub-entity from the list. This will open the Sub-entity details page
- Under Balances, the sub-entity's balance is split into 4 sections
- Available: The funds available to be used for transactions such as transfers or payouts
- Incoming: Funds on the way to the sub-entity's account. These funds will be added to Available once settled
- Outgoing: Funds being paid out of the sub-entity's account, but not yet settled
- Total: The sum of Available and Incoming
Troubleshooting
If you cannot see your sub-entities' balances in the Dashboard, you may not have access to this feature. Contact us to find out more.
View balances using the API
To get a detailed view of all required and optional fields, see our API reference.
Note
Notice that the sub-domain – balances.checkout.com
– is slightly different to Checkout.com's other endpoints.
get
https://balances.checkout.com/balances/{id}
Tip
Narrow down the search by applying a query to your request. For example, query=currency:EUR
.
Response example
1{2"data": [3{4"descriptor": "Revenue Account 1",5"holding_currency": "EUR",6"balances": {7"pending": 10,8"available": 50,9"payable": 0,10"collateral": 011}12}13]14}
Next steps
Transfer funds to and from your sub-entity
Full
accounts on our Platforms solution can view sub-entity balances. If you’re unsure, take a look at our account structure page
Find out more
Platforms
Create rich and flexible payment programs suited to the needs of you and your customers.