Skip to content

Accounts API for Platforms Beta

Last updated: April 29, 2022

The Accounts API uses OAuth authentication.

Select your account type

Your account type is determined during onboarding and depends on whether you require payment capabilities (lite), or payment and payout capabilities (full).

Lite

Lite account types process payments only. All funds are settled to your platform as per the frequency agreed during onboarding.

Full

Full account types can process payments and payouts capabilities on behalf of their sub-entities. Funds are paid out using our payouts solution from your sub-entity's currency account to the bank account of your sub-entity.

Sub-entity status

To provide you with visibility to what's going on with your sub-entities, our API responses include a status field.

You can also subscribe to the status webhook notification to keep up to date with any asynchronous changes.

    If we're expecting you to provide us with more information, your sub-entity will have a status of requirements_due. With this status, the requirements_due array will also be populated to inform you of the information that is missing.

    Use the information required table to find out what information is required to trigger due diligence checks.

    Example response

    In this example, we have created a company sub-entity without any representatives or a registered address.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    {
    "id": "ent_vjmdzvijizs7o26kiuiakywvyi",
    "reference": "tmvhWvvZfFSkJy4",
    "status": "requirements_due",
    "capabilities": {
    "payments": {
    "enabled": false
    },
    "payouts": {
    "enabled": false
    }
    },
    "requirements_due": [
    {
    "field": "company.representatives",
    "reason": "required"
    },
    {
    "field": "company.registered_address",
    "reason": "required"
    }
    ],
    "_links": {
    "self": {
    "href": "https://api.checkout.com/accounts/entities/ent_vjmdzvijizs7o26kiuiakywvyi"
    }
    }
    }