Manage sub-entity balances
If you're on the Full account type, you can view sub-entity balances and manage their reserve rules.
You can view the balances your sub-entities hold with Checkout.com using the Dashboard or the API.
To view balances in the Dashboard, you must have one of the following user roles:
- Admin
- A custom role with the
View balancespermission
- Sign in to the Dashboard.
- Go to Payments > Processing > Sub-entities.
- Select the relevant sub-entity from the list. The Activity page opens.
The sub-entity's balances are displayed in their default currency.
To see the breakdown of balances in your sub-entity's currency accounts, call the Retrieve entity balances endpoint, and provide the sub-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}
For more information on reserve rules, see Fixed and rolling reserves.
- Sign in to the Dashboard.
- Go to Payments > Processing > Sub-entities.
- Select the relevant sub-entity from the list.
- Go to Reserve rules.
You can see all active, upcoming, and expired reserve rules configured for the sub-entity.
- Sign in to the Dashboard.
- Go to Payments > Processing > Sub-entities.
- Select the relevant sub-entity from the list.
- Go to Reserve rules > Add reserve rule.
- Enter the reserve period in weeks, rate percentage, and start date.
- Select Save.
The rule is displayed in the Upcoming section until the start date.
You can only edit the period and rate percentage of upcoming reserve rules.
- Sign in to the Dashboard.
- Go to Payments > Processing > Sub-entities.
- Select the relevant sub-entity from the list.
- Go to Reserve rules > Upcoming.
- Select the edit icon next to the reserve rule you want to edit.
- Make the required changes in the popup that opens.
- Select Save.