![Shopware](/assets/img/plugin/shopware/shopware.png)
Shopware
The Nexi XPay payment extension for Shopware, 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 extension for Shopware is available for free on the website store.shopware.com, from which it will be possible to check the compatibility of the versions. To proceed with the installation, it's necessary to add the extension to the cart and proceed with the purchase using a Shopware account.
It is possible to install Nexi XPay using the appropriate installer made available by Shopware.
- Log into the Shopware administrative panel.
- In the left navigation bar, select Extension > Store.
- On the new page, enter Nexi XPay in the search bar.
- Locate the XPay extension and click Add Extension.
- In the left navigation bar, select Extension > My extension.
- Identify the Nexi XPay extension and click on the Install option.
The installation phase is complete, proceed with the configuration.
Configuration
Here are the instructions to correctly configure the Nexi XPay plugin:
- Log into the Shopware administrative panel.
- In the left navigation bar, select Extension > My extension.
- Identify the Nexi XPay extension, click on the three dots, and then select the Configure option.
- Proceed with the configuration of the module:
Campo | Descrizione |
---|---|
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 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 OneClick | This feature allows you to tokenize the customer's card data in order to allow faster subsequent payments. Make sure that this option is also enabled on your terminal configuration. |
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. |
To obtain the api-key, 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.
Payment Methods Synchronization
Once the extension is configured, it's necessary to synchronize the enabled payment methods on the Nexi terminal with Shopware:
- Login to the Shopware administrative panel.
- In the left navigation bar, select Settings > Payment Methods.
- Identify the Nexi XPay payment method and click on the Synchronize payment methods button.
Adding 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.
To enable the payment method via cards on the Shopware ecommerce:
- Login to the Shopware administrative panel.
- In the left navigation bar, select Sales Channels > Storefront.
- In the new page, select General > Payment and shipping
- Click inside the Payment methods window and select from the dropdown menu Cards | Payment cards
- Save the settings by clicking on the Save button at the top right of the page.
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:
ATTENTION: once a new payment method has been enabled from the XPay back office, it will be necessary to repeat the payment methods synchronization described in the previous paragraph.
To add alternative payment methods on the Shopware ecommerce:
- Login to the Shopware administrative panel.
- In the left navigation bar, select Sales Channels > Storefront.
- In the new page, select General > Payment and shipping
- Click inside the Payment methods window and select from the dropdown menu Cards | APM Name
- Save the settings by clicking on the Save button at the top right of the page.
Back Office Functionality
In the details of each order, the plugin provides information related to transactions such as the details of the card used and the payment status on the XPay gateway.
Refund
You can perform full or partial refund operations. This operation will refund the desired amount to the customer. Below are the steps to follow:
- Login to the Shopware administrative panel.
- In the left menu, click on Orders > Overview.
- Identify the order to be refunded, click on the three dots at the bottom of the row, and then select View.
- In the new page, select the Nexi XPay tab.
- Enter an amount and click on the Refund button.
Capture
You can perform full or partial capture operations. This operation will capture the 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.
You can perform full or partial refund operations. This operation will refund the desired amount to the customer. Below are the steps to follow:
- Login to the Shopware administrative panel.
- In the left menu, click on Orders > Overview.
- Identify the order to be refunded, click on the three dots at the bottom of the row, and then select View.
- In the new page, select the Nexi XPay tab.
- Enter an amount and click on the Account button.