Follow these steps to perform a payment using Nuvei REST API integration:

1. Generate a sessionToken

Press here for details.

2. Send a /payment Request

Perform the payment by sending a /payment request with its mandatory parameters including:

• userTokenId – Unique customer identifier in merchant system.
• amount
• currency
• paymentOption.alternativePaymentMethod class containing:
  • paymentMethod: “apmgw_AlipayUnified“
• deviceDetails class containing: deviceType, deviceName, deviceOS, browser, ipAddress
• billingAddress class containing: firstName, lastName, email, country
• userDetails class containing: firstName, lastName, email, country

Example /payment Request

{
  "sessionToken": "<sessionToken from /getSessionToken&>",
  "merchantId": "<your merchantId>;",
  "merchantSiteId": "<your merchantSiteId>",
  "clientRequestId": "<unique request ID in merchant system>",
  "amount": "200",
  "currency": "HKD",
  "userTokenId": "<unique customer identifier in merchant system>",
  "clientUniqueId": "<unique transaction ID in merchant system>",
  "paymentOption": {
    "alternativePaymentMethod": {
      "paymentMethod": "apmgw_AlipayUnified"
    }
  },
  "deviceDetails": {
    "deviceType": "TABLET",
    "deviceName": "iPad",
    "deviceOS": "iOS",
    "browser": "safari",
    "ipAddress": "<customer's IP address>"
  },
  "billingAddress": {
    "firstName": "John",
    "lastName": "Smith",
    "country": "HK",
    "email": "[email protected]"
  },
  "userDetails": {
    "firstName": "John",
    "lastName": "Smith",
    "country": "HK",
    "email": "[email protected]"
  },
  "timeStamp": "<YYYYMMDDHHmmss>",
  "checksum": "<calculated checksum>"
}

After the transaction is processed, Nuvei sends a Direct Merchant Notification (DMN) that includes the result of the transaction to urlDetails.notificationUrl, which Nuvei recommends including in the /payment request.

Follow these steps to perform a payment using Nuvei Web SDK integration.

1. Initiate a Session

Before you can submit payment using the client-side Nuvei Web SDK, you need to send the /openOrder API call with its mandatory parameters, and include the deviceDetails class with deviceType, deviceName, deviceOS, browser, ipAddress.

Example /openOrder Request

{
  "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",
  "amount": "200",
  "deviceDetails": {
    "deviceType": "TABLET",
    "deviceName": "iPad",
    "deviceOS": "iOS",
    "browser": "safari",
    "ipAddress": "<customer's IP address>"
  },
  "urlDetails": {
    "notificationUrl": "<URL to which DMNs are sent>"
  },
  "timeStamp": "<YYYYMMDDHHmmss>",
  "checksum": "<calculated checksum>"
}

2. Initialize the Web SDK

Instantiate the Web SDK with the sessionToken received from the server call to /openOrder.

3. Create an APM Payment

Send a createPayment() request with its mandatory parameters including:

• paymentOption.alternativePaymentMethod class containing:
  • paymentMethod: “apmgw_AlipayUnified“
• billingAddress class containing: firstName, lastName,  country, email
• userDetails class containing: firstName, lastName,  country, email

Example createPayment() Request

sfc.createPayment({
    sessionToken: "<sessiontoken>",
    paymentOption: {
      alternativePaymentMethod: {
        paymentMethod: "apmgw_AlipayUnified",
      }
    },
    billingAddress: {
      firstName: "John",
      lastName: "Smith",
      country: "HK",
      email: "[email protected]"
    },
    userDetails: {
      firstName: "John",
      lastName: "Smith",
      country: "HK",
      email: "[email protected]"
    },
  },
  function(res) {
    console.log(res);
  });

After the transaction is processed, Nuvei sends a Direct Merchant Notification (DMN) that includes the result of the transaction to urlDetails.notificationUrl, which Nuvei recommends including in the /openOrder request.