Adyen

Adyen is an end-to-end payments platform that enables businesses to accept, process, and settle payments globally, with integrated data insights and financial management tools to optimize revenue and control operations.

Power end-to-end data operations for your Adyen API with Nexla. Our bi-directional Adyen connector is purpose-built for Adyen, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Adyen or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Adyen workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating an Adyen credential in Nexla, you need to obtain your API key, prefix URL, and API version from your Adyen Customer Area. These credentials authenticate Nexla with the Adyen Payments API and should be kept secure.

To obtain your Adyen API credentials, follow these steps:

1. Sign in to your Adyen Customer Area account.

2. Navigate to Developers → API credentials in the left navigation menu to access the API credentials page.

3. Locate or create an API credential that has the necessary permissions for the operations you want to perform. API credentials are used to authenticate API requests and provide access to your Adyen account.

4. Copy your API Key Value. This is a secret key that authenticates API requests and provides access to your Adyen account. The API key is sent in the x-API-key header for all API requests.

5. Locate your Prefix URL. This is a string composed of a hex-encoded random part and your company name. The prefix is used to construct the API endpoint URL for your account. You can find the prefix in your live Customer Area under the API credentials section.

6. Determine the API Version you want to use. The API version number always starts with "v" (for example, v52). API versions are used to access specific features and endpoints. To learn more about API versioning, see the Adyen API documentation.

   Your API Key Value, Prefix URL, and API Version are unique to your Adyen account and should be kept secure. Do not share these credentials publicly or commit them to version control systems. If you suspect your API key has been compromised, regenerate it immediately in your Adyen Customer Area.

For additional information about Adyen API authentication and credential management, see the Adyen API authentication documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
API Key Value	Yes	Yes
Prefix URL	Yes	No	A string composed of a hex-encoded random part and your company name. Get the prefix from your live Customer Area
Api Version	Yes	No	The version number, always starting with "v" (for example, v52). To learn more about API versioning for classic and new APIs

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Adyen

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter your Adyen API Key Value in the API Key Value field. This key authenticates Nexla with the Adyen Payments API and should match the API key obtained from your Adyen Customer Area. The API key is sent in the x-API-key header for all API requests.

   The API Key Value provides access to your Adyen account through the API. Keep your API key secure and do not share it publicly or commit it to version control systems. Adyen uses the API key in the x-API-key header for authentication, which allows Nexla to make authenticated requests to your account.

4. Enter your Adyen Prefix URL in the Prefix URL field. This should be the prefix string from your Adyen Customer Area, which is used to construct the API endpoint URL. The prefix is composed of a hex-encoded random part and your company name.

5. Enter your Adyen API Version in the Api Version field. This should be the version number you want to use, always starting with "v" (for example, v52). The API version determines which features and endpoints are available.

   The API endpoint URL is automatically constructed using your Prefix URL and API Version in the format https://{prefix}-checkout-live.adyenpayments.com/checkout/{version}. Ensure that your Prefix URL and API Version are correct to ensure proper API endpoint construction.

6. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Adyen connector tile, then select the credential that will be used to connect to the Adyen instance, and click Next; or, create a new Adyen credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Adyen endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

Payment Link

This endpoint retrieves the payment link details using the payment link ID. Use this endpoint when you need to access information about a specific payment link, including payment status, amount, and other transaction details.

• Enter the unique identifier of the payment link in the Payment Link Id field. Payment link IDs are unique identifiers that can be obtained when creating payment links through the Adyen API or from your Adyen Customer Area.
• The endpoint will return detailed information about the payment link, including payment status, amount, currency, expiration date, and other relevant transaction details.

Payment link IDs are unique identifiers for each payment link created in your Adyen account. For detailed information about retrieving payment link details, see the Adyen API documentation.

Payment Session

This endpoint returns the status of a payment session using the session ID and session result. Use this endpoint when you need to check the status of a payment session created for Web Drop-in or Web Components integrations.

• Enter the unique identifier of the payment session in the Session Id field. Session IDs are unique identifiers that can be obtained when creating payment sessions through the Adyen API.
• The endpoint will return the current status of the payment session, including payment result, amount, currency, and other relevant session details.

Session IDs are unique identifiers for each payment session created in your Adyen account. For detailed information about retrieving payment session details, see the Adyen API documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Adyen data sources can also be manually configured to ingest data from any valid Adyen API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Adyen API endpoints typically follow the pattern https://{prefix}-checkout-live.adyenpayments.com/checkout/{version}/{endpoint}, where {prefix} is your account prefix, {version} is your API version, and {endpoint} is the specific API endpoint path. For a complete list of available Adyen API endpoints, see the Adyen API Explorer.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Adyen data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Adyen destination, and select the Send to Destination option from the menu. Select the Adyen connector from the list of available destination connectors, then select the credential that will be used to connect to the Adyen organization, and click Next; or, create a new Adyen credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Adyen endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Create Payment Link

This endpoint creates a payment link to Adyen's hosted payment form where shoppers can pay. Use this endpoint when you need to generate payment links for e-commerce transactions. The list of payment methods presented to the shopper depends on the currency and country parameters sent in the request.

• The endpoint will send the Nexset data as JSON in the request body to create the payment link. Ensure your Nexset contains all required fields for payment link creation, including amount, currency, country code, and merchant account information.
• Each record in the Nexset will be sent as a separate API request to create a new payment link in your Adyen account.
• The response will include the payment link URL that can be shared with customers to complete their payment.

The request body must contain valid JSON with all required fields for payment link creation. For detailed information about required fields and data formats, see the Adyen API documentation.

Create Payment Session

This endpoint creates a payment session for Web Drop-in and Web Components integrations. Use this endpoint when you need to initialize a payment session for your web-based checkout flow.

• The endpoint will send the Nexset data as JSON in the request body to create the payment session. Ensure your Nexset contains all required fields for payment session creation, including amount, currency, country code, and merchant account information.
• Each record in the Nexset will be sent as a separate API request to create a new payment session in your Adyen account.
• The response will include the session data that can be used to initialize the Adyen Web Drop-in or Web Components on your checkout page.

The request body must contain valid JSON with all required fields for payment session creation. For detailed information about required fields and data formats, see the Adyen API documentation.

Manual configuration

Adyen destinations can also be manually configured to send data to any valid Adyen API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Adyen API endpoints typically expect JSON format for request bodies. For update/upsert operations, include the ID of the object to be updated at the end of the URL. Adyen API endpoints typically follow the pattern https://{prefix}-checkout-live.adyenpayments.com/checkout/{version}/{endpoint}, where {prefix} is your account prefix, {version} is your API version, and {endpoint} is the specific API endpoint path.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Adyen endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Adyen endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.