Configuration

Make Adyen Payment for OXID operational.

Basic procedure

Configure and test Adyen Payment for OXID in sandbox mode, then switch on live mode.

Procedure

  1. Activate the module and test Adyen Payment for OXID in sandbox mode: Testing Adyen Payment for OXID in sandbox mode.

  2. Optional: Set up delayed or manual money capture if needed (for business customers, for example): Configuring capture delay for selected payment methods.

  3. Under Language configuration make sure that messages from Adyen are displayed in the correct language: Setting up the language configuration.

  4. Link the payment methods provided by Adyen to your shipping types and shipping rules and run test payments in the Adyen sandbox.

  5. Test Adyen in the Adyen sandbox and adjust the configuration until all payment processes work the way you want.

  6. When you have completed your tests, configure live operation: Activating Adyen Payment for OXID in live mode and configuring payment methods.

Testing Adyen Payment for OXID in sandbox mode

Test Adyen Payment for OXID in sandbox mode.

Procedure overview

  1. Create access data in the Adyen Customer Area.

    To do this, generate the following data that you will need during configuration:

    • API key

    • Client key

    • Optional: HMAC code (key hash message authentication code).

    For more information about the HMAC code, see https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures#enable-hmac-signatures.

  2. Enter the credentials in Adyen Payment for OXID.

  3. Configure the desired payment methods.

  4. To verify the connection with Adyen, perform test payments.

Creating and entering access data

Generate credentials in the Adyen Customer Area, create a webhook URL for Adyen Payment for OXID, and register the webhook URL again in the Adyen Customer Area.

Prerequisites

  • You have Adyen Payment for OXID installed (see Installation).

  • You have https.

  • If you want to offer PayPal, you have

    • a PayPal Private Sandbox account for test payments

    • a PayPal Business Sandbox account for activities in the PayPal backend.

  • If you want to offer Google Pay, for test payments you have

    • a Google account

    • a credit card

    When you make payments with your credit card in sandbox mode, your credit card will not be charged. Google will replace your credit card number with a sample credit card number.

    For more information, see the Adyen documentation under Development resources –> Integration –> Testing –> Test card numbers –> Google Pay.

Procedure

  1. Choose Extensions ‣ Modules ‣ Adyen Payment for OXID, and do the following:

    1. Activate the module.

    2. Choose Settings ‣ Adyen Access Sandbox.

  2. Under https://www.adyen.com/signup, create an Adyen test account.

    For more information, see https://docs.adyen.com/get-started-with-adyen#test-account.

  3. Under https://ca-test.adyen.com/ca/ca/overview/default.shtml, log in to the Adyen Customer Area.

  4. Under your test account (Fig.: Choosing a merchant account, item 1), choose a merchant account (with the suffix ECOM, Fig.: Choosing a merchant account, item 2).

    Background: Adyen distinguishes the Point of Sales (POS) account, which manages multiple merchant accounts, from the individual merchant (ECOM) accounts. By default, after logging in, you are in the POS account.

    Choosing a merchant account

    Fig.: Choosing a merchant account

  5. Choose Developers ‣ API credentials.

  6. Choose the ws web service user (Fig.: Choosing the web service user, item 1).

    Choosing the web service user

    Fig.: Choosing the web service user

  7. Under Server Settings (Fig.: Generating the API key, item 1), generate an API key and paste it into the API Key field (Fig.: Entering Adyen access data, item 1).

    Generating the API key

    Fig.: Generating the API key

  8. Under Client Settings ‣ Client key, generate a client key (Fig.: Generating the client key, item 1) and insert it into the Client Key field (Fig.: Entering Adyen access data, item 2).

    Generating the client key

    Fig.: Generating the client key

  9. Under Client Settings ‣ Add allowed origins, enter the root URL of your OXID eShop test store, choose the Add button (Fig.: Generating the client key, item 2), and save your entries (Fig.: Generating the client key, item 3).

  10. Under Permissions ‣ Roles, in the Account dropdown menu (Fig.: Activating the Payment methods read role, item 1), make sure the Payment methods read checkbox is activated (Fig.: Activating the Payment methods read role, item 2).

    Activating the Payment methods read role

    Fig.: Activating the Payment methods read role

  11. In the Shop Operator Account field (Fig.: Entering Adyen access data, item 4), enter your Adyen Merchant Account Code (Fig.: Choosing a merchant account, item 2).

  12. In the PayPal Merchant Id field (Fig.: Entering Adyen access data, item 5), enter your PayPal Merchant ID.

    Find your PayPal Merchant Id in your PayPal Business Sandbox account under Settings.

    Entering Adyen access data

    Fig.: Entering Adyen access data

  13. Save your entries.

  14. Copy the webhook URL displayed under Important module information (Fig.: Copying the webhook URL, item 1).

    Copying the webhook URL

    Fig.: Copying the webhook URL

  15. In the Adyen Customer Area, under Developers ‣ Webhooks, choose Webhook (Fig.: Adding a webhook at Adyen, item 1).
    The Create new webhook dialog box appears.

  16. Choose the Add button (Fig.: Adding a webhook at Adyen, item 2) for the Standard webhook type.

    Adding a webhook at Adyen

    Fig.: Adding a webhook at Adyen

  17. Register your webhook:

    1. Under Server configuration, in the URL field (Fig.: Registering the webhook with Adyen, item 1), enter the webhook URL.

    2. Choose JSON (Fig.: Registering the webhook with Adyen, item 2).

    3. Choose Apply (Fig.: Registering the webhook with Adyen, item 3).

    Registering the webhook with Adyen

    Fig.: Registering the webhook with Adyen

  18. Choose Save changes (Fig.: Registering the webhook with Adyen, item 4).

    The ID of the webhook is displayed (Fig.: Displaying the Webhook ID, item 1).

    Displaying the Webhook ID

    Fig.: Displaying the Webhook ID

  19. Optional: Generate an HMAC key.

    The HMAC key is required only in live operation.

    1. Choose Developers ‣ Webhooks.

      The webhook you registered is displayed.

    2. Choose Edit Webhook.

    3. Choose Security ‣ HMAC Key and click Generate (Fig.: Generating the HMAC key, item 1).

    4. Choose Apply (Fig.: Generating the HMAC key, item 2)

    Generating the HMAC key

    Fig.: Generating the HMAC key

  20. Copy the HMAC key, enter it in the HMAC Code (keyed hash message authentication code) field (Fig.: Entering Adyen access data, item 3), and choose Save.

Activating Apple Pay as payment method

If you want to offer Apple Pay, follow the instructions in the Adyen documentation.

Prerequisites

  • You have an Apple device for testing.

    Background: Payments via Apple Pay can only be made with an Apple device.

Procedure

You have the following options:

  • The easiest and fastest way is to use a ready-made Apple certificate from Adyen.

    To do so, follow the instructions in the Adyen documentation under Set up Apple Pay.

  • Alternatively, you can generate keys yourself using your own certificate and register them with Apple. This gives you full control over secure communication with Apple Pay.

    To do so, follow the instructions in the Adyen documentation under Enable Apple Pay with your own certificate.

Configuring payment methods and making test payments

Configure the desired payment methods.

To verify that the connection to Adyen is established, make test payments.

Prerequisites

  • If you want to offer PayPal or Google Pay, you have a test payments account to test the connection with Adyen.

  • If you want to offer Apple Pay, you have generated Apple merchant ID and certificates in your Apple developer account (see Activating Apple Pay as payment method).

Procedure

  1. In the Adyen Customer Area, configure payment methods.

    To do so, choose Settings ‣ Payment Methods.

    The preconfigured payment methods are displayed.

  2. Check if the payment methods covered by Adyen Payment for OXID (see Which markets are covered?) are active.

  3. If a payment method is missing, choose Request payment methods and enter the required credentials.

    The button is active only if you are in your merchant account (with suffix ECOM, Fig.: Choosing a merchant account, item 2).

  4. In your OXID eShop, under shop settings ‣ payment methods, enable, for example, the PayPal payment method.

  5. Make a test order, in our example with PayPal.

    In our example, we configured capture delay with manual triggering of the payment (see Configuring capture delay for selected payment methods).

  6. Review the order and payment flow:

    1. Choose Administer Orders ‣ Orders and highlight your test order.

    2. Choose the Adyen tab.

      In our example, the order is configured with delayed money capture and therefore still in status authorized (Fig.: Displaying an order, item 1)

      Displaying an order

      Fig.: Displaying an order

    3. To trigger the capture of the invoice amount manually, choose Capture (Fig.: Displaying an order, item 2).

      The payment has been made, the order is in Adyen: received status (Fig.: Capturing money manually (example: PayPal), item 1).

      Capturing money manually (example: PayPal)

      Fig.: Capturing money manually (example: PayPal)

Result

You have successfully completed the test payment. The connection with Adyen is verified.

Configuring capture delay for selected payment methods

For specific payment methods, specify whether the amount should be captured automatically (automatic capture), or whether payments should only be reserved and triggered with a delay (separate captures).

For capture delay (separate captures), specify how it should be triggered:

  • manually

    or

  • automatically after a certain number of days (delayed automatic capture).

Example

By default, the money is captured immediately (automatic capture).

In certain use cases it makes sense that the payment is only triggered by the delivery:

  • You sell certain individualized products that you only manufacture, commission or order after the order has been received.

  • You have an OXID eShop for business customers. Here, the delivery quantities and payment amounts are larger than for private customers.
    In the event of an error, returns management would be correspondingly more difficult.
    Therefore, you want to make sure that the payment is only triggered when the goods are there or on their way to be shipped.

Procedure

  1. Configure the desired capture delay in the Adyen Customer Area (for example Manual).

    For more information, in the Adyen documentation see Delayed automatic capture.

    The capture delay affects all Adyen payment methods that support this feature.

    To see which Adyen payment methods allow capture delay (separate captures), see the Adyen documentation under Payment methods overview.

  2. Choose Settings ‣ Capture delay for selected payments.

  3. To specify for a payment method that capture should be delayed, choose the capture type.

    The type of capture you make in the module overrides the setting you made in the Adyen Customer Area. So, you can configure payment methods with different types of capture delay.

    However, make sure that the payment method supports capture delay in the first place.

    To find out which Adyen payment methods allow capture delay (separate captures), see the Adyen documentation under Payment methods overview.

  4. Save your settings.

  5. Assign capture delay methods to the customized products in your eShop.

    It is technically not possible to assign certain payment methods exclusively to certain items. We suggest the following workaround:

    1. Create a dedicated shipping rule and assign the relevant items to it.
      Make sure that the quantity condition is correctly specified.

    2. Create a dedicated shipping type.

    3. Assign to it the payment method with capture delay and the shipping rule for individualized products.

    4. In the description text of the item, instruct your customers to choose only the dedicated shipping method for payment (Fig.: Choosing the dedicated shipping method in the checkout, item 1).

      Choosing the dedicated shipping method in the checkout

      Fig.: Choosing the dedicated shipping method in the checkout

Result

For manual money capture, collect the invoice amounts under Administer orders ‣ Orders (see Capturing money manually).

Setting up the language configuration

By default, German and American English are configured as languages in which customers are prompted to enter, for example, their credit card information.

If you have configured additional languages under Master Settings ‣ Languages, make sure you configure the appropriate one (language abbreviation according to ISO 639-1 and country according to ISO 3166-1, for example fr_CA for Canadian French) for messages from Adyen Payment for OXID.

Procedure

  1. Under Master Settings ‣ Languages, check the languages you have configured.

  2. In the module settings, under Settings ‣ Language configuration, in the Language localizations matching the OXID language field, enter the appropriate language abbreviations in the format <language abbreviation>_<country abbreviation>.

    Or customize the default language abbreviations. If your OXID eShop targets customers in the UK, for example, enter the language abbreviation for English in en_UK.

Activating Adyen Payment for OXID in live mode and configuring payment methods

Activate Adyen in each subshop where you want to use the module.

Establish the live connection with Adyen.

Activate the correct payment methods.

Prerequisites

Procedure

  1. Choose Extensions ‣ Modules.

  2. Choose the Adyen Payment for OXID module and choose Overview ‣ Activate.

    Activate Adyen in each subshop where you want to use the module.

  3. Under Settings ‣ Adyen Access Live, enter the API access credentials for live operation in the same way as described under Testing Adyen Payment for OXID in sandbox mode.

    In addition, perform the following steps:

    1. Enter the Live Endpoint Prefix in the field of the same name (Fig.: Entering Adyen access data, item 6).

    2. Enter the HMAC key required in live mode (see Fig.: Entering Adyen access data, item 7).

  4. Under Shop Settings ‣ Payment Methods, make sure that only those payment methods are activated that you have

    Important

    Conversion at risk

    If a payment method is enabled that Adyen Payment for OXID does not support or that you have not enabled in the Adyen Customer Area, your customer will not be able to complete a purchase with that payment method. He will have to choose another payment method and may bounce.

  5. Optional: Allow Adyen to collect data about your module to improve system performance.

    To do this, under Adyen API, check the Analytics active? checkbox.

    For more information, see the Adyen documentation at Analytics and data tracking.