Magento

The Magento plugin supports the Magento Community and Enterprise edition. Integrate a Point-of-Sale solution, including the Adyen Verifone terminals to offer a full omni-channel experience.

Features:

  • Payments through HPP
  • Payment Pre-Selection
  • OpenInvoice (Afterpay/Klarna)
  • API payments (incl Boleto/ELV)
  • Creditcard Installments
  • Creditcard 3D secure
  • Creditcard Client Side Encryption
  • POS payment mobile devices
  • Order details linked to Adyen platform
  • Refund support

Magento Integration

Here we describe how to submit payment transactions to the Adyen payment system using our plugin for Magento. We advise you to download and install the plugin from GitHub. Alternatively, it is also possible to download and install it with Magento Connect.

Magento last update

Version

Date

Changes

4.0.1 2016-01-06 Updated info about hosting providers.

Version

Date

Changes

4.0.1 2016-01-06 Updated info about hosting providers.
4.0 2015-09-07
  • Documentation migration from PDF to web-based online deliverable as main distributable asset.
  • New sections for set up and configuration of the Adyen plugin
  • Versioning: version reset and adoption of semantic versioning as per v. 4.0.0.
  • Manual redesign to improve readability, navigation, content search.

Install the Adyen plugin

GitHub download

  1. Download the latest version of our Adyen plugin available on GitHub.
  2. Extract the contents from the downloaded file.
  3. Upload only the content that's inside the extracted folder (magento-x.x.x) and move it to the root folder of your Magento installation.
  4. Verify the folder and file permissions of the uploaded files.
  5. In your Magento backend, go to System > Cache Management and click on  the Flush Cache Storage button.
  6. If you are already logged in to your Magento backend, log out, and then log in again.

Magento Connect download

  1. Install the latest version of our Adyen Plugin available on Magento Connect.
  2. In Magento backend go to the Magento Connect Manager.
  3. Copy the key into the field under the section Install New Extensions.
  4. Click the Install button.
  5. If you are already logged in to your Magento backend, log out, and then log in again.

Some hosting providers including Byte are running php in CGI modus. This means that HTTP Basic Authentication, used for the notifications, is not working on default. Enable the authorisation by adding the following rules to the .htaccess file in the Magento root directory.

RewriteEngine on:
RewriteCond %{HTTP:Authorization} (.+)
RewriteRule .* - [E=REMOTE_USER:%{HTTP:Authorization},L]

For further Magento-specific details, refer to the official Magento documentation.

Prepare the settings in the Adyen Customer Area

Before configuring the settings, make sure that the Adyen Customer Area (CA) set up is complete.  

  1. Go to ca-test.adyen.com and log in using your test account credentials.
  2. In the Main menu, click Account.
  3. Select the name of your Merchant account.

Configure notifications

  1. Go to Settings Server Communication. 
  2. Click Add next to Standard Notification.
  3. Under the Transport section:
    1. Enter your website URL followed by /adyen/process/json
      If you have turned off URL rewrite in Magento, you need to use index.php/adyen/process/json
    2. Select the Active checkbox.
    3. Set Method to JSON.
  4. Under the Authentication section, enter the User Name and Password.
    Take a note of this information, as you will need it later on when configuring the Adyen plugin.
  5. Click Save Configuration.

Configure merchant account settings

  1. Go to Settings Merchant Settings. 
    The default value for Capture Delay is Immediate, you may adjust it according to your preferences.
  2. Click Submit.

Configure web service (ws) user

  1. Go to Settings Users.
  2. From the first dropdown in the upper left table cell, select System.
  3. Click the ws user (ws@Company.YourCompanyCode).
    If you have not yet set a password for your ws user yet, you can do it by clicking Generate. 
    Take a note of the password as you will need it later on when configuring the Adyen plugin.
  4. Click Save.

Configuring your LIVE account

  1. After your merchant account is enabled on the Adyen LIVE platform, using your live account credentials log in to ca-live.adyen.com.
  2. In the main menu, click Account.
  3. Select your Merchant account. 
  4. Configure the notifications, merchant account settings, and ws user following the steps described above.


Configure the Adyen plugin

Before you start

Before tweaking your Adyen Payment settings in Magento, you need to configure the default Magento cronjob.

Configure the default Magento cronjob

To configure the default Magento cronjob:

  1. In the Magento Admin Panel, go to the System menu, and select Configuration.
  2. On the left-hand navigation sidebar In the Magento Admin Panel, browse to the Advanced category and click System.
  3. In the System area, click the Cron (Scheduled Tasks) section.
  4. Set the Generate Schedules Every input field to 1.
  5. Click Save Config.

This sets the cronjob generation time interval to 1 minute.

Adyen Payment Configurations

  1. Log in to your Magento Admin Panel to configure the Adyen plugin.
  2. Go to SystemConfiguration from the main menu.
    You are redirected to the general settings of Magento.
  3. Select Payment Methods from the left menu in the Sales tab.
    You are redirected to the page with settings for the Adyen plugin.

Set up the required settings

This section will describe the configuration of the required settings for the Adyen plugin in Magento.

Under the Payment Method configuration, you will find various sections related to the configuration of the Adyen plugin. 

  • Click Adyen Default Settings and open the Required Settings section by clicking on it.
  • Fill out the fields. Hovering over the question mark ( (question) ) on the right of each field will give you more information about the required setting.

 

Fields

Setting Value(s) Description
  The merchant account identifier you want to process the (transaction) request with. Find this at the top of the screen in the Adyen Customer Area, where you will see [YourCompanyAccount] > [YourMerchantAccount] . Please note that the merchant account is different from the company account; a company account can have one or more merchant accounts. You always have at least one company account with one corresponding merchant sub-account. For more information on the account structure, view this article.

Test

In the test mode you must use test cards. See section Documentation & Support for the link to the test cards
Live
  Set your own username and copy it over to Adyen Customer Area => Settings => Server Communication => Standard Notification => User Name.
  Set your own password and copy it over to Adyen Customer Area => Settings => Server Communication => Standard Notification => Password.
 

Find this in your Test Adyen Customer Area => Settings => Users => System. Normally this will be ws@Company.YourCompanyCode. Copy and Paste the exact ws username here.

When everything is correctly configured and you receive an authentication error when testing the notifications from the Adyen Customer Area, follow the note at the bottom of this page.

  Find this in your Test Adyen Customer Area => Settings => Users => System. Click on your web service user and generate a new password. Copy and Paste the exact password here.
  Find this in your Live Adyen Customer Area => Settings => Users => System. Normally this will be ws@Company.YourCompanyCode. Copy and Paste the exact ws username here.
  Find this in your Live Adyen Customer Area => Settings => Users => System. Click on your web service user and generate a new password. Copy and Paste the exact password here.

Auto Capture

Immediate is the default. Set to manual if you want to perform the capture of funds manually later (only affects credit cards and a few alternative payment methods). You need to change this setting as well in Adyen Backoffice => Settings => Merchant Settings => Capture Delay. If you have selected a capture delay of a couple of days in Adyen of a couple of days keep it here on immediate
Manual Capture 
-- Please select -- Status given to newly created orders before payment result confirmation via server notifications from Adyen.
Pending
-- Please select -- Status given to orders after authorisation confirmed by an AUTHORISATION notification from Adyen. Note: an authorisation status via the result URL does not yet trigger this status.
Pending
Processing
-- Please select -- Status given to orders after capture result is confirmed by an AUTHORISATION notification for a auto capture or CAPTURE notification for a manual capture from Adyen.
Processing
On Hold Status given to orders after order cancellation is confirmed by an CANCEL_OR_REFUND notification from Adyen. If orders are already invoiced, they cannot be cancelled, but will be refunded instead.

Yes

 
No

Some hosting providers are running php in CGI modus. This means that HTTP Basic Authentication, used for the notifications, is not working on default. Enable the authorisation by adding the following rules to the .htaccess file in the Magento root directory.

RewriteEngine on:
RewriteCond %{HTTP:Authorization} (.+)
RewriteRule .* - [E=REMOTE_USER:%{HTTP:Authorization},L]

Also, some hosting providers are blocking Bots, which may block our notifications from being sent correctly.

If you are using Byte as your hosting provider you can see more information about that and how to allow bots on their website.

Set up the advanced settings

This section describes the configuration of the advanced settings for the Adyen plugin in Magento.
Under the Payment Method configuration, you will find various sections related to the configuration of the Adyen plugin. 

  • Click Adyen Default Settings. There are various sections related to advanced settings.
  • Hovering over the question mark ( (question) ) on the right of each setting field will give you more information about the required setting.
Magento order processing

This section will describe the configuration of the advanced Magento order processing for the Adyen plugin in Magento.

Under the Payment Method configuration, you will find various sections related to the configuration of the Adyen plugin. 

  • Click Adyen Default Settings and open the Advanced: Magento Order Processing section by clicking on it.
  • Fill out the fields. Hovering over the question mark ( (question) ) on the right of each field will give you more information about the required setting

Fields

Setting Value(s) Description
Use manual-capture for PayPal Yes  Should be on 'No' by default. If you have requested with Adyen Support for your Paypal integration to be on manual-capture, set this to 'Yes'.
No
Use auto-capture for OpenInvoice payments Yes

Applicable for Klarna and Afterpay only. By default OpenInvoice is set to manual capture. If you want auto capture you need to contact magento@adyen.com. After approval has been given, then you can set this option to 'Yes'.
No
Order status: payment capture (virtual products) -- Please select -- Select only status assigned to state complete. Leave empty to use the same as normal products
Completed
Order status: Adyen Refunded -- Please select -- Status given to order after a (partial) refund has been made on the order. This is triggered when the REFUND notification is received
Closed
Order status: pending Bank Transfer/SEPA orders -- Please select -- By default, Adyen does not inform your Magento store about pending payments. If you want these notifications to be received,  Go to Adyen Customer Area => Server Communication and add BankTransfer Pending Notification and Direct-Debit Pending Notification.
Pending Payment
Send order confirmation email for Bank Transfer/SEPA Yes Send a confirmation mail after Bank Tranfer/SEPA is placed (not yet paid). If you want these notifications to be received,  Go to Adyen Customer Area => Server Communication and add BankTransfer Pending Notification and Direct-Debit Pending Notification.
No
Create a pending invoice (only for manual capture) Yes This will create a pending invoice if the AUTHORISATION notification is received.
No
Order status: Capture on shipment Yes If you enable this function it will do a capture request to Adyen platform if you do a shipment
No
Invoice email Yes
Enable/Disable update mails
No
Receive order status update email (deprecated) Yes
DEPRECATED Enable/Disable update mails for all order status changes to the shopper
No
Adyen payment notifications

This section will describe the configuration of the Adyen advanced payment notifications for the Adyen plugin in Magento.

Under the Payment Method configuration, you will find various sections related to the configuration of the Adyen plugin. 

  • Click Adyen Default Settings and open the Advanced: Adyen Payment Notifications section by clicking on it.
  • Fill out the fields. Hovering over the question mark ( (question) ) on the right of each field will give you more information about the required setting

Fields

Setting Value(s) Description
Ignore refund notification

Yes

If the refund is done on the Adyen Platform it will send a refund notification to Magento that automatically create a credit memo. If you enable this setting this will not happen because it will not process any of the REFUND notification that is received.
No
Allow multiple merchants

Yes

Allow notifications sent from other Adyen merchant accounts. Keep in mind that the Notification user name and password should be the same for all the merchant accounts
No
Billing agreements

This section will describe the configuration of the advanced billing agreements for the Adyen plugin in Magento.

Under the Payment Method configuration, you will find various sections related to the configuration of the Adyen plugin. 

  • Click Adyen Default Settings and open the Advanced: Billing Agreements section by clicking on it.
  • Fill out the fields. Hovering over the question mark ( (question) ) on the right of each field will give you more information about the required setting

Fields

Setting Value(s) Description
Agreement Type  NONE

When enabled, users can save their Credit Cards and their SEPA authorizations. ONECLICK will require the input of the CVC for subsequent payments, while RECURRING does not.

ONECLICK: The shopper opts in to storing their card details for future use. The shopper is present for the subsequent transaction, for cards the security code (CVC/CVV) is required.

RECURRING: Payment details are stored for future use. For cards, the security code (CVC/CVV) is not required for subsequent payments.

ONECLICK, RECURRING: Payment details are stored for future use. This allows the use of the stored payment details regardless of whether the shopper is on your site or not.

ONECLICK
RECURRING
ONECLICK,RECURRING
Checkout experience

This section will describe the configuration of the advanced checkout experience settings for the Adyen plugin in Magento.

Under the Payment Method configuration, you will find various sections related to the configuration of the Adyen plugin. 

  • Click Adyen Default Settings and open the Advanced: Checkout Experience section by clicking on it.
  • Fill out the fields. Hovering over the question mark ( (question) ) on the right of each field will give you more information about the required setting

Fields

Setting Value(s) Description
Redirect destination after cancellation Cart Determines how shoppers get redirected after they cancel a payment.
Checkout
Payment method render method Title Determines whether the payment methods will be displayed with its logo or just the name.
Logo + Title
Language locale (optional)   This will override the default shopper locale of the Magento store. Leave empty to let Magento decide (Ex: nl_NL)
ISO Country Code (optional)   This will override the shopper billing address country when determining what payment methods to display.
Case Management (Manual Review)

This section will describe the configuration of the advanced Manual Review settings for the Adyen plugin in Magento. The manual review is now referred as case management in the Adyen environment.

Adyen's Risk analysis tool allows merchants to configure when a transaction should be accepted or rejected depending on certain characteristics of the payment. This process has two automatic outcomes, either accept or reject the payment.

Case Management (part of Adyen RevenueProtect+) allows for a third option, in which you can manually review payments which have triggered some fraud rules but do not yet meet the criteria for automatic refusal. To use this option, speak to your Adyen account manager for approval. 

Under the Payment Method configuration in Magento, you will find various sections related to the configuration of the Adyen plugin. 

  • Click Adyen Default Settings and select Advanced: Manual Review.
  • Enter the required information. 
    Hovering over the question mark ( (question) ) on the right of each field gives you more information about the required settings.

Fields

Setting Value(s) Description
-- Please select -- Do you wish to have a separate status for payments that go into case management?
  1. Yes --> Set Manual Review Status  to 'Pending Payment'
  2. No --> Set Manual Review Status  to '-- Please Select --'
Pending Payment
Manual Review Accepted Status -- Please select -- Do you wish to push payments to force a certain status for accepted case management transactions?
  1. Yes --> Set Manual Review Accepted Status  to 'Processing'
  2. No --> Set  Manual Review Accepted Status  to '-- Please Select --'
Processing

Adyen backend:

Adyen Support needs to configure your account for case management to enable you to use it. Send your answers to the following questions to magento@adyen.com.   

  1. When you accept a case management transaction, do you want to perform a capture on it? (Only relevant for manual capture)
  2. When you reject a case management transaction, do you want to cancel/refund it? 
  3. If you do not act on a case management transaction and the authorisation is about to expire, do you want Adyen to capture or cancel the transaction for you?

Once Adyen Support has confirmed that the required settings are completed, you can begin to use case management with Magento.

Set up Adyen HPP payment methods

You can use our Magento integration to handle payments through our HPP Manual.

Before you configure the payment methods you want tot use, you need to take care of a few preliminary steps to ensure the process runs smoothly. 

Set things up

If you want to handle your payments through our Hosted Payment Pages (HPP), you will have to use the Adyen HPP option in the plugin.
This will give you access to the wide range of available payment methods that we support and can be set up for your merchant account.
For this to work, you will first have to set up a skin in the Adyen Customer Area (CA).

Define the skin in the Adyen CA

  • Go to https://ca-test.adyen.com and log in with your test account credentials
  • In the main menu click Skins
  • If no skin was configured yet, do so by clicking the button Create a new skin
  • Click HMAC with SHA-256 and new signing algorithm (Recommended)
  • Fill in a description for your skin, e.g. Magento Skin
  • Take a note of the Skin Code, as you will need it later on when configuring the plugin
  • Generate new HMAC Key for the Test and Live platform.
  • Take a note of these HMAC keys, as you will need it later on when configuring the plugin

Configure HPP in the Adyen plugin

  • Open the Adyen HPP panel in the Magento backend (under System > Configuration > Payment Methods)

  • Use the information which you previously noted when preparing the skin in the Adyen CA to fill out the fields

Setting Value(s) Description
Enabled Yes This option will have to be set to Yes if you want to enable the HPP payment methods
No
Sort Order   This is the position of the HPP payment methods during the checkout
Skin Code   Copy and paste the skin code of the skin you want to use from Test Customer Area => Skins
HMAC Key for Test Skin   Copy and paste the skin code of the skin you want to use from Test Customer Area => Skins => click on [skin code] => Edit => HMAC for Test platform
HMAC Key for Live   Copy and paste the skin code of the skin you want to use from Test Customer Area => Skins => click on [skin code] => Edit => HMAC for Live platform

Advanced settings

Setting Value(s) Description
Title   This is the title that will show on the checkout if Leave payment method selection on HPP is set to Yes
Days for Delivery   How many days to be added to the current date for delivery. ONLY numbers allowed.
Leave payment method selection on HPP Yes If you say yes here, payment methods in the checkout won't be displayed and you will be redirected to the Adyen HPP to make the selection.
No
Return url in request Yes If you have a multi webshop and you want to use one skin only, enable this option
No
Fee + Add Fee The Payment method name of the HPP payment can be found in Adyen backoffice. Go to Settings => Payment Methods and here you see under the column name the name of the payment method
Set up HPP iDeal

If you want to enable the iDeal (Dutch bank transfer) payment method, you will have to configure HPP iDeal on the Adyen plugin.

Under the Payment Method configuration, you will find various sections related to the configuration of the Adyen plugin. 

  • Click Adyen HPP iDEAL this will open up the configuration for this payment method.
  • Fill out the fields. Hovering over the question mark ( (question) ) on the right of each field will give you more information about the required setting.

Fields

Setting Value(s) Description
Enabled Yes This option will have to be set to Yes if you want to enable the HPP iDEAL payment method
No
Title   This is the title that will show on the checkout next to the iDEAL button
Show iDEAL bank logos Yes Show iDEAL bank logos (radio buttons) instead of dropdown
No
Fee   An additional fee that will be added to iDEAL payments
Sort Order   This is the position of the HPP iDEAL payment method during the checkout
Payment to applicable countries All allowed countries When set to Specific Countries, this will override the allowed countries for iDEAL payments.
Specific Countries
Payment to Specific countries   Make sure that the settings in the Adyen CA match the selection here. You can set the override countries in the Adyen CA by going to Skins > [yourskincode] > Payment methods > pen icon > Override available countries.
Set up HPP OpenInvoice (AfterPay or Klarna)

If you want to enable an OpenInvoice payment method such as AfterPay or Klarna, you will have to configure HPP OpenInvoice (AfterPay or Klarna) on the Adyen plugin.

Under the Payment Method configuration, you will find various sections related to the configuration of the Adyen plugin. 

  • Click Adyen HPP OpenInvoice (AfterPay or Klarna) this will open up the configuration for this payment method.
  • Fill out the fields. Hovering over the question mark ( (question) ) on the right of each field will give you more information about the required setting.

Fields

Setting Value(s) Description
Enabled Yes This option will have to be set to Yes if you want to enable the HPP OpenInvoice (AfterPay or Klarna) method
No
Title   This is the title that will show for the payment method
Sort Order   This is the position of the HPP OpenInvoice payment method during the checkout
OpenInvoice Type AfterPay Netherlands The type of OpenInvoice that you want to use
Klarna
Show Gender Yes  
No
Show Date of Birth Yes  
No
Show Phonenumber Yes  
No
Fee    
Disable on if billing and delivery addresses differ Yes If the delivery address and billing address in the checkout is not the same disable this payment method because Klarna will most likely reject it
No
Disable this payment method if first attempt is refused Yes If the first attempt is refused don't show this as an payment option for the current quote
No

Payment to applicable countries

All Allowed Countries

When set to Specific Countries, this will override the allowed countries for OpenInvoice payments.

Specific Countries
Payment to Specific countries   Make sure that the settings in the Adyen CA match the selection here. You can set the override countries in the Adyen CA by going to Skins > [yourskincode] > Payment methods > pen icon > Override available countries.

Set up API credit card payments

This section will describe the configuration of Credit Card Payments using our API. The advantage of using this method (over card payments through the HPP) is that shoppers will not leave your website, but instead can do the card payment directly in your checkout. For this to work you will need to have Client Side Encryption (CSE) enabled for your merchant account. On the TEST environment the role is enabled by default. 

If you are considering implementing CSE and want this to be enabled on your LIVE platform, download and fill in the PCI Self Assessment Questionnaire (SAQ) A, then email it to the Adyen Support Team.

  • Make sure that you have received confirmation from the Adyen Support Team that CSE is enabled for your account
  • Open the Credit Card panel in the Magento backend (under System > Configuration > Payment Methods)
  • Configure the settings. Hovering over the question mark ( (question) ) on the right of each field will give you more information about the required setting.

Fields

Setting Value(s) Description
Enabled Yes If you want to enable payment by Credit Cards through our API, set this option to Yes.
No
Title   Title displayed for the payment method.
Sort Order   This is the position of the Credit Cards during the checkout.
Credit Card Types   Select the credit card type(s) that you want to use.
Enable Client-Side Encryption (CSE) Yes

On TEST, check if the role API Clientside Encryption Payments role is enabled by going to Test Adyen Customer Area > Settings > Users > System (from the dropdown) > [web service user].

Contact support@adyen.com if the role is not enabled on your account. If you want this to be turned on on your LIVE account please fill in the SAQ A form and send this to salessuport@adyen.com.

No
Enter CSE Public Key of Test Adyen Webservice User   Copy this from the Test Adyen Customer Area > Settings > Users > System (from the dropdown) > [web service user] > Client Encryption Public Key.
Enter CSE Public Key of Live Adyen Webservice User   Copy this from the Live Adyen Customer Area > Settings > Users > System (from the dropdown) > [web service user] > Client Encryption Public Key.
Payment to applicable countries All Allowed Countries When set to Specific Countries, this will override the allowed countries for Credit Card payments.
Specific Countries
Payment to Specific countries   Make sure that the settings in the Adyen CA match the selection here. You can set the override countries in the Adyen CA by going to Skins > [yourskincode] > Payment methods >pen icon > Override available countries.
Visible in Backend and Frontend Where you want to show this payment method: in the backend of Magento and/or in the frontend for the shoppers
Backend Only
Frontend Only

Advanced Settings

Setting Value(s) Description
Enable MOTO for backend orders Yes Important you have to activate MOTO for your account contact magento@adyen.com. For more information our MOTO feature.
No
Enable Installments Yes If you want to have installments enabled, set this to Yes. You can set specific installment settings in the settings below.
No
Installments default   The default settings for installments
Installments for [type]   You can specify payment method specific installment configurations. Click Add Installment Boundary next to the payment method to further configure this. Make sure that you define every installment. So if you want to add 5 installments then configure installment 1,2,3,4 and then 5.

Set up OneClick

This section will describe the configuration of OneClick for the Adyen plugin in Magento. During checkout shoppers can choose to have their payment details remembered and stored for trusted websites in Adyen’s highly secure platform. Adyen takes care of this process for its customers. Shoppers can then select the saved card and checkout with ‘one-click’ in the Magento checkout.

Make sure you have turned on RECURRING_CONTRACT notification on your merchantAccount. Alternatively, contact Adyen Support Team

Under the Payment Method configuration, you will find various sections related to the configuration of the Adyen plugin. 

  • Click Adyen OneClick - Requires Adyen Credit Card this will open up its configuration.
  • Fill out the fields. Hovering over the question mark ( (question) ) on the right of each field will give you more information about the required setting.

Fields

Setting Value(s) Description
Enabled Yes This will enable OneClick
No
Title   Title of the saved card option
Sort Order   This is the position of OneClick during the checkout
Recurring Payment Type ONECLICK  With ONECLICK the shopper needs to fill in their security code for credit cards. For RECURRING, this is not needed. If you want to use RECURRING make sure you have Agreement Type (in Adyen Default Settings > Advance: Billing Agreements) set to RECURRING or ONECLICK,RECURRING
RECURRING

Set up Adyen SEPA

This section will describe the configuration of the Adyen SEPA payment method for the Adyen plugin in Magento.

Under the Payment Method configuration, you will find various sections related to the configuration of the Adyen plugin. 

  • Click Adyen SEPA this will open up the configuration for this payment method.
  • Fill out the fields. Hovering over the question mark ( (question) ) on the right of each field will give you more information about the required setting.

Fields

Setting
Value(s)
Description
Enabled Yes This will enable you to do SEPA payments
No
Title   Title of the payment method that shows on checkout
Sort Order   This is the position of the SEPA payment method during the checkout
Validate IBAN Yes This is a basic validation on the IBAN number
No
Flow Sales If you are not sure just use the default, this is Sale
Auth/Cap
Payment to applicable countries All Allowed Countries When set to Specific Countries, this will override the allowed countries for SEPA payments.
Specific Countries
Payment to Specific countries   Make sure that the settings in the Adyen CA match the selection here. You can set the override countries in the Adyen CA by going to Skins > [yourskincode] > Payment methods > pen icon > Override available countries.
Visibile in Backend and Frontend Where you want to show this payment method: in the backend of Magento and/or in the frontend for the shoppers
Backend Only
Frontend Only

Set up Adyen POS

This section will describe the configuration of the Adyen POS payment method settings for the Adyen plugin in Magento.

Under the Payment Method configuration, you will find various sections related to the configuration of the Adyen plugin. 

  • Click Adyen POS  this will open up the configuration for this payment method.
  • Fill out the fields. Hovering over the question mark ( (question) ) on the right of each field will give you more information about the required setting.

Fields

Setting Value(s) Description
Enabled Yes This will enable you to do POS payments on your IOS and/or android device
No
Title

Title of the payment method
Sort Order   This is the position of the POS method during the checkout
Recurring Type NONE You can set different value for POS because you have to have the permission of the customer
ONECLICK
RECURRING
ONECLICK, RECURRING
Add orderlines to receipt Yes If you have the Adyen App configured to print to an external printer the orderlines can be printed on to the receipt if you turn this option on.
No
Enable Scanner Yes If you enable this you have the possibility to scan products with a hand scanner on the shopping cart page and this will automatically add products to the shopping cart based on the same SKU name.
No
Auto submit scanner Yes If you have a scanner that puss a enter command after scanning turn this setting on.
No
Express checkout Yes This will show a checkout buttton on the shopping cart to directly do a POS payment without going to the checkout steps. You must be logged into your magento account on the front-end to see the button.
No
Redirect direct Yes Redirect directly to the Adyen app to do the PIN payment. This is not supported for all browsers if you have problems set this setting to false
No
Kiosk mode Yes If you turn kiosk modus on it will not autocomplete the customers based on the filled in email address
No
Show Recurring Cards Yes This will show the recurring cards beneath the express checkout and makes it possible to do a recurring online payment by clicking on the card
No
Create Shipment Yes If you enable this there will be automatically be created a shipment if the invoice is created
No
IP filter Yes Enable IP filter let's you define an IP range when this payment method is visable
No
IP From    
IP To    
Payment to applicable countries All Allowed Countries Make sure that the settings in the Adyen CA match the selection here. You can set the override countries in the Adyen CA by going to Skins > [yourskincode] > Payment methods >pen icon > Override available countries.
Specific Countries
Payment to Specific countries   Where you want to show this payment method: in the backend of Magento and/or in the frontend for the shoppers

Set up Adyen Boleto

This section will describe the configuration of the Adyen Boleto payment method for the Adyen plugin in Magento.

Under the Payment Method configuration, you will find various sections related to the configuration of the Adyen plugin. 

  • Click Adyen Boleto this will open up the configuration for this payment method.
  • Fill out the fields. Hovering over the question mark ( (question) ) on the right of each field will give you more information about the required setting.

Fields

Setting Value(s) Description
Enabled Yes This will enable you to do Boleto payments.
No
Title   Title of the payment method
Sort Order   This is the position of the Boleto payment method during the checkout
Days for Delivery   How many days to be added to the current date for delivery.
Boleto Types   The Boleto types you want to offer to the shopper.
Use taxvat for CPF or CNPJ Yes If you use taxvat for the CPF/CNPJ field you can then enable this option to auto fill in the Social Security Number
No
Order status underpaid -- Please select -- With Boleto it is possible to pay less than the full amount. Select here the status if this is the case. If you leave this empty it will take the Order status authorised payment as default status
Processing
Order status overpaid -- Please select -- With Boleto it is possible to pay more than the total amount. Select here the status if this is the case. If you leave this empty it will take the Order status authorised payment as default status
Processing
Payment to applicable countries All Allowed Countries Make sure that the settings in the Adyen CA match the selection here. You can set the override countries in the Adyen CA by going to Skins > [yourskincode] > Payment methods >pen icon > Override available countries.
Specific Countries
Visible in Backend and Frontend

Where you want to show this payment method: in the backend of Magento and/or in the frontend for the shoppers

Backend Only
Frontend Only

Set up Adyen Cash

This section will describe the configuration of the Adyen Cash payment method for the Adyen plugin in Magento.

Under the Payment Method configuration, you will find various sections related to the configuration of the Adyen plugin. 

  • Click Adyen Cash this will open up the configuration for this payment method.
  • Fill out the fields. Hovering over the question mark ( (question) ) on the right of each field will give you more information about the required setting.

Fields

Setting Value(s) Description
Enabled Yes This will enable you to do Cash payments
No
Title   Title of the payment method
Sort Order   This is the position of the Cash method during the checkout
Create Shipment Yes If you enable this there will automatically be created a shipment if the invoice is created
No
Cash Express checkout Yes This will show a checkout button on the shopping cart to directly do a Cash payment without going to the checkout steps. Make sure that you have Cash enabled on your skin and HPP payment method is enabled and correctly configured. You must be logged into your magento account on the front-end to see the button
No
Open Cash Drawer Yes Open the Cash drawer if you connect this to your printer this works for all Epson ePOS-Device printers
No
IP address printer   Enter the IP address of the printer to which the cash drawer is connected
Printer port   Enter the port number of the printer to which the cash drawer is connected
Printer Device ID   Enter the deviceID of the printer to which the cash drawer is connected
IP filter Yes This lets you define an IP range when this payment method is visible
No
IP From    
IP To    
Visible in Backend and Frontend Where you want to show this payment method: in the backend of Magento and/or in the frontend for the shoppers
Backend Only
Frontend Only
Payment from applicable countries All Allowed Countries Make sure that the settings in the Adyen CA match the selection here. You can set the override countries in the Adyen CA by going to Skins > [yourskincode] > Payment methods >pen icon > Override available countries.
Specific Countries
Payment from specific countries   Where you want to show this payment method: in the backend of Magento and/or in the frontend for the shoppers

Set up Adyen Pay By Mail

This section will describe the configuration of the Adyen Pay By Mail payment method for the Adyen plugin in Magento.
If you select this payment method the order will automatically created and in the order confirmation mail in the payment section the payment link will be visable.
With this payment link the shopper will be redirect to the Adyen HPP to do his payment. The order will be automatically updated when a payment is made trough the Adyen Notifications system. 

Under the Payment Method configuration, you will find various sections related to the configuration of the Adyen plugin. 

  • Click Adyen Pay By Mail this will open up the configuration for this payment method.
  • Fill out the fields. Hovering over the question mark ( (question) ) on the right of each field will give you more information about the required setting.

Fields

Setting
Value(s)
Description
Enabled Yes This will enable you to do Pay By Mail payments
No
Title   Title of the payment method
Sort Order   This is the position of the Pay By Mail payment method during the checkout
Session Validity   How many days do you want this payment page to be active
Skin Code   The skin code you want to use. Leave this empty if you want to use the same as Adyen HPP settings
HMAC Key for Test   Should match with the HMAC test key in the Adyen Customer Area. Fill this in if you are using a different skin then defined in Adyen HPP
HMAC Key for Live   Should match with the HMAC live key in the Adyen Customer Area. Fill this in if you are using a different skin then defined in Adyen HPP
Visible in Backend and Frontend Where you want to show this payment method: in the backend of Magento and/or in the frontend for the shoppers
Backend Only
Frontend Only

Set up Adyen ELV (deprecated)

This section will describe the configuration of the Adyen ELV payment method for the Adyen plugin in Magento.

This payment method is deprecated and you can better switch to Adyen SEPA. This separate payment method will be removed in the next release.  

Under the Payment Method configuration, you will find various sections related to the configuration of the Adyen plugin. 

  • Click Adyen ELV this will open up the configuration for this payment method.
  • Fill out the fields. Hovering over the question mark ( (question) ) on the right of each field will give you more information about the required setting.

Fields

Enabled Yes This will enable you to do Pay By Mail payments
No
Title   Title of the payment method
Sort Order   This is the position of the ELV payment method during the checkout
Payment from applicable countries All Allowed Countries Make sure that the settings in the Adyen CA match the selection here. You can set the override countries in the Adyen CA by going to Skins > [yourskincode] > Payment methods >pen icon > Override available countries.
Specific Countries
Visible in Backend and Frontend Where you want to show this payment method: in the backend of Magento and/or in the frontend for the shoppers
Backend Only
Frontend Only

Import stored cards in Magento

In the new version of the module (2.4.0 or higher) you can find the Recurring References in the Billing Agreements of Magento. 

If you already running the Adyen plugin with version 2.3.1 or lower, you need to import the already saved card data into your Magento store to make OneClick visible to your shoppers.

You need to enable the Adyen OneClick payment method.

To import the current saved cards into billing agreements of Magento you need to manually execute the script by following these steps:

  1. Open a terminal session.
  2. In the terminal, go to the Magento home directory.
  3. Go to the folder shell.
  4. Now execute the script by entering the following PHP command: 

    adyen.php -action loadBillingAgreements

 

All new saved cards will be automatically saved into billingAgreement of Magento.
Make sure you have turned on RECURRING_CONTRACT notification on your merchantAccount. If you want to add this or if you are not sure, just send us an email.

Issue a refund in Magento

You may need to issue a refund when a payment is cancelled, or when a shopper asks to be refunded.
Depending on the terms of sale, you can cancel a payment and return the partially or fully charged amount to the shopper.

How to issue a refund in Magento

After authorising a payment and after charging the shopper, if the shopper requests a refund and they are eligible for it, you may need to return the paid amount to them.
To issue an order refund in Magento, follow these steps:

  • In the Magento Admin Panel, go to Sales, and then select Orders.
  • In the order overview page, browse to the order you want to refund, then click it.
  • In the Order View left-hand navigation sidebar, click Invoices.
  • In the invoice overview page for the selected order, click the order invoice you need to create a refund for.
  • Click Credit Memo on the top-right corner of the page.
  • In the New Credit Memo for Invoice page, scroll down to the Refund Totals pane.
  • In this pane you can define and issue a regular Refund or a Refund Offline.
    • Refund: this option triggers the Adyen system to automatically execute a refund for the transaction.
    • Refund Offline: an offline refund does not trigger the Adyen system. You need to take action and carry out the refund manually, for example from the Adyen Customer Area (CA).

After a refund operation, the order status changes to Closed. This change is controlled by the Magento system, and we cannot influence it.
The status change does not mean that the refund was carried out successfully on our side.
If the Adyen status changes to REFUND:TRUE, then the refund went through successfully.

Once a refund is issued, it cannot be cancelled or undone.
Make sure the refund amount and any other details are correct before triggering the operation.

Refunds of payments that were done using Sofort, SEPA and OpenInvoice (Klarna & Afterpay) are only refundable after they have the status Settled in the Adyen Customer Area. When a payment is still SentForSettle it is not possible to refund the payment yet. You cannot find this status in Magento, only in the Adyen Customer Area.

Magento2 integration

Here we describe submitting payment transactions to the Adyen payment system using our plugin for Magento2.

Magento2 last update

Version

Date

Changes

1.0 2016-02-10

Initial version

Install the plugin

Composer

  1. Run the following composer commando in the root of magento: composer require adyen/module-payment
  2. In your Magento backend, go to System > Cache Management and click the Flush Cache Storage button.
    If you are already logged in to your Magento backend, log out, and then log in again.

Some hosting providers including Byte are running php in CGI modus. This means that HTTP Basic Authentication, used for the notifications, is not working on default. Enable the authorisation by adding the following rules to the .htaccess file in the Magento root directory.

RewriteEngine on:
RewriteCond %{HTTP:Authorization} (.+)
RewriteRule .* - [E=REMOTE_USER:%{HTTP:Authorization},L]

For further Magento-specific details, refer to the official Magento documentation.

Settings in the customer area

Before configuring the settings, make sure that the Adyen Customer Area (CA) set up is complete.  

  1. Go to ca-test.adyen.com and log in using your test account credentials.
  2. In the Main menu, click Account.
  3. Select the name of your merchant account.

Configure notifications

  1. Go to Settings Server Communication. 
  2. Click Add next to Standard Notification.
  3. In the Transport section:
    1. Enter your website URL followed by /adyen/process/json
      If you have turned off URL rewrite in Magento, you need to use index.php/adyen/process/json
    2. Select the Active checkbox.
    3. Set Method to JSON.
  4. Under the Authentication section, enter the username and password.
    Take a note of this information, as you will need it later on when configuring the Adyen plugin.
  5. Click Save Configuration.

Configure merchant account settings

  1. Go to Settings Merchant Settings. 
    The default value for Capture Delay is Immediate, you may adjust it according to your preferences.
  2. Click Submit.

Configure web service (ws) user

  1. Go to Settings Users.
  2. From the first dropdown in the upper left table cell, select System.
  3. Click the ws user (ws@Company.YourCompanyCode).
    If you have not yet set a password for your ws user yet, you can do it by clicking Generate. 
    Take a note of the password as you will need it later on when configuring the Adyen plugin.
  4. Click Save.

Configuring your LIVE account

  1. After your merchant account is enabled on the Adyen LIVE platform, using your live account credentials log in to ca-live.adyen.com.
  2. In the main menu, click Account.
  3. Select your merchant account. 
  4. Configure the notifications, merchant account settings, and ws user following the steps described above.


Configuring the Adyen plugin

Before tweaking your Adyen Payment settings in Magento, configure the default Magento cronjob:

  1. In the Magento Admin Panel, go to the Stores menu, and select Configuration.
  2. On the left-hand navigation sidebar In the Magento Admin Panel, browse to the Advanced category and click System.
  3. In the System area, click the Cron (Scheduled Tasks) section.
  4. Set the Generate Schedules Every input field to 1.
  5. Click Save Config.

This sets the cronjob generation time interval to 1 minute.

Adyen Payment Configurations

  1. Log in to your Magento backend to configure the Adyen plugin.
  2. Go to StoresConfiguration from the main menu.
    You are redirected to the general settings of Magento.
  3. Select Sales from the left menu and then select Payment Methods.
    You are redirected to the page with settings for the Adyen plugin.

The following sections describe how to configure the Adyen plugin in Magento, and how to set up the payment methods you want to support:

Required settings

In the Payment Method configuration, there are various sections related to the configuration of the Adyen plugin. 

  1. Click Adyen All-in-One Payment Solutions
  2. Click Required Settings.
  3. Enter the information in the fields. Hovering over the question mark ( (question) ) on the right of each field gives you more information about the required setting.

 

Fields

Setting Value(s) Description
 

The merchant account identifier you want to process the (transaction) request with. Find this at the top of the screen in the Adyen Customer Area (CA), where you will see [YourCompanyAccount] > [YourMerchantAccount] .

The merchant account is different from the company account; a company account can have one or more merchant accounts. You always have at least one company account with one corresponding merchant sub-account. For more information, see Account structure.

Test

In the test mode you must use test cards.
Live
  Set your own username and copy it over to Adyen Customer Area => Settings => Server Communication => Standard Notification => User Name.
  Set your own password and copy it over to Adyen Customer Area => Settings => Server Communication => Standard Notification => Password.
 

Find this in your Test Adyen Customer Area => Settings => Users => System, format: ws@Company.YourCompanyCode. Copy and Paste the exact ws username here.

When everything is correctly configured and you receive an authentication error when testing the notifications from the Adyen Customer Area (CA), follow the note at the bottom of this page.

  Find this in your Test Adyen Customer Area => Settings => Users => System. Click on your web service user and generate a new password. Copy and Paste the exact password here.
  Find this in your Live Adyen Customer Area => Settings => Users => System. Normally this will be ws@Company.YourCompanyCode. Copy and Paste the exact ws username here.
  Find this in your Live Adyen Customer Area => Settings => Users => System. Click on your web service user and generate a new password. Copy and Paste the exact password here.

Auto Capture

Set to Immediate by default. Set to manual if you want to perform the capture of funds manually later (only affects credit cards and a few alternative payment methods). Change this setting as well in Adyen Backoffice => Settings => Merchant Settings => Capture Delay. If you have selected a capture delay of a couple of days in Adyen of a couple of days keep it here on immediate
Manual Capture 
-- Please select -- Status given to newly created orders before payment result confirmation via server notifications from Adyen.
Pending
-- Please select -- Status given to orders after authorisation confirmed by an AUTHORISATION notification from Adyen. Note: an authorisation status via the result URL does not yet trigger this status.
Pending
Processing
-- Please select -- Status given to orders after capture result is confirmed by an AUTHORISATION notification for a auto capture or CAPTURE notification for a manual capture from Adyen.
Processing
On Hold Status given to orders after order cancellation is confirmed by an CANCEL_OR_REFUND notification from Adyen. If orders are already invoiced, they cannot be cancelled, but will be refunded instead.

Yes

 
No

Some hosting providers are running php in CGI modus. This means that HTTP Basic Authentication, used for the notifications, is not working on default. Enable the authorisation by adding the following rules to the .htaccess file in the Magento root directory.

RewriteEngine on:
RewriteCond %{HTTP:Authorization} (.+)
RewriteRule .* - [E=REMOTE_USER:%{HTTP:Authorization},L]

Also, some hosting providers are blocking Bots, which may block our notifications from being sent correctly.

If you are using Byte as your hosting provider you can see more information about that and how to allow bots on their website.

Advanced settings

In the Payment Method configuration, there are various sections related to the configuration of the Adyen plugin. 

  1. Click Adyen All-in-One Payment Solutions. There are various sections related to advanced settings.
  2. Hovering over the question mark ( (question) ) on the right of each setting field gives you more information about the required setting.

These settings allow you to set up and configure the following features:

Billing agreement

In the Payment Method configuration, there are various sections related to the configuration of the Adyen plugin. 

  1. Click Adyen Default Settings.
  2. Click Advanced: Billing Agreements.
  3. Enter the information in the fields. Hovering over the question mark ( (question) ) on the right of each field gives you more information about the required setting.

Fields

Setting Value(s) Description
Agreement Type  NONE

When enabled, users can save their credit cards and their SEPA authorisations. ONECLICK requires the input of the CVC for subsequent payments, while RECURRING does not.

ONECLICK: The shopper opts in to storing their card details for future use. The shopper is present for the subsequent transaction, for cards the security code (CVC/CVV) is required.

RECURRING: Payment details are stored for future use. For cards, the security code (CVC/CVV) is not required for subsequent payments.

ONECLICK, RECURRING: Payment details are stored for future use. This allows the use of the stored payment details regardless of whether the shopper is on your site or not.

ONECLICK
RECURRING
ONECLICK,RECURRING
Magento order process

In the Payment Method configuration, there are various sections related to the configuration of the Adyen plugin. 

  1. Click Adyen Default Settings. 
  2. Click Advanced: Magento Order Processing.
  3. Enter the information in the fields. Hovering over the question mark ( (question) ) on the right of each field gives you more information about the required setting

Fields

Setting Value(s) Description
Use manual-capture for PayPal Yes 

This option is set to No by default.

If you have requested with support for your Paypal integration to be on manual-capture, set this to Yes.

No
Use auto-capture for OpenInvoice payments Yes

Applicable for Klarna and Afterpay only.

OpenInvoice is set to Manual capture by defailt.

If you want auto capture, contact magento@adyen.com.

No
Order status: payment capture (virtual products) -- Please select -- Select only status assigned to state complete. Leave empty to use the same as normal products.
Completed
Order status: Adyen Refunded -- Please select -- Status given to order after a (partial) refund has been made on the order. This is triggered when the REFUND notification is received.
Closed
Order status: pending Bank Transfer/SEPA orders -- Please select -- By default, Adyen does not inform your Magento store about pending payments. If you want these notifications to be received,  Go to Adyen Customer Area (CA) => Server Communication and add BankTransfer Pending Notification and Direct-Debit Pending Notification.
Pending Payment
Send order confirmation email for Bank Transfer/SEPA Yes Send a confirmation mail after Bank Tranfer/SEPA is placed (not yet paid). If you want these notifications to be received,  Go to Adyen Customer Area (CA) => Server Communication and add BankTransfer Pending Notification and Direct-Debit Pending Notification.
No
Payment notifications

In the Payment Method configuration, there are various sections related to the configuration of the Adyen plugin. 

  1. Click Adyen Default Settings. 
  2. Click Advanced: Adyen Payment Notifications.
  3. Enter the information in the fields. Hovering over the question mark ( (question) ) on the right of each field gives you more information about the required setting.

Fields

Setting Value(s) Description
Ignore refund notification

Yes

If the refund is processed on the Adyen platform, a refund notification is sent to Magento, that automatically creates a credit memo.

Enabling this setting does not process the received REFUND notification.

No
Allow multiple merchants

Yes

Allow notifications sent from other Adyen merchant accounts.  

Ensure that the notification user name and password should be the same for all the merchant accounts.

No

Set up HPP payment methods

You can use our Magento integration to handle payments through our HPP solution.

Before you configure the payment methods you want tot use, you need to take care of a few preliminary steps to ensure the process runs smoothly. 

Set things up

If you want to handle your payments through our Hosted Payment Pages (HPP), you need to use the Adyen HPP option in the plugin.
This gives you access to the wide range of available payment methods that we support and can be set up for your merchant account.
For this to work, set up a skin in the Adyen Customer Area (CA).

Define the skin in the Adyen CA

  1. Go to Adyen Customer Area (CA) and log in with your test account credentials.
  2. In the main menu click Skins.
  3. If no skin was configured yet, do so by clicking the button Create a new skin.
  4. Click HMAC with SHA-256 and new signing algorithm (Recommended).
  5. Enter a description for your skin, e.g. Magento Skin.
    Take a note of the Skin Code, as you need it later on when configuring the plugin.
  6. Click on generate new HMAC key for the Test and Live platform.
    Take a note of these HMAC keys, as you need it later on when configuring the plugin
  7. Leave the Result URLs and Continue-to URLs empty

Configure HPP in the Adyen plugin

  1. Open the Adyen HPP panel in the Magento backend (under Stores > Configuration > Sales > Payment Methods > Hosted Payment Page (HPP) integration).

  2. Use the information which you previously noted when preparing the skin in the Adyen Customer Area (CA) to enter the information in the fields.

Setting Value(s) Description
Enabled Yes If you want to enable the HPP payment methods, Set this option to Yes.
No
Sort Order   This is the position of the HPP payment methods during the checkout.
Skin Code   Copy and paste the skin code of the skin you want to use from Test Customer Area => Skins.
HMAC Key for Test Skin   Copy and paste the skin code of the skin you want to use from Test Customer Area => Skins => click on [skin code] => Edit => HMAC for Test platform.
HMAC Key for Live   Copy and paste the skin code of the skin you want to use from Test Customer Area => Skins => click on [skin code] => Edit => HMAC for Live platform.

Advanced settings

Setting Value(s) Description
Title   If Leave payment method selection on HPP is set to Yes, this title shows on the checkout.
Days for Delivery  

Days to be added to the current date for delivery.

Allowed format: Numerical.

Payment method selection on Adyen Hosted Payment Page (HPP) Yes If this is set to Yes, payment methods are not displayed at the checkout and the shopper is redirected to the Adyen HPP to make the selection.
No

Setting up API credit card payments

The advantage of using this method (over card payments through the HPP) is that shoppers do not leave your website, but instead can do the card payment directly in your checkout. For this to work you should have Client Side Encryption (CSE) enabled for your merchant account. On the TEST environment the role is enabled by default. 

If you are considering implementing CSE and want this to be enabled on your LIVE platform, download and fill in the PCI Self Assessment Questionnaire (SAQ) A, then email it to the Adyen Support Team.

  • Make sure that you have received confirmation from the Adyen Support Team that CSE is enabled for your account
  • Open the Credit Card panel in the Magento backend (under Stores > Configuration > Sales > Payment Methods > CreditCard API integration)
  • Configure the settings. Hovering over the question mark ( (question) ) on the right of each field will give you more information about the required setting.

Fields

Setting Value(s) Description
Enabled Yes If you want to enable payment by credit cards through our API, set this option to Yes.
No
Title   Title displayed for the payment method.
Sort Order   This is the position of the credit cards during the checkout.
Credit Card Types   Select the credit card type(s) that you want to show.
Enter CSE Public Key of Test Adyen Webservice User   Copy this from the Test Adyen Customer Area > Settings > Users > System (from the dropdown) > [web service user] > Client Encryption Public Key.
Enter CSE Public Key of Live Adyen Webservice User   Copy this from the Live Adyen Customer Area > Settings > Users > System (from the dropdown) > [web service user] > Client Encryption Public Key.
Payment to applicable countries All Allowed Countries When set to Specific Countries, this will override the allowed countries for credit card payments.
Specific Countries
Payment to Specific countries   Make sure that the settings in the Adyen Customer Area (CA) match the selection here. You can set the override countries in the CA by navigating to Skins > [yourskincode] > Payment methods >pen icon > Override available countries.

Setting up OneClick

During checkout shoppers can choose to have their payment details remembered and stored for trusted websites in Adyen’s highly secure platform. Adyen takes care of this process for its customers. Shoppers can then select the saved card and checkout with one-click in the Magento checkout.

Make sure you have turned on RECURRING_CONTRACT notification on your merchantAccount. Alternatively, contact Adyen Support Team

In the Payment Method configuration, there are various sections related to the configuration of the Adyen plugin. 

  1. Click configure under the OneClick - Requires Adyen Credit Card title.
  2. Enter the information in the fields. Hovering over the question mark ( (question) ) on the right of each field will give you more information about the required setting.

Fields

Setting Value(s) Description
Enabled Yes This enables OneClick.
No
Title   Title of the saved card option.
Sort Order   This is the position of OneClick during the checkout.
Recurring Payment Type ONECLICK  With ONECLICK the shopper needs to fill in their security code for credit cards. For RECURRING, this is not needed. If you want to use RECURRING make sure you have Agreement Type (in Adyen Default Settings > Advance: Billing Agreements) set to RECURRING or ONECLICK,RECURRING.
RECURRING

Issuing a refund in Magento

You may need to issue a refund when a payment is cancelled, or when a shopper asks to be refunded.
Depending on the terms of sale, you can cancel a payment and return the partially or fully charged amount to the shopper.

How to issue a refund in Magento

After authorising a payment and after charging the shopper, if the shopper requests a refund and they are eligible for it, you may need to return the paid amount to them.
To issue an order refund in Magento, follow these steps:

  • In the Magento Admin Panel, go to Sales, and select Orders.
  • In the order overview page, browse to the order you want to refund, then click it.
  • In the Order View left-hand navigation sidebar, click Invoices.
  • In the invoice overview page for the selected order, click the order invoice you need to create a refund for.
  • Click Credit Memo on the top-right corner of the page.
  • In the New Credit Memo for Invoice page, scroll down to the Refund Totals pane.
  • In this pane you can define and issue a regular Refund or a Refund Offline.
    • Refund: This option triggers the Adyen system to automatically execute a refund for the transaction.
    • Refund Offline: An offline refund does not trigger the Adyen system. You need to take action and carry out the refund manually, for example from the Adyen Customer Area (CA).

After a refund operation, the order status changes to Closed. This change is controlled by the Magento system, and we cannot influence it.
The status change does not mean that the refund was carried out successfully on our side.
If the Adyen status changes to REFUND:TRUE, then the refund went through successfully.

After a refund is issued, it cannot be cancelled or undone. Make sure the refund amount and any other details are correct before triggering the operation.

Refunds of payments that were done using Sofort, SEPA and OpenInvoice (Klarna & Afterpay) are only refundable after they are Settled in the Adyen Customer Area. When a payment is still SentForSettle, it is not possible to refund the payment yet.

You can view the status only in the Adyen Customer Area (CA)

 

 

Magento Subscriptions

Here we describe how to configure Adyen subscriptions in the in the Adyen Subscriptions section of your Magento content management system.

Magento subscription last update

Version

Date

Changes

1.0 2015-09-04

Initial version

Magento Subscriptions Requirements

This module is tested against Magento Community version 1.9 or later and Magento Enterprise version 1.14 or later.

For the subscription module to function appropriately:

  • Enable Recurring Role on Adyen platform for the active web service user.
    To enable send an email to magento@adyen.com
  • Enable the RECURRING_CONTRACT notification.
    To enable send an email to magento@adyen.com
  • Install and configure Adyen Payment module for Magento.
    Magento versions less than 2.4.0 are not compatible. 
  • Go to Adyen Default SettingsAdvanced: Billing Agreements > Agreement Type.

  • Set the Agreement type to ONECLICK,RECURRING or RECURRING.
  • Enable Adyen CreditCard in the Magento configuration.
  • Enable Adyen OneClick in the Magento configuration.

Install the subscription module

Magento CE installation

Download the Adyen Subscription Module from our GitHub repository or from Magento Connect.

GitHub download

  • Download the latest version of the Adyen Subscription Module from GitHub.
  • Extract the contents from the downloaded ZIP file to a local folder.
  • Upload the extracted files to the root folder of your Magento installation via FTP.
  • Verify the folder and file permissions of the uploaded files.
  • Log in to Magento with your credentials.
  • In the Magento Admin Panel, go to System > Cache Management, and then click the Flush Cache Storage button on the top right corner of the page.
  • If you are already logged in to your Magento backend, log out, and then log in again.

Magento Connect download

Waiting for approval from Magento

Magento EE

  • Install the module like you would do for a standard CE installation.
  • Copy the app/etc/modules/Adyen_Subscription_Enterprise.xml_disabled file to app/etc/modules/Adyen_Subscription_Enterprise.xml.

Make product available for subscription

To enable purchasing a product with subscription, follow these steps:

  • Log in to Magento with your credentials.
  • In the Magento Admin Panel, go to Catalog > Manage Products.
  • On the Manage Products page, select the product you want to make subscription available for.
  • In the Product Information left hand navigation sidebar, select Adyen Subscription.
  • In the Adyen Subscription pane, a drop-down menu offers three options:

    Option Description
    Adyen Subscription Disabled The selected product is not available for purchase with a  subscription.
    Adyen Subscription Enabled
    + Standalone purchase possible
    The selected product is available for purchase either with a subscription or as a standalone item.
    Adyen Subscription Enabled
    + Subscription option selection required
    The selected product is available for purchase only with a subscription.
  • After selecting an option from the drop-down menu, you can add a new subscription by clicking Add New Adyen Subscription:

    Now you can populate the fields to define the newly created subscription:

    Value Description
    Label The name of the subscription for the product.
    Website Set this option if the subscription should be displayed and enabled for a specific web site.
    Otherwise, leave the default selection All Websites as is.
    Customer Group Set this option if you want to restrict the subscription to a specific customer group.
    Otherwise, leave the default selection All Customer Groups as is.
    Billing Period Time interval between consecutive billing periods.
    Billing Period Unit Time period included in each billing:
    Day, Week, Month, or Year.
    Qty in Subscription The number of products included in the subscription, and that will be deducted from the stock once they are purchased.
    Price The price of the subscription.
    Show on Frontend Set this to Yes if you want to offer the subscription to the shopper on the frontend.

Subscription overview

Admin subscriptions

You can view the subscription overview if you go to Sales => Adyen Subscriptions.

In this overview you see all subscriptions that are created. If you click on the order you get to the detail page of the subscription.

Status: Order can have the following statuses:

  • Active
    Subscription is successful created and active
  • Canceled
    The user has cancelled the subscription. Go into the history tab to find out who has triggered this. 
  • Paused
    The user has paused the subscription. Go into the history tab to find out who has triggered this. 
  • Subscription Error
    When you are updating a subscription and it could not be updated. Check the logs for the exception
  • Quote Creation Error
    Something went wrong with creating the Quote for this subscription. This can have multiple reasons for example product is not available or deleted.
  • Order Creation Error
    Quote is successful created but could not convert this to an order. This could happen if for example the product is deleted after the quote is generated.
  • Payment Error
    The recurring payment failed.  An Error Message field will be shown with the exact reason why it is failed.

A subscription is connected to a Billing Agreement. The billing Agreement is the reference that can be used to do a new recurring payment.

In the top of the screen you have the following buttons:

  • Delete 
    This will delete the whole subscription. You can not view it back and will be deleted from the database as well. 
  • Pause Subscription
    You pause the subscription. If you have the setting "Pause/Resume Subscription" turned on the shopper has the option to enable it.
  • Cancel Subscription 
    You cancel the subscription. If you have filled in reason codes in the configurations you have to select a reason as well. Only the admin can put it back to active.
  • Schedule Order
    This button will only be visible if there is not yet a scheduled order created. It will create a schedule order
  •  Edit Subscription
    You have the option to edit the subscription. Add/Remove products and change schedule date.
  • Activate Subscription
    If the subscription is paused or cancelled you will see this button. Then it put it back to active next schedule date will be set to today.

Schedule Order

In the schedule order overview you see the upcoming order. It could be that this tab is not showing. This will be generated 2 weeks before the next order should be executed.  You can manually add this by pressing the "Schedule Order" button on the top of the screen. You have the option to Edit Scheduled Order to make a change to this specific schedule order, it will not effect the subscription.

Past Orders:

Here you see the orders that are created for this subscription.

History:

Every change to the subscription will be saved into the history tab. Here you can see if the admin,customer or cronjob did the change. The status and code (if applicable) will be saved and visible.

Shopper subscriptions

The shopper can view his subscription overview if it goes to Account => My Subscriptions.

In this overview you see all subscriptions that are created.  If you click on the order you get to the detail page of the subscription.

If the setting "Cancel Subscription" is enabled, you see on the top right the button Cancel to cancel his subscription if the status of the subscription is active.

If the setting "Pause/Resume Subscription" is enabled, you see on the top right the button Pause if the status of the subscription is active.

If the status of the subscription is paused, the resume button will be visible if the setting "Pause/Resume Subscription" is enabled.

If you have the setting "Show upcoming orders" turned on, you will see the upcoming orders in a list view.


Configurations

Before you start

Before tweaking your Adyen subscription settings in Magento, you need to configure the default Magento cronjob.

Configure the default Magento cronjob

To configure the default Magento cronjob, do the following:

  • In the Magento Admin Panel, go to the System menu, and select Configuration.
  • On the left-hand navigation sidebar In the Magento Admin Panel, browse to the Advanced category, then click System.
  • In the System area, click the Cron (Scheduled Tasks) section.
  • Set the Generate Schedules Every input field to 1.
  • Click Save Config.

This sets the cronjob generation time interval to 1 minute.

Adyen subscriptions

You can access the configuration area to adjust the default settings depending on your needs:

  • Log in to Magento with your credentials.
  • In the Magento Admin Panel, go to the System menu, and select Configuration.
  • On the left-hand navigation sidebar, browse to the Sales category, then click Adyen Subscriptions.

The Adyen Subscriptions area makes the following sections available:

  • General
  • Subscription
  • Order

This is where you can change and edit all the settings related to the Magento integration with the Adyen payment system.

Adyen subscription configurations

In the Adyen Subscriptions area you can edit settings and options to customize the integration depending on your needs.
These are some typical action you can carry out in this area to adjust the configuration to satisfy your requirements:

Require a cancel reason before cancelling a subscription

Before cancelling a subscription, you may want to obtain some additional information providing more context for the cancellation.
To do so, you can define a number of cancellation reasons that fit your business scenario and use cases.

  • In the Adyen Subscriptions area, go to the Subscription section.
  • The Cancel Reasons settings allow you to:
    • Add Reason: add a new cancel reason for a subscription cancellation.
    • Delete: remove an existing cancel reason for a subscription cancellation.
  • Add Reason: when you create a new cancel reason, specify the following values:
    • Code: the cancel reason code.
    • Label: a reference label with a short description of the cancel reason code.

The cancel reason code is saved with the subscription it belongs to.
It is displayed in the
subscription history overview, and the label value is displayed to the user when they cancel a subscription.

Configure the allowed payment methods for subscriptions

By default, only credit cards are allowed.
To enable more payment methods, do the following:

  • In the Adyen Subscriptions area, go to the Subscription section.
  • Allowed payment methods offers a list with the available payment methods.
    The list is limited because not all payment methods support recurring payments.

iDeal and Sofort recurring transactions are processed as SEPA Direct Debit payments in the background.

Allow shoppers to cancel subscriptions

You can allow shoppers to cancel subscriptions.
To enable this feature, do the following:

  • In the Adyen Subscriptions area, go to the Subscription section.
  • Cancel Subscription  offers a drop-down menu: select Yes to allow cancelling subscriptions.

Allow shoppers to pause and resume subscriptions

You can allow shoppers to pause and resume subscriptions.
To enable this feature, do the following:

  • In the Adyen Subscriptions area, go to the Subscription section.
  • Pause/Resume Subscription  offers a drop-down menu: select Yes to allow pausing and resuming subscriptions.

Allow shoppers to see their upcoming orders

You can allow shoppers to see dates referring to their upcoming orders.
To enable this feature, do the following: 

  • In the Adyen Subscriptions area, go to the Subscription section.
  • Show upcoming orders offers a drop-down menu: select Yes to allow showing upcoming orders .
    By default, this option is disabled.
  • Number of upcoming orders: sets the maximum number of orders displayed.
    The default setting is 5 . You can change this value.

Allow shoppers to reorder subscriptions

You can allow shoppers to include an existing subscription into a new subscription as a reorder.
To enable this feature, do the following:

  • In the Adyen Subscriptions area, go to the Order section.
  • Subscription at reorder  offers a drop-down menu: select Yes to allow including the product subscriptions in a reorder.
    The default setting for this option is No.

Enable retrying failed payments

By default, when a payment request fails, the subscription returns a  a payment error.
You can change this behaviour by enabling the retry feature for failed payments.
To enable this feature, do the following: 

  • In the Adyen Subscriptions area, go to the Subscription section.
  • Retry failed payment offers a drop-down menu: select Yes to allow enable the failed payment retry feature .
  • Number of retries for payment failure: sets the maximum number of retries for a failed payment
    If you leave this field empty, the system keeps retrying as long as a payment failure is received.
    The default setting is 3 retries. You can change this value.
  • Time (in hours) between retries payment failure : sets the time interval between a payment error response and the corresponding payment retry.
    This time check depends on the cronjob.
    The default setting is 24 hours between a payment failure and a payment retry. You can change this value.

Schedule the cronjobs

Default  Subscription
cronjob expression
*/5 * * * *
The  cronjob is executed every 5 minutes.
Default  Quote
cronjob expression
*/20 * * * *
The  cronjob is executed every 20 minutes.
Default Order
cronjob expression
*/30 * * * *
The  cronjob is executed every 30 minutes.

Adyen subscriptions

You can access the configuration area to adjust the default settings depending on your needs:

  • Log in to Magento with your credentials.
  • In the Magento Admin Panel, go to the System menu, and select Configuration.
  • On the left-hand navigation sidebar, browse to the Sales category, then click Adyen Subscriptions.

The Adyen Subscriptions area makes the following sections available:

  • General
  • Subscription
  • Order

This is where you can change and edit all the settings related to the Magento integration with the Adyen payment system.

Adyen subscription configurations

Overview

In the Adyen Subscriptions area you can edit settings and options to customize the integration depending on your needs.
These are some typical action you can carry out in this area to adjust the configuration to satisfy your requirements:

Require a cancel reason before cancelling a subscription

Before cancelling a subscription, you may want to obtain some additional information providing more context for the cancellation.
To do so, you can define a number of cancellation reasons that fit your business scenario and use cases.

  • In the Adyen Subscriptions area, go to the Subscription section.
  • The Cancel Reasons settings allow you to:
    • Add Reason: add a new cancel reason for a subscription cancellation.
    • Delete: remove an existing cancel reason for a subscription cancellation.
  • Add Reason: when you create a new cancel reason, specify the following values:
    • Code: the cancel reason code.
    • Label: a reference label with a short description of the cancel reason code.

The cancel reason code is saved with the subscription it belongs to.
It is displayed in the subscription history overview, and the label value is displayed to the user when they cancel a subscription.


Configure the allowed payment methods for subscriptions

By default, only credit cards are allowed.
To enable more payment methods, do the following:

  • In the Adyen Subscriptions area, go to the Subscription section.
  • Allowed payment methods offers a list with the available payment methods.
    The list is limited because not all payment methods support recurring payments.


iDEAL and Sofort recurring transactions are processed as SEPA Direct Debit payments in the background.


Allow shoppers to cancel subscriptions

You can allow shoppers to cancel subscriptions.

To enable this feature, do the following:

 In the Adyen Subscriptions area, go to the Subscription section.

  • Cancel Subscription offers a drop-down menu: select Yes to allow cancelling subscriptions.


Allow shoppers to pause and resume subscriptions

You can allow shoppers to pause and resume subscriptions.
To enable this feature, do the following:

In the Adyen Subscriptions area, go to the Subscription section.

  • Pause/Resume Subscription offers a drop-down menu: select Yes to allow pausing and resuming subscriptions.


Allow shoppers to see their upcoming orders

You can allow shoppers to see dates referring to their upcoming orders.

To enable this feature, do the following: 

  • In the Adyen Subscriptions area, go to the Subscription section.
  • Show upcoming orders offers a drop-down menu: select Yes to allow showing upcoming orders.
    By default, this option is disabled.
  • Number of upcoming orders: sets the maximum number of orders displayed.
    The default setting is 5 . You can change this value.

 

Allow shoppers to reorder subscriptions

You can allow shoppers to include an existing subscription into a new subscription as a reorder.

To enable this feature, do the following:

  • In the Adyen Subscriptions area, go to the Order section.
  • Subscription at reorder offers a drop-down menu: select Yes to allow including the product subscriptions in a reorder.
    The default setting for this option is No.


Enable retrying failed payments

By default, when a payment request fails, the subscription returns a  a payment error.

You can change this behaviour by enabling the retry feature for failed payments.
To enable this feature, do the following: 

 In the Adyen Subscriptions area, go to the Subscription section.

  • Retry failed payment offers a drop-down menu: select Yes to allow enable the failed payment retry feature.
  • Number of retries for payment failure: sets the maximum number of retries for a failed payment
    If you leave this field empty, the system keeps retrying as long as a payment failure is received.
    The default setting is 3 retries. You can change this value.
  • Time (in hours) between retries payment failure: sets the time interval between a payment error response and the corresponding payment retry.
    This time check depends on the cronjob.
    The default setting is 24 hours between a payment failure and a payment retry. You can change this value.


Schedule the cronjobs

Three cronjobs affect the behaviour of the Adyen subscription integration with Magento.

Default  Subscription
cronjob expression
*/5 * * * *
The  cronjob is executed every 5 minutes.
Default  Quote
cronjob expression
*/20 * * * *
The  cronjob is executed every 20 minutes.
Default Order
cronjob expression
*/30 * * * *
The  cronjob is executed every 30 minutes.

Cronjobs

Make sure you have the cronjobs enabled in Magento. A handy tool to see if your cronjob is running is AOE Scheduler  

The module comes with three cronjobs that need to run. We will explain them here.

Subscription Cronjob

 If a order has a subscription product and the following requirements are true:

  •  invoice is created (pending, captured or offline)
  • Status is processing
  • Has Billing Agreement**

It will create a subscription profile based on the order that is created. This subscription profile is viewable in Sales => Adyen Subscriptions section

It will create an subscription out of the created order. You can see this subscription in the Sales => Adyen Subscriptions section

** Make sure you have Recurring_Contract notification turned on. Please contact magento@adyen.com to enable this for you

Quote Cronjob

A quote for a subscription will be created as the follow requirements are true: 

  • Scheduled Order is in the upcoming 2 weeks
  • Subscription status is active or quote_error

It will create a Quote. This gives you the option to change the quote before it is created to an order. You can see this as an open shopping cart.

Order Cronjob

A quote will be converted to a order when the following requirements are true: 

  • The Scheduled Order date is in the past
  • Subscription status is in active, order_error or payment_error**
  • Has an active quote that is not yet converted to a order

** payment_error is by default it will not retry on a payment_error you can overrule this in subscription configuration