How-to Guide: Generating Adyen's API Token

How-to Guide: Generating Adyen Balance Platform API Credentials

To make requests to Adyen's Balance Platform APIs, you need to create and configure API credentials with the correct permissions. Follow these steps:

Step 1: Log in to the Balance Platform Customer Area

• Go to your Balance Platform Customer Area (or live environment as appropriate).

• Make sure your user account has the Balance platform admin role.

Step 2: Create a New API Credential

• Navigate to Developers > API credentials.

• Click Create new credential.

• In the dialog, under Credential type, select Web service user

• (Optional) Add a description for the credential "Used by Ledge".

• Click Create credential.

Step 3: Assign All Permissions

• On the configuration page for your new credential, go to the Permissions section.

• Expand all categories and select all available roles/permissions for the credential.

  • This ensures the credential can access all required Balance Platform APIs.

• Click Save changes.

Step 4: Generate an API Key

• On the same page, in the Server settings section, select the API key tab.

• Click Generate API key.

• Copy the API key and store it securely.

  Note: You cannot copy the key again after leaving the page.

• Click Save changes.

Step 5: Use the API Key

Once the API key is generated, please copy the token, go to the Ledge Sources page, and follow the instructions