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
• paymentOption.alternativePaymentMethod class containing:
  • paymentMethod: “apmgw_QRIS“
• deviceDetails class containing: ipAddress
• billingAddress class containing: firstname, lastname, country, email
• userDetails class containing: firstname, lastname, country, email

Example /payment Request

{
  "sessionToken": "<sessionToken from /getSessionToken>",
  "merchantId": "<your merchantId>",
  "merchantSiteId": "<your merchantSiteId>",
  "userTokenId": "<unique customer identifier in merchant system>",
  "paymentOption": {
    "alternativePaymentMethod": {
      "paymentMethod": "apmgw_QRIS",
    }
  },
  "currency": "IDR",
  "amount": "100",
  "deviceDetails": {"ipAddress": "<customer's IP address>"},
  "billingAddress": {
    "firstName": "John",
    "lastName": "Smith",
    "email": "[email protected]",
    "county": "ID"
  },
  "userDetails": {
    "firstName": "John",
    "lastName": "Smith",
    "email": "[email protected]",
    "country": "ID"
  },
  "timeStamp": "<YYYYMMDDHHmmss>",
  "checksum": "<calculated checksum>"
}

Example /payment Response

{
"orderId": "39143501",
"userTokenId": "<unique customer identifier in merchant system>",
"paymentOption":
{
"redirectUrl": "https://jumpbox.safecharge.com/dmz/TWOC2PRedirect/PaymentPageProxy.aspx?...",
"card": {}
},
"transactionStatus": "REDIRECT",
"sessionToken": "sessionToken from /getSessionToken",
"internalRequestId": 26441241,
"status": "SUCCESS",
"errCode": 0,
"reason": "",
"merchantId": "<your merchantId>",
"merchantSiteId": "<your merchantSiteId>",
"version": "1.0"
}

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

1. Send a /payments Request

Perform the payment by sending a /payments request. REST 2.0 simplifies authentication and does not require creating a session token before financial transactions.

Mandatory request parameters for QRIS payments:

• buyerDetails.buyerId – Unique customer identifier in the merchant’s system.
• amount
• currency
• paymentOption.alternativePaymentMethod.name = “qris”
• deviceDetails.ipAddress
• buyerDetails class containing:
  • firstName, lastName, email
  • billingAddress.countryCode

Example /payments Request (REST 2.0, QRIS)

{
  "processingEntityId": "<<processingEntityId>>",
  "amount": 10.5,
  "currency": "IDR",
  "paymentOption": {
    "alternativePaymentMethod": {
      "name": "qris"
    }
  },
  "custom": {
    "description": "Some description"
  },
  "deviceDetails": {
    "ipAddress": "203.0.113.45",
    "browser": {
      "acceptHeader": "Y",
      "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/105.0.0.0 Safari/537.36",
      "javaEnabled": false,
      "language": "en-US",
      "colorDepth": 24,
      "screenHeight": 1080,
      "screenWidth": 1920,
      "timeZone": -120,
      "javaScriptEnabled": true
    }
  },
  "buyerDetails": {
    "buyerId": "JohnSmith12443",
    "firstName": "John",
    "lastName": "JSmith",
    "country": "ID",
    "email": "[email protected]",
    "billingAddress": {
      "countryCode": "ID"
    }
  },
  "urlDetails": {
    "webhookUrl": "https://merchant.example.com/webhooks/nuvei"
  }
}

Example /payments Response (Redirect)

{
  "paymentId": "087331e441724a55841b28b98e102438",
  "amount": 10.5,
  "currency": "IDR",
  "transactionType": "Sale",
  "result": { "status": "redirect" },
  "redirectUrl": "https://test.safecharge.com/APMNotificationGateway/TWOC2PRedirect/PaymentPageProxy.aspx?…",
  "paymentOption": {
    "alternativePaymentMethod": {
      "name": "qris",
      "paymentTokenId": "2cb4e096863d415f8acd2335dbc49dea"
    }
  }
}

After the transaction is processed, Nuvei sends a webhook with the transaction result to the URL provided in urlDetails.webhookUrl. REST 2.0 uses webhook notifications instead of Direct Merchant Notification (DMN) and notificationUrl.

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:

• sessionToken
• paymentOption.alternativePaymentMethod class containing:
  • paymentMethod: “apmgw_QRIS“
• deviceDetails class containing: ipAddress
• billingAddress class containing: firstname, lastname, email, country
• userDetails class containing: firstname, lastname, email, country

Example createPayment()

sfc.createPayment({
  sessionToken: "<sessiontoken>",
  paymentOption: {
    alternativePaymentMethod: {
      paymentMethod: "apmgw_QRIS",
    }
  },
  deviceDetails: {
    ipAddress: "<customer's IP address>"
  },
  billingAddress: {
    firstName: "John",
    lastName: "Smith",
    email: "[email protected]",
    country: "ID"
  },
  userDetails: {
    firstName: "John",
    lastName: "Smith",
    email: "[email protected]",
    country: "ID"
  }
}, 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 the URL provided in urlDetails.notificationUrl, which Nuvei recommends including in the /openOrder request.

1. The payment flow begins when the customer selects the QRIS payment method from the payment method gallery.
2. The customer enters the phone, Amount and presses the Deposit button.

Example Payment Page Request

https://ppp-test.safecharge.com/ppp/purchase.do?merchant_id=5970183043540730700&merchant_site_id=238459&user_token=auto&user_token_id=TestQris&item_open_amount_1=false&item_min_amount_1=1&item_max_amount_1=410000&item_name_1=Cashier%20Test%20product&item_amount_1=1000&item_quantity_1=1&item_discount_1=0&numberofitems=1&total_tax=0&discount=0&total_amount=1000.00&currency=IDR&version=4.0.0&encoding=UTF-8&first_name=test&last_name=test&address1=test&city=test&zip=123456&country=ID&phone1=123456&email=Test%40gmail.com&time_stamp=&checksum=6c31e2cae087d71f235b47b0d2ca5425&

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