Adyen connectors

6 min

Important

Optimizely Configured Commerce has an integration with Spreedly, a global payments ecosystem, to give you access to more payment gateway options. When implementing new payment gateways on your Configured Commerce storefront, you must select a payment gateway and a payment method Spreedly supports. The previous payment connectors are no longer supported.

Adyen is a plug-in that you can configure to process payments when completing an order on your Optimizely Configured Commerce website.

Note

For any new payment gateway with TokenEx, TokenEx must whitelist the customer's production instance. The whitelisting process with TokenEx can take up to 2 weeks. The developer or partner must contact Optimizely Support at least 2 weeks before your intended go-live date to ensure the whitelist process has been completed properly.

Sandbox environments do not require whitelisting for testing, but issues may arise after going live if TokenEx has not whitelisted the production instance.

Settings

Go to Admin Console > Settings.

Search for and select Payment Gateway.

Select Adyen from the Payment Gateway menu.

Populate the following fields with the criteria provided via your Adyen account:

Merchant Account Number – The merchant number for your Adyen account.

API Key – API key value.

Test Mode – The ability to use Adyen test URLs. The default value is On.

Adyen Domain – Your specific subdomain for Adyen, such as [Random]-[CompanyName]-pal-live.adyenpayments.com.

Use Payment Gateway Vault – The ability to use credit card tokens from the payment gateway and send them to the ERP. Use this option only if your ERP requires the payment card token to process a transaction, as opposed to the authorization token. The default value is Off.

Use Ship-to# For Payment Gateway Vault – The ability to use the CustomerSequence # for an account if present. The default value is Off.

Note

Configured Commerce does not store sensitive credit card or profile information.

Configure the Adyen drop-in

Along with the regular gateway option described above, Configured Commerce has an Adyen drop-in option. This option uses Adyen’s IFrame rather than TokenEx and offers additional features and functionality, such as incorporating a number of payment methods supported by Adyen. Follow the TokenEx implementation detailed above to use the Adyen gateway in the Admin Console.

Important

The Adyen Drop-in is locked behind the system-level IFrame setting. To use this functionality, submit a Support ticket request to update your Sandbox environment with the Payment Gateway IFrame value set to Adyen. Once updated, your Sandbox’s IFrame across all sites uses the Adyen drop-in, and you can no longer use TokenEx.

Warning

Due to data incompatibility across iframes, changing to a different iframe (such as TokenEx, Paymetric, Square Drop-in, or Adyen Drop-in) deletes all existing saved payment methods for all web users.

Configure your Adyen Portal to use the desired payment methods. Some supported payment methods require front-end customization of the configuration object for the Adyen drop-in.

Generate keys through the Adyen Portal and configure them in the Admin Console.

Generate an API Key and add it to Settings > Order Management > Adyen > API Key.

Generate a Client Key and add it to Settings > Order Management > Payment > Client Key.

Generate an HMAC Key and add it to Settings > Order Management > Adyen > HMAC Key.

Configure the following in the Adyen Portal and Configured Commerce:

Add your Configured Commerce site domain to Adyen by navigating to Developers > API Credentials > Choose Account > Client Settings > Add Allowed Origins.

Retrieve your Merchant Account name by going to Settings > Merchant Accounts in the Adyen Portal and noting the "Account code" field of the merchant account you wish to use. Enter this value into the Admin Console by navigating to Settings > Order Management > Adyen > Merchant Account Number.

Set up notifications in the Customer Area for Configured Commerce webhook:

URL format: {Configured Commerce Site URL}/api/v1/paymentauthentication/adyenwebhook

Type: JSON

If your URL is live, configure the live URL Prefix in Configured Commerce by navigating to Settings > Order Management > Adyen > Live URL Prefix. You can find the prefix in the live Adyen portal (for example, 1797a841fbb37ca7-AdyenDemo).

Configure the Adyen Domain by navigating to Settings > Order Management > Adyen > Adyen Domain. Since Adyen is a multi-tenant payment gateway, you have a specific subdomain, like [Random] -[CompanyName]-pal-live.adyenpayments.com. For example, if it were 123456-episerver-pal-live.adyenpayments.com, this value would be 123456 – Optimizely.

Note

If the Adyen drop-in is not configured correctly, transaction data may not sync between Configured Commerce and Adyen, as Configured Commerce relies on the Adyen webhook to return transaction details. Be sure to thoroughly test the Adyen drop-in after configuration.

Drop-in settings

Along with the base connector Adyen settings mentioned previously, some settings are necessary for the Adyen drop-in.

Live URL Prefix – Found in your live Adyen portal, such as 1797a841fbb37ca7-AdyenDemo. See Adyen's Live endpoints structure documentation.

HMAC Key – Found in your live Adyen portal, such as 0D4E494A384434C3D2C35C0E91DEF53E59334BCF1AABDBB6C945824E3AB9475F. See Adyen's Verify HMAC signatures documentation.

Failed Orders Email Address – The email address to receive details on failed orders. This is useful when a payment method does not return the authorization results right away.

Note

The Adyen drop-in does not currently support PayPal. You can add PayPal as a separate option in the payment area.