Introduction
This User Guide will explain everything you need to know, before starting with our Adyen WooCommerce plugin version 1.5.1 or higher.
Download, install & activate the plugin
You can download the plugin from the plugin settings
Go to the WordPress dashboard
Go to plugins –> add new
Search for: Integration for Adyen with WooCommerce
Click Install Now
Click Activate
Questions and Support
Submit a Support Ticket and our Support Specialists will help you out with any questions regarding our plugin.
Plan a free 30-minute demo call with one of our team members and walkthrough our plugin and your questions together.
About Adyen
What is Adyen?
Adyen is a Payment Service Provider (PSP). This means they provide different kind of payment methods for your online store.
One of the biggest benefits of Adyen is that they offer a wide-range of local payment methods in different countries. It is safe to say that they are one of the biggest payment providers, with regards to local presence.
The Adyen WooCommerce plugin of Woosa, is the official plugin supported by Adyen itself.
Before you start: create an Adyen test-account
To be able to start with the Adyen WooCommerce plugin, you will first need to sign up for a test account at Adyen. You can sign up for free via adyen.com/signup.
Even though you will get immediate access to your test account, it does not guarantee that you will be able to process live payments. In case you would like to start the process to process live payments, we advise you to contact the Sales team of Adyen and apply for a live account.
Before applying for a live account, we suggest you first check the list of prohibited or restricted products and services.
Authorization & License
Adyen API authorization
Authorize test account
To authorize your Adyen test account, you will need to following information:
Merchant account name
API key
To find those credentials in your Adyen account, please follow the steps below.
Click on your company name left above and select the account that says Merchant behind it
Click again on your company name left above and you will see the merchant account name above MerchantAccount
Next go to the menu-item Developers > API credentials in the Adyen test account
Click Create new credential right above and select Web service user
Click Create credential
Click below Authentication on the tab API key and generate and copy the API key
Go to WooCommerce > Settings > Adyen > Authorization
Set the Test mode dropdown on Yes
Fill in the Merchant account name of your Adyen test account and the API key you have just copied
Click the button Click to authorize
The status should change to Authorized in green
Authorize live account
To authorize your Adyen test account, you will need to following information:
Merchant account name
API key
URL-prefix
To find those credentials in your Adyen account, please follow the steps below.
Click on your company name left above and select the account that says Merchant behind it
Click again on your company name left above and you will see the merchant account name above MerchantAccount
Next go to the menu-item Developers > API credentials in the Adyen test account
Click Create new credential right above and select Web service user
Click Create credential
Click below Authentication on the tab API key and generate and copy the API key
Last but not least, go to Developers > API URLs and copy the prefix only
For example the URL in your Adyen dashboard is: https://1797a841fbb37ca7-AdyenDemo-checkout-live.adyenpayments.com/checkout/v53/payments, you should only copy 1797a841fbb37ca7-AdyenDemo. Read here where to find the URL-prefix.
Go to WooCommerce > Settings > Adyen > Authorization
Set the Test mode dropdown on No
Fill in the Merchant account name of your Adyen test account and the API key you have just copied
Click the button Click to authorize
The status should change to Authorized
Does the authorization fails? Please check our list of errors for the Adyen WooCommerce plugin.
General settings
Capture mode
Some online payment methods require a separate capture. This means the payment will be completed in 2 steps:
Authorisation: The payment details of the customer are verified with the issuer, and the funds are reserved.
Capture: The reserved funds are transferred from the customer to your account.
You can choose to either capture manually or automatically. This can be configured in the Capture Mode dropdown. We advise you to always capture payments automatically, unless the products you’re selling require a manual check before the order is finalized.
The Capture Mode setting in the plugin, is not synchronized with the same setting in your Adyen merchant account. Log in to your Adyen merchant account > Go to Settings > Account Settings > and configure the Capture Delay exactly the same as the Capture Mode in the plugin.
Capture Klarna payments automatically
Accept Klarna payments to be automatically captured. This is the same setting as Capture Mode, however in this setting you should contact the Adyen support team. In this way they can enable capturing Klarna payments automatically for you.
Reference prefix
Normally the Adyen WooCommerce plugin will copy the WooCommerce order number as the Merchant reference in the Adyen payment. However, you can choose wether or not to add a prefix to this Merchant reference.
Remove Customer’s Data
Because of the GDPR laws and regulations, you should be able to remove the data of your Customer. By checking this box, this option will be added to the my order account page of your WooCommerce store.
This allows your customers to remove their personal data (GDPR) attached to an order payment. This only deletes the customer-related data for the specific payment, but does not cancel the existing recurring transaction.
Include Server Port
In some cases a different server port is configured, which causes a fail in generating the Origin domain & key. With this functionality we force the plugin to use the default port, required from Adyen.
Debug mode
When you enable the checkbox for Debug Mode, all data our plugins add will be visible in Custom Fields. For example: when an Adyen payment number is present, it will show the name and value of that particular field.
Custom Fields can be adjusted, deleted or added. In this way developers have the ability to debug issues.
Remove configuration
When you activate a WordPress plugin it will add information to your database. The database stores this information, until you remove it yourself. Also when you disable and even delete a plugin, the database tables will still exist. This has a benefit and a downside at the same time.
If you keep the database tables stored, the plugin will remember the data once you re-install it. However, it can also take up unnecessary space in your database table. Basically, it is up to you what your expectation for the future is!
Are you in doubt what to do here? Discuss it with your developer or web agency.
Webhooks
Standard notification
Webhooks are necessary to receive realtime statuses from payments. For example, when somebody pays an order with credit card there will be a slight delay if the order is actually approved and captured. Webhooks make sure this information will be synchronised with the particular order in WooCommerce.
Therefore it is mandatory to configure these webhooks. Follow the steps below to enable the standard notification webhooks.
Log in to your Customer Area to configure notifications
Go to Developers > Webhooks
In the upper-right corner, select the + Webhook button
Next to Standard Notification, click Add
Under Server Configuration, enter your server’s:
URL –
https://adyen.woosashop.nl/wp-json/woosa-adyen/payment-statusMethod – HTTP
Encryption protocol – TLSv12
In the Security > Basic authentication section, enter a username and password that will be used to authenticate Adyen notifications in your webshop.
Click Save Changes
Boleto Bancario pending
Boleto Bancario is the leading Brazilian payment method. In order for Boleto Bancario the properly work, a webhook should be configured.
Log in to your Customer Area to configure notifications
Go to Developers > Webhooks
In the upper-right corner, select the + Webhook button
Next to Boleto Bancario Pending, click Add
Under Server configuration, enter your server’s:
URL –
https://adyen.woosashop.nl/wp-json/woosa-adyen/boleto-payment-statusMethod – HTTP
Encryption protocol – TLSv12
In the Security > Basic authenticaion section, enter a username and password that will be used to authenticate Adyen notifications in your webshop.
Click Save Changes
Fill in username and password
Go to WooCommerce > Settings > Adyen > Webhooks > Scroll down to username and password. Fill in the username and password created for the Standard Notification and Boleto Bancario pending.
Payment methods
You will be able to enable, disable and edit payment methods in your WooCommerce checkout by going to WooCommerce > Settings > tab Payments. The Adyen payment methods can be recognised, because of the “Adyen” in front of the title. Click on the Manage button behind the payment method or on the payment method its title to apply edits.
iDEAL
Enable/Disable: Select the checkbox if you want to enable this payment method
Title: Change the title which will be visible in the WooCommerce checkout
Description: Change the description which will be visible in the WooCommerce checkout
Icon URL: Upload your own iDEAL payment icon which will be visible in the WooCommerce checkout
SEPA Direct Debit
Enable/Disable: Select the checkbox if you want to enable this payment method
Title: Change the title which will be visible in the WooCommerce checkout
Description: Change the description which will be visible in the WooCommerce checkout
Icon URL: Upload your own SEPA Direct Debit payment icon which will be visible in the WooCommerce checkout
Credit card
Enable/Disable: select the checkbox if you want to enable this payment method
Title: change the title which will be visible in the WooCommerce checkout
Description: change the description which will be visible in the WooCommerce checkout
Icon URL: upload your own SEPA Direct Debit payment icon which will be visible in the WooCommerce checkout
Allow installments: installments are term payments (e.g. an order of €100 will be paid in 5 installments of €20 each). Installments are only available in Brazil, Mexico and Turkey.
Installments number: the amount of terms with a maximum of 20.
Giropay
Enable/Disable: Select the checkbox if you want to enable this payment method
Title: Change the title which will be visible in the WooCommerce checkout
Description: Change the description which will be visible in the WooCommerce checkout
Icon URL: Upload your own Giropay payment icon which will be visible in the WooCommerce checkout
SOFORT
Enable/Disable: Select the checkbox if you want to enable this payment method
Title: Change the title which will be visible in the WooCommerce checkout
Description: Change the description which will be visible in the WooCommerce checkout
Icon URL: Upload your own SOFORT payment icon which will be visible in the WooCommerce checkout
Bancontact
Enable/Disable: Select the checkbox if you want to enable this payment method
Title: Change the title which will be visible in the WooCommerce checkout
Description: Change the description which will be visible in the WooCommerce checkout
Icon URL: Upload your own Bancontact payment icon which will be visible in the WooCommerce checkout
Boleto
Before you enable Boleto Bancario as a payment method, make sure the webhook for Boleto Bancario is configured.
Enable/Disable: Select the checkbox if you want to enable this payment method
Title: Change the title which will be visible in the WooCommerce checkout
Description: Change the description which will be visible in the WooCommerce checkout
Icon URL: Upload your own Boleto payment icon which will be visible in the WooCommerce checkout
Alipay
Enable/Disable: Select the checkbox if you want to enable this payment method
Title: Change the title which will be visible in the WooCommerce checkout
Description: Change the description which will be visible in the WooCommerce checkout
Icon URL: Upload your own Alipay payment icon which will be visible in the WooCommerce checkout
WeChat Pay
Enable/Disable: Select the checkbox if you want to enable this payment method
Title: Change the title which will be visible in the WooCommerce checkout
Description: Change the description which will be visible in the WooCommerce checkout
Icon URL: Upload your own WeChat Pay payment icon which will be visible in the WooCommerce checkout
Google Pay
Enable/Disable: Select the checkbox if you want to enable this payment method
Title: Change the title which will be visible in the WooCommerce checkout
Description: Change the description which will be visible in the WooCommerce checkout
Icon URL: Upload your own Bancontact payment icon which will be visible in the WooCommerce checkout
Test mode: enable or disable the test mode
Merchant identifier: this is your Google Merchant ID
Klarna – Pay later / Klarna – Pay now / Klarna – Pay over time
Enable/Disable: Select the checkbox if you want to enable this payment method
Title: Change the title which will be visible in the WooCommerce checkout
Description: Change the description which will be visible in the WooCommerce checkout
Icon URL: Upload your own Klarna payment icons which will be visible in the WooCommerce checkout
PayPal
Before you can accept payments with PayPal, you will need to configure the API permissions in your PayPal account.
Under Third Party Permission Username, depending on your account type, enter:
Live: Enter
paypal_api2.adyen.comTest: Enter
sell1_1287491142_biz_api1.adyen.com
In the Available Permissions list, select the following boxes:
Use Express Checkout to process payments.
Issue a refund for a specific transaction.
Process your shopper’s credit or debit card payments.
Authorize and capture your PayPal transactions.
Obtain information about a single transaction.
Obtain authorization for pre-approved payments and initiate pre-approved transactions.
Generate consolidated reports for all accounts. (if available in your region)
Use Express Checkout to process mobile payments. (if you plan on supporting mobile payments)
Charge an existing customer based on a prior transaction.
Create and manage Recurring Payments.
Obtain your PayPal account balance.
Initiate transactions to multiple recipients in a single batch.
Click Add.
Once this is done you can follow the steps below, to enable PayPal in your WooCommerce checkout.
Enable/Disable: Select the checkbox if you want to enable this payment method
Title: Change the title which will be visible in the WooCommerce checkout
Description: Change the description which will be visible in the WooCommerce checkout
Icon URL: Upload your own PayPal payment icon which will be visible in the WooCommerce checkout
Apple Pay
Before you can accept payments with Apple Pay, you will need to configure the Apple Pay certificate.
Download and unzip the Apple Pay certificate by clicking the link via WooCommerce > Settings > Payments > Apple Pay.
Host the certificate file with the name apple-developer-merchantid-domain-association on each domain you want to use, including subdomains, under the following path:
/.well-known/apple-developer-merchantid-domain-association. The file must:Be externally accessible.
Not be password protected.
The file cannot be behind a proxy or redirect.
See an example of a working certificate file.
Add Apple Pay in your live customer area of Adyen, where you will be asked for:
Shop website: your main website URL, for example
https://www.mystore.com.Additional shop websites: Add any other domains you use for your shop website, for example
https://www.mystore1.com, orhttps://www.mystore1.com. You must register all top-level domains and subdomains.
Once this is done you can follow the steps below, to enable PayPal in your WooCommerce checkout.
Enable/Disable: Select the checkbox if you want to enable this payment method
Title: Change the title which will be visible in the WooCommerce checkout
Description: Change the description which will be visible in the WooCommerce checkout
Icon URL: Upload your own PayPal payment icon which will be visible in the WooCommerce checkout
Dotpay & BLIK
Enable/Disable: Select the checkbox if you want to enable this payment method
Title: Change the title which will be visible in the WooCommerce checkout
Description: Change the description which will be visible in the WooCommerce checkout
Icon URL: Upload your own Dotpay & BLIK payment icons which will be visible in the WooCommerce checkout
Bancontact mobile
Enable/Disable: Select the checkbox if you want to enable this payment method
Title: Change the title which will be visible in the WooCommerce checkout
Description: Change the description which will be visible in the WooCommerce checkout
Icon URL: Upload your own Dotpay & BLIK payment icons which will be visible in the WooCommerce checkout
Vipps
Enable/Disable: Select the checkbox if you want to enable this payment method
Title: Change the title which will be visible in the WooCommerce checkout
Description: Change the description which will be visible in the WooCommerce checkout
Icon URL: Upload your own Dotpay & BLIK payment icons which will be visible in the WooCommerce checkout
Swish
Enable/Disable: Select the checkbox if you want to enable this payment method
Title: Change the title which will be visible in the WooCommerce checkout
Description: Change the description which will be visible in the WooCommerce checkout
Icon URL: Upload your own Dotpay & BLIK payment icons which will be visible in the WooCommerce checkout
GrabPay
Enable/Disable: Select the checkbox if you want to enable this payment method
Title: Change the title which will be visible in the WooCommerce checkout
Description: Change the description which will be visible in the WooCommerce checkout
Icon URL: Upload your own Dotpay & BLIK payment icons which will be visible in the WooCommerce checkout
MobilePay
Enable/Disable: Select the checkbox if you want to enable this payment method
Title: Change the title which will be visible in the WooCommerce checkout
Description: Change the description which will be visible in the WooCommerce checkout
Icon URL: Upload your own Dotpay & BLIK payment icons which will be visible in the WooCommerce checkout
MolPay
Enable/Disable: Select the checkbox if you want to enable this payment method
Title: Change the title which will be visible in the WooCommerce checkout
Description: Change the description which will be visible in the WooCommerce checkout
Icon URL: Upload your own Dotpay & BLIK payment icons which will be visible in the WooCommerce checkout
Added support for using HMAC signature for Webhooks
Countries & Currencies
Payment method | Countries | WooCommerce Subscriptions |
iDEAL | NL (EUR) | As a first payment method (will switch automatically to SEPA Direct Debit) |
Bancontact | BE (EUR) | As a first payment method (will switch automatically to SEPA Direct Debit) |
SOFORT | AT (EUR), BE (EUR), DE (EUR), IT (EUR), ES (EUR), CH (CHF), NL (EUR), GB (GBP) | As a first payment method (will switch automatically to SEPA Direct Debit) |
Giropay | DE (EUR) | As a first payment method (will switch automatically to SEPA Direct Debit) |
Credit card | All countries & currencies | As a first and recurring payment method |
SEPA Direct Debit | NL (EUR), BE (EUR), DE (EUR) | As a recurring payment method |
Boleto | BR (BRL) | No |
Alipay | CN (AUD, CAD, CHF, CNY, CZK, DKK, EUR, GBP, HKD, JPY, MYR, NOK, NZD, RUB, SEK, SGD, THB, USD) | No |
WeChat Pay | CN (AUD, CAD, CHF, CNY, DKK, EUR, GBP, HKD, JPY, NOK, NZD, SEK, SGD, THB, USD) | No |
Google Pay | All countries & currencies | As a first and recurring payment method |
Klarna – Pay Later | AT (EUR), BE (EUR), DK (DKK), FI (EUR), DE (EUR), NO (NOK), SE (SEK), CH (CHF), NL (EUR), GB (GBP) | No |
Klarna – Pay Later | AT (EUR), DK (DKK), FI (EUR), DE (EUR), NO (NOK), SE (SEK), CH (CHF), NL (EUR) | As a first and recurring payment method |
Klarna – Pay Now | AT (EUR), DE (EUR), SE (SEK), CH (CHF), NL (EUR) | No |
Klarna – Pay Now | DE (EUR), SE (SEK), NL (EUR) | As a first and recurring payment method |
PayPal | All countries & currencies | No |
Apple Pay | All countries & currencies | No |
Dotpay | PL (PLN) | No |
BLIK | PL (PLN) | No |
Developers
Errors
During each process it is possible that you will get errors. Luckily for every error there is a solution. Check our list of errors to solve them yourself, without the support of our specialists.
Tools
At this moment we only support the clear cache functionality for our plugin users.
Logs
All error logs related to the Adyen WooCommerce plugin, can be find via WooCommerce > Status > Logs > woosa-adyen-xxx.
Can’t figure it out? You can always send a message to the support team via the chat bubble at the bottom right 🎈 Support to the rescue 👨💻 👩💻