¶ Introduction
Nuvei is a preferred partner, which means ByDesign will continue developing future enhancements for this integration at no additional cost.
Nuvei is a credit card processor that operates via Tokenization, which means it provides additional transactional security via a secure data entry screen using a framed page inside the user checkout interface.
Since Nuvei is tokenized, no PCI-sensitive credit card information (card number, CVV, etc.) is stored inside Freedom. Instead, Nuvei encrypts this data as it’s entered and uses a token to pass the information along to the connected merchant account.
¶ Integrations
There are two separate integrations between Freedom and Nuvei: Nuvei Tokenized and Nuvei APM. Nuvei Tokenized is an older integration that uses Server-to-Server API calls to communicate. Nuvei APM is powered by Nuvei’s SimplyConnect, an all-in-one solution offered by Nuvei that combines its various features into one easy-to-use Integration Option. Not all areas within Freedom support Nuvei APM; those areas will require Nuvei Tokenized.
These are the areas each Nuvei integration currently supports:
| Integration | BackOffice | AutoShip | Party | Enrollment | Checkout 2.0 |
|---|---|---|---|---|---|
| Nuvei Tokenized | Y | Y | Y | Y | N |
| Nuvei APM | N | N | N | Y | Y |
¶ The Process
The information below provides a detailed explanation of the process each integration uses and the experience it provides.
When a user clicks Process Payment at Checkout, Freedom calls Nuvei to get a single-use token that is used to request the connection from Nuvei.
The user is then presented with a SimplyConnect payment modal that lists all available payment methods. Depending on the payment method selected, the payment process can differ.
¶ Payment Methods
If a user previously opted in to the "Save my details for future use" feature, the first options that will appear on the payment modal are the Saved Payments stored within Nuvei’s vault. For more information on creating a new Saved Payment, please see both the Credit Card and Alternative Payments tabs for their respective processes.
Currently, users will not be able to remove their Saved Payments through the payment modal. The user must contact your support team to remove the Saved Payment through the Nuvei C-panel.
By default, Credit Card is typically the first payment method available on the payment modal if no Saved Payment is available.
The user is presented with required fields to enter their credit card number, expiration date, and CVV codes. The sensitive data is encrypted through tokenization for the user’s security.
If the user opts into the "Save my details for future use" feature, Nuvei will store the card information as a UserPaymentOption (UPO) in the Nuvei vault. The UPO is then returned to Freedom for future payments use in the BackOffice, but will also be available for quick use the next time the user accesses the Nuvei Payment Modal.
Nuvei does not store payment information for reuse unless the user opts into the "Save my details for future use" feature. However, if the order results in the creation of an AutoShip profile, ByDesign will automatically opt the user into this feature to ensure the Autoship profile does not fail.
The steps for payment authorization - approval and capturing of funds - are completed in the same process. An approval of payment indicates that the funds will typically settle with the bank by the end of the day.
Alternate Payment Methods (APMs) are the non-standard payment options that Nuvei offers. They can range from eWallet services, like Google Pay or PayPal, to invoice-specific payment options, such as ACH or Klarna. Depending on the shopper's choice, the payment flow when using APMs will differ.
For instance, PayPal requires authentication on its website and approval of purchases by requiring users to login to their account through the payment modal. After the user logs in and approves the purchase, the payment flow will function similarly to a Credit Card transaction.
Some APMs, such as ACH, will have a delayed approval. The order created will remain in a pending status until ByDesign receives a notification from Nuvei with a payment approval or decline.
For more information on the APM's ByDesign supports, please refer to the Alternative Payment Methods article.
¶ Payment Completion
Upon receiving approval within the payment modal, the user will be redirected to a loading page asking the user to wait while the order is being processed and created. During this time, Freedom waits to receive a Direct Merchant Notification (DMN) from Nuvei. Upon receiving the DMN, Freedom will create the order within the BackOffice, and the user will be redirected to the Order Complete page once successfully completed.
If something happens to the user’s connection during the order creation process, the order will still be made as expected.
The Payment Completion process usually occurs instantly. As a result, the end user may to not see the loading page and will be immediately redirected to the Order Complete page.
If for any reason the user remains on the waiting page for 5 minutes, they will be redirected to a page advising that their order has been placed in a pending status but will be completed soon.
¶ Payments with Delayed Approvals
When delayed approvals are required, we receive the initial approval for a payment option and create an order in pending status. We then wait for a DMN that advises that the third party has fully approved the user's payment; at this point, the system finds the existing order and posts it for completion. This is used for APMs like ACH or Klarna.
When a user accesses a payment page in the Freedom BackOffice or Revolution, a Server-to-Server connection with Nuvei is established to present the user with an iframe where they can enter the cardholder's name, credit card number, expiration date, and CVV codes. The sensitive data is then encrypted through tokenization for the user’s security, and stored as a UserPaymentOption (UPO) in the Nuvei vault. Finally, the UPO is returned to Freedom for future use with payment recalling on BackOffice orders and AutoShip profiles.
The Nuvei Tokenized integration does not support using Nuvei's APMs or a user's Saved Payments in the Shopping Cart.
¶ Payment Completion
Upon receiving approval for the payment, the user will be redirected to a landing page based on where the order is being placed:
- For Checkout versions 1.0 and 1.5, the user will receive the Order Complete page.
- For Parties, the user will return to the order created within the party module.
- For AutoShip, when updating the payment method on an active profile, the user will be redirected to the updated AutoShip profile.
- For Freedom BackOffice, the user will be brought back to the order with the payment successfully applied.
¶ 3D Secure (3DS)
3DS transactions are an additional form of fraud prevention often required by the issuing bank that will affect a user's checkout experience when attempting to process a credit card transaction. Some acquiring banks, gateways, and processors may require 3DS validations passed to approve the transaction.
If a 3DS challange is requested, the user will be prompted to respond to the challenge initiated by their bank. This can be in the form of a verification message on a mobile device or a challenge question set by the bank. Nuvei and ByDesign do not control when and how the 3DS challenge will occur.
¶ Direct Merchant Notifications (DMNs)
Nuvei sends ByDesign notifications regarding transactions directly from their servers. As a result, ByDesign does not have to rely on the end user's connection for updates regarding the payment process.
¶ Back Office Payment Recall
When an order is created in the Freedom BackOffice, the UPOs that Nuvei sends back to Freedom can be reused for future Back-Office orders. This allows a Freedom User to make a merchant-initiated transaction on behalf of an end user without having to ask for their Payment information, further increasing the end user's security.
If a decline is received on a payment recall attempt, it can mean that the payment option is no longer valid. As a result, the Freedom User will need to request the payment information for the order as usual.
¶ Configuring Nuvei
To configure the Nuvei Tokenized and Nuvei APM Credit Card Accounts, please see Configuring Nuvei.