Version 8 of the plugin will be deprecated in January 2025. This means that there will be no security updates and you will no longer receive support from Adyen. We recommend to migrate the latest major version.
You need to add payment methods to your Customer Area before you can add them to your Adobe Commerce admin panel.
When you have added the payment methods to your Customer Area, make sure to enable Alternative payment methods in the Adobe Commerce admin panel in order to render local payment methods in your checkout.
For a list of all payment methods supported by the plugin, refer to Supported payment methods.
Some payment methods require extra steps to enable. To find the section for setting up payment methods in Adobe Commerce:
- Log in to your Adobe Commerce admin panel.
- In the left navigation bar, go to Stores > Configuration.
- In the menu, go to Sales > Payment Methods.
- Select Configure payment methods.
Alternative payment methods
This needs to be enabled in order to render payment methods in your checkout.
| Field | Description |
|---|---|
| Enabled | Select Yes. |
| Sort Order | The position of this payment method during checkout. |
| Store alternative payment methods | Select Yes to securely store the SEPA payment details of shoppers. |
| Tokenized Payment Methods | Select the alternative payment methods you want to securely store the payment details of the shoppers. |
| Token Type | Select CardOnFile, UnscheduledCardOnFile or Subscription, depending on how the token will be used. For more information, see our FAQ. |
Klarna\Ratepay\Afterpay Settings
Enter the unique RatePAY ID provided by your Ratepay integration consultant.
Advanced settings
| Setting | Description |
|---|---|
|
Title |
The title that indicates the alternative payment methods during the checkout. |
|
Language locale |
The language shown to the shopper during checkout. By default, this is the language of your shop in Adobe Commerce. |
|
ISO Country Code |
Determine the payment methods shown to the shopper during checkout. By default, this depends on the billing address of the shopper, however you can override it here. |
Card payments
To set up credit card payments, select Card Payments and fill out the following fields:
| Field | Description |
|---|---|
|
Enabled |
Select Yes to enable this payment method. |
|
Title |
The title that indicates this payment method during checkout. |
|
Sort Order |
The position of this payment method during checkout. |
|
Click To Pay Enabled |
Select Yes to offer Click To Pay payments to your shoppers. |
From plugin version 7.3.1 and later, shoppers that use a co-badged credit card can choose with which credit card type they want to complete their payment. For this functionality to work, both types have to be enabled in Credit Card Types.
Installments Setup
Credit card installments are optionally available in some countries/regions. To learn more about their availability, see Credit card installments.
| Field | Description |
|---|---|
|
Enable Installments |
Select Yes to enable installments for each credit card type. |
Apple Pay
The steps for adding Apple Pay depend on which version of the plugin you are using:
Testing
Use Apple's test card numbers to test your integration.
For a full list of test cards and instructions how to add these to your test device, see Sandbox testing on Apple's Developer website.
Check the status of an Apple Pay test payment in your Customer Area > Transactions > Payments.
Boleto
To set up Boleto, select Boleto integration, and fill out the following fields:
| Field | Description |
|---|---|
|
Enabled |
Select Yes to enable this payment method. |
|
Title |
The title that indicates this payment method during checkout. |
|
Sort Order |
The position of this payment method during checkout. |
|
Days for Delivery |
The number of days to be added to the current date to set the delivery date. |
Gift cards
If you want to accept gift card payments, contact our Support Team.
Once our team confirms that gift card payments have been set up for you account, you can start to accept gift cards in your checkout.
Google Pay
The steps for adding Google Pay depend on which version of the plugin you are using:
MOTO
To use MOTO, you need a MOTO merchant account. Follow these steps to request a merchant account.
After you create a MOTO merchant account, you can configure the MOTO payment method in your plugin.
- Go to Stores > Configuration > Sales > Payment methods > Adyen Payments.
- Go to the Configure payment methods section.
- Select the MOTO accordion.
- Set Enabled to Yes.
- Add a line.
- Fill in the MOTO merchant account as explained here. You can only process MOTO payments through your MOTO merchant account.
- Enter the Client Key and the API key related to your MOTO merchant account.
- Select the TEST or LIVE environment.
- Save your configuration.
We recommend that you clean your cache.
To test MOTO:
- In your Adobe Commerce admin panel, go to Sales > Orders.
- Select Create New Order > Create New Customer or select an existing customer.
- Select a store, then select Add Products > Adyen MOTO.
PayPal
To connect your PayPal account to your integration, you have to grant third party permissions to Adyen in your PayPal Business account.
To do this:
- Set up third party API access on your PayPal account.
- Get your PayPal Merchant ID.
- Set up the PayPal payment method.
Pay by Link
Pay by Link lets you create an order and send an Adyen payment link directly to the shopper in the order confirmation email. This option is available for orders created from the Adobe Commerce admin panel.
Pay by Link is available from plugin v7.3.0 and later. In earlier versions, use Pay by Mail.
The orders created with Pay by Link are not finished until the shopper clicks the generated link and proceeds with the payment. If the shopper doesn't complete the payment, unfinished orders will be automatically closed by the plugin's cron.
Watch how to configure Pay by Link:
Set up Pay by Link
To create payment links, make sure you have the Pay by Link user permissions set up in your Adyen Customer Area. You can also customize the Pay by Link theme from your Adyen Customer Area.
To set up Pay by Link in the Adobe Commerce plugin, select Adyen Pay by Link and fill out the following fields:
| Field | Description |
|---|---|
| Enabled | Select Yes to enable this payment method. |
| Title | The title that indicates this payment method during checkout. |
| Default days to expire payment links | How many days this payment link should be active. You can override this value when creating the payment link. |
| Sort Order | The position of this payment method during checkout. |
Create a payment link
After you have set up Pay by Link, you can start creating payment links for admin orders.
- In your Adobe Commerce Admin panel, go to Sales > Orders > Create New Order > Create New Customer (or select an existing customer).
- Select a store, and then Add Products.
- Select Adyen Pay By Link as the payment method.
- You can optionally enter a custom expiration date for this payment link.
Pay by Mail
Create an order and send an Adyen payment link directly to the shopper.
Pay by Mail is replaced with Pay by Link in v7.3.0 or later.
Set up the Pay by Mail redirect page
To set up the page that your shopper is redirected to after they click the payment link, you need to create a skin in your Adyen Customer Area. Before you go live, you also need to publish the skin to live.
Set up and enable Pay by Mail
To set up Pay by Mail, select Pay by Mail integration and fill out the following fields:
| Field | Description |
|---|---|
|
Enabled |
Select Yes to enable this payment method. |
|
Title |
The title that indicates this payment method during checkout. |
|
Sort Order |
The position of this payment method during checkout. |
|
Session Validity |
How many days do you want this payment page to be active. |
|
Skin Code |
Code of the skin you want to use. |
|
HMAC Key for Test |
The HMAC key for the test platform linked to the skin. |
|
HMAC Key for Live |
The HMAC key for the live platform linked to the skin. |
Use Pay by Mail
After you have set up Pay by Mail and the redirect page, you can start to use Pay by Mail.
- In your Adobe Commerce admin panel, go to Sales > Orders > Create New Order > Create New Customer (or select an existing) > Select a store > Add Products > Select Pay By Mail.
In-person payments
You can also offer terminal payments for your customers for the endless aisle experience. An employee can place an order from the admin panel and send the payment to the selected terminal.
To set up in-person payments, follow this checklist. To configure in-person payments in your Adobe Commerce 2 store, refer to Set up point of sale.
Donations
With our Giving feature, you can give shoppers the option to donate to a charity after they have placed an order. Make sure that the charity is onboarded at Adyen before you configure this feature.
To configure donations using Giving:
- In your Adobe Commerce Admin panel, go to Sales > Payment Methods.
- In the menu, go to Configure payment methods > Adyen Giving. Fill out the following fields:
| Field | Description |
|---|---|
| Enabled | Select Yes to enable Giving. |
| Charity name | Name of the charity displayed on the Adyen Giving component. |
| Charity merchant account | Adyen merchant account name for the charity. For testing, use MyCharity_Giving_TEST. For accepting live donations, change this to the account name that we give you after choosing your charity. |
| Suggested donation amounts | Suggested amounts that the shopper can donate using the order currency, separated by commas. The minimum amount is the equivalence of EUR 1 in your selected currency. |
| Charity description | Description of the charity. |
| Charity website | Link to the charity website. |
| Background image | Background image of the Adyen Giving component. |
| Charity logo | Logo displayed on the Adyen Giving component. |
Watch how to configure Adyen Giving:
Test and go live with Giving
Test
You must have the Merchant admin user role.
- In your test Customer Area, go to Settings > Account Settings.
- Under Giving, select the Online donations toggle to enable it.
- In your Adobe Commerce admin panel, use the test account MyCharity_Giving_TEST for Charity merchant account.
- Make test donations using our test cards.
When testing Visa payments, use the test card which has the security code as optional.
- Verify the outcome of your test donations in a Giving report or dashboard:
In your Customer Area, go to Reports > Giving Overview, which shows the successful donations the next day.
If an issue occurs with your test donation requests, you can find more details in the API logs.
Go live
- Contact your Adyen Account Manager or our Support Team and ask them to set up your live account for Giving, connecting it to the right nonprofit account.
- (Only if you have a manual integration) In your live Customer Area, enable the Adyen Giving merchant webhook.
- In your Adobe Commerce admin panel, use the account name that we give you after choosing your nonprofit for Charity merchant account.
- Verify the outcome of live donations by either:
- Finding the donation in a Giving report or dashboard.
- Getting the DONATION webhook for the donation.