Adyen Payment Gateway: Configuration

The Adyen Add-on allows you to accept online payments processed through the Adyen platform directly in the Chauffeur Taxi Booking System booking form. Configuration consists of two main steps:

1. Generating required credentials in your Adyen Dashboard.
2. Entering these values and basic settings in the booking form configuration.

Generating Credentials in Adyen

To configure Adyen, you need to generate/copy three values:

• API Key
• HMAC Key (for webhooks verification)
• Merchant account (Account code)

1) Log in to Adyen

1. Go to https://ca-live.adyen.com/.
2. Select the environment at the top: ‘Live’ or ‘Test’.
3. Enter your username, then select the account and enter your password.

If you don’t have an Adyen account yet, follow the onboarding steps here: https://docs.adyen.com/get-started-with-adyen.

2) Generate API Key

To generate the API Key, follow these steps:

1. In the left menu, go to ‘Developers’ -> ‘API credentials’.
2. Click ‘Create new credential’.
3. In the popup, keep the default option ‘Web service user’ and click ‘Create credential’.
4. On the credential details screen, open ‘Server settings’ -> ‘Authentication’ -> ‘API key’.
5. Click ‘Generate API key’ and copy the generated key.
6. Click ‘Save changes’ to store and enable the newly generated API key.

3) Generate HMAC Key (Webhook)

To generate the HMAC key for webhook verification, follow these steps:

1. In the left menu, go to ‘Developers’ -> ‘Webhooks’.
2. Click ‘Create new webhook’.
3. In the popup, select ‘Standard webhook’ and click ‘Add’.
4. In the webhook configuration screen, first open the ‘Server configuration’ section and set the following:
   • URL – enter the URL of the page where the Chauffeur Taxi Booking System plugin is installed. In most cases, this will be your website domain or the exact page URL with the booking form. Example: if the plugin is installed on https://yourdomain.com/test/chauffeur-booking-system/, use this URL.
   • Method – leave the default value (usually JSON).
   • Encryption protocol – leave the default value (e.g. TLSv1.3).
5. Next, open the ‘Security’ section.
6. In the ‘Authentication method’, select ‘No authentication’.
7. In the ‘HMAC’ section, choose ‘Generate a new key’ and click ‘Generate’.
8. Copy the generated HMAC key and save the webhook configuration.

4) Copy Merchant account (Account code)

To find your Merchant account (Account code), follow these steps:

1. In the left menu, go to ‘Settings’ -> ‘Account’ -> ‘Merchant accounts’.
2. Copy the Account code (your Merchant account value).

Configuring Adyen in the Booking Form

Once the add-on is installed and activated, you can configure Adyen for each booking form individually.

1. In your WordPress dashboard, go to ‘Chauffeur Booking System’ -> ‘Booking Forms’.
2. Edit the booking form where you want to enable Adyen payments.
3. Open the ‘Payments’ tab of the form editor.
4. Go to the sub-tab ‘Payments’ and then click the ‘Adyen’ payment method tab.

On the ‘Adyen’ tab you will find the following options:

Test Mode

Enable this option if you want to process test transactions using Adyen Test environment credentials. Disable it when switching to Live.

API Key

Paste here your Adyen API key generated in the Adyen Dashboard (‘Developers’ -> ‘API credentials’ -> ‘Server settings’ -> ‘API key’). This key authorizes the Chauffeur Taxi Booking System to communicate with the Adyen API.

HMAC Key

Paste here your Adyen HMAC key generated in the Adyen Dashboard (‘Developers’ -> ‘Webhooks’ -> ‘Create new webhook’ -> ‘Standard webhook’ -> ‘Security’ -> ‘HMAC’). This key is used to verify webhook notifications from Adyen.

Merchant Account

Enter your Adyen Merchant account (Account code) copied from the Adyen Dashboard (‘Settings’ -> ‘Account’ -> ‘Merchant accounts’).

Return URL

Enter the full URL (including https://) of the page where customers should be redirected after they are sent back from Adyen. We recommend using a dedicated “Thank you” or “Order summary” page.

Redirection Delay

Set the delay (in seconds) before the customer is redirected from the booking form to the Adyen payment gateway.

Logo

Optionally, you can upload a custom logo that will be displayed on step #3 of the booking form when the customer selects the Adyen payment method.

Information for Customer

Use this field to display additional information to the customer before they are redirected to the Adyen gateway (step #5 of the booking process).

Enabling Adyen as a Payment Method

After entering the Adyen settings, you still need to enable this gateway as one of the payment options in the booking form:

1. While still editing the booking form, go to ‘Payments’ -> ‘General’.
2. In the ‘Payment’ option, select ‘Adyen’ as one of the available payment methods for this form.
3. Optionally, set ‘Adyen’ as the ‘Default Payment’ if you want it to be preselected for customers.
4. Click ‘Update’ or ‘Publish’ to save your changes.

Debugging and Log Manager

After installing the add-on, a new settings section will appear in your WordPress dashboard under ‘Settings’ -> ‘Chauffeur Booking System: Adyen’. This section includes a Log Manager tool that allows you to verify the correctness of your configuration and review any errors or warnings related to the payment process.