On this page:

Overview

Assumptions and Restrictions

Before installing the Nuvei plugin, you need to have WordPress installed. The WooCommerce module should also be installed and configured.

If you do not have test credentials to test the payment flow, please contact our Integration Team.

Requirements

The merchant profile must have enabled DMN and DCC support.

On the store, the plugin Notify URL must be accessible to the public. The plugin needs read/write permission so it can create logs and read some of its saved files.

Integration with Other Plugins

The current plugin is integrated with:

Multi-step checkout for WooCommerce
WooCommerce subscriptions

Downloading the Plugin

https://github.com/Nuvei/nuvei-plugin-woocommerce

Installation

To install the Nuvei plugin using the native WordPress plugin functionality:

Log in to WordPress backend with your credentials.
Navigate to Plugins > Installed Plugins and then press the Add New button.
Select the plugin archive that you previously downloaded and install it.
After successful installation, you should see the status “Plugin Activated”.

Plugin Configuration

Before setting up Nuvei WooCommerce plugin, you should contact our Integration Team to provide account credentials.

To configure the Nuvei plugin:

Navigate to WooCommerce > Settings.

Select the Payment tab and then under “Pay with Nuvei”, press the Manage button.

The plugin settings are separate in three tabs:

General Settings

Field Name	Mandatory	Notes
Enable/Disable	no	Enables or disables the Nuvei plugin
Default Title	yes	The name of the payment option in your Payment Page
Description	no	A short description what payment options Nuvei provide to the users.
Site Mode	yes	Choose between Sandbox and Live mode.
Merchant ID	yes	This is the merchant ID provided by Integration Team. If you don’t have it, please contact Integration.
Merchant Site ID	yes	This is the Merchant Site ID provided by Integration. If you don’t have it, please contact Integration.
Secret Key	yes	This is the secret key provided by Integration. If you don’t have it, please contact Integration.
Hash Type	yes	The hash type provided by Integration. If you don’t have it, please contact Integration.
Payment Action	yes	Use Authorize or Authorize & Capture (Sale) mode.
Save Daily Logs	no	Creates daily logs with sent and received data and settings. The logs are very helpful for debugging and resolving problems with the plugin. These logs are recommended since each file has a secure unique name.
Save Single Log File	no	Creates single log file to write in it. It is a less secure file, but may be useful in some cases.
Hide WCS Warning	no	When WCS products and Nuvei Rebilling products are present in the same store, a warning message is displayed (see the top of the image above).

Advanced Settings

Field name	Mandatory	Notes
Integration Type	Yes	Choose between Cashier (redirect page) and Simply Connect checkout. Most of the options here are available only for Simply Connect.
Status Pending DMN	No	Set WooCommerce status for Nuvei Pending Orders.
Status Authorized	No	Set WooCommerce status for Nuvei Authorized Orders.
Status Paid	No	Set WooCommerce status for Nuvei Paid Orders.
Status Refunded	No	Set WooCommerce status for Nuvei Refunded Orders.
Status Voided	No	Set WooCommerce status for Nuvei Voided Orders.
Status Failed	No	Set WooCommerce status for Nuvei Failed Orders.
Combine Cashier Products into One	No	Combine the products into one to avoid eventual problems with taxes, discounts, coupons, or restrictions into the URL length. This options is available only for the Cashier integration. This option is available for Cashier integration only.
Enable Nuvei GW for Zero-total Products	No	If this option is enabled, only Nuvei GW is listed as a payment option. This option can be used for Card authentication. Zero-total checkout for rebilling products is enabled by default.
Allow Client to use UPOs	No	Enable or disable usage of UPOs.
Save UPOs for Guest Users	No	Save UPOs for guest users or not. The recommended option is No.
Allow Rebilling with PayPal	No	Give PayPal as an option in Nuvei GW, but disable the usage of UPOs.
Simply Connect Theme	No	Switch between available themes.
Use Currency Conversion	No	Enable or disable or force the usage of DCC.
Block Cards	No	Block cards if needed.
Block Payment Methods	No	Block some of the available payment methods. Do not use this option and the Block Cards option at the same time!
Choose the Text on the Pay Button	No	Select from amount or selected payment method.
Auto-expand PMs	No	May not work for all themes. For better user experience, we recommend setting it to Yes.
Auto-close APM Pop-Up	No	Yes is recommended! Use “No” only for testing!
Mask User Data into the Log	No	When set to Yes, the plugin tries to mask user personal data into the log.
Checkout Log Level	No	The logging level of Simply Connect.
Translations	No	Translate Simply Connect elements.

Help Tools

If you plan on using Nuvei Rebilling, press the Sync Payment Plans button to get the latest payment plan from your merchant profile.
The Notify URL is where the DMNs are delivered. It must be accessible to the public. Please provide this email to the Integration team, so it can be added in the merchant configuration and later be used in the Nuvei Rebilling system.

Press Save changes on any tab to save you settings.

Payment Page

Select a product from your shop and go to the Payment Page.
Enter your billing details, select the Nuvei payment option, and press Continue.
If the merchant uses Simply Connect as checkout, the client sees a similar screen (depending on the theme).
If the merchant uses the Cashier as a checkout option, the client is redirected to the hosted payment page. The actual page may be different depending on the merchant theme.

If you press “Go Back“, you are re-directed to your shop’s checkout page.
Upon successful payment, you are redirected to your shop successful order page.

Order Payment Status Update

Order payment details can be found in WooCommerce > Orders menu. Press on any order to see the details.

For each order processed with Nuvei, there are order trace notes to help track the payment process.

Once the order is saved and the user is redirected to the secured checkout page, the order status changes to “pending payment”.
After successful payment, the transaction is processed and the order status is updated in the background.

To have your order payment status updated, you should:

Enable your Notify URL (see Plugin Configuration) for public use.
Enable DMNs in the merchant account settings (contact Integration/Technical Support team).

Order Details

The Order Details page and the logs (if they are enabled) are the two places where the merchant can see what happened with an order.

If the merchant flow is “Auth & Settle” (Transaction Type option), all new orders have status “Pending payment” and under the Items you see two buttons: Refund and Settle.

Use the Settle button to settle the Order and use the Refund button to request a refund. For each button, you must confirm your action. After the action completes, notes with information are created.
If the merchant flow is “Sell” or the order was Settled, the following two buttons are available: Refund and Void. You can either request a refund or void your transaction.

For supported refund amount, please contact Integration. After the process is finished, the notes are saved.

When the refunded amount is equal to the total order amount, WooCommerce changes the status to “Refunded”. If you void your order, the status is changed to “Canceled”.

If your refund is rejected for some reason, you must manually delete the created Refund record.

Read the order notes carefully!

WooCommerce