Overview

Nuvei Simply Connect provides an out-of-the-box payment experience, but it also allows you to control the process by setting values on the checkout() input and/or switching certain values on or off.

This page describes some of the many ways you can customize the Simply Connect payment flow.

General

Save Payment Method

You can decide whether to allow users to save their payment method for future use. If this option is set, the user is prompted to save their payment details for future use.

This is done using the savePM input field.

checkout({…
    savePM: true,
…});

Dynamic Currency Conversion

You can use the useDCC input field to enable, disable or force the use of DCC on the payment page.
Possible values for DCC control:

• enable: Enables the checkbox.
• disable: (default): Disables the checkbox.
• force: Enables and selects the checkbox (the customer is still able to unselect the checkbox).

checkout ({…
    useDCC: "enable", //or disable, force
…});

Card Processing

Card Blocking Rules

blockCards – Specifies which sets of cards can be blocked from appearing to the customer in Payment Methods lists.

See Blocking Cards for more information.

checkout({…
    blockCards: [
        ["visa", "credit", "corporate"],
        ["amex", "GB"]
    ], //blocks Visa corporate credit cards, and also blocks British Amex cards
…});

CVV Customization

alwaysCollectCvv – Determines if the CVV is collected also for a stored card, on second or more trial (default is true).

maskCvv – Determines if the CVV digits in the CVV textbox are masked or visible (default is false).

checkout({…
    alwaysCollectCvv: true,
    maskCvv: false
…});

In some cases, a merchant may want to perform an MPI Only request, which means that a payment request is initiated for the 3DS validation, but an actual payment is not made. You can set it using the cardAuthMode input field.

MPI Only

The response for such request:

• Includes the 3D Secure authentication.
• If the request is successful, a result status of AUTHENTICATED is returned (other possible values: DECLINED, ERROR). Please follow the MPI only guide for further details on this flow.

Possible values:

• 3dAuthOnly – Always performs only the 3DS validation (no payment)
• 3dAuthForNewCardsOnly – Performs only 3DS validation, but only for first-time processing (not including UPOs).
• paymentForAll (default) – Performs 3D Secure validation and proceeds to payment automatically.

checkout({…
    cardAuthMode: "3dAuthOnly",
…});

Apple Pay and Google Pay

Google Pay

You can enable Google Pay as a payment method for your customers.

Simply follow the steps in the Google Pay guide (Simply Connect) guide.

• No special configuration code is needed.
• However, if you prefer, we provide a set of powerful customizations which are easy to apply.

Apple Pay

You can enable Apple Pay as a payment method for your customers:

• Contact Nuvei Tech Support to enable the Apple Pay payment provider in your merchant account.
• Set your domain, as described in the Register and Verify Your Domain topic.
• No special configuration code is needed.
  However, if you prefer, we provide a set of powerful customizations which are easy to apply.

APMs

APM Whitelisting/Blacklisting

The APMs supported for your account is set on the Nuvei server-side and, by default, only APMs relevant to the end user are displayed (according to country and currency). However, in some case you may want to override certain APMs for a certain audience, specific users, or a specific user session. This can be done by either whitelisting the APMs you would like to show or by blacklisting the ones you wish to hide:

pmWhitelist – Only the specified APMs are displayed to the customer in the Payment Methods list.

pmBlacklist – The specified APMs are not displayed to the customer in the Payment Methods list, even if they are returned by an API.

checkout({…
    pmBlacklist: ['apmgw_PaySafeCard', 'apmgw_Neteller', 'apmgw_MoneyBookers'],
    // -or- pmWhitelist: ['apmgw_PaySafeCard', 'apmgw_Neteller', 'apmgw_MoneyBookers', 'cc_card'],
…});

APM Fields

Some APMs require additional user fields (such as billingAddress and userDetails) that can be collected from the user during the payment initialization. The merchant can provide these fields to mitigate user friction. If, however, these fields are not provided, this feature prevents the payment from failing by automatically detecting that the fields were not provided and instead collecting them directly from the payment page (see Sepa example):

function main() {
    document.getElementById('checkout').innerHTML = "";
    checkout({
        sessionToken: document.getElementById('session').value,
        env: 'int', // Nuvei API environment - 'int' (integration) or 'prod' (production - default if omitted)
        merchantSiteId: '<your merchantSiteId goes here>',
        merchantId: '<your merchantId goes here>',
        country: 'US',
        currency: 'USD',
        amount: 135,
        userId: '259',
        "billingAddress": {
            "email": "john.smith@email.com",
            "country": "US"
        },
        renderTo: '#checkout', // <div id="container"></div>
        onResult: function(result) {
            console.log("Result", result)
        },
 
        fullName: document.getElementById('cardHolderName').value,
        email: 'john.smith@email.com',
        locale: 'en', // de, es, fr, it, pt, ru
        }
    });
}

apmWindowType

This allows you to specify the window type (popup, newTab, or redirect (modal window)) for the system to redirect the customer to their APM provider. Alternatively, by specifying customRedirect, the system will provide you with the redirectUrl for you to initiate the redirect.
Possible values:

• popup (default): A popup window opens automatically, redirecting the customer to their APM provider’s page.
• newTab: A new tab opens automatically, redirecting the customer to their APM provider’s page.
• redirect: A modal window opens automatically on top of the current payment page, redirecting the customer to their APM provider’s page.
  Note: To use the redirect window type, you must have already provided the urlDetails (e.g. urlDetails.successUrl, etc.) in the /openOrder request, for the system to navigate the customer back to, after leaving the APM provider’s page.
• customRedirect: You (the merchant) must redirect your customer to their APM provider’s page, as follows:
  1. The response from the request will include a redirectUrl.
     Redirect your customer to this redirectUrl using a type of window of your choice, for example, IFrame, popup, a new tab, etc.
  2. Your customer submits their APM details and closes the window.
  3. Check the transaction status either by sending a /getPaymentStatus request, or by setting up a DMN to receive a direct notification, (at the webhook endpoint on your system, which you provided in the urlDetails.notificationUrl in the original /openOrder request).

checkout({
  ...
  apmWindowType: 'newTab', // 'popup' (default), 'redirect', 'customRedirect'
  ...
})

 

Dynamic Payment Amount

Simply Connect allows you to dynamically change the payment amount according to customer input or behavior using Open Order Features, for example the /updateOrder API call to change the actual payment amount, as well as using Simply Connect Event Callbacks,
For example, when a customer:

• Adds or removes purchased products from their shopping cart.
• Or, selects certain payment methods which require additional charges when using their service.

You can use event callbacks such as prePayment(),  selectPaymentMethod(), and onPaymentFormChange() to trigger an /updateOrder API call to update the payment amount.  For example when a customer selects a payment method that requires the addition of a specific “payment method fee”.
For more details, see the list of Simply Connect Event Callbacks.

Changing the amount based on Customer Input

You can set a “hook” on a customer event to trigger a callback function that will update the payment amount.

The following example uses the prePayment() callback to change the payment amount in the order before proceeding the payment, for example to add additional fees required by certain Payment Methods:

• The needToUpdateAmount(paymentDetails) function is used to determine if the original payment amount has changed, (and therefore the payment amount in the order will also need to be updated).
  (The paymentDetails are provided in the input parameters of the prePayment() callback.)
• In a case where the amount needs to be updated, but the customer still needs to agree to the new amount:
  Display an appropriate message informing the customer about the new payment amount, and ask if they wish to proceed.
  • If the customer declines, then use the reject() function to instruct Simply Connect to abort payment, and display the relevant custom error message .
  • If the customer agrees to proceed, then continue:
    1. The updateAmountInUI() function updates the displayed amount.
    2. The callServerSideToUpdateOrder() function passes the decision to your server-side, and then a server-side /updateOrder request is performed to set the new amount.
    3. The resolve() instructs Simply Connect to proceed to payment, (based on the new amount).

Example Simply Connect Code using the prePayment() Callback Function to Change the Amount Based on Customer Input

prePayment: function(paymentDetails) {
  return new Promise(async(resolve, reject) => {

    //you get PM and card details such as name, card type, etc. in paymentDetails.paymentOption.card

    If(needToUpdateAmount(paymentDetails)) //decide if you want to update the amount
      updateAmountInUI();
      callServerSideToUpdateOrder() // openOrder server-side call sample below
      resolve(); // proceed with payment
    //else
      //  reject("<message to the user>");
  });
},

Example /updateOrder Request

{
  "sessionToken": "<sessiontoken received from openOrder>",
  "orderId": "<orderId received from openOrder>",
  "merchantSiteId": "<your merchantSiteId>",
  "merchantId": "<your merchantId>",
  "timeStamp": "<YYYYMMDDHHmmss>",
  "checksum": "<calculated checksum>",
  "currency": "USD",
  "amount": "300",
  "items": [
    {
      "name": "product X",
      "price": "300",
      "quantity": "1"
    }
  ]
}

Open Amount Feature

This feature supports merchants in industries where the payment amount is not known at the beginning of the payment flow, or needs to be updated on the client-side device, for example, in the gambling industry.

The Open Amount feature allows you to:

• Set Amount Limits (min and max) in the /openOrder request.
• Call the setOpenAmount() method (if you have not sent the checkout() request yet).

Set Amount Limits

You can set “payment amount limits” in the /openOrder request by including the openAmount{min,max} object.

Send an /openOrder request with its mandatory parameters, and include an openAmount{min,max} object (and the optional amount), as shown below:

Example /openOrder Request with an openAmount{min,max} Object

{
  "merchantId": "<your merchantId goes here>",
  "merchantSiteId": "<your merchantSiteId goes here>",
  "clientUniqueId": "<unique transaction ID in merchant system>",
  "clientRequestId": "<unique request ID in merchant system>",
  "currency": "USD",
  "openAmount": {
    "min": "1",
    "max": "100"
  },
  "amount": "50",
  "timeStamp": "<YYYYMMDDHHmmss>",
  "checksum": "<calculated checksum>"
}

setOpenAmount() Method

The setOpenAmount() method is used to set/overridden the payment amount (same currency) from the client-side.

Use the setOpenAmount() method when you need to set the transaction amount.
For example, whenever the customer changes any amount on your payment page, etc.

Call the setOpenAmount() method from the client-side, as shown below:
(If you included the openAmount{min,max} object in the /openOrder request earlier, then the system will also validate that the amount falls within the (min,max) “limits”.)

Example setOpenAmount() Request

sfc.setOpenAmount({
     clientRequestId:"<unique request ID in merchant system>",
     clientUniqueId:"<unique transaction ID in merchant system>",     
     amount:"156"
}, function(crRes) {
     console.log(crRes);
});