On this page you'll learn the steps for developing an Adyen for Platforms integration and for taking your integration live.
Before you start building your integration, make sure that you have already:
- Received your API credentials from your Adyen contact.
- Designed your implementation.
Verify your test credentials
To verify that your test API credentials are working, make your first requests.
You'll need your credentials for the following:
- ws@BalancePlatform.[YourBalancePlatform]: You'll use the API key to make requests to the Configuration API and Transfers API.
- ws@Scope.BalancePlatform[YourBalancePlatform]: You'll use your API credentials to make requests to the Legal Entity Management API using basic authentication.
- ws@Company.[YourCompanyAccount]: You'll use the API key to make requests to the Checkout API.
Try out the requests below.
Use the API key for your ws@BalancePlatform.[YourBalancePlatform] API credential.
If the call was successful, you receive an HTTP 200 result code along with the
status of your balance platform.
Set up webhooks
Adyen sends webhooks to communicate events in your platform such as when a resource was created or a payout was triggered.
- Configure a webhook endpoint.
Set up a webhook endpoint in your system to receive webhooks from Adyen.
- Configure webhooks in your Balance Platform Customer Area.
- Verify the HMAC signature (Recommended).
Verify that the webhook is sent from Adyen.
- Accept webhooks.
Acknowledge every webhook you receive.
Onboard and verify users
Before you can start processing payments for your users and paying out to them, Adyen needs to verify their information.
- Identify and collect the required information.
Check the required information based on the country where your user is operating in.
- Create legal entities.
Create the required legal entity resources for your user and for entities associated to the user.
- Associate legal entities.
Link other legal entities connected to the main entity
- Create transfer instruments.
Create a transfer instrument, the resource that represents the user's payout bank account. Before you can send a payout to a user, Adyen verifies the account information.
- Create business lines (Conditional)
For additional financial products, such as business bank accounts or the platform setup, create business lines.
- Create account holders.
Create account holders and link it to their legal entity.
- Get updates about account holders
Get updates about the verification status and capability changes for an account holder. Capabilities are actions that an account holder can do in your platform, such as paying out to their bank accounts.
- Upload additional documents (Conditional).
Adyen may require you to upload additional documents in order to verify user data.
- Create balance accounts.
Create balance accounts to hold the funds of your account holders.
Start processing payments for your users.
- Split payments.
Accept payments on behalf of your user and split payments with them at time of authorisation or capture.
- Listen to webhooks.
Learn which webhooks Adyen sends to inform your server of payment events.
Pay out funds to your user's bank account.
- Make scheduled payouts
Set up scheduled payouts.
- Pay out on demand
Make on-demand payouts.
- Listen to webhooks.
Learn which webhooks Adyen sends to inform your server of payout events.
Use reports to reconcile payments and balances in your system.
- Set up your reports credentials.
Your Adyen contact will provide you with a reports credential, which you'll need if you want to programmatically download reports.
- Download reports.
Listen to the balancePlatform.report.created webhook to know when a report was generated and is ready to be downloaded. To download a report, you must authenticate your GET requests with your report credentials.
To get your Adyen for Platforms integration to live, you need to apply for a live account. When you have your live account, follow the steps below to take your integration live.
Replicate your test account setup.
The setup from your test Adyen for Platforms account is not replicated to your live Adyen for Platforms account.
Update your code base.
Switch to live Balance Platform and Legal Entity API credentials.
Get your live API credentials from your Adyen contact. Use these credentials in your live platform.
Switch from test to live endpoints.
Change the endpoints from
live. For example,
Run end-to-end tests.
- Live Balance Platform and Legal Entity API credentials: Make your first live API request to make sure that your live API credentials are working.
- Legal entities: Confirm that you can create legal entities.
- Account holders and balance accounts: Confirm you can create and retrieve account holders and balance accounts.
- Test successful payment scenarios.
- Test your error handling scenarios. For example, when payments are declined.
- Webhooks: Confirm that you can receive and accept webhooks in the live environment.
- Verification errors: Test your error handling scenarios when onboarding users.
- Reports: Confirm that you can download reports for transactions in the live environment.