On this page:
- Release 76 (11 April 2022)
- Release 75 (28 February 2022)
- Release 74 (07 February 2022)
- Release 73 (10 January 2022)
- Release 72 (6 December 2021)
- Release 71 (8 November 2021)
- Release 70 (11 October 2021)
- Release 69 (23 August 2021)
- Release 68 (26 July 2021)
- Release 67 (28 June 2021)
- Release 66 (31 May 2021)
- Release 65 (10 May 2021)
- Release 64 (5 April 2021)
- Release 63 (9 March 2021)
- Release 62 (9 February 2021)
- Release 61 (14 January 2021)
Release 76 (11 April 2022)
Documentation Portal Updates
- Added noButton to
payButton
to checkout() Input Parameters. - Updated description of
merchantName
underdescriptor
in/createSubMerchant
Input Parameters. - In PayPal guide:
- Added a section on Error Handling.
- Added note to Billing Agreements and Reference Transactions regarding risk requirements.
- Added definition for ECI=7 for Mastercard in the Payment Page Output Transaction Parameters and DMN Parameters.
- In the APM Input Fields and APIs topic, added apmgw_Local_Payments_Vietnam, apmgw_Local_payments_Africa, apmgw_AlipayHK, apmgw_Dana, apmgw_GCash, apmgw_KaKaoPay, apmgw_TouchnGo, apmgw_Truemoney, apmgw_DragonPay, apmgw_eNETS to the APM Payments (deposits) table.
- Added a new dedicated menu for all APM documentation.
- On the APM documentation page, added the following APM guides: PIX, PIX Payouts, Alipay HK, Dana, GCash, India Payouts, KakaoPay, TouchnGo, TrueMoney, Dragonpay, Enets, and SEPA Payouts.
- In the Apple Pay guide:
-
Corrected steps in the Registering with Apple Pay page.
-
Corrected steps in the Apple Pay Integration Testing page.
-
Added the Apple Pay Guide (Checkout) page.
- Updated steps in the following pages:
-
- Updated steps in the Google Pay Guide (Web SDK) page.
- Added Google Pay button customizations to the Google Pay Guide (Checkout) and corrected the transaction flow.
-
Added the Set the Open Amount step to the DCC in Web SDK Workflows page.
- For the 3D flow, added missing relatedTransactionId parameter in
/initPayment
and added steps to call /initPayment (for 3D purposes) in the following pages: -
Added the Payout (Withdrawal) and the Generating UPOs sections to the ACH Guide.
- Added the External Authorization Addendum page.
- Added the Checkout SDK Demo to the Checkout Quick Start.
API Reference Guide Updates
- Added the checkout.submitPayment method.
- Added noButton to
payButton
under checkout(). - Under
/payment
, changeduserDetails
to Conditional and added a note about APMs. - Under
/openOrder
input, changedisRebilling
to Conditional and updated the notes. - Added ECI=7 for Mastercard under
authenticate3d()
and threeD Output Class.
Release 75 (28 February 2022)
Documentation Portal Updates
- Under the Alternative Payments page, edited the following APM integration guides, changed “apmgw_Interac_Instant” to “apmgw_INTERAC_Instant” in Interac Instant Guide.
- In the APM Input Fields and APIs topic, changed “apmgw_Interac_Instant” to “apmgw_INTERAC_Instant”.
- Under the Checkout topic:
- Added
maskCvv
,useDCC
,cardAuthMode
,pmSelected
, andupoDeleted
to checkout() input table. - Added
checkout.destroy()
to Advanced Controls page.
- Added
API Reference Guide Updates
- Added the following fields/callbacks to
checkout()
:maskCvv
,useDCC
,cardAuthMode
,pmSelected
, andupoDeleted
. -
Added the following methods to Checkout Methods:
checkout.applyOverlay()
,checkout.removeOverlay()
,checkout.getToken()
,checkout.getToken()
, andcheckout.destroy()
. - Added a note that
/getPayoutStatus
supports payouts performed by credit card and APM.
Release 74 (07 February 2022)
Documentation Portal Updates
- Under the Alternative Payments page, added the following APM guides:
- Added WIX to the Plugins guide page.
- Added External Subscription Support to the Cashier Features topic.
- Under the Alternative Payments page, edited the following APM integration guides:
- Added Mazooma to the Capturing Account Details table
- Added Account Capture section to the Mazooma Guide.
- Added the Bank Transfer (ACH) – Payment (Without UPO) – For Web SDK topic.
- Added support for Checkout and updated Web SDK topics in the ACH Guide.
- Added the VIP Pref. (Web SDK/Checkout) page.
- Added the Payment with externalMPI topic to the Google Pay Guide (REST API) page.
- In the APM Input Fields and APIs topic, added apmgw_exito, apmgw_Banco_Nacional, apmgw_UPI, apmgw_Netbanking_TW, apmgw_South_Korea_LocalCards, and apmgw_OKTO_CASH to the APM Payments (deposits) table.
- Updated the link to NuGet.
- Updated the Calculating Request Checksums and Calculating DMN Checksums section in the Withdrawals Guide.
- Updated the Authentication topic.
API Reference Guide Updates
- Removed
isLiabilityOnIssuer
fromauthorize3d()
. - Added a note to
browserDetails
under the threeD Input Class thatbrowserDetails
should not be sent in/openOrder
. - Updated the definition of
merchantName
underdynamicDescriptor
for PayFac. - Updated the
/enrollAccount
method to include With Account Funding.
Release 73 (10 January 2022)
Documentation Portal Updates
- Fixed all instances of “dsTransId” to “
dsTransID
“. - Updated the Configuring the Events API page.
- Added SAP to the Plugins guide page.
- In the APM Input Fields and APIs page, added Fonix to the APM Payments (deposits) table.
- Under the Alternative Payments page, added the following APM guides:
- Under the Alternative Payments page, edited the following APM integration guides:
- Added the Recurring Transactions section to the Dynamic Apple Pay Button Integration Guide.
- Added the recurring payments flow to the REST Payments appendix in the Google Pay guide.
- Updated the PlayPlus Guide (REST) to support the “Rescue journey flow”:
- Added the Enroll (Direct) – (NewRequestWithFunding) section.
- Updated the /enrollAccount (Direct) section and added Example
/enrollAccount
Request (Direct)(NewRequestWithFunding).
- Added Example JSFiddle – Web SDK and Example JSFiddle – Checkout to the VIP Preferred Guide.
- Updated the Web SDK JSFiddle example and the Checkout JSFiddle example in the Google Pay Guide.
- Added
prePayment
to checkout() Input Parameters.
API Reference Guide Updates
- Fixed all instances of “dsTransId” to “
dsTransID
“. - Added
prePayment
function to checkout() input.
Release 72 (6 December 2021)
Documentation Portal Updates
- In the APM Input Fields and APIs page, added input fields to eCheckSelect in the APM Withdrawals (payouts) table.
- In the Mazooma Guide:
- Updated the Generating UPOs section to include sending an
/addUPOAPM
request by includingaccountID
. - Updated the Example Payment DMNs and Example Payout DMNs sections to include
apmPayerInfo
.
- Updated the Generating UPOs section to include sending an
- Added Theme Type to the Cashier Features topic.
- Added the Web SDK Payment (deposit) and Checkout Payment (deposit) flows to the Google Pay guide.
- Updated the Gateway Filter Error Codes and Gateway Decline Reasons tables on the Error Handling page.
- Updated airline addendum field attributes in the Airline Request Addendum Parameters table.
- Added Triggering a Frictionless or Challenged Flow to the Testing Cards page.
Release 71 (8 November 2021)
Documentation Portal Updates
- Under the Alternative Payments page, added the following APM integration guides:
- Under the Alternative Payments page, edited the following APM integration guides:
- Added Web SDK and REST API to the Open Banking Guide.
- Added Web SDK to the PlayPlus Guide.
- Updated the banking details in the /payout DMN response in the Mazooma Guide.
- Updated the Install the iOS Mobile SDK section on the iOS Mobile SDK page.
- On the Checkout page under checkout() Input Parameters:
- Added
textDirection
for left-to-right support. - Added
onReady
function. -
Changed
strict
tostrictDcc
. - Added
userId
and thebillingAddress
,shippingAddress
,userDetails
, andclientUniqueId
classes.
- Added
API Reference Guide Updates
- Removed
cvv
paymentOption.card
under/initpayment
. - Added
removeOverlay()
to the Checkout section. - Added “Payment with UPO” JSON scenario to
/payment
. - Changed
strict
tostrictDcc
undercheckout()
and made it a Boolean field. - Added
clientUniqueId
,userId
, and thebillingAddress
,shippingAddress
, anduserDetails
classes tocheckout()
. - Added the Advanced APM Integration section that included five new methods.
- Added
textDirection
for left-to-right support tocheckout()
. - Added
onReady
function tocheckout()
.
Release 70 (11 October 2021)
Documentation Portal Updates
- Added note to the Callbacks (DMNs) guide that Nuvei now supports Paypal for pre-deposit.
- In the APM Input Fields and APIs topic:
- Added input fields to PaySafeCard in the APM Withdrawals (payouts) table.
- Added Interac_Instant to both tables.
- Added apmgw_P24, apmgw_SafetyPay_Online, and apmgw_SafetyPay_Cash to the APM Withdrawals (payouts) table.
-
Deleted the existing entry for apmgw_Open_Banking from the APM Payments (deposits) table.
-
Added apmgw_Open_Banking and apmgw_Finnish_Banks to the APM Payments (deposits) table.
- Added the missing mandatory user details to apmgw_Faster_Payments in the APM Withdrawals (payouts) table.
- Under Pre-chargeback Inquiry, added
eventCorrelationId
to the example and addedeventDateUTC
to the parameter table. - Added the
showCancelButton
parameter to the Redirection Parameters table. - Added the plugin download link in each of the respective plugin pages.
- Added the following features to the Cashier Features topic:
- Added
alwaysCollectCvv
to Checkout() Input Parameters table and updated the request example. - Added a section for case when the merchant performs the decryption for Apple Pay.
- Under the Alternative Payments page, added the following APM guides:
- Updated the Subscription Management section on the Subscription (Rebilling) page including adding a note that Nuvei’s subscription (rebilling) plan service now supports PayPal, GooglePay and Apple Pay accounts.
-
Updated the PayFac endpoint URLs in the Onboarding a Sub-merchant section on the Payment Facilitators (PayFac) page.
-
In the Error Handling page, added missing Error Codes to the the API Response Codes and Gateway Filter Error Codes tables.
- Added references to the Checkout page in the relevant sections in the Payment Scenarios page.
- Added the APM with createPayment and getAPMs scenario to the Web SDK Scenarios page.
- Added apmgw_BankPayouts to the supported APMs table in Capturing Account Details.
API Reference Guide Updates
- Updated and reorganized the Cashier Implementation topic.
- Added the
listValues
parameter to:- The
paymentMethods
array (output) under the getApms() method. - The
paymentMethods
array (output) under the /getMerchantPaymentMethods method.
- The
- Added the
identification
parameter to theuserDetails
class under /payout input.
Release 69 (23 August 2021)
Documentation Portal Updates
- Added the following features to the Cashier Features topic:
- Updated the supported APMs table in Capturing Account Details.
- Added the Configuring the Events API topic.
- Added the Rebilling with PrestaShop topic for the PrestaShop plugin.
-
In the Merchant-Initiated Transactions (MIT) page, deleted the “single-letter” values for
brand
. - Updated Checkout for “DCC Allowed” and
strict
. - Updated DCC in Web SDK Workflows page.
- Updated DCC in REST API Workflows page.
- Updated the Blocking Cards topic to the Features menu.
- Updated the Submit Subsequent MIT Payments section.
-
Added the Checkout Example page under the Checkout page.
- In the APM Input Fields and APIs topic:
- Removed “Secure Bank Transfer” from the APM Withdrawals (payouts) table.
- Removed “eCheck” from both tables.
- Removed “buyerAreaCode” and “buyerMobile” from the APM Withdrawals (payouts) table.
- Added “Faster Payments” to the APM Withdrawals (payouts) table.
- Added “Afterpay”, “Clearpay”, “Visa by Astropay”, “PayNearMe”, “Western Union Panama”, and “MercadoPago” to the APM Payments (deposits) table.
- Added the “PayNow” (redirect) to both tables.
- Updated the APM Countries and Currencies topic.
-
Removed references to Nuvei internal configuration steps from the Payment Facilitators (PayFac) topic related to these fields:
-
merchantsOnboarding
=subMerchant
-
Template has the attribute:
isSubMerchantTemplate
=true
-
-
In the Gateway Filter Error Codes table, added GW error code 1277.
- Updated the Risk Guide:
- Appendix 2: Updated list of CFT supported and blocked countries as per latest schemes regulations.
- Appendix 5: Added a new section Diners/Discover.
API Reference Guide Updates
- Added
cardType
andcardBrand
to output parameters of /payment and /authorize3d. - Added new
identification
parameter touserdetails
under createPayment(), authenticate3d(), /openOrder, /payment, and /authorize3d. - Under checkout() and SafeCharge(),
blockCards
can now be used per country. - Added descriptions to all the fields in the
airlines
addendum under the addendums Class. - Added new method /getPayoutStatus to Payment APIs.
- Added clientGetDccDetails() method to Web SDK Methods.
- Added
dccFullSupport
to /getDccDetails. - Added
strict
to checkout(). - Added new method accountCapture() to Web SDK Methods.
Release 68 (26 July 2021)
Documentation Portal Updates
- Replaced the definition of ECI throughout the documentation portal.
- On the Web SDK Additional Functions page, changed the content of the Authorization-Only section from steps for server-to-server to steps for Web SDK.
- On the Testing Cards page, added the “FL-BRW1-EXMPT” testing scenario to the
cardHolderName
Scenario Codes table. - Moved the Mangento 1 topic to an appendix since Magento has discontinued support to Magento 1.
- Added a note regarding the recommended value of
rebillExpiry
to the Merchant-Initiated Transactions (MIT) topic. - Added a note that Void supports APMs such as Paypal.
- In the Zero-Authorization topic, added the Zero-Auth for Non-3D Tokenization with a Low PCI Level section.
- In the APM Input Fields and APIs topic:
- Corrected name of “apmgw_Astropay” to “apmgw_AstroPay” in the APM Withdrawals (payouts) table.
- Updated the details of “Secure Bank Transfer” in the APM Payments (deposits) table.
- Renamed “Express-Connect” to “eCashout” in the APM Withdrawals (payouts) table and removed it from the APM Payments (deposits) table.
-
Added explanation that fields should be included in the as “name-value pairs” (if needed) in the
apmData
block when calling the/addUPOAPM
or/editUPOAPM
methods. - In the APM Payments (deposits) table, updated “Interac_Combined”:
- In the “Mandatory User Details” column, deleted “IP”.
- In the “Mandatory User Details” column, added “billingAddress.” to
firstName
andlastName
.
API Reference Guide Updates
- Under the threeD Input Class class, added a note regarding the recommended value of
rebillExpiry
to thev2AdditionalParams
subclass. - Added a note that the /voidTransaction method supports APMs such as Paypal.
Release 67 (28 June 2021)
Documentation Portal Updates
- Added Shopify via AsiaBill to the Plugins guide page.
- Updated the Handling Stored Credentials Yourself section on the Card-on-File page.
- In the Testing Cards page, replaced the “NameOnCard” parameter name with “cardHolderName”.
- Updated content of the 3D-Secure Guide.
- Added the Web SDK Flow using ReactJS guide.
- Added the Google Pay integration guide.
- Added the following features to the Cashier Features page:
- In the Zero-Authorization page:
- Added the Zero-Auth with Web SDK topic (for USA merchants).
- Added the Zero-Auth for Merchants with a Low PCI Level topic.
- Added the Website Compliance Guides page.
- Added the Rebilling with WooCommerce topic for the WooCommerce plugin.
- In the Navigation Parameters table (under Payment Page > Input Parameters), updated a (case-sensitive) parameter from
"quick_Deposit"
to"quick_deposit"
.
API Reference Guide Updates
- Added possible values to
cvv2Reply
andavsCode
under /payment and /authorize3d responses.
Release 66 (31 May 2021)
Documentation Portal Updates
- Added the VISA Checkout via REST API guide under the Alternative Payments page.
- Added the Account Details Capture topic under the Alternative Payments page.
- Added the Multiple Currency Pricing (MCP) guide for Web SDK and REST API.
- Added the Blocking Cards topic to the Features menu.
- Added the Blocking Cards topic to the Web SDK Additional Functions page.
- Updated various APM parameters in the APM Input Fields and APIs page.
- Updated the content in the following 3D-Secure pages:
- Added Salesforce plugin under the Plugins page.
- Updated Neteller credentials in the Testing APMs topic.
- In the Merchant-Initiated Transactions (MIT) page, a correction was made in the Transactions Originally Initiated by Another PSP topic, which describes requirements for submitting a “subsequent MIT (merchant-initiated-payment) transaction”, where the preceding initial MIT transaction was submitted by another PSP (acquirer).
In such a case, the documentation previously stated: “Include either therelatedTransactionId
field or theexternalSchemeDetails
block…”.
This has been changed to state: “Include theexternalSchemeDetails
block…”. - Added two sections to the Zero-Authorization topic.
API Reference Guide Updates
- Updated description of
pmWhitelist
,pmBlacklist
, andblockCards
under checkout(). - Updated description of
blockCards
under SafeCharge(). - Updated description of
currencyConversion
under /openOrder and /payment.
Release 65 (10 May 2021)
Documentation Portal Updates
- Added the Rebilling topic to the Magento Plugin Guide.
- Added support for DCC in Web SDK Workflows, (which includes a description of the new Web SDK
clientGetDccDetails
method). - Added support for DCC in Checkout.
- Added the Simplified Apple Pay Setup for Apple Pay Mass enablement.
- Added support for subMethods used for:
- Added support for
challengePreference
andexemptionRequestReason
in theexternalMpi
block, affecting these topics: - Added support for getCardDetails for Web SDK.
- Updated details for Astropay in the APM Input Fields and APIs topic.
API Reference Guide Updates
- Added SafeCharge() method to Web SDK Methods.
- Added
pmWhitelist
,pmBlacklist
, andblockCards
under checkout(). - Added
subMethod
andsavePM
under checkout(). - Under /payment, corrected subMethodDetails to
subMethod
and updated subfield descriptions. - Added
subMethod
class to createPayment(). - Added note to
billingAddress
under /payment for cross-border Visa Direct OCT to/from Canada. - Added getCardDetails() method to Web SDK Methods.
Release 64 (5 April 2021)
Documentation Portal Updates
- Added the new Checkout integration topic, and its supporting Payment Form Styling topic.
- Expanded the Payment Facilitators (PayFac) integration topic to include these new sections:
API Reference Guide Updates
- Added the checkout() method under Web SDK methods.
Release 63 (9 March 2021)
Documentation Portal Updates
- Removed these topics from the 3DS Implementations:
- 3D-Secure-Only Transaction (MPI) – Nuvei as the 3D-Secure Provider
- 3D-Secure-Only Transaction (MPI) – Another PSP as the 3D-Secure Provider
- Added these topics to the 3DS Implementations:
- Updated the 3D-Only (MPI only) workflow in the Payment Scenarios topic. It now references the 3DS MPI-Only REST integration.
- Added a comprehensive Other Functions provided by the Web SDK topic to Quick Start for Web SDK.
- Added 3D-Secure Fingerprinting topic, split from the “3D-Secure Fingerprinting and Authentication Challenges” topic.
- Added 3D-Secure Authentication Challenge topic, split from the “3D-Secure Fingerprinting and Authentication Challenges” topic.
- Added 3D-Secure Response Values topic, containing these tables:
- Added the new Android Mobile SDK integration topic.
- Added the new iOS Mobile SDK integration topic.
API Reference Guide Updates
- Added externalMpi class under Class Objects.
- Removed the Checkout Page topic and left a reference to the Payment Page topic.
- In
isRebilling
under /openOrder and /payment, changed that sendingrelatedTransactionId
is mandatory for both card and UPOID. - In /openOrder, changed
deviceDetails
to optional (ipaddress
is no longer “Required”). - In PHP request example under Payout, changed “getPaymentService” to “getPayoutService”.
Release 62 (9 February 2021)
Documentation Portal Updates
- Expanded the Tokenization-Only topic in Web SDK Additional Functions to include the tokenization steps.
- Updated some of the flows and test cards in the Testing Cards topic.
- Added “3D-Secure authentication failed, payment not allowed” to the Gateway Decline Reasons table in the Error Handling topic.
- Added an “On This Page” table to most pages in the Documentation Portal, to improve end-user experience.
API Reference Guide Updates
- Changed
languageCode
from String(5) to String(2) in /accountCapture and getApms() because the system accepts a 2-letter language code. - Removed
partialApprovalDetails
class from/payment output and replaced with thepartialApproval
class. - Added
amount
andcurrency
parameters to the/getPaymentStatus
method examples. - Added
partialApproval
class to /payment output. - Removed userTokenId from createPayment and authenticate3d.
- Added
cascadedTo3Dv1
to threeD Output Class.
Release 61 (14 January 2021)
Documentation Portal Updates
- Updated the ECI value returned from the Authorize 3D-Secure request in the following topics in the Risk Guide: ECI and Exceptional Cases topics. Also in the Callbacks (DMNs) guide in the DMN Parameters section.
- Restructured the 3DS Authentication Flows: Restructured and rewrote the topic and added mini TOC for readability.
- Restructured the APM Input Fields and APIs topic: Restructured and rewrote the page and added mini TOC for readability.
- Updated to the Merchant-Initiated Transactions (MIT) topic for MITs initiated by another PSP –
externalSchemeDetails
. - Added Fast Bank Transfer Payment Method as an APM, to the APM Input Fields and APIs table and restructured the rest of the topic.
- Added missing error codes to the API Response Codes table in the Error Handling topic.
- Added the new Mirakl Plugin topic in the Guides > Plugins menu, to link to the Smart2Pay Mirakl Plugin for Marketplaces page.
- Included the
ccTempToken
field in the Server-to-Server integration for accepting payments examples: Example of authenticate3d() response and the Example of Payment without Liability Shift.
API Reference Guide Updates
- Under threeD Input Class, changed accepted values of
javaEnabled
andjavaScriptEnabled
(underbrowserDetails
) from Y/N to TRUE/FALSE. - Added /accountCapture method.
- In /verify3d, removed APM option.
- Added
externalSchemeDetails
class to /openOrder. - Added
authenticationOnlyType
parameter to /payment. - Added /getCardDetails method (under DCC Methods).
- Replaced DMNs parameter table in DMNs with link to the table in the Callbacks (DMNs) Guide.
- Added
mpiChallengePreference
under Additional Class Parameters (under threeD Input Class) and updated description forchallengePreference
. - Added ECI value for MC for “Payment authentication was not performed” for all relevant instances of
eci
. - Added the
currencyConversion
class to /openOrder and /payment. - Added addendums class to Class Objects and linked other addendum instances to the class.
- Added
ccTempToken
to authenticate3d() output. - Added
deviceDetails
to /verify3d.