Fast-payout icon

Integration checklist

Checklist for building and taking your Adyen payouts integration live.

On this page you'll learn the steps for developing your payouts integration and for taking 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 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_[123456]@Scope.Company_[YourCompanyAccount]: You'll use your API credentials to make requests to the Legal Entity Management API using basic authentication.

Try out the requests below.

Set up webhooks

Adyen sends webhooks to communicate events, 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 your business entity

Before you can start paying out, Adyen needs to verify your information.

  1. Identify and collect the required information.
    Check the required information based on the country/region where your business entity is operating in.
  2. Create legal entities.
    Create the required legal entity resources for your business and for entities associated with the business.
  3. Associate legal entities.
    Link other legal entities connected to the main entity.
  4. Create account holders.
    Create account holders and link it to your legal entity.
  5. Get updates about account holders.
    Get updates about the verification status and capability changes for an account holder.
  6. Upload additional documents (Conditional).
    Adyen may require you to upload additional documents to verify your data.
  7. Create balance accounts.
    Create balance accounts to hold your funds.

Pay out

Pay out funds to your beneficiaries.

  1. Pay out on demand
    Pay out to third-party bank accounts or cards.
  2. Listen to webhooks.
    Learn which webhooks Adyen sends to inform your server of your payouts to bank accounts or cards.

Going live

To get your payouts integration 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 account is not replicated to your live account.

  2. Update your code base.

    1. 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.

    2. Switch from test to live endpoints.
      Change the endpoints from test to live. For example, https://balanceplatform-api-test.adyen.com/ to live https://balanceplatform-api-live.adyen.com/.

  3. 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.
    • 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.