Nuvei Web SDK 2.0 supports the methods and functions appearing on this page.

Initialization

nuveiWebSDK()

nuveiWebSDK – This method initializes the Web SDK.

Example Request

var nuveiWebSDK = webSDK({

  //env: 'int', //  int, prod

    sessionId: 'sid_f3a192a9844545d29a11cbc3e3a46bb2' // received from /orders API response

    support19Digits:true   , // false (default)
    alwaysCollectCvv : 'optional',

    blockCards: ['visa'], / Visa cards are blocked
    onResult: function(res) {

    console.log('onResult callback', res);}}

      );

Input Parameters

Payment Methods

payment()

Use this method to process end-to-end card payments. The method receives any form of cardholder information, tokenized or not, and performs the process to the end, including seamlessly performing any 3D-Secure or PCI requirement.

Before submitting a payment using the client-side Web SDK 2.0, you need to send a server-to-server POST /orders REST API 2.0 request that authenticates your Nuvei merchant credentials and creates a session. For details, press here.

Example Request

function payment() {
  nuveiWebSDK.payment({
    paymentOption: {
      card: {
        cardHolderName: document.getElementById('cardHolderName').value,
      }
    }
    useFields: 'ccNumber'
  }).then(x => console.log(x))
}

Input Parameters

Output Parameters

setOpenAmount()

The setOpenAmount() method is used to set or override the payment amount (in the same currency) from the client side.

You can only call the setOpenAmount() method before calling a payment() request.

Use this method:

• When an amount was not sent in the POST /orders request.
• To change a payment amount (same currency) if you have not called the payment() request yet. For example, whenever the user changes any amount on your payment page.

Call the setOpenAmount() method from the client-side, as shown below.

Example Request

function setOpenAmount() {  

var openAmount = document.getElementById('openAmount').value; nuveiWebSDK.setOpenAmount(openAmount).then(console.log); } 

APMs

getPaymentOptions()

This method returns the APMs supported with all the metadata needed for displaying them to the user and preparing them for processing, such as their display name, logo, required input to collect from the end user, etc. One important parameter it returns for each APM is the APM identifier with Nuvei that you must submit when requesting the payment (with the payment() method).

The getPaymentOptions() method can retrieve either the entire APM set supported by your account with Nuvei or, alternatively, a customized set of APMs. For example, you can request to retrieve APMs corresponding to certain criteria such as by transaction currency or by the user country.

Example Request

function getPaymentOptions()  

{ nuveiWebSDK.getPaymentOptions({ 		 

countryCode: 'US', 		 

currency: 'USD', 		 

includeOptionalFields: false 	 

}).then(console.log);

Input Parameters

Output Parameters

Additional Functions

destroy()

This method is used to remove the payment element from the payment page.

document.getElementById("SfcFields").addEventListener('click', function (ev) {
      ev.preventDefault();
      SfcFields.destroy();
  });