Opencart
The Nexi XPay payment extension for Opencart 4, allows you to integrate the XPay payment gateway without further implementation on your site.
Manages the transfer of the customer from the merchant's ecommerce site to the Nexi secure environment and vice versa.
The customer stays on the merchant's e-commerce site until checkout, then is redirected to the XPay gateway to make the payment.
Installation
The Nexi XPay plugin is compatible with Opencart version 4 and is available for free on the Opencart Marketplace.
It is possible to install the extension using the installer provided by Opencart:
- Log into the Opencart administration panel.
- In the left navigation bar and select Extensions > Installer .
- Upload the file downloaded from the site Opencart.com.
The installation phase is complete, proceed with the configuration.
Configuration
Here are the instructions to correctly configure the Nexi XPay plugin:
- Log into the Opencart administration panel.
- In the left navigation bar, select Extensions > Extensions.
- Select Payments under Choose the extension type .
- Find the Nexi XPay plugin in the list and click on the Edit button.
- Proceed with the configuration of the module:
Field | Description |
---|---|
Enable | Enable the Nexi XPay payment module. |
Typology | Select API Key |
API Key | Code required for communication with the XPay gateway. To obtain this data for the production or test environment, follow the instructions in the following paragraph Test and production. |
Enable TEST mode | Enable test mode: register in the test area to receive your credentials. Test credentials can be found in the Test area section. |
Enable the 3D Secure 2 service | The new 3D Secure 2 protocol adopted by the main international circuits (Visa, MasterCard, American Express), introduces new authentication methods, capable of improving and speeding up the cardholder's shopping experience. |
Enable Multicurrency | Available only through payment cards: enable this option to allow payment via card in various currencies. For the full list of supported currencies, visit the Multicurrency payments section of the developer portal. Make sure that this option is also enabled on your terminal configuration. |
Test and production
It is highly recommended that you test the plugin in a test environment, before entering the production code.
It is possible to obtain the test credentials (API key) in the test area. In the area there will also be test cards that can be used to carry out successful and negative transactions. In this phase it is necessary to verify that the orders are created correctly, also checking the details of the orders.
Switch to production
To carry out the transition to production it is necessary to create the production credentials (API Key). To generate the new credentials follow these steps:
- Log in to Nexi Business.
- Sign in to the XPay Web Back Office.
- In the "Admin" section click on "APIKey".
- Click on "Add new APIKey".
- Once the terminal has been selected, click on "Add" to generate the production API Key.
Once the API Key has been created, the module configuration must be updated:
- Log into the Opencart administration panel.
- In the left navigation bar, select Extensions > Extensions.
- Select Payments under Choose the extension type .
- Find the Nexi XPay plugin in the list and click on the Edit button.
- Disable the TEST mode and enter the API Key generated on Nexi Business
- Save the new configuration
It is advisable to carry out a proof of payment with a real card with the transition to production.
Payment methods
The Nexi XPay plugin offers customers various payment methods:
Payment by cards
With this solution, the customer remains on the merchant's e-commerce until checkout. It is redirected to the Nexi environment to make the payment and then return to the merchant's website at the end of the transaction.
Alternative Payment Methods (APM)
The plugin offers several alternative payment methods. By selecting the desired method, the customer will be redirected to the checkout page of the chosen payment service. Below is a list of supported payment methods:
Once a new payment method has been enabled from the XPay back office, it will be necessary to save the plugin configuration to update the APM list and show the new payment method in the ecommerce site checkout.
Back office functionality
In the details of each order, the plugin provides information relating to transactions such as the details of the card used and the status of payments on the XPay gateway.
Refund
You can perform full or partial refund operations. This operation will reverse the desired amount by refunding the customer. Below are the operations to be performed:
- Log into the Opencart administration panel.
- In the left navigation bar, select Sales> Orders.
- Select the order to refund.
- In the History section select the Nexi XPay tab.
- In the new tab it is possible to execute the refund by clicking on the Refund button. There is the Amount field where you can change the amount in order to proceed with a partial refund. /li>
Capture
You can perform full or partial capture operations. This operation will capture the desired amount on the XPay gateway.
By default, total capture of the amount occurs automatically at midnight, use this option only in case of non-standard terminal configurations.
- Log into the Opencart administration panel.
- In the left navigation bar, select Sales > Orders.
- Select the order to be posted.
- In the History section select the Nexi XPay tab.
- In the new tab you can perform the capture by clicking on the button Capture. The Amount field is present in which to modify the amount in order to proceed with a partial capture.