Default icon

Integration and go-live checklist

Checklist for building and taking your Adyen for Platforms integration live.

Adyen APIs Postman collections

Fork our Postman collections in your private workspace to start testing API calls with your own credentials.

On this page, you can learn about the steps required to integrate Adyen's payment processing capabilities to your platform, and how to take your integration live.

Before you start building your integration, make sure that you have already:

Verify your test credentials

To verify that your test API credentials are working, make your first requests.

You'll need the API keys of the following credentials:

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 id and 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.

  1. Configure a webhook endpoint.
    Set up a webhook endpoint in your system to receive webhooks from Adyen.
  2. Configure webhooks in your Balance Platform Customer Area.
    Configure webhooks.
  3. Verify the HMAC signature (Recommended).
    Verify that the webhook is sent from Adyen.
  4. 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.

  1. Identify and collect the required information.
    Check the required information based on the country where your user is operating in.
  2. Create legal entities.
    Create the required legal entity resources for your user and for entities associated to the user.
  3. Associate legal entities.
    Link other legal entities to the main legal entity of your user.
  4. 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.
  5. Create business lines
    Create business lines to provide Adyen with information about your users' line of business, such as their industry and sales channels.
  6. Create stores
    Create stores to ensure that payments are processed in a compliant manner and settled with the correct user.
  7. Create account holders
    Create account holders and link it to their legal entity.
  8. Accept the terms of service
    Accept Adyen's terms of service. Depending on your integration, your may need to accept more than one Terms of Service document.
  9. 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.
  10. Upload additional documents.
    Adyen may require you to upload additional documents in order to verify user data.
  11. Create balance accounts.
    Create balance accounts to hold the funds of your account holders.

Process payments

Start processing payments for your users.

  1. Split payments.
    Accept payments on behalf of your user and split payments with them at time of authorisation or capture.
  2. Listen to webhooks.
    Learn which webhooks Adyen sends to inform your server of payment events.

Pay out

Pay out funds to your user's bank account.

  1. Make scheduled payouts
    Set up scheduled payouts.
  2. Pay out on demand
    Make on-demand payouts.
  3. Listen to webhooks.
    Learn which webhooks Adyen sends to inform your server of payout events.

Download reports

Use reports to reconcile payments and balances in your system.

  1. 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.
  2. Download reports.
    Listen to the balancePlatform.report.created webhook to know when a report is generated and ready to be downloaded. To download a report, you must authenticate your GET requests with your report credentials.

Go live

To take 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.

  1. Replicate your test account setup.
    The setup from your test Adyen for Platforms account is not replicated to your live Adyen for Platforms account.
  2. Update your code base.
  3. Switch to live API credentials.
    Get your live API credentials from your Adyen contact. Use these credentials in your live account.
  4. Switch from test to live endpoints.
    Change the endpoints from test to live. For example, https://balanceplatform-api-test.adyen.com/ to
    https://balanceplatform-api-live.adyen.com/.
  5. Run end-to-end tests.
    • Live 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.
    • Payments:
      • 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.