Before proceeding to the Nuvei plugin installation, you need to have installed OpenCart. The module should be also installed and configured.
If you do not have test credentials to test the payment flow, please contact our Tech Support Team.
Nuvei OpenCart plugin is tested on the following versions:
|Oldest Supported Version||Last Tested Version|
To install the Nuvei plugin using the native OpenCart plugin functionality:
- Extract the proper plugin for your version of OpenCart:
- Follow the instructions in the repo’s README.md file to install the relevant plugin.
If your modification file was installed, you see it in the Extensions > Modifications menu. Depending on your OC version, the menu may have a different name.
- Here you can enable or disable the modifications. Click the Refresh button (blue button, top right) after each Enable or Disable action.
Before setting up the Nuvei OpenCart plugin, you should contact Tech Support to provide account credentials.
To configure the Nuvei plugin:
- Navigate to Extensions > Select menu and select Payments (for OC 126.96.36.199 and up). For OC 2 the menu is Extensions > Payments.
- From the list of payment methods, find Nuvei and click the green Plus button to install the plugin.
After installing the plugin, the list looks like the image below:
- Click the blue Pencil button to edit the settings.
|Merchant ID||Yes||This is the merchant ID provided by Tech Support. If you don’t have it, please contact Tech Support.|
|Merchant Site ID||Yes||This is the Merchant Site ID provided by Tech Support. If you don’t have it, please contact Tech Support.|
|Merchant Secret key||Yes||This is the secret key provided by Tech Support. If you don’t have it, please contact Tech Support.|
|Merchant Hash type||Yes||The hash type provided by Tech Support. If you don’t have it, please contact Tech Support.|
|Payment Action||Yes||Choose between a Sale and Auth flow.|
|Sandbox mode||Yes||Enables the payment Sandbox mode. Any payments made in Sandbox mode are not actually processed. Please do not use real credit card details.|
|Enable UPOs||Yes||Enable/disable the creation and usage of UPOs.|
|Use HTTP Notify URL||Yes||If your site is on https server, but you cannot receive the DMS, force Notify URL to be http.|
|Enable logs||Yes||Choose the type of the log.|
|Total||No||The checkout total the order must reach before this payment method becomes active.|
|Various "Status" fields||No||These fields allow the merchant to select the status they want to appear for each status.|
|Geo Zone||No||Enables the plugin only for specific geographic zones.|
|Status||No||Enable or disable the plugin.|
The default OC settings are not described in the table above.
- Select a product from your shop and go to the Payment Page.
- Follow the steps of checkout.
In the Payment Method step (its number can be different), select Nuvei and then press Continue.
In the Confirm Order step, you see the order details and Preferred Payment methods if you are using the REST API. In this case, a method must be selected and its fields filled.
- Click the Confirm Order button.
Upon successful payment, the user is redirected to the merchant’s successful order page.
Order payment details are found in the Sales > Orders menu.
Click on any order. 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 is set to “Pending Payment”.
After successful payment, the transaction is processed and the order status is updated in the background.
Here and the logs (if they are enabled) are the two places where the merchant can see what happen with its order.
If the merchant flow is “Auth & Settle” (Transaction type option), all new orders have a status of “Pending payment”.
Under Items, you see the Settle button to settle an order.
OC v 188.8.131.52
OC v 184.108.40.206
If the merchant flow is “Sell” or the order was Settled, two buttons are available: Partial Refund and Void. With them you can request a refund or void your transaction once the order is completed. As you can see on the image below, you must enter the amount to refund.
When you click on either of these buttons, you must confirm your action. After the action is completed, a note with the information is created.
For the supported refund amount, please contact Tech Support.
When the refunded amount is equal to the total order amount, the Order status changes to “Refunded”. If you void your order, the status changes to “Canceled”.
|Oldest Supported Version||Last Tested Version|
Oldest Supported Version
Last Tested Version
|1||Merchant ID||Yes||This is the merchant ID provided by Tech Support. If you do not have it, please contact Tech Support|
|2||Merchant Site ID||Yes||This is the Merchant Site ID provided by Tech Support. If you do not have it, please contact Tech Support|
|3||Merchant Secret key||Yes||This is the secret key provided by Tech Support. If you do not have it, please contact Tech Support|
|4||Merchant Hash type||Yes||The hash type provided by Tech Support. If you do not have it, please contact Tech Support|
|5||Payment API||Yes||The merchant’s preferred payment API (Cashier or REST). If you are not sure about it, please contact Tech Support|
|6||Transaction type||Yes||The merchant’s preferred transaction type provided by Tech Support. If you do not have it, please contact Tech Support|
|7||Test mode||No||Enable the payment test mode. Any payments made in Test mode are not actually processed. Please, do not use real credit card details.|
|8||Use HTTP Notify URL||No||If your site is on https server, but you cannot receive the DMS, force Notify URL to be http.|
|9||Enable logs||No||Create daily logs with sent and received data and settings. The logs are very helpful for debugging and resolving problems with the plugin.|
|10||Status||Yes||Enable or disable the plugin.|
|11||Remove Logs||Deletes older logs. The 30 most recent of them are kept.|