On this page:
- Release 96 (04 December 2023)
- Release 95 (23 October 2023)
- Release 94 (11 September 2023)
- Release 93 (14 August 2023)
- Release 92 (17 July 2023)
- Release 91 (19 June 2023)
- Release 90 (22 May 2023)
- Release 89 (17 April 2023)
- Release 88 (13 March 2023)
- Release 87 (14 February 2023)
- Release 86 (16 January 2023)
Release 96 (04 December 2023)
Documentation Portal Updates
- Added pasted to the list of possible values under the
onPaymentFormChangeparameter. - Updates throughout the Risk Guide:
- Nuvei Services:
- Removed 3D1 as no longer relevant.
- Added more ECI responses to 3D2 ECI table.
- Fraud Programs:
- Visa Fraud Monitoring Program – Added High-Risk MCCs.
- Added the Visa Digital Goods Merchant Fraud Monitoring Program.
- Mastercard Excessive Fraud Merchant Program – Updated the country list excluded from the program, as well as those countries considered as regulated and non-regulated.
- Added the AMEX Fraud Program.
- Chargeback Programs:
- New page created from Chargeback Reason Codes.
- Added the Visa Fraud Dispute Monitoring Program.
- Card Scheme Compliance Programs:
- The Visa Integrity Risk Program was recently renamed by Visa.
- Chagebacks:
- Added the AMEX Dispute Life Cycle.
- Added the Diners/Discover Dispute Life Cycle.
- In the Dispute Required Documentation under Chargeback Reason Codes and Documentation – Added more details to each code and updated the compelling evidence for each scheme.
- Nuvei Services:
- Added a note to the MIT page regarding the
relatedTransactionId. - Updated the Gateway Filter Error Codes table.
- Add a note to the table for Faster Payments.
- Moved 3DS flows to the appendices of the Apple Pay (REST API) page.
- Added the following APM guides:
- Added the Payment (Deposit) Flow to the Efecty guide.
- Added
merchantAdviceCodeto the DMN Parameters table. - For the Visa Mandate, specified which parameters are mandatory in the
billingAddressandpaymentOptionclasses on the following pages:- REST 1.0
- 3DS MPI-Only REST
- Apple Pay (REST API)
- Google Pay (REST API)
- On the Input Parameters page (Payment Page), changed the mandatory status of relevant parameters in the Customer Details table.
- Added the Display Card Logos section.
- Added the collectUserDetails parameter to the Apple Pay (Simply Connect) page.
- Added a Postman Collection file.
- Added/updated and restructured the Mobile SDKs pages.
- Updated the countries and currencies in the Pay with Cash guide.
- Added “Mastercard Account Billing Updater (ABU)” to the Cashier Features.
- In the iDEAL guide, updated the list of supported banks.
- On the APM Input Fields and APIs page, added apmgw_CoDi to the relevant APM Payments table.
API Reference Guide Updates
- Added
blockPasteCardto theSafeCharge()andcheckout()inputs. - Added the pasted to the list of possible values under the
onPaymentFormChangeparameter undercheckout(). - Update the supported values of the
loglevelparameter under theSafeCharge()andcheckout()inputs. - Added the submitWdRequest() method to Web SDK Methods.
- Added the withdrawal() method to Simply Connect Methods.
- Added
merchantAdviceCodeto the input of/payment,/payout, and/refundTransaction. - Added
sessionCardDeclineLimitto the/openOrderinput. - Added
companyDetailsto the input of/openOrder,/payment,/refundTransaction, and/payout. - Added the
/updateOrderAPI method. - Added the Frontend Tokenization API section (
/cardTokenizationmethod). - Added blockedCards to the list of possible values under the
paymentMethodsparameter under/getMerchantPaymentMethods. - The following parameters were marked as mandatory for the Visa Mandate for the following methods:
openOrder,/payment, the/p2pPayment, and/authorize3d:paymentOption.card.threeD.browserDetails.ippaymentOption.card.threeD.browserDetails.screenHeightpaymentOption.card.threeD.browserDetails.screenWidthpaymentOption.card.cardHolderNamebillingAddress.phonebillingAddress.citybillingAddress.addressbillingAddress.zipbillingAddress.state
- Added a note under
currencyConversionclass in/payoutinput that currency conversion is only supported for credit cards. - Added
showCardLogosundercheckout()inputs.
Release 95 (23 October 2023)
Documentation Portal Updates
- Added the following APM guides:
- Added the Handling In-Process WebView page.
- Added the “RECURRING” attribute to all APM guides.
- In the Payment Transaction Requests page:
- Updated the descriptoin of
productId. - Added a note regarding MD5 encryption being supported.
- Updated the descriptoin of
- Added Version 1.73 to Java SDK page.
- On the Input Parameters page (Payment Page), changed all mandatory fields to optional in the Customer Details table.
- In the Account Details Capture page, added the
urlDetailsclass to the input ofaccountCapture()and toaccountCapture (API). - Added four events to the Tracking Implementation Details section.
- Removed the
cryptogramparameter from DMNs and from any responses. - Added hide to possible values of
autoOpenPmunder Payment Customization input.
API Reference Guide Updates
- Added the
urlDetailsclass to the input ofaccountCapture()and toaccountCapture (API). - Update the description of
addendumsunder/settleTransactionwithl23processingDatasubclass. - Added a note to the
addendumsclass.
Release 94 (11 September 2023)
Documentation Portal Updates
- Added the Examples of Cashier Demo Sites under the Payment Page (Cashier).
- Added the QRIS APM guide.
- Added the following features to the Cashier Features page:
- Added the following features to the Payment Page Features page:
- Removed Ideal, EPS and Sofort from table of APMs supporting recurring on the APM subMethod Class page since these are not currently supported for recurring.
- On the Input Parameters page (Payment Page):
- Added
shippingCompanyName,shippingState, andshippingStreetNumberto the Shipping Details table. - Added
airline_BoardingFee,consumption_tax_amount,tax_amount_base Double, andtip_amountto the Item Details table.
- Added
- On the Static Pay Button (Web SDK) page, added a note about enhancing the
createApplePayPaymentmethod. - Updated the User Experience section in the Interac Instant guide.
- Updated the note regarding Gaming and Gambling merchants in the Payouts page, and added this note to the Google Pay (REST API) and Apple Pay (REST API) pages.
- Added
addApmUpo()andaddCardUpo()to Web SDK Methods. - Added the P2P Payment with Nuvei page.
- On the APM Input Fields and APIs page, added apmgw_QRIS and apmgw_Nequi to the relevant APM Payments tables.
- Added
amountSuggetionsto the Open Amount feature on the Simply Connect Payment Customization page.
API Reference Guide Updates
- Added
productId,customData, andwebMasterIdto/openOrderinput. - Changed field length of
address,addressLine2, andaddressLine3from 60 to 50 throughout. - Added the
l23processingDatasubclass under theaddendumsclass. - Added input fields to the
localPaymentsubclass under theaddendumsclass. - Added the
/p2pPaymentmethod. - Added the
strictCardBlockingfield to theSafeCharge()andcheckout()inputs. - Updated description of
support19digitsunderSafeCharge().
Release 93 (14 August 2023)
Documentation Portal Updates
- In the MobilePay payment flow:
- Added
deviceTypeand a note. - Added
phoneto theuserDetailsclass.
- Added
- Added the Level 2&3 Processing Data page to Addendums.
- Added possible values for
npp_pay_id_typeunder NPP Payout flow (PayID). - Added Version 1.72 to Java SDK page.
- Added
isAFTto the AFT page. - Added the following APM guides:
- Added apmgw_Local_Payments_Indonesia to the table of APMs Supporting
/accountCapture. - Added the Adobe (Magento 2) Headless page for the Magento plugin guide.
- Changed EcoPayz to Payz versus in the relevant APM Payments and APM Payouts tables.
- On the Input Parameters page (Payment Page), added
current_balanceto the Basic Parameters table. - Added the Scan Card feature.
- Added the Payment Method Icon Recommendation feature.
- Added
webpay_personal_idtopaymentOption.alternativePaymentMethodclass in WebPay guide. - Added Colombia Fields appendix to the Local Payment (Installments) page.
API Reference Guide Updates
- Added hide to possible values of
autoOpenPmundercheckout()input. - Added
isAFTto output of/payment,/refundTransaction, and/settleTransaction. - Added
openAmountundercheckout()input. - Added
amountSuggetionsundercheckout()input. - Added
checkout.addUpo()to Simply Connect Methods. - Added
addApmUpo()andaddCardUpo()to Web SDK Methods. - Added
/p2pPaymentmethod.
Release 92 (17 July 2023)
Documentation Portal Updates
- Updated all the content in the Partner Tools menu, including the Marketplaces content.
- Added Version 1.71 to Java SDK page.
- Added Versions section to PHP SDK page.
- In the Paypal guide, updated the note in the Billing Agreements and Reference Transactions that Paypal must provide the merchant with a “PayPal Billing Agreement ID”.
- In the Mazooma guide, added the Developer Notes section.
- In the STPMex guide, added the Bank Codes appendix.
- In the Open Banking guide, added description of two options to the beginning of the Payout Request section.
- In the MobilePay guide, added a note to the introduction regarding the minimum age of 18 requirement.
- Fixed the IP address in the code sample.
- Replaced the old IP ranges with two new IP ranges (194.247.167.0–24 and 87.120.10.0–24) in the following documents:
- Added the following APM guides:
- On the Control Panel Events API page, updated the event structure by removing the message class.
- Removed the Fallback scenario from the 3D-Secure v2 Test Scenarios table.
- Removed HRK from supported currencies on all relevant pages.
- For the Stored Card Credentials feature, added a note to the Display section.
- On the APM Input Fields and APIs page, added apmgw_BancomatPay, apmgw_Satispay, apmgw_Local_Payments_Indonesia, apmgw_Konbini, and apmgw_Clave to the relevant APM Payments tables.
API Reference Guide Updates
- Added
referenceIdtosubMethodclass undercreatePayment()and/payment). - Removed
userTokenIdanddisableNuveiAnalyticsfromcheckout(). - Removed
clientUniqueIdfrom input ofcheckout(),createpayment(), andauthenticate3d(). - In the output of authenticate3d(), updated the introduction text about the response (no DMN is sent).
Release 91 (19 June 2023)
Documentation Portal Updates
- On the Control Panel Events API page, changed “statusCategory” to
ChargebackStatusCategory, and addedReportedAmount,ReportedCurrency, andChargebackReasonCategory. - In the Storing Credentials Yourself section, removed the sentence that
userTokenIdmust be included. - Updated the description of
cardNumberundergetCardDetails(). - Updated the Prerequisites and Notes in the STPmex guide regarding
merchant_unique_id(clientUniqueID). - Added
ipAddressto the “Mandatory User Details” column for apmgw_UPIbyAstropay and apmgw_Netbanking in the relevant APM Payments table. - In the iDEAL guide.
- Updated the list of supported banks.
- Added the Presentation section.
- In the Interac Instant guide, added a note about the format of
clientUniqueIdfor the payment and payout flows. - In the Google Pay (REST API) guide, updated the “Google Pay Brand Promoting Guidelines” under Prerequisites and Notes.
- Removed
binfromcardNumberunder clientGetDccDetails.
API Reference Guide Updates
- Updated the description of
cardNumberundergetCardDetails(). - Updated note in externalToken Class.
- Removed
binfromcardNumberunder clientGetDccDetails.
Release 90 (22 May 2023)
Documentation Portal Updates
- Added
item_shipping_tax_Nandshipping_tax parametersto the Item Details table. - In the OpenCart plugin guide, updated the Supported Versions and Installation sections.
- Updated the Mirakl plugin guide.
- Added possible values to
chargeback.statusCategoryin Chargeback Parameters table. - Updated the Gateway Filter Error Codes table.
- Added
onDeclineRecoveryto the Event Callbacks page. - Added the following Simply Connect Methods:
checkout.deleteUpo()checkout.showDeclined()checkout.showApproved()checkout.showRefresh()
- Added the following APM guides:
- Added the Local Payment (Installments) under Addendums.
- Updated the Self Track topic.
- Added an appendix to the PayPal guide.
- Added logos to all the APM guides.
- Added Versions section to Java SDK page.
- Added “prepaid” to blocking list options.
API Reference Guide Updates
- Updated the
localPaymentsubclass under theaddendumsclass. - Added DINERS and DISCOVER to the
externalSchemeDetailsclass under the input of/openOrderand/payment. - Added the
currencyConversionclass to the input of/openOrder,/payment, and/payout. - Added the
threeDclass under thepaymentOptionclass in the output of/getPaymentStatus. - Removed
merchantIdandmerchantSiteIdfrom the input ofcreatePayment()andauthenticate3d(). - Updated the description of
idunder thesubMerchantclass in the input of/payment,/openOrder,/settleTransaction,/refundTransaction,/voidTransaction, and/authorize3d. - Added
prepaidto output ofgetCardDetails(),checkout.getCardDetails(), and/getCardDetails (API). - Added
bin,last4digits,ccExpMonth, andccExpYearto output ofgetCardDetails()andcheckout.getCardDetails(). - Added geolocation using “detect” to
countryunder input ofgetApms()andcheckout.getApms(), as well ascheckout(). - Updated description of
currencyandcountryundercheckout.clientGetDccDetails(). - Removed
originalAmountandoriginalCurrencyfrom input ofclientGetDccDetails(). - Added
savePmto thepaymentOptionclass under/paymentinput. - Added
onDeclineRecoverytocheckout()input. - Added
themeandpaymentTilestocheckout()input. - Added
showAccountCaptureto the Web SDK Features. - Added “Returns Partial Approval” to under the Cards that Return APPROVED table.
Release 89 (17 April 2023)
Documentation Portal Updates
- Removed the “WooCommerce with Web SDK” page, and renamed and reorganized the WooCommerce plugin guide.
- Removed the “PrestaShop with Web SDK” page, and renamed and reorganized the PrestaShop plugin guide.
- Added
showAccountCaptureto the Additional Functions page. - Google Pay guide:
- Updated Example /initPayment Response – “v2supported”: “false”.
- Removed
cardHolderNamefrom all requests.
- Apple Pay APM guide:
- Updated Example /initPayment Response – “v2supported”: “false”.
- Removed
cardHolderNamefrom all requests.
- Added a note to the Refund guide about instructing the client to wait before requesting a refund again.
- Added DINERS and DISCOVER to brand on the Merchant-Initiated Transactions (MIT) page.
- Added a section about sending a
/payoutrequest to the Visa Checkout (REST API) guide. - Added
rateTypeto the Multiple Currency Pricing (MCP) page. - In the Card Payouts Without an Existing UPO section on the Payout page:
- Added a note regarding Gaming and Gambling merchants.
- Added responses to the two credit card options.
- On the APM Input Fields and APIs page:
- Added apmgw_OVO, apmgw_LinkAja, and apmgw_Shopee_Pay to the relevant APM Payments tables.
- Added
firstName,lastName,country, andemailto the apmgw_NPP row in the relevant APM Payments table. - Added
firstName,lastName,address,city,state,zip,country,phoneto the apmgw_Instant_Bank_Transfer row in the relevant APM Payments table. - Added
firstName,lastName,country, andemailto the apmgw_MobilePay row in the relevant APM Payments table. - Added the Payout Input Fields for apmgw_NPP to the relevant APM Payouts table.
- Added apmgw_Instant_Bank_Transfer to the table of APMs Supporting
/accountCapture.
- Updated links for Java in the Prerequisites for Initialization table.
- On the Zero-Authorization page:
- Added an appendix for
authenticationOnlyTypepossible values. - Added
authenticationOnlyTypeto all relevant flows.
- Added an appendix for
- Added an example
/addUPOAPMrequest for Secure Bank Transfer.
API Reference Guide Updates
- Added
rateTypeto the/getMcpRatesmethod input. - Added
showAccountCaptureto theSafeCharge()input. - Updated note in the introduction of
/getPayoutStatusand changedclientRequestIdfrom Optional to Required in input.
Release 88 (13 March 2023)
Documentation Portal Updates
- Updated screenshots in the Payout User Experience section of the STPMex guide.
- Added
cityto payment flow in the Mazooma guide. - Added
phone,address,city, andzipto payment flow in the PSE guide. - On the APM Input Fields and APIs page:
- Added apmgw_BanContact to the relevant APM Payments table.
- Added
cityto the apmgw_eCheckSelect row in the relevant APM Payments table. - Added
phone,address,city, andzipto the apmgw_PSE_PZ row in the relevant APM Payments table. - Removed MISTERCASH and PRZELEWY from the relevant APM Payments tables.
- Renamed P24 to Przelewy24 in the relevant APM Payments table.
- Added a note regarding
payButtonto the Set Amount Limits feature. - Added the following APM guides:
- Removed the “Magento with Web SDK” page, and renamed and reorganized the Magento 2 plugin guide.
- Added an appendix to the Payout page regarding using the
userDetailsclass with /payout. - Added a link to Google Pay’s developer page regarding payment data cryptography to the Google Pay (REST API) guide.
API Reference Guide Updates
- Added
initialTransactionIdto/createSubscriptionand/editSubscription. - Changed the Rebilling API method names to the actual .do method names.
- Made the following changes in the
localPaymentclass under Addendums Class:- Removed
firstInstallmentandperiodicalInsatallment. - Added description to
numberOfInstallments. - Added
installmentType.
- Removed
- Changed
billingAddressunder/addUPOAPMto be optional. - Updated
firstNameandlastNameto Required under/createUser. - Added
setOpenAmount()(Web SDK Methods) andcheckout.setOpenAmount()(Simply Connect Methods). - Added
clientRequestIdandclientUniqueIdto/verify3dinput. - Added the
userDetailsclass to /payout, including a link to the Payout page. - Added descriptions to the possible values of
authenticationOnlyTypein/openOrderand/payment.
Release 87 (14 February 2023)
Documentation Portal Updates
- In the relevant APM Payments table:
- Removed Klarna_Pay_later, Klarna_Pay_now, Klarna_Slice_it; added apmgw_klarna.
- Added
phone,city,zip,street,country, andstateto apmgw_Netbanking_TW and apmgw_UPI.
- Added the Payout (Withdrawal) Flow section to the Google Pay (REST API) guide.
- Added the Payout (Withdrawal) Flow section to the PIX guide.
- Added example responses and DMNs to payment and payout sections in the Aircash guide.
- On the Input Parameters page (Payment Page):
- Added
withdrawableBalanceto the Basic Parameters table. - Added
suggestedAmount1,suggestedAmount2, andsuggestedAmount3to the Item Details table.
- Added
- Added an example Acknowledgement DMN to the Withdrawal Guide.
API Reference Guide Updates
- Updated the description of
isRebillingin/openOrderand/payment, including clarifying which 3DS flows and payment methods are available for rebilling. - Added the following parameters to
checkout()input:selectUpo,disableDeleteUpoButton,prepopulateApmFields, andreadonlyPrepopulateApmFields. - Added the following methods to Simply Connect Methods: checkout.deleteUpo(), SimplyConnect.showDeclined(), SimplyConnect.showApproved(), and SimplyConnect.showRefresh().
- Added
openAmountclass to/openOrderinput. - Added
openAmounttocreatePayment()input. - Added
minandmaxtocheckout()input.
Release 86 (16 January 2023)
Documentation Portal Updates
- Added the following APM guides:
- In the Okto Cash guide, added that Romania merchants need to send
firstName,lastName,dateOfBirth,email,phone, andidentification. - On the APM Input Fields and APIs page:
- Added
firstNameandlastNameto the “Mandatory User Details” column for apmgw_Open_Banking in the relevant APM Payments table. - Added apmgw_iDeal and apmgw_Open_Banking to the relevant APM Payouts table.
- Added
- Added the APM Integrations and Flows page.
- Corrected “isDecrypeService” to “
isDecryptService” in the DMN Parameters table on the Payment Transaction Requests page. - Restructured and updated the Subscriptions (Rebilling) page.
- Added the following note to three
/paymentresponse examples in the Apple Pay (REST API) page: “TheccCardNumberandlast4Digitsresponse values represent the customer’s real card number.” This note is relevant only for REST merchants. - On the Input Parameters page (Payment Page), added
showMessageKeysto the Basic Parameters table. - Changed the type of
item_min_amount_1anditem_max_amount_1from “Integer” to “Double” in the Item Details table.
API Reference Guide Updates
- Updated the description of
identificationunder theuserDetailsclass throughout. emailis required in the /createUser method.- getCardDetails no longer receives BIN as an input (only card).
- Added
cryptogramandeciProviderunder externalToken Class. - Added
brandandlast4Digitsunder /payment >paymentOption>card. - Added
deviceManufacturerIdentifierunder /payment >deviceDetails.