Skip to main content

Adyen Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that sends data to an Adyen location.
adyen_api.png

Adyen

Create an Adyen Destination​

  1. Click the + icon on the Nexset that will be sent to the Adyen destination, and select the Send to Destination option from the menu.

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

  3. In Nexla, Adyen destinations can be created using pre-built endpoint templates, which expedite destination setup for common Adyen endpoints. Each template is designed specifically for the corresponding Adyen endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    Adyen destinations can also be configured manually, allowing you to send data to Adyen endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Adyen endpoints. Each template is designed specifically for the corresponding Adyen endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, 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.

Configure Manually​

Adyen destinations can be manually configured to send data to any valid Adyen API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Adyen API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Adyen API from the Method pulldown menu.

Data Format​

  1. Select the format in which the Nexset data will be sent to the Adyen API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call. Adyen API endpoints typically expect JSON format for request bodies.

API Endpoint URL​

  1. Enter the URL of the Adyen API endpoint to which you want to send the Nexset data in the URL field. 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.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include any headers already present in the credentials.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this Adyen destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

Response Webhook​

Optional

Nexla can automatically send the response received from the Adyen API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the Adyen API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)​

After all endpoint settings have been configured, Nexla can send a test payload to the Adyen API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Adyen API using the current settings.

Save & Activate the Destination​

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