# Manage sub-entity balances If you're on the `Full` account type, you can view sub-entity balances and manage their reserve rules. --- ## View sub-entity balances You can view the [balances](https://www.checkout.com/docs/funds-management/manage-funds/balances.md) your sub-entities hold with Checkout.com using the Dashboard or the API. ### View balances in the Dashboard To view balances in the Dashboard, you must have one of the following user roles: - Admin - A custom role with the `View balances` permission 1. Sign in to the [Dashboard](https://dashboard.checkout.com). 2. Go to _Sub-entities_. 3. Select the relevant sub-entity from the list. The _Activity_ page opens. The sub-entity's balances are displayed in their default currency. ### View balances using the API To see the breakdown of balances in your sub-entity's currency accounts, call the [Retrieve entity balances](https://api-reference.checkout.com/tag/Balances/#operation/getEntityBalances) endpoint, and provide the sub-entity ID as the `{id}` path parameter. **Production** `GET` `https://balances.checkout.com/balances/{id}` **Sandbox** `GET` `https://balances.sandbox.checkout.com/balances/{id}` Optionally, you can include the following query parameters: - `withCurrencyAccountId` – Set to `true` to include the `currency_account_id` field for each currency account in the response. Default value is `false`. - `balancesAt` – Set to a UTC datetime value in the past to retrieve balances at a specific point in time. If omitted, the response returns live balances. ### Response example ```json { "data": [ { "currency_account_id": "ca_g5y7d6jo4e2urgforcbf2ey5jm", "descriptor": "Revenue Account 1", "holding_currency": "EUR", "balances_as_of": "2026-05-06T13:59:59.9999999+00:00", "balances": { "available": 50000, "collateral": 6000, "collateral_breakdown": { "fixed_reserve": 4000, "rolling_reserve": 2000 }, "operational": 7000, "payable": 2700, "pending": 23000 } } ] } ``` --- ## View reserve rules A rolling reserve rule typically has a reserve percentage and a reserve period. For more information, see [Fixed and rolling reserves](https://www.checkout.com/docs/funds-management/manage-funds/balances/fixed-and-rolling-reserves.md). 1. Sign in to the [Dashboard](https://dashboard.checkout.com). 2. Go to _Sub-entities_. 3. Select the relevant sub-entity from the list. 4. Go to _Reserve rules_.
You can see all active, upcoming, and expired reserve rules configured for the sub-entity. --- ## Add a reserve rule You can add multiple reserve rules, but only one rule can be active at a time. ### Using the Dashboard 1. Sign in to the [Dashboard](https://dashboard.checkout.com). 2. Go to _Sub-entities_. 3. Select the relevant sub-entity from the list. 4. Go to _Reserve rules_ > _Add reserve rule_. 5. Enter the reserve period in weeks, rate percentage, and start date. 6. Select _Save_.
The rule is displayed in the _Upcoming_ section until the start date. ### Using the API Call the [Add a reserve rule](https://api-reference.checkout.com/tag/Reserve-rules/#operation/addReserveRule) endpoint, and provide the sub-entity ID as the `{id}` path parameter. In the request body, provide the following: - `type` – Set to `rolling`. - `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. > **Information** > > Your base URL's `{prefix}` value is unique to your account and environment. To learn how to retrieve your base URLs for the sandbox and production environments, see [API endpoints](https://www.checkout.com/docs/developer-resources/api/api-endpoints.md). **Production** `POST` `https://{prefix}.api.checkout.com/accounts/entities/{id}/reserve-rules` **Sandbox** `POST` `https://{prefix}.api.sandbox.checkout.com/accounts/entities/{id}/reserve-rules` #### Request example ```json { "type":"rolling", "valid_from":"2024-01-01T13:33:00.000Z", "rolling":{ "percentage":10, "holding_duration":{ "weeks": 2 } } } ``` --- ## Update a reserve rule 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. ### Using the Dashboard 1. Sign in to the [Dashboard](https://dashboard.checkout.com). 2. Go to _Sub-entities_. 3. Select the relevant sub-entity from the list. 4. Go to _Reserve rules_ > _Upcoming_. 5. Select the edit icon next to the reserve rule you want to edit. 6. Make the required changes in the popup that opens. 7. Select _Save_. ### Using the API Call the [Update reserve rule](https://api-reference.checkout.com/tag/Reserve-rules/#operation/updateReserveRule) 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 to `rolling`. - `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. > **Information** > > Your base URL's `{prefix}` value is unique to your account and environment. To learn how to retrieve your base URLs for the sandbox and production environments, see [API endpoints](https://www.checkout.com/docs/developer-resources/api/api-endpoints.md). **Production** `PUT` `https://{prefix}.api.checkout.com/accounts/entities/{entityId}/reserve-rules/{id}` **Sandbox** `PUT` `https://{prefix}.api.sandbox.checkout.com/accounts/entities/{entityId}/reserve-rules/{id}` #### Request example ```json { "type":"rolling", "rolling":{ "percentage":20, "holding_duration":{ "weeks": 3 } } } ``` --- ## Related topics - [Transfer sub-entity funds](https://www.checkout.com/docs/platforms/for-payfac/manage-sub-entity-balances/transfer-sub-entity-funds.md): Transfer funds to your sub-entities using the Dashboard or the Transfers API.