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

1. Generate a sessionToken

Press here for details.

3. Send a /payment Request

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

• userTokenId
• amount
• currency
• paymentOption.alternativePaymentMethod class containing:
  • paymentMethod: “apmgw_SSG_Pay“
• deviceDetails class containing: ipAddress
• billingAddress class containing: firstName, lastName, country, email, address, city, state, phone, zip
• userDetails class containing: firstName, lastName, country, email
• items class containing:
  • name
  • price
  • quantity

Example /payment Request

{
  "sessionToken": "<sessionToken from getSessionToken>",
  "merchantId": "<your merchantId>",
  "merchantSiteId": "<your merchantSiteId>",
  "clientRequestId": "<unique request ID in merchant system>",
  "amount": "200",
  "currency": "KRW",
  "userTokenId": "<unique customer identifier in merchant system>",
  "clientUniqueId": "<unique transaction ID in merchant system>",
  "paymentOption": {
    "alternativePaymentMethod": {
      "paymentMethod": "apmgw_SSG_Pay"
    }
  },
  "billingAddress": {
    "firstName": "John",
    "lastName": "Smith",
    "address": "65, Overlea str",
    "email": "[email protected]",
    "phone": "2432432",
    "city": "Seoul",
    "country": "KR",
    "zip": "K0A 0A2",
    "state": "KR-41",
    "identification": "ABCDE1234F",
    "dateOfBirth": "1999-01-01"
  },
  "deviceDetails": {
    "ipAddress": "<customer's IP address>"
  },
  "userDetails": {
    "firstName": "John",
    "lastName": "Smith",
    "email": "[email protected]",
    "country": "KR"
  },
  "timeStamp": "<YYYYMMDDHHmmss>",
  "checksum": "<calculated checksum>",
  "items": [
    {
      "name": "FIFA",
      "price": "50",
      "quantity": "1"
    },
    {
      "name": "GTA",
      "price": "50",
      "quantity": "1"
    }
  ]
}

The response generates and returns a redirect URL (redirectUrl) to redirect the customer to the payment page, as well as a UPO (userPaymentOptionId) for use in future transactions.

Example /payment Response

{
  "internalRequestId": 34773871,
  "status": "SUCCESS",
  "errCode": 0,
  "reason": "",
  "merchantId": "5634436935940029474",
  "merchantSiteId": "242181",
  "version": "1.0",
  "sessionToken": "4aa9d47a-a8f5-419f-ac3a-c23cf8ad01db",
  "orderId": "41421681",
  "userTokenId": "test5634436935940029474",
  "paymentOption": {
    "redirectUrl": "https://gfp-test.erompay.com/v3/ui/payment.html?eromtoken=871810de31bd17d7c7a16f1d18a06522",
    "userPaymentOptionId": "2153078001",
    "card": {}
  },
  "transactionStatus": "REDIRECT"
}

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.

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_SSG_Pay“
• deviceDetails class containing: ipAddress
• billingAddress class containing: firstName, lastName, country, email, address, city, state, phone, zip
• userDetails class containing: firstName, lastName,  country, email

Example createPayment() Request

sfc.createPayment({

  sessionToken: "<sessiontoken>",
  paymentOption: {
    alternativePaymentMethod: {
      paymentMethod: "apmgw_SSG_Pay",
      }     
  },
  deviceDetails:{
    ipAddress:"<customer's IP address>"
  },
  billingAddress: {
    firstName: "John",
    lastName: "Smith",
    address: "65, Overlea str",
    email: "[email protected]",
    phone: "2432432",
    city: "Seoul",
    country: "KR",
    zip: "K0A 0A2",
    state: "KR-41",
    identification: "ABCDE1234F",
    dateOfBirth: "1999-01-01"
  },
  userDetails: {
    firstName: "John",
    lastName: "Smith",
    country: "IE",
    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.