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}
A rolling reserve rule typically has a reserve percentage and a reserve period. For more information, 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.
You can add multiple reserve rules, but only one rule can be active at a time.
- 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.
Call the Add a reserve rule endpoint, and provide the sub-entity ID as the {id} path parameter.
In the request body, provide the following:
type– Set torolling.valid_from– The date and time the reserve rule becomes active. This must be at least 15 minutes in the future.rolling.percentage– The percentage of captured funds that must be reserved as a collateral balance.rolling.holding_duration.weeks– The number of weeks the funds must be reserved for.
post
https://api.checkout.com/accounts/entities/{id}/reserve-rules
You can only update the period and rate percentage of upcoming reserve rules.
When the reserve period is updated, the new period immediately applies to the existing Collateral balance. For example, if the new reserve period is shorter than the previous one, it initiates a bulk release of any collateral funds that are held longer than the new reserve period.
- 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.
Call the Update reserve rule endpoint, and provide the sub-entity ID as the {entityId} path parameter and the reserve rule ID as the {id} path parameter.
Provide the version of the reserve rule you want to update in the If-Match header parameter.
In the request body, provide the following:
type– Set torolling.rolling.percentage– The percentage of captured funds that must be reserved.rolling.holding_duration.weeks– The number of weeks the funds must be reserved for.
put
https://api.checkout.com/accounts/entities/{entityId}/reserve-rules/{id}