Payment Scenarios

On this page:

Overview

Nuvei supports several payment flows to accommodate a range of merchant payment models.

For example, some merchants require a one-time payment to charge their customers, while others have subscriptions based on recurring payment. In addition, many merchants handle 3D-Secure differently.
This page summarizes the main merchant payment flows:

If you need a workflow not mentioned on this page, please contact our Support Team for assistance.

Merchant Requirement

I would like Nuvei to control my 3D management (to process 3D-secure).

I would like Nuvei to manage all aspects of the 3D-Secure workflow, and avoid the implementation complexities (e.g. when to process with 3D-Secure and which 3D-Secure version to use, how processing differs between the two 3D-Secure versions, when and how to perform 3D-Secure fingerprinting, when and how to perform challenge, etc.

Nuvei Solutions

  • Using the Checkout Page (seamless integration).
  • Using the Web SDK:
  • Using API:
    • When a 3D challenge is required, after presenting the challenge to the customer, send a liability-shifted payment and include the relatedTransactionId field containing the initial 3D-Secure payment_id.
    • When a 3D challenge is not required, then send a 3D-Secure /payment request and include the threeD JSON block containing the 3D data.

    For details, see 3D-Secure Explained and the 3D-Secure How-To Guide.

Always 3D

Merchant Requirement

I would like to perform 3D transactions only. If a payment request fails the 3D-Secure authentication, then abort the payment and don’t continue processing any transaction.

Some merchants wish to perform 3D-Secure transactions only.

Nuvei Solution

This is a sub-case of the Manage 3D-Secure scenario (described above), which does not continue processing the transaction if the 3D authentication fails.
(In the standard the Manage 3D-Secure scenario, if 3D authentication fails (e.g. if the cardholder or issuer is not registered for 3D-Secure), then the system will continue to process the payment as a non-3D transaction.)

This option will become obsolete in the near future, when 3D-Secure becomes mandatory for all card schemes.

Non-3D

Merchant Requirement

I would like to make a simple non-3D-Secure transaction.

This is relevant to merchants who operate in parts of the world that do not support 3D-Secure.

Nuvei Solutions

  • Using the Checkout Page (seamless integration)
  • Using the Web SDK:
    • Using the createPayment() method.
    • See the Web SDK Quick Start

      Before using Web SDK for non-3D payments, you must contact Nuvei and have them configure your account for the non-3D payment flow.

  • Using API:
    • Send 3D-Secure /payment requests without the threeD JSON block.

3D-Only (MPI only)

Merchant Requirement

I would like to run authorizer/authenticate 3D.

I would like to use Nuvei’s 3D-Secure authorization and authentication services only, and then continue to process the transaction with another payment provider.

Nuvei Solutions

Liability Shift Payment (External MPI)

Merchant Requirement

I want to run a liability-shifted transaction using 3D authentication that I received with my (external) MPI provider.
Some merchants prefer to receive the 3D-Secure service from a different party (e.g. having one 3D-Secure provider and multiple payment providers).

Nuvei Solutions

  • Checkout Page – Not applicable
  • Web SDK – Not applicable
  • Using API:

Merchant Initiation Transaction (MIT) / Recurring

Merchant Requirement

I would like to manage a recurring plan on my system.

Nuvei Solutions

Nuvei offers seamless integration solutions to manage your recurring payment system on your behalf. These solutions conform to all the relevant rules prescribed by the various card schemes.

However, if you prefer to “self-manage” your recurring payment system, we also provide the full range of services needed to do that. For example, you can tokenize payment methods, perform MITs, “Add a Card” to a customer account without performing a transaction (using the Nuvei User Payment Option management (UPO)), etc.

Steps

Processing recurring payments involves initiating “recurring payment” facility in the first payment request, followed by any number of subsequent payment requests.

Step 1: Initiating a Recurring Session
  • Using the Checkout Page (seamless integration).
  • Using the Web SDK:
    • Using the createPayment() method. Prior to calling the createPayment(), you need to set the recurring flags on the server-side /openOrder API call:
      • isRebilling”: “0” to mark it to as initializing a recurring session.
  • Using API:
    • /payment with recurring flags.
      • isRebilling”: “0” to mark it to as initializing a recurring session.

With MITs or recurring initiating payments, you need also to choose how you handle 3D-Secure, and therefore how they need to be combined with any of the 3D scenarios mentioned above.

Step 2: Performing subsequent Recurring Payments
  • Checkout Page – Not applicable
  • Web SDK – Not applicable
  • Using API:
    • /payment: With the relatedTransactionId of the initiating payment request in Step 1.
      Also provide the userPaymentOptionId retrieved from the initiating payment request, which represents the customer payment option for charging.
    • /payment: With any of the above scenarios and with rebilling fields, not using UserTokenId
    • Web SDK: createPayment(), rebilling fields are set via /openOrder.
Step 3:
  • Using the /payment method with the relatedTransactionId, not using UPO.
  • Web SDK: Not supported by Web SDK, only Server-to-Server.

You can work with a full workflow using the “Recurring (with 3D-Secure)” example, which can be found in the Nuvei Postman collection. To access the example, import the JSON file (provided in the link), into Postman and follow additional instructions in Testing APIs with Postman.


Alternative Payment Methods (APMs)

Merchant Requirement

I would like to process APMs with Nuvei.

Nuvei Solutions

  • Using the Checkout Page (seamless integration).
  • Using the Web SDK:
    • See Web SDK APMs.
    • Using the createPayment() method, providing the alternativePaymentMethod JSON block with the relevant payment method details. You can also use the getAPMs() method to retrieve the relevant APMs for the customer.
    • The function will automatically redirect the customer for the completion of the payment.
  • Using API: