No results

VirtueMart

The Nexi XPay payment extension for VirtueMart allows you to integrate the XPay payment gateway without requiring any additional implementation on your website. It manages the transfer of the customer from the merchant's e-commerce site to the secure Nexi environment and back. The customer remains on the merchant’s e-commerce site until the checkout stage, and is then redirected to the XPay gateway to complete the payment.

Installation

The extension can be installed using the Extension Manager installer provided by Joomla:

  1. Log in to the Joomla administration panel.
  2. In the top navigation bar, select Extensions > Manage.
  3. Upload the file downloaded from the Joomla Extensions Directory.
  4. From the left-hand menu, select Manage.
  5. Search for Nexi XPay in the list.
  6. Enable the extension by clicking the appropriate button.
  7. In the top navigation bar, select VirtueMart > Payment Methods.
  8. On the new page, select the Nexi XPay plugin from the list and click the Edit button.
  9. Click the New button at the top of the page.
  10. On the new page, enter Nexi XPay in the Payment Name field and select Nexi XPay as the Payment Method.
  11. Click the Save button at the top of the page.

The installation phase is now complete. You can proceed with the configuration.

Configuration

Below are the instructions to correctly configure the Nexi XPay plugin:

  1. Log in to the Joomla administration panel.
  2. In the top navigation bar, select VirtueMart > Payment Methods.
  3. On the new page, click on the Nexi XPay plugin from the list.
  4. Select the Configuration section.
  5. Proceed with configuring the module.
Field Description
Enable/Disable 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 follow the instructions in the following paragraph.
Enable/Disable TEST mode Enable or disable test mode. Register in the test area to receive your credentials. Test credentials can be found in the Test area section.
Enable 3D secure 2 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.

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:

  1. Log in to Nexi Business.
  2. Sign in to the XPay Web Back Office.
  3. In the "Admin" section click on "APIKey".
  4. Click on "Add new APIKey".
  5. 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:

  1. Access the configuration section as indicated in the previous steps
  2. Disable TEST mode and enter the API Key generated in the merchant Back Office.
  3. Save the new configuration.

Payment methods

The Nexi XPay plugin provides customers with various payment options:

Card payment

With this solution, the customer remains on the merchant's e-commerce site until the checkout phase. They are redirected to the UniCredit environment to complete the payment and then returned 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 the supported payment methods:

Back office features

Within each order detail, the plugin provides information related to transactions such as the card details used and the payment status on the XPay gateway.

Refund

It is possible to perform full or partial refund operations. This operation will reverse the specified amount, refunding the customer and changing the order status in VirtueMart. Below are the steps to follow:

  1. Log in to the Joomla administration panel
  2. From the side menu, open the section Components > VirtueMart > Orders
  3. Select the order to be refunded
  4. At the bottom of the order detail page, there will be a section dedicated to the payment method where a button to proceed with the refund will be available
  5. Enter the amount to be refunded and click the button

Capture

It is possible to perform full or partial capture operations. This operation will settle the desired amount on the XPay gateway.

By default, capture is performed automatically at midnight; use this option only in case of non-standard terminal configurations.

  1. Log in to the Joomla administration panel
  2. From the side menu, open the section Components > VirtueMart > Orders
  3. Select the order to be capture
  4. At the bottom of the order detail page, there will be a section dedicated to the payment method where a button to proceed with the settlement will be available
  5. Enter the amount to be capture and click the button