Skip to content

View sub-entity balances Beta

Last updated: May 06, 2022

Keep track of your sub-entities' funds using the Balances API directly, or through the Dashboard.

Before you begin


View balances in the Dashboard

  1. From the Dashboard home page, go to Sub-entities
  2. Select a sub-entity from the list. This will open the Sub-entity details page
  3. Under Balances, the sub-entity's balance is split into 4 sections
Sub-entity balances in the Dashboard
  • 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.

balances disabled

View balances using the API

To get a detailed view of all required and optional fields, see our API reference.

Notice that the sub-domain – balances.checkout.com – is slightly different to Checkout.com's other endpoints.

    get

    https://balances.checkout.com/balances/{id}

    Copied!

    Narrow down the search by applying a query to your request. For example, query=currency:EUR.

    Response example

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    {
    "data": [
    {
    "descriptor": "Revenue Account 1",
    "holding_currency": "EUR",
    "balances": {
    "pending": 10,
    "available": 50,
    "payable": 0,
    "collateral": 0
    }
    }
    ]
    }

    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.

    Accept a payment

    Process payments on behalf of your sub-entities.

    Find out more


    Platforms

    Create rich and flexible payment programs suited to the needs of you and your customers.