Adyen connectors

  • Updated

The Optimizely Configured Commerce engineering team is releasing an integration to Spreedly, a global payments ecosystem, in December 2023. All new payment implementations are expected to use the Spreedly integration to facilitate payment processing. Optimizely will not make any feature enhancements to old payment connectors.

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

Settings

  1. Go to Admin Console > System > Settings.
  2. Search for and select Payment Gateway.
  3. Select Adyen from the Payment Gateway menu.
  4. Populate the following fields with the criteria provided via your Adyen account.
Field Name Description
Merchant Account Number The merchant account number for your Adyen account.
API Key API key value.
Test Mode Default: On. Uses the Ayden test URLs.
Adyen Domain Ayden in a multi-tenant payment gateway and you will have a specific domain, such as [Random]-[CompanyName]-pal-live.adyenpayments.com.
Use Payment Gateway Vault Default: Off. Enables using credit card tokens from the payment gateway that can be submitted to the ERP. Enable this option only if the ERP requires the payment card token to process a transaction, as opposed to the authorization token.

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.

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.

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.

  1. Configure your Adyen Portal to use the desired payment methods. Some supported payment methods require frontend customization of the configuration object for the Adyen drop-in. 
  2. 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. 
  3. 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’s 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 will 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”. 
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 

In addition to the base connector Adyen settings mentioned above, there are a number of settings specifically necessary for the Adyen drop-in itself (see configuration steps above) 

Field Name Description
Live URL Prefix  Found in customer's live Adyen portal; looks like 1797a841fbb37ca7-AdyenDemo. See https://docs.adyen.com/development-resources/live-endpoints#live-endpoints-structure 
HMAC Key  Found in customer's live Adyen portal; looks like 0D4E494A384434C3D2C35C0E91DEF53E59334BCF1AABDBB6C945824E3AB9475F. See https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures 
Failed Orders Email Address  An email will be sent to this address with details on failed orders. This is useful when a payment method does not return the authorization results right away. 

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