Adyen is a global payment platform that lets you accept credit card payments directly through Checkfront. This article walks you through the complete setup process, from configuring your Adyen account to going live, so you can start taking bookings and processing refunds with confidence.
Learn more about Adyen, including:
- Checking on the Service Status
- Setting up your Adyen account
- Creating your web service user and Client Key (new)
- Creating your web service user and Origin Key (deprecated)
- Configuring API Response settings
- Turning on Apple Pay and Google Pay in Adyen
- Turning on refunds in Adyen
- Going live in Adyen
- Setting up Adyen in Checkfront
- Turning on MOTO for Staff payments
-
Requiring email addresses
Accessing the features mentioned in this article
Where can I find this feature using the top menu?
- Manage > Ecommerce Setup > Payment
What more do I need to use this feature?
- Admin permissions are required to manage Payment Providers.
- Online account and merchant account with Adyen.
About Adyen
Adyen is a technology company that provides businesses with a single solution for accepting payments anywhere in the world - online, in-app, and at the point of sale with in-depth data insights.
Checkfront has added Adyen to the growing list of Payment Providers we are integrated with!
If you would like to use Adyen as your Payment Provider, please request that Checkfront Support enable this feature for your account via Technical Support.
|
PSD2 and SCA compliant This integration is Payment Services Directive 2 (PSD2) compliant, including Strong Customer Authentication (SCA). Checkfront is prepared to handle any transactions that the Payment Provider deems applicable. These measures help reduce fraud and make online payments more secure! Learn more about PSD2 and SCA here: |
Checking on the Service Status
|
Check the status of Adyen's services at any time here: |
Setting up your Adyen account
First, you need an Adyen online account with an associated merchant account! Learn more about setting up a merchant account here: Set up for Adyen accounts.
Creating your web service user and Client Key (new)
Client Key is Adyen's recommended replacement for Origin Key: a single key covers your entire environment, and you can add or remove allowed domains later without regenerating it.
You need a web service user's API Key and a Client Key, both generated from the same credentials in your Adyen Customer Area. Adyen's own guides cover the full steps, since this happens entirely on Adyen's side:
- Create API credentials: Creating a web service user and generating your API Key
- Client-side authentication: Generating a Client Key from the Client key tab on that credential, and adding your allowed domain(s) under "Add allowed origins"
Unlike Origin Key, you don't need to get the domain format exactly right up front. You can add, remove, or fix allowed origins later without regenerating the key.
Creating your web service user and Origin Key (deprecated)
|
Origin Key is deprecated by Adyen New integrations should use a Client Key instead. The Origin Key is available only for the legacy checkout and applies only if a Client Key isn't available to you yet. |
You need a web service user's API Key and Origin Key from Adyen to complete the setup in Checkfront. Create these in your Adyen Customer Area. Adyen's own guides cover the full steps, since this happens entirely on Adyen's side:
Create API credentials: Creating a web service user and generating your API Key
Client-side authentication: Generating an Origin Key from the "Origin key (legacy)" tab
One detail specific to Checkfront that's worth knowing before you generate the Origin Key: enter your website domain as https://companyname.checkfront.com, without www.. If the domain is entered incorrectly, you won't see an error until you test your payment page in Checkfront, so double-check it before you generate the key.
Configuring API Response settings
In your Adyen Customer Area, enable the following additional data fields so Checkfront receives the information it needs. See Adyen's guide on additional settings for webhooks for where to find and enable each one:
- Authorized Amount Value (Payment amount processed)
- Card Summary (Last 4 digits of the card number)
- Recurring Details (allows for rebilling)
- Variant (Payment Method)
Turning on Apple Pay and Google Pay in Adyen
Do you want to accept Apple Pay or Google Pay? These need to be requested and approved in your Adyen Customer Area first. Checkfront can't turn them on for you.
See Adyen's guide, How do I add a payment method?, and repeat the same request in both your Test and Live Customer Area.
|
Requires Client Key Apple Pay and Google Pay don't work with an Origin Key. Both your Adyen account and your Checkfront setup need to be configured with a Client Key first. |
|
Learn more about offering additional payment methods Apple Pay and Google Pay are additional payment methods supported by our Adyen integration. |
Turning on refunds in Adyen
You need to tell Adyen where to send that response, or refunds will stay pending in Checkfront.
In your Adyen Customer Area, add a Standard Notification webhook (Developers > Webhooks). See Adyen's guide on configuring and managing webhooks for the full steps. Set the Transport URL to:
https://youraccountname.checkfront.com/notify/Adyen/
Replace youraccountname with your Checkfront account name, and make sure the webhook is marked Active. You don't need a username or password. Leave everything else at its default, then save.
Going live in Adyen
There's one final step in Adyen before you go live: find your live URL prefix and paste it into your Adyen modal in Checkfront. In your live Customer Area, go to Account > API URLs — see Adyen's guide on live endpoints for where to find the prefix. You don't need this step if you're staying in sandbox (test) mode.
Setting up Adyen in Checkfront
To enable Adyen, log in to your Checkfront account and navigate to Manage > Ecommerce Setup, ensuring the Payment tab is selected.
Here you see a list of available payment modules. Locate the Adyen tile from the list.
You find it by clicking the links in the left-side menu labeled "Available to [your country]" or "All". You can also search for the Adyen tile directly in the provided search box.
Click the listing to open the Add-on Setup modal.
An Add-on Setup modal displays. You can enter the required information in the fields provided. Let's look at this information and where to locate it in Adyen.
Enter your Merchant Account code here. This can be found within your Adyen account (Account > Merchant Account > Account Code).
Entering your API Key
Enter the API Key you were issued when you created your Adyen web service user, in the steps under:
- Creating your web service user and Client Key (new accounts)
- Creating your web service user and Origin Key (legacy accounts)
Entering your Client Key (new)
Enter the Client Key you generated for your Adyen web service user, in the steps above under Creating your web service user and Client Key.
Entering your Origin Key (deprecated)
Enter the Origin Key you were issued when you created your Adyen web service user, in the steps above under Creating your web service user and Origin Key.
|
Origin Key is deprecated by Adyen. Origin Key is deprecated by Adyen. New integrations should use a Client Key instead. This field exists only for the legacy checkout and applies only if a Client Key isn't available to you yet. |
Enabling test mode (sandbox)
Select the Sandbox checkbox to enable Test Mode for testing transactions before going live with Adyen.
Enabling refunds in Checkfront
To process refunds through Checkfront and Adyen, select Enable Refunds within the Add-on Setup modal. See Turning on refunds in Adyen above for instructions on configuring refund notifications.
Entering your Live URL Prefix
Submit the Live URL prefix provided by Adyen during the go-live process, which can be found in the API URLs section of your account (see Going live in Adyen above).
For example
- Live URL: https://1797a841fbb37ca7-AdyenDemo-checkout-live.adyenpayments.com/checkout/v32/payments
- Live URL prefix: 1797a841fbb37ca7-AdyenDemo
Turning on MOTO for Staff payments
This option allows Staff to process mail and telephone orders without encountering a 3D Secure (3DS) challenge.
You can turn on MOTO (Mail Orders Telephone Orders) for your account by selecting the Enable MOTO for Staff payments section.
- If the setting is NOT selected, a Customer payment triggers a 3DS challenge, and a Staff payment warns Staff that 3DS is required (as shown below).
- If the setting is selected, a Customer payment triggers a 3DS challenge, whereas a Staff payment does not.
With the setting selected, you can rebill from the Staff-side payment form without issue.
Requiring email addresses
To continue processing payments for cardholders (for example, taking a deposit and then accepting final payment later), you need to require an email address in your booking forms. A payment token is associated with the email address to facilitate future payments.
|
Learn more about booking form fields Learn more about ensuring your form contains the required email address here: |