Skip to content

Sub-entity payouts Beta

Last updated: 23rd May 2022

There are different options available depending on what account type you were onboarded with. If you're unsure which account type you are, please see our account structure page or contact us.

Choose your account from the headings below to find out what payout options are available to you.

Client settlements for lite account types

For those on the lite account type, all funds will be settled to your platform’s designated bank account(s) as per the frequency agreed during your onboarding.

The distribution of funds to your sub-entities and collection of fees for your platform are both done outside of our solution.

You can optionally process daily balance reports and financial actions reports to retrieve the closing available balance of your currency account(s) and perform reconciliation.


Scheduled payouts solution for full account types

For those on the full account type, you can manage payouts using our API or through the Dashboard.

Sub-entity funds will be paid out as per your agreed schedule during your onboarding – daily, by weekdays or by days in a month. The funds will move from your Platform currency account to the sub-entity's external bank account.

Weekly payouts

You can schedule a payout Monday through to Sunday. However, it may mean that your weekend or bank holiday payout instruction occurs the following working day.

Funds are distributed to your sub-entities inside our solution, so sub-entity bank account details must be captured as payment instruments to be later used as the destination in payout requests.

Retrieve a sub-entity's schedule through the API

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

    get

    https://api.checkout.com/accounts/entities/{id}/payout-schedules

    Response example

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    {
    "GBP": {
    "recurrence": {
    "enabled": false,
    "threshold": 0.0,
    "schedule": {
    "frequency": "Unknown",
    "is_empty": true
    }
    },
    "_links": {}
    }
    }

    Update a sub-entity's schedule through the API

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

      put

      https://api.checkout.com/accounts/entities/{id}/payout-schedules

      Request example

      The frequency of a payout can be set to weekly, daily or monthly. If selecting weekly or monthly, you can specify either days of the week, or days of the month.

        1
        2
        3
        4
        5
        6
        7
        8
        9
        {
        "EUR": {
        "enabled": true,
        "threshold": 100,
        "recurrence": {
        "frequency": "daily"
        }
        }
        }

        Response example

        1
        2
        3
        4
        5
        6
        7
        {
        "_links": {
        "self": {
        "href": "https://api.checkout.com/accounts/entities/ent_wxglze3wwywujg4nna5fb7ldli"
        }
        }
        }

        Receive notifications about scheduled payouts

        Get notified about your scheduled payouts by subscribing to the following webhook notifications.

        • payout_paid
        • payout_declined

        Find out more


        Platforms

        Find out all you need to know about our Platforms solution – from onboarding to processing your first payment or payout.