Checkout for Oxid

Overview

Our Oxid plugin is the perfect extension that enables you to use the Checkout to its full potential for your Oxid store. Checkout supports most popular payment methods. Also, in order to cater to different segments and to highlight specific payment methods, it is possible to either use the Checkout as one solution or to specify and show individual payment methods for your consumers.

Shop features

• The fast checkout with "remember me" functionality.
• Embedded checkout for an optimized user experience. Users are not redirected outside Oxid.
• A smart mix of payment methods to suit all preferences.
• Multiple checkout languages and currencies for selling in your domestic market and abroad.

The following screenshot shows a checkout page provided by the Checkout module:

Admin features

• Quick setup and flexible configuration.
• Intuitive order management with synchronized captures and refunds.
• Compatibility with discounts, tax (VAT), and shipping options.

The screenshot below shows the Settings page in the Oxid administration portal:

Installation

Follow the steps below to install and activate the Checkout module in Oxid.

Step 1: Upload the module to Oxid

1. Download the module archive: https://github.com/Nets-eCom/oxid7/archive/refs/heads/master.zip.
2. Extract the zip archive to the folder /source/modules/nexi-checkout.
3. Clear your cache from third party plugins or simply delete the files in the /source/tmp folder.

Step 2: Install the module

Connect with an SSH client and navigate to the root directory of your Oxid 7 installation and run the command:

$ php vendor/bin/oe-console oe:module:install-configuration source/modules/nets

Step 3: Activate the module

After installing the module, you need to activate it:

1. Navigate to Extensions > Modules in Oxid Admin.
2. Locate and select Checkout module from the list of installed modules.
3. Select the Overview tab and press the Activate button. If the Checkout module has been installed correctly, you will now see a green checked circle in the ACTIVE column next to Checkout on your list.

Step 4: Activate the new payment method

Here's how to activate the new payment method:

1. Navigate to Shop Settings > Payment Methods
2. Payment methods are listed in alphabetical order on multiple pages. Find or search for Checkout and select it.
3. On the Main tab, make sure to check the Active box.
4. (Optional) Fill out the Name and Payment Description fields if you want to customize the text displayed in the payment method selector presented to your customers in the webshop.
5. (Optional) Specify User Groups and Countries and translations if needed.
6. Click Save.

The module is now installed and ready to be configured for your Checkout account.

Configuration

After installing and activating the module, you now need to do some basic configuration of the module:

1. Navigate to the plugin settings: Extensions > Modules > Checkout.
2. Select the Settings tab and press Checkout settings to reveal the configuration settings.
3. Fill out the required fields, such as merchant ID and integration keys (secret keys and checkout keys).
4. (Optional) Customize the module according to your needs using the additional settings on the configuration page.

The screenshot below shows the settings page for the module:

The following table lists all the settings you can configure in the administration area for the Checkout module:

Order management

It's possible to manage orders directly in Oxid:

1. Navigate to Admin > Administer Orders > Orders. Select an order item paid through Checkout.
2. Choose your desired payment operation:
   • Fully cancel / charge / refund your order.
   • Partially charge / refund your order.

Payment status is updated in real-time and reflected in Order details even if you make the changes in Checkout Portal.

Troubleshooting

Below are some of the most common configuration errors, their cause and steps that you can follow to solve them.

Nexi Group payment plugin is not visible as a payment method

• Ensure the Nets plugin is activated in Shop Settings and in the Extensions plugin configuration.
• Ensure the Nets plugin is assigned in available listings in various User Groups and Countries.
• Various User Groups, Countries and Payment Methods setup listings can be found in Admin > Shop > Settings under Payment Methods and Shipping Methods.

Nexi Group payment window is blank

• Ensure your integration keys in the Nexi Group plugin settings are correct and do not contain additional blank spaces.
• Temporarily deactivate third party plugins that might affect the functionality of the plugin.
• Check if there are any temporary technical inconsistencies: https://nets.eu/Pages/operational-status.aspx

Payments in live mode don't work

• Ensure you have an approved Live Checkout account for production.
• Ensure your Live Checkout account is approved for payments with the selected currency.
• Ensure payment method data is correct and supported by your Checkout agreement.

How do I choose currency and language in the payment window?

• Currency and Language is based on customers selection on the frontend shop page.
• A complete list of supported currencies and languages can be found in the Checkout API Reference.

Go live checklist

For more information, refer to the section Go-live checklist.