Integration checklist

This page explains the steps to integrate Adyen Capital into your existing Adyen for Platforms integration.

The integration steps are the following:

1. Review your account structure
2. Complete the integration checklist for Adyen for Platforms
3. Test your API keys
4. Set up webhooks
5. Implement Capital features
6. Go live

Requirements

Before you start building your integration, make sure that:

• Reached out to your Adyen contact and expressed interest in Capital.
• You have already designed your implementation with your Adyen implementation manager.

Review your account structure

Before you start the integration process, you must be familiar with the account structure for Capital. You need this information to building the different parts of your implementation.

Every integration that includes Capital must have at least the following resources:

• Company account: Represents your core business entity and holds your merchant accounts.
• Merchant account: The account where we process payments for your users. You can have multiple merchant accounts.
• Balance platform: The accounting system in which you manage your users and funds.
• Account holder: Specifies what your user can do in your platform, for example, receive fund transfers to their balance account and payouts to their verified transfer instrument (bank account).
• Balance account: Holds the funds of your user or your platform. All financial activities in your platform, such as paying out to a bank account, happen through balance accounts.
• Legal entity: Contains information about your user, for example, the legal name, address, and tax information of the organization. Adyen uses this information to perform verification checks required by payment industry regulations.
• Transfer instrument: Your user's verified bank account where they can receive payouts.
• Grant account: allows you to track the total amount of outstanding receivables that Adyen has in relation to grants in your balance platform.
• Grant references: tracks the balances related to specific grants. These references are created when a grant is paid out.

Complete the integration checklist for Adyen for Platforms

Before integrating Capital, you must complete the integration steps for either the marketplace or platform model of Adyen for Platforms.

Test your API keys

To make API requests related to Capital, you can use the same API credentials that you generated for your marketplace or platform. If needed, you can generate your API credentials and assign roles to them in your Customer Area.

Make sure that you have the following API credentials and roles.

Set up webhooks

Adyen sends webhooks to communicate events related to your grant requests. For example, you recieve a webhook when a grant is configured or when the grant funds have been paid out.

To configure webhooks:

1. Set up webhook endpoints on your server and build the logic for acknowledging webhooks.
2. Configure webhooks in your Customer Area.
3. Secure webhooks with HMAC signing.

Implement Capital features

You can implement Capital features in two ways:

• Using Capital components
• Using Adyen's Capital API

Implement Capital using components

To reduce implementation time and effort, use Adyen's prebuilt component libraries that you can integrate into your user interface.

Components simplify the process of integrating all the features of Capital.

To implement Capital components:

1. Create an authentication session from your server
   Create a session token to ensure secure communication between the component and the Adyen server.
2. Install the component library in your front end
   Install the npm package, then import the library, component, and style sheet in your front-end application.
3. Initialize the component
   1. Gather the required information on the specific library and component you want to integrate.
   2. Create a DOM element on your user interface page where you want the component to be rendered.
   3. Add a function that calls your API to retrieve and refresh an authentication session token.
   4. Initialize the component and mount it to the DOM element you created.
4. Customize the component(s)
   Customize the component to match your platform's look and feel.

Implement Capital using Adyen's API

You can use our API to build your own user interface for offering Capital.

Make sure that you implement features to:

1. Show available grant offers to your users.
2. Show the Terms of Service to your users.
3. Allow your users to electronically sign the Terms of Service.
4. Allow your users to select a grant offer.
5. Make a request for the selected grant offer on behalf of your users.

Go live

To take your Capital integration live:

1. Replicate your test account setup in your live account: The Capital setup from your test account for Adyen for Platforms is not automatically replicated in your live 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 requests to make sure that your live API credentials are working.
   • Grant account: Create a grant account in your live environment.
   • Grant offers: Confirm that you can get grant offers for users with the required capability.
   • Pay out grants: Confirm that grant amounts are correctly paid out to the corresponding balance accounts or transfer instruments.
   • Webhooks: Confirm that you can receive and accept webhooks in the live environment.