Are you looking for test card numbers?

Would you like to contact support?

No momento, esta página não está disponível em inglês
Issuin icon

Manage your platform

View and manage account holders and balance accounts in your platform.

To manage your platform, you can use the Balance Platform Configuration API to:

You can also log in to your Balance Platform Customer Area to view account holders, their balance accounts, and the cards issued to them.

View account holders

To view account holder details, you can either use your Balance Platform Customer Area or make an API request.

To get account holders, use the following endpoints:

Update an account holder

To update an account holder, make a PATCH /accountHolders/{id} request. For example, for account holders that have several balance accounts, they might want to change their primary balance account.

Change the primary balance account

View balance accounts

To view the balance accounts and the available balances of your account holder, you can either use your Balance Platform Customer Area or make an API request.

To get balance accounts, use the following endpoints:

Update a balance account

To update a balance account, make a PATCH /balanceAccounts/{id} request. The example below shows how you would update the description of a balance account.

Change the description of a balance account

Page through API responses

For endpoints that return a list of account holders or balance accounts, we paginate the results to make the data more manageable. Use the query parameters offset and limit to page through the items. By default, we limit the number of items returned per page to 10.

Here is an example of how you would limit the page items to 2 and to skip the first 4 items of a GET /accountHolders/{id}/balanceAccounts request.

Get account holder's balance accounts
curl https://balanceplatform-api-test.adyen.com/bcl/v2/accountHolders/AHA1B2C3D4E5F6G7H8I9J0/balanceAccounts?limit=2&offset=4 \
 -H "x-api-key: YOUR_BALANCE_PLATFORM_API_KEY" \

The response returns the list, along with a hasNext and hasPrevious boolean parameters indicating if there are more items in the previous or next page.

Response
{
    "balanceAccounts": [
        {
            "accountHolderId": "AHA1B2C3D4E5F6G7H8I9J0",
            "defaultCurrencyCode": "EUR",
            "id": "BA3227C223222H8NLP6JQC3FD",
            "status": "Active"
        },
        {
            "accountHolderId": "AHA1B2C3D4E5F6G7H8I9J0",
            "defaultCurrencyCode": "EUR",
            "id": "BA32272223222B5BRR27D2M7B",
            "status": "Active"
        }
    ],
    "hasNext": "true",
    "hasPrevious": "true"
}

Próximas etapas