Install and configure Adyen

This topic describes how to install and configure the Adyen module to integrate Adyen into your project.

Integration overview

The spryker-eco/adyen module provides integration of Spryker e-commerce system with Adyen technology partner. It requires the SprykerEco.AdyenApi spryker-eco/adyen-api module that provides the REST Client for making API calls to the Adyen Payment Provider.

The SprykerEco.Adyen module includes integration with:

• Checkout process - payment forms with all necessary fields that are required to make payment request, save order information and so on.
• OMS (Order Management System) - state machines, all necessary commands for making modification requests and conditions for changing orders status accordingly.

The SprykerEco.Adyen module provides the following payment methods:

• Credit Card
• Direct Debit
• Klarna Invoice
• Prepayment
• Sofort
• PayPal
• iDeal
• AliPay
• WeChatPay

Installation

To install the Adyen module, run the command:

composer require spryker-eco/adyen

General Configuration

You can find all necessary configurations in vendor/spryker-eco/adyen/config/config.dist.php. The table below describes all general configuration keys and their values.

Specific configuration

1. Also, you need to add payment methods to the State Machine (OMS), Domain Whitelist, and Session Frontend configuration:

  $config[KernelConstants::DOMAIN_WHITELIST] = array_merge($trustedHosts, [
     ...
     'adyen.com', // trusted Adyen domain
     'test.adyen.com', // trusted Adyen domain for tests
 ]);
 ...
 // >>> SESSION FRONTEND
 ...
 $config[SessionConstants::YVES_SESSION_COOKIE_SAMESITE] = 'none';
 ...
 $config[OmsConstants::PROCESS_LOCATION] = [
 ...
 APPLICATION_ROOT_DIR . '/vendor/spryker-eco/adyen/config/Zed/Oms',
 ];
 $config[OmsConstants::ACTIVE_PROCESSES] = [
 ...
 'AdyenCreditCard01',
 'AdyenSofort01',
 'AdyenDirectDebit01',
 'AdyenKlarnaInvoice01',
 'AdyenPrepayment01',
 'AdyenIdeal01',
 'AdyenPayPal01',
 'AdyenAliPay01',
 'AdyenWeChatPay01',
 ];
 $config[SalesConstants::PAYMENT_METHOD_STATEMACHINE_MAPPING] = [
 ...
 AdyenConfig::ADYEN_CREDIT_CARD => 'AdyenCreditCard01',
 AdyenConfig::ADYEN_SOFORT => 'AdyenSofort01',
 AdyenConfig::ADYEN_DIRECT_DEBIT => 'AdyenDirectDebit01',
 AdyenConfig::ADYEN_KLARNA_INVOICE => 'AdyenKlarnaInvoice01',
 AdyenConfig::ADYEN_PREPAYMENT => 'AdyenPrepayment01',
 AdyenConfig::ADYEN_IDEAL => 'AdyenIdeal01',
 AdyenConfig::ADYEN_PAY_PAL => 'AdyenPayPal01',
 AdyenConfig::ADYEN_ALI_PAY => 'AdyenAliPay01',
 AdyenConfig::ADYEN_WE_CHAT_PAY => 'AdyenWeChatPay01',
 ];

2. Based on the Adyen API version, you need to configure Session Frontend:

 // >>> SESSION FRONTEND
 ...
 $config[SessionConstants::YVES_SESSION_COOKIE_SAMESITE] = Cookie::SAMESITE_LAX; // Checkout API v67 and later (https://docs.adyen.com/online-payments/3d-secure/redirect-3ds2/web-drop-in/#handle-the-redirect)
 $config[SessionConstants::YVES_SESSION_COOKIE_SAMESITE] = Cookie::SAMESITE_NONE; // Checkout API v66 and earlier. (https://docs.adyen.com/online-payments/3d-secure/redirect-3ds2/web-drop-in/#handle-the-redirect)
 ...

Notifications

To complete the payment modification requests (cancel, capture, refund), it’s necessary to configure notification on Adyen merchant backend side.

You can get more information form Adyen documentation.

The link to accept notifications from Adyen looks like https://mysprykershop.com/adyen/notification.

Adyen Configuration

You can get your credentials by following the instruction.

You can get JS SDK url and generate your origin key by following this instruction from.