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
• amount
• currency
• paymentOption.alternativePaymentMethod block containing:
  • paymentMethod: “apmgw_APAC_bank_transfer“
• deviceDetails block containing: deviceType,deviceName,deviceOS,browser ,ipAddress
• billingAddress block containing: firstName, lastName, country, email
• userDetails block containing: firstName, lastName, country, email

Example /payment Request

{
  "merchantSiteId": "<merchantSiteId>",
  "merchantId": "<merchantId>",
  "sessionToken": "<sessionTokenId>",
  "clientRequestId": "<clientRequestId>",
  "timeStamp": "<timestamp>",
  "checksum": "<checksum>",
  "clientUniqueId": "<clientRequestId>",
  "currency": "CNY",
  "amount": "3001",
  "userTokenId": "Abcd1234589155",
  "isRebilling": "0",
  "paymentOption": {
    "alternativePaymentMethod": {
      "paymentMethod": "apmgw_APAC_bank_transfer"
    }
  },
  "deviceDetails": {
    "deviceType": "DESKTOP",
    "deviceName": "deviceName",
    "deviceOS": "deviceOS",
    "browser": "browser",
    "ipAddress": "123.4.5.6"
  },
  "userDetails": {
    "email": "[email protected]",
    "firstName": "John",
    "lastName": "SMITH",
    "country": "CN"
  },
  "billingAddress": {
    "email": "[email protected]",
    "firstName": "John",
    "lastName": "SMITH",
    "country": "CN"
  },
  "dynamicDescriptor": {
    "merchantName": "merchantName",
    "merchantPhone": "merchantPhone"
  }
}

The response generates and returns a UPO (userPaymentOptionId) for use in future transactions.

Example /payment Response

{
"internalRequestId": 43646701,
"status": "SUCCESS",
"errCode": 0,
"reason": "",
"merchantId": "4972436454212160565",
"merchantSiteId": "209631",
"version": "1.0",
"clientRequestId": "20240828104213",
"sessionToken": "9a3e9728-435a-4b7b-8cb3-b82b92f9e7cf",
"clientUniqueId": "20240828104213",
"orderId": "43644451",
"userTokenId": "Abcd1234589155",
"paymentOption": {
"redirectUrl": "https://prod52.t365.io/test-provider/73f0b4d1-c4fd-494b-834f-09cdfee841df",
"userPaymentOptionId": "2153379291",
"card": {}
}
}

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 block containing:
  • paymentMethod: “apmgw_APAC_bank_transfer“
• deviceDetails block containing: deviceType,deviceName,deviceOS,browser ,ipAddress
• billingAddress block containing: firstName, lastName,  country, email
• userDetails block containing: firstName, lastName,  country, email

Example createPayment() Request

sfc.createPayment({
      sessionToken: "<sessiontoken>",
      paymentOption: {
        alternativePaymentMethod: {
          paymentMethod: "apmgw_APAC_bank_transfer",
        }
      },
      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]"
    },
  },
  function(res) {
    console.log(res);
  });

Example Payment Page Request

https://ppp-test.safecharge.com/ppp/purchase.do?checksum=529244c12dc032e44d49f9e89a728d96&item_open_amount_1=true&country=CN&shippingCity=Sofia&personalId=9988979799&customField1=meccabingo.com&customField2=a2db82db-8186-44bb-a6d9-cb9f8f7ea25e&mobileNumber=&item_name_1=Shoes%25201&userid=ScMigrationTest3&isNative=&building=BV+8&ssn=123456789&phone1=%2B&shipping=&shippingCountry=&debit_type=RegularCredit&state=&item_long_description_2=LONG%2520description&zip=M6T+1J1&customField15=rnk_pr01&appReturnLink=&merchant_site_id=209631&allow_special_debit=0&item_shipping_1=0&languageCode=EN&item_min_amount_1=1&encoding=utf-8&version=3.0.0&user_token_id=Siltokenfrgt1wyy65666&docUploadSuccessUrl=https%3A%2F%2Fwww.safecharge.com%2Fpayment-methods&kyc=&allow_installments=1&total_amount=1&parent_url=*&shippingFirstName=First&shippingMail=&item_quantity_1=1&item_amount_1=1&merchantLocale=en_US&merchant_unique_id=97c10831-d399-48d7-8ea5-41f89619d2fa6&gender=&city=&nativeAppFlow=&quick_deposit=&theme_id=&initial_amount=&kycFlow=&merchant_id=4972436454212160565&title=Mr&platform=&docUploadCancelUrl=https%3A%2F%2Fwww.safecharge.com%2Fpayments-engine&admin_area_2=&item_max_amount_1=1000000&currency=CNY&user_token=auto&max_num_installments=12&first_name=John&email=john%40email.com&address.admin_area_2=&shippingZip=6000&InternalUserId=123456789&dynamicDescriptor=test_descriptor&firstDepositConfirmation=&time_stamp=2019-02-28.12%253A01%253A48&shippingLastName=Last&mobileCountryCode=&address1=&item_short_description_1=Short%2520Description%2520of%2520the%2520items%2520&last_name=Smith&dateOfBirth=1985-01-01&shippingPhone=&eKYCType=&userName=Test+Username&rebilling_amount=&item_image_url_1=128306%252F1519143691__.holland_souveniers_shoes.png&shippingAddress=10%252C%2520Cavendish%2520Square&handling=

To perform a payout using REST API integration, you need to use the /accountCapture method before sending the /payout request:

1. Send an /accountCapture request that includes the following mandatory fields as shown in the example request below:
   • userTokenId – Unique customer identifier in merchant system.
   • paymentMethod: “apmgw_APAC_bank_transfer“
   • countryCode – 2-letter ISO country code for a supported country. The country must be where the currency is used.
   • currencyCode – 3-letter ISO currency code for a supported currency.

Example /accountCapture Request

{
  "sessionToken": "8279467b-c12f-4227-aafc-fadbfb6870a9",
  "merchantSiteId": "<merchantId>",
  "merchantId": "<merchantSiteId>",
  "userTokenId": "tokenforapac",
  "paymentMethod": "apmgw_APAC_bank_transfer",
  "currencyCode": "CNY",
  "countryCode": "CN",
  "languageCode": "en",
  "deviceDetails": {
    "ipAddress": "192.206.151.131"
  },
  "notificationUrl": "http://srv-bsf-devppptrunk.gw-4u.com/ppptest/NotifyMerchantTest"
}

The request returns a redirectUrl.

Example /accountCapture Response

{
  "internalRequestId": 43659811,
  "status": "SUCCESS",
  "errCode": 0,
  "reason": "",
  "merchantId": "4972436454212160565",
  "merchantSiteId": "209631",
  "version": "1.0",
  "sessionToken": "8279467b-c12f-4227-aafc-fadbfb6870a9",
  "redirectUrl": "https://ppp-test.safecharge.com/ppp/resources/cdn/v1/bank-details-58820.html?submitUrl=https%3A%2F%2Fjumpbox.safecharge.com%2Fdmz%2FApmConnector%2FbankCapture%2FE70A87670D855991AABC064AD6D26B53&locale=en_CN&pm=APAC+Bank+Transfer",
  "userTokenId": "tokenforapac"
}

2. Use redirectUrl to redirect the customer to Nuvei’s account details capture page.
3. The customer enters account details.
   Nuvei stores the data in a userPaymentOptionId (UPO) identifier, and sends a DMN with the newly created userPaymentOptionId to urlDetails.notificationUrl, which Nuvei recommends including in the /accountCapture request.
4. Send a /payout request and include the userPaymentOptionId, which contains the user’s stored account details. Press here for an example.

After the transaction is processed, Nuvei sends a DMN that includes the result of the transaction to urlDetails.notificationUrl, which Nuvei recommends including in the /payout request.

Example /payout DMN Status=APPROVED

...'ppp_status=OK&Status=APPROVED&ExErrCode=0&ErrCode=0&errApmCode=0&errApmDescription=&errScCode=0&errScDescription=&Reason=&ReasonCode=&PPP_TransactionID=43653171&userid=tokenforapac2&merchant_unique_id=&customData=Silvenam&productId=&first_name=&last_name=&email=&currency=CNY&pmDisplayName=12312312300&customField1=&customField2=&customField3=&customField4=&customField5=&customField6=&customField7=&customField8=&customField9=&customField10=&customField11=&customField12=&customField13=&customField14=&customField15=&invoice_id=&address1=&address2=&country=&state=&city=&zip=&phone1=&phone2=&phone3=&client_ip=&nameOnCard=&cardNumber=&bin=&noCVV=&acquirerId=&expMonth=&expYear=&Token=&tokenId=&AuthCode=&AvsCode=&Cvv2Reply=&shippingCountry=&shippingState=&shippingCity=&shippingAddress=&shippingZip=&shippingFirstName=&shippingLastName=&shippingPhone=&shippingCell=&shippingMail=&total_discount=0.00&total_handling=0.00&total_shipping=0.00&total_tax=0.00&buyButtonProductBundleId=&merchant_site_id=209631&merchant_status=&action=&requestVersion=&message=APPROVED&merchantLocale=&unknownParameters=&payment_method=apmgw_APAC_bank_transfer&ID=&merchant_id=4972436454212160565&responseTimeStamp=2024-08-29.06%3A34%3A23&buyButtonProductId=&webMasterId=&appliedPromotions=&uniqueCC=&transactionType=Credit&externalEmail=&cardCompany=&eci=&user_token_id=tokenforapac2&userPaymentOptionId=2153382301&TransactionID=2610000000000055513&externalTransactionId=8e6c1327-c660-4241-82b6-8182e5806d85&totalAmount=5000.0&dynamicDescriptor=Sil+Descriptor&feeAmount=&houseNumber=&customCurrency=&upoRegistrationDate=20240829&type=DEPOSIT&clientRequestId=&relatedTransactionId=&responsechecksum=5b8f8bcef7362ef70da54ac1848b2e1b&advanceResponseChecksum=55c6ba23cb43763f3e23461b6e103ef7',

Example /payout DMN Status=DECLINED

...'ppp_status=FAIL&Status=DECLINED&ExErrCode=0&ErrCode=0&errApmCode=0&errApmDescription=&errScCode=0&errScDescription=&Reason=Min+amount+is+100000.0&ReasonCode=0&PPP_TransactionID=43654581&userid=tokenforapac4&merchant_unique_id=&customData=Silvenam&productId=&first_name=&last_name=&email=&currency=VND&pmDisplayName=12312312300&customField1=&customField2=&customField3=&customField4=&customField5=&customField6=&customField7=&customField8=&customField9=&customField10=&customField11=&customField12=&customField13=&customField14=&customField15=&invoice_id=&address1=&address2=&country=&state=&city=&zip=&phone1=&phone2=&phone3=&client_ip=&nameOnCard=&cardNumber=&bin=&noCVV=&acquirerId=null&expMonth=&expYear=&Token=&tokenId=&AuthCode=&AvsCode=&Cvv2Reply=&shippingCountry=&shippingState=&shippingCity=&shippingAddress=&shippingZip=&shippingFirstName=&shippingLastName=&shippingPhone=&shippingCell=&shippingMail=&total_discount=0.00&total_handling=0.00&total_shipping=0.00&total_tax=0.00&buyButtonProductBundleId=&merchant_site_id=209631&merchant_status=&action=&requestVersion=&message=DECLINED&merchantLocale=&unknownParameters=&payment_method=apmgw_APAC_bank_transfer&ID=&merchant_id=4972436454212160565&responseTimeStamp=2024-08-29.08%3A16%3A37&buyButtonProductId=&webMasterId=&appliedPromotions=&uniqueCC=null&transactionType=Credit&externalEmail=&cardCompany=&user_token_id=tokenforapac4&userPaymentOptionId=2153382831&TransactionID=2610000000000055555&totalAmount=5000.0&dynamicDescriptor=Sil+Descriptor&feeAmount=&houseNumber=&customCurrency=&upoRegistrationDate=20240829&type=DEPOSIT&clientRequestId=&relatedTransactionId=&responsechecksum=9644e23876b0104ff946d2141cfbd23e&advanceResponseChecksum=9a6616cd5d5b9b89b336b1f43e79ebf6',

Example Payment Page Request

https://ppp-test.safecharge.com/ppp/withdrawal/withdraw.do?checksum=ac210a4dfd12292ec9ce34572c3f6e9a&country=CN&personalId=55807111079&customField1=meccabingo.com&mobileNumber=13094526617&customField3=333&identificationType=NationalId&userid=UID&isNative=&building=BV+8&phone1=%2B14161238888&wd_open_amount=true&identification=4080470885&state=ON&zip=M6T+1J1&appReturnLink=&merchant_site_id=209631&languageCode=PT&version=4.0.0&user_token_id=Siltoken224542ttt65ur68ru&kyc=&phone=%2B14161238888&parent_url=*&merchantLocale=zh_CN&merchant_unique_id=merchant_unique_id&gender=Male&city=Ontario&backUrl=&nativeAppFlow=&theme_id=2634771&kycFlow=&merchant_id=4972436454212160565&title=Mr&showCancelButton=0&wd_max_amount=500000&user_token=auto&first_name=John&email=success%40test.com+&time_stamp=2024-08-26.10%3A22%3A06&mobileCountryCode=054&wd_amount=50&address1=Test+Address&last_name=Doe&dateOfBirth=1990-01-01&eKYCType=&userName=Test+Username&layout=0&wd_currency=CNY&wd_min_amount=10;

After the transaction is processed, Nuvei sends a DMN that includes the result of the transaction to notify_url, which Nuvei recommends including in the Payment Page request.

Example Withdrawal Request DMN wdRequestStatus=Approved

...'wdOrderId=5436961&wdRequestId=6828511&gwTrxId=2610000000000054799&notificationType=WITHDRAW_REQUEST_NOTIFICATION&merchantSiteId=209631&merchantGwId=4972436454212160565&merchantLocale=vi_VN&wdRequestState=Closed&wdRequestStatus=Approved&wdOrderStatus=Settled&settlementType=WITHDRAWAL&gwErrCode=0&gwExtendedErrorCode=0&apmTrxId=2610000000082481&externalTransactionId=c7c1805c-7256-41c1-b93a-26ac2944af76&apmReferenceId=E5DA440407C73FA87800BD0C37888DE1&apmErrorCode=0&firstName=John&lastName=Doe&userTokenId=Siltoken224542tttrrry66&zip=M6T+1J1&city=Ontario&country=VN&phone1=%2B14161238888&email=success%40test.com&address=Test+Address&amount=100000.00&approvedAmount=100000.00&currency=VND&userId=UID&userPMId=2153376761&paymentMethod=apmgw_APAC_bank_transfer&version=1.0&pmDisplayName=12312312300&customField1=meccabingo.com&customField3=333&client_ip=170.40.150.126&wdOrderAmount=100000.00&wdOrderCurrency=VND&responseTimeStamp=2024-08-27.10%3A25%3A04&ExternalaccountID=12312312300&feeAmount=0.0&transactionAmount=100000.0&merchantUniqueId=merchant_unique_id&upoRegistrationDate=20240827&acquirerBank=Transact365-PI&checksum=c59f5560c5dd58186aa20501687a251b',

Example Withdrawal Order DMN wdRequestStatus=Approved

...'wdOrderId=5436961&wdRequestId=6828511&gwTrxId=2610000000000054799&notificationType=WITHDRAW_ORDER_NOTIFICATION&merchantSiteId=209631&merchantGwId=4972436454212160565&merchantLocale=vi_VN&wdRequestState=Closed&wdRequestStatus=Approved&wdOrderStatus=Settled&settlementType=WITHDRAWAL&gwErrCode=0&gwExtendedErrorCode=0&apmTrxId=2610000000082481&externalTransactionId=c7c1805c-7256-41c1-b93a-26ac2944af76&apmReferenceId=E5DA440407C73FA87800BD0C37888DE1&apmErrorCode=0&firstName=John&lastName=Doe&userTokenId=Siltoken224542tttrrry66&zip=M6T+1J1&city=Ontario&country=VN&phone1=%2B14161238888&email=success%40test.com&address=Test+Address&amount=100000.00&approvedAmount=100000.00&currency=VND&userId=UID&userPMId=2153376761&paymentMethod=apmgw_APAC_bank_transfer&version=1.0&pmDisplayName=12312312300&customField1=meccabingo.com&customField3=333&client_ip=170.40.150.126&wdOrderAmount=100000.00&wdOrderCurrency=VND&responseTimeStamp=2024-08-27.10%3A25%3A04&ExternalaccountID=12312312300&feeAmount=0.0&transactionAmount=100000.0&merchantUniqueId=merchant_unique_id&upoRegistrationDate=20240827&acquirerBank=Transact365-PI&checksum=3f2c92daeb5c6e67193ff29753baad19',