Nexi XPay Build
The Nexi XPay Build payment extension for Magento provides the possibility to directly host the payment form within your own e-commerce website, maintaining high security standards while at the same time avoiding the need to handle payment card data.
Through this extension, the number of steps required to complete the payment is reduced.
Installation
The Nexi XPay Build plugin for Magento 2 is available for free on the website Adobe Commerce Marketplace, from which you will be able to check for compatible versions.
Installation via composer
Before proceeding, check that Composer is installed in your environment. Below is the list of commands to run for installation:
1. Install the plugin
2. Enable the plugin
3. Run the update command
4. Clear the cache
The installation phase is complete, proceed with the configuration.
Configuration
Here are the instructions to correctly configure the plugin:
- Log into the Magento administrative panel.
- In the navigation bar on the left select Stores (Stores) > Configuration (Configuration).
- In the new menu on the left select Sales (Sales) > Payment methods (Payment methods) > Nexi XPay Build.
- Proceed with the configuration of the module:
Field | Description |
---|---|
Typology | Select API Key |
Enabled | Enable the Nexi XPay Build payment module. |
Enable TEST Mode | Enable or disable test mode. 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. |
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. |
Timeout Pay-By-Link | Maximum time in hours for which the Pay-By-Link link will be usable. |
Sort order | Manages the position of the payment method on the checkout page relative to other payment methods |
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. |
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 in to the Magento back office
- In the payment configuration section click on "Nexi"
- 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.
Pay-By-Link
This solution involves generating an order on the Prestashop side, selecting the appropriate products and the customer who wishes to make the purchase.
By clicking on the button "Send an email to the customer with the link to make the payment" an email will be sent to the customer containing a link to make the payment. The customer will be redirected to the checkout page of the ecommerce site.
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 and changing the Magento order status. Here are the operations to perform:
- Log into the Magento administrative panel.
- In the left navigation bar, select Sales > Orders .
- Select the order to refund.
- In the menu on the left select Invoices and click on the corresponding invoice.
- Select Credit Note at the top right.
- At the bottom of the page it is now possible to make a refund by clicking on the Refund button. There is the Adjustment fee field where you can change the amount in order to proceed with a partial refund.
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 Magento administrative panel.
- In the left navigation bar, select Sales > Orders .
- Select the order to be captured.
- Click on the Invoice button at the top right.
- Click on the Submit Invoice button at the bottom of the page.