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 85 (19 December 2022)
- Release 84 (14 November 2022)
- Release 83 (24 October 2022)
- Release 82 (19 September 2022)
- Release 81 (29 August 2022)
- Release 80 (01 August 2022)
- Release 79 (04 July 2022)
- Release 78 (06 June 2022)
- Release 77 (09 May 2022)
- 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 96 (04 December 2023)
Documentation Portal Updates
- Added pasted to the list of possible values under the
onPaymentFormChange
parameter. - Added the Native App Integration section to the main Google Pay page.
- Updates throughout the Risk Guide.
- 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 3D flows to the appendix of the Apple Pay (REST API) page.
- Added the following APM guides:
- Added the Payment (Deposit) Flow to the Efecty guide.
- Added
merchantAdviceCode
to the DMN Parameters table. - For the Visa Mandate, specified which parameters are mandatory in the
billingAddress
andpaymentOption
blocks on the following pages:- REST 1.0
- 3DS MPI-Only REST
- Apple Pay (REST API)
- Google Pay (REST API)
- Under the Input Parameters topic (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 the
blockPasteCard
parameter to theSafeCharge()
andcheckout()
inputs. - Added the pasted to the list of possible values under the
onPaymentFormChange
parameter undercheckout()
. - Update the supported values of the
loglevel
parameter under theSafeCharge()
andcheckout()
inputs. - Added the submitWdRequest() method to Web SDK Methods.
- Added the withdrawal() method to Simply Connect Methods.
- Added  the
merchantAdviceCode
parameter to the input of/payment
,/payout
, and/refundTransaction
. - Added the
sessionCardDeclineLimit
parameter to the/openOrder
input. - Added the companyDetails parameter to the input of
/openOrder
,/payment
,/refundTransaction
, and/payout
. - Added the
/updateOrder
API method. - Added the Frontend Tokenization API section.
- Added blockedCards to the list of possible values under the
paymentMethods
parameter 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.ip
paymentOption.card.threeD.browserDetails.screenHeight
paymentOption.card.threeD.browserDetails.screenWidth
paymentOption.card.cardHolderName
billingAddress.phone
billingAddress.city
billingAddress.address
billingAddress.zip
billingAddress.state
-
Added a note under
currencyConversion
block in/payout
input that currency conversion is only supported for credit cards. - Added
showCardLogos
undercheckout()
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.
- Under the Input Parameters topic (Payment Page), changed all mandatory fields to optional in the Customer Details table.
- In the Account Details Capture page, added the
urlDetails
block to the input ofaccountCapture()
and toaccountCapture (API)
. - Added four events to the Tracking Implementation Details section.
- Removed the
cryptogram
parameter from DMNs and from any responses. - Added hide to possible values of
autoOpenPm
under Payment Customization input.
API Reference Guide Updates
- Added the
urlDetails
block to the input ofaccountCapture()
and toaccountCapture (API)
. - Update the description of
addendums
under/settleTransaction
withl23processingData
subclass. - Added a note to the
addendums
class.
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 Payment Page Features topic:
- Added the following features to the Cashier Features topic:
- Removed Ideal, Giropay, EPS and Sofort from table of APMs supporting recurring on the APM subMethod Class page since these are not currently supported for recurring.
- Under the Input Parameters topic (Payment Page):
- Added
shippingCompanyName
,shippingState
, andshippingStreetNumber
to the Shipping Details table. - Added
airline_BoardingFee
,consumption_tax_amount
,tax_amount_base Double
, andtip_amount
to the Item Details table.
- Added
- On the Static Pay Button (Web SDK) page, added a note about enhancing the
createApplePayPayment
method. - 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
amountSuggetions
to the Open Amount feature on the Simply Connect Payment Customization page.
API Reference Guide Updates
- Added
productId
,customData
, andwebMasterId
to /openOrder input. - Changed field length of
address
,addressLine2
, andaddressLine3
from 60 to 50 throughout. - Added the
l23processingData
subclass under theaddendums
class. - Added input fields to the
localPayment
subclass under theaddendums
class. - Added the
/p2pPayment
method. - Added the
strictCardBlocking
field to theSafeCharge()
andcheckout()
inputs. - Updated description of
support19digits
underSafeCharge()
.
Release 93 (14 August 2023)
Documentation Portal Updates
- In the MobilePay payment flow:
- Added
deviceType
and a note. - Added
phone
to theuserDetails
block.
- Added
- Added the Level 2&3 Processing Data page to Addendums.
- Added possible values for
npp_pay_id_type
under NPP Payout flow (PayID). - Added Version 1.72 to Java SDK page.
- Added
isAFT
to 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 to the Magento plugin guide.
- Changed EcoPayz to Payz versus in the relevant APM Payments and APM Payouts tables.
- Under the Input Parameters topic (Payment Page), added
current_balance
to the Basic Parameters table. - Added the Scan Card feature.
- Added the Payment Method Icon Recommendation feature.
- Added
webpay_personal_id
topaymentOption.alternativePaymentMethod
block in WebPay guide. - Added Colombia Fields appendix to the Local Payment (Installments) page.
API Reference Guide Updates
- Added hide to possible values of
autoOpenPm
undercheckout()
input. - Added
isAFT
to output of/payment
,/refundTransaction
, and/settleTransaction
. - Added
openAmount
undercheckout()
input. - Added
amountSuggetions
undercheckout()
input. - Added
checkout.addUpo()
to Simply Connect Methods. - Added
addApmUpo()
andaddCardUpo()
to Web SDK Methods. - Added /p2pPayment method.
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 block.
- 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
referenceId
tosubMethod
block undercreatePayment()
and/payment
). - Removed
userTokenId
anddisableNuveiAnalytics
fromcheckout()
. - Removed
clientUniqueId
from 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
userTokenId
must be included. - Updated the description of
cardNumber
undergetCardDetails()
. - Updated the Prerequisites and Notes in the STPmex guide regarding
merchant_unique_id
(clientUniqueID
). - Added
ipAddress
to 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
clientUniqueId
for the payment and payout flows. - In the Google Pay (REST API) guide, updated the “Google Pay Brand Promoting Guidelines” under Prerequisites and Notes.
- Removed
bin
fromcardNumber
under clientGetDccDetails.
API Reference Guide Updates
- Updated the description of
cardNumber
undergetCardDetails()
. - Updated note in externalToken Class.
- Removed
bin
fromcardNumber
under clientGetDccDetails.
Release 90 (22 May 2023)
Documentation Portal Updates
- Added
item_shipping_tax_N
andshipping_tax parameters
to the Item Details table. - On the OpenCart plugin page, updated the Supported Versions and Installation sections.
- Updated the Mirakl plugin guide.
- Added possible values to
chargeback.statusCategory
in Chargeback Parameters table. - Updated the Gateway Filter Error Codes table.
- Added
onDeclineRecovery()
to Advanced Controls 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
localPayment
subclass under theaddendums
class. - Added DINERS and DISCOVER to the
externalSchemeDetails
class under the input of/openOrder
and/payment
. - Added the
currencyConversion
class to the input of/openOrder
,/payment
, and/payout
. - Added the
threeD
block under thepaymentOption
class in the output of/getPaymentStatus
. - Removed
merchantId
andmerchantSiteId
from the input ofcreatePayment()
andauthenticate3d()
. - Updated the description of
id
under thesubMerchant
class in the input of/payment
,/openOrder
,/settleTransaction
,/refundTransaction
,/voidTransaction
, and/authorize3d
. - Added
prepaid
to output ofgetCardDetails()
,checkout.getCardDetails()
, and/getCardDetails (API)
. - Added
bin
,last4digits
,ccExpMonth
, andccExpYear
to output ofgetCardDetails()
andcheckout.getCardDetails()
. - Added geolocation using “detect” to
country
under input ofgetApms()
andcheckout.getApms()
, as well ascheckout()
. - Updated description of
currency
andcountry
undercheckout.clientGetDccDetails()
. - Removed
originalAmount
andoriginalCurrency
from input ofclientGetDccDetails()
. - Added
savePm
to thepaymentOption
class under/payment
input. - Added
onDeclineRecovery
tocheckout()
input. - Added
theme
andpaymentTiles
tocheckout()
input. - Added
showAccountCapture
to 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 page.
- Removed the “PrestaShop with Web SDK” page, and renamed and reorganized the PrestaShop plugin page.
- Added
showAccountCapture
to the Additional Functions page. - Google Pay guide:
- Updated Example /initPayment Response – “v2supported”: “false”.
- Removed
cardHolderName
from all requests.
- Apple Pay APM guide:
- Updated Example /initPayment Response – “v2supported”: “false”.
- Removed
cardHolderName
from 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
/payout
request to the Visa Checkout (REST API) guide. - Added
rateType
to the Multiple Currency Pricing (MCP) page. - In the Payouts for Credit Cards 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
, andemail
to the apmgw_NPP row in the relevant APM Payments table. - Added
firstName
,lastName
,address
,city
,state
,zip
,country
,phone
to the apmgw_Instant_Bank_Transfer row in the relevant APM Payments table. - Added
firstName
,lastName
,country
, andemail
to 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
authenticationOnlyType
possible values. - Added
authenticationOnlyType
to all relevant flows.
- Added an appendix for
- Added an example
/addUPOAPM
request for Secure Bank Transfer.
API Reference Guide Updates
- Added
rateType
to the/getMcpRates
method input. - Added
showAccountCapture
to theSafeCharge()
input. - Updated note in the introduction of
/getPayoutStatus
and changedclientRequestId
from 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
city
to payment flow in the Mazooma guide. - Added
phone
,address
,city
, andzip
to payment flow in the PSE guide. - On the APM Input Fields and APIs page:
- Added apmgw_BanContact to the relevant APM Payments table.
- Added
city
to the apmgw_eCheckSelect row in the relevant APM Payments table. - Added
phone
,address
,city
, andzip
to 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
payButton
to 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 page.
- Added an appendix to the Payout page regarding using the
userDetails
block 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
initialTransactionId
to/createSubscription
and/editSubscription
. - Changed the Rebilling API method names to the actual .do method names.
- Made the following changes in the
localPayment
block under Addendums Class:- Removed
firstInstallment
andperiodicalInsatallment
. - Added description to
numberOfInstallments
. - Added
installmentType
.
- Removed
- Changed
billingAddress
under/addUPOAPM
to be optional. - Updated
firstName
andlastName
to Required under/createUser
. - Added
setOpenAmount()
(Web SDK Methods) andcheckout.setOpenAmount()
(Simply Connect Methods). - Added
clientRequestId
andclientUniqueId
to/verify3d
input. - Added the
userDetails
block to /payout, including a link to the Payout page. - Added descriptions to the possible values of
authenticationOnlyType
in/openOrder
and/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
, andstate
to 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.
- Under the Input Parameters topic (Payment Page):
- Added
withdrawableBalance
to the Basic Parameters table. - Added
suggestedAmount1
,suggestedAmount2
, andsuggestedAmount3
to the Item Details table.
- Added
- Added an example Acknowledgement DMN to the Withdrawal Guide.
API Reference Guide Updates
- Updated the description of
isRebilling
in/openOrder
and/payment
, including clarifying which 3D 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
openAmount
block to/openOrder
input. - Added
openAmount
parameter tocreatePayment()
input. - Added
min
andmax
tocheckout()
input.
Release 86 (16 January 2023)
Documentation Portal Updates
- Updated the Shopify plugin guide.
- Added the following APM guides:
- In the Okto Cash guide, added that Romania merchants need to send send
firstName
,lastName
,dateOfBirth
,email
, andidentification
. - On the APM Input Fields and APIs page:
- Added
firstName
andlastName
to 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
/payment
response examples in the Apple Pay (REST API) page: “TheccCardNumber
andlast4Digits
response values represent the customer’s real card number.” This note is relevant only for REST merchants. - Added
showMessageKeys
to the Basic Parameters table. - Changed the type of
item_min_amount_1
anditem_max_amount_1
from “Integer” to “Double” in the Item Details table.
API Reference Guide Updates
- Updated the description of
identification
under theuserDetails
block throughout. email
is required in the /createUser method.- getCardDetails no longer receives BIN as an input (only card).
- Added
cryptogram
andeciProvider
under externalToken Class. - Added
brand
andlast4Digits
under /payment >paymentOption
>card
. - Added
deviceManufacturerIdentifier
under /payment >deviceDetails
.
Release 85 (19 December 2022)
Documentation Portal Updates
- Added
deviceManufacturerIdentifier
to all relevant Apple Pay examples on the Apple Pay (REST API) integration page. - Removed
deviceManufacturerIdentifier
from all Google Pay examples on the Google Pay (REST API) integration page. - Added the Google Pay (REST API) page.
- Added the Apple Pay (REST API) page.
- Added the autoOpenPM topic to the Simply Connect Payment Customization page.
- Renamed
selectPaymentMethod
toonSelectPaymentMethod
on the following Simply Connect pages: - Updated the Save Payment Method topic on the Simply Connect Payment Customization page.
- Updated the
savePM
description in the checkout() Input Parameters table on the Simply Connect Quick Start page. - Added links on the Simply Connect Advanced Controls page to the following Simply Connect methods in the API Reference Guide:
- Added Australia, New Zealand, and United Kingdom to State/Province/Territory/Union/County ISO Codes.
- Renamed the Self Track guide.
- In the Pay4Fun guide:
- Added CPF to both payment and payout flows.
- Added
pay4funId
to thepaymentOption.alternativePaymentMethod
block.
- In the Okto Cash guide, added a note in the support of the new regulated flow for Romania.
- Updated the note in the Account Capture section of the Mazooma guide and added the same note to the Account Details Capture page.
- Separated Cashier Features into a second page for Payment Page Features.
- Added status UPDATE to APMs and DMNs (with note) and to DMN Parameters table.
- Added
representmentInformation
to DMN Parameters table. - On the APM Input Fields and APIs page:
- Added apmgw_NEQUI_CO to the relevant APM Payments table.
- Added apmgw_OXXO_PAY to the relevant APM Payouts table.
- Added input validation for Fonix to the relevant APM Payments table.
- Added the Decline Recovery Feature to Payment Page Features and Payment Customization pages.
API Reference Guide Updates
- Updated the description of
state
throughout. - Updated description of
autoOpenPm
undercheckout()
input. - Renamed
selectPaymentMethod
toonSelectPaymentMethod
undercheckout()
input. - Updated
savePM
and addedsavePmUrl
under checkout() input. - Added
useFields
to clientGetDccDetails() input and updated description ofcardNumber
andapm
accordingly. - Added checkout.getCardDetails(), checkout.clientGetDccDetails(), checkout.getApms(), and checkout.getUserUPOs() to Simply Connect Methods.
- Added
onPaymentEvent
to input ofcheckout()
andSafeCharge()
. - Added accountCapture() method to Web SDK Methods.
- Added new “Additional Input Parameters” section including
merchantDetails
tocheckout()
. - Added
disableDeclineRecovery
tocheckout()
input.
Release 84 (14 November 2022)
Documentation Portal Updates
- Added links to the Nuvei product demo sites on the main Nuvei Docs landing page.
- Added note to Apple Pay (Simply Connect) for details on how to change the height and width of the Apple Pay button in the CSS.
- Updated the Technical Requirements section in the PayPal guide.
- In the Pay4Fun guide, added
pay4funId
toalternativePaymentMethod
block. - On the APM Input Fields and APIs page, added
pay4funId
to Pay4Fun in the relevant APM Payments and APM Payouts tables. - On the Apple Pay Integration Testing page, updated the list of testing cards according the Apple Pay site.
API Reference Guide Updates
- Added
isMoto
to/openOrder
input. - Added
alwaysCollectCvv
tocreatePayment()
input and updatedalwaysCollectCvv
incheckout()
input. - Added
apmConfig
class tocheckout()
input. - Removed
aftOverride
from and updated description ofrecipientDetails
class in/payment
input. - Removed
paresponse
frompaymentOption.card
in/verify3d
and from threeD Input Class.
Release 83 (24 October 2022)
Documentation Portal Updates
- Added
item_tax_N
anditem_tax_included_N
to the Item Details table. - Added appendix to STPmex guide for Check Order feature.
- Added Magento with Simply Connect to the Magento plugin guide.
- Added the iDEAL guide.
- Updated the Payout topic:
- For
/payout
for APM:- Added
userDetails
block withemail
andcountry
. - Added a note that
countryCode
is needed instead ofcountry
for certain APMs.
- Added
- For
/addUPOAPM
:- Added
billingAddress
block withemail
andcountry
. - Added a note that
countryCode
is needed instead ofcountry
for certain APMs.
- Added
- For
- In the ACH guide:
- Added
additionalTransactionBankId
to the/payout
response. - Added the “Pending” response under Secure Bank Transfer.
- Added
- On the APM Input Fields and APIs page, added apmgw_OneCard and apmgw_Mach to the relevant APM Payments tables.
- Removed Moneta (Direct Integration) from the relevant APM Payments and APM Payouts tables.
- Added the Unrelated Refunds topic to the Refund page.
API Reference Guide Updates
- Added “Card Request with tempToken” JSON scenario to
/payment
. - Under
/refundTransaction
input, added thepaymentOption.card
class and theuserTokenID
parameter, and changedrelatedTransactionId
from Required to Conditional. - Under
/refundTransaction
output, addeduserPaymentOptionId
to output. - Added
recipientDetails
class andaftOverride
parameter for AFTs to/payment
input. - Updated
uerDetails
block under/payout
:- Added note that class is required only for APMs.
- Added
email
andcountry
as mandatory. - Added a note that
countryCode
is needed instead ofcountry
for certain APMs. - Updated description of
identification
.
- Updated
billingAddress
under /addUPOAPM:- Changed from “Optional” to “country and email Required”.
- Changed
email
andcountry
to Required. - Added a note that
countryCode
is needed instead ofcountry
for certain APMs.
- Added PENDING to status in /refundTransaction output.
- Added
additionalTransactionBankId
to/payment
and/payout
response.
Release 82 (19 September 2022)
Documentation Portal Updates
- Added the Submit the Initial MIT Payment for Web SDK topic to the Merchant-Initiated Transactions (MIT) page.
- Added the DMNs for APM Refunds appendix to the Refund page.
- Added the APM Refunds section to the Introduction to APMs page.
- Added new test cards for Discover, Diners, and CUP to the Testing Cards page.
- Under the Input Parameters topic (Payment Page):
- Added
planId
to the Basic Parameters table. - Updated the descriptions of
item_discount_N
anddiscount
in the Item Details table.
- Added
- Added the following APM guides:
- Added the following feature to the Cashier Features topic:
- Added
acquirerBank
to the DMN Response Parameters table in the Withdrawal Guide. - On the APM Input Fields and APIs page, added apmgw_Khipu and apmgw_QR_Redeban to the relevant APM Payments table.
- Added the Testing section to the ACH guide.
- Added the
disableNuveiAnalytics
feature to:- checkout() Input Parameters table on the Simply Connect Quick Start page
- Web SDK Features on the Web SDK Additional Functions page
API Reference Guide Updates
- Under /account capture (API):
- Changed
amount
to Conditional and added a note thatamount
is mandatory for certain APMs. - Added the
userDetails
and thedeviceDetails
blocks.
- Changed
- Added
apmWindowType
to input ofcheckout()
and tocreatePayment()
. - Added
isPartialApproval
to /openOrder input andpartialApproval
to/openOrder
output. - Added
disableNuveiAnalytics
to input ofcheckout()
andSafeCharge()
. - Added
flow
,acquirerDecision
, anddecisionReason
) to the threeD Output Class.
Release 81 (29 August 2022)
Documentation Portal Updates
- Added the Challenges and Exemptions page under 3DS Implementations.
- Removed instances of 3D-Secure v1 throughout.
- Added the Nuvei Postman Collections topic to the Testing APIs with Postman page.
- Added
PAR
to the DMN Parameters table. - Added a note showing the gateway credentials for the test (sandbox) and production environments in these pages:
- Google Pay (Web SDK) guide.
- Google Pay (REST) guide.
- Added the Dynamic Payment Amount topic to the Simply Connect Payment Customization page.
- Updated the Open Amount Feature topic on the Simply Connect Payment Customization page.
- Updated the Open Amount Feature topic on the Web SDK Additional Functions page.
- Changed “Checkout” product name to Simply Connect throughout.
- Added the Daviplata guide.
- On the APM Input Fields and APIs page:
- Added apmgw_Daviplata to the relevant APM Payments table.
- Added apmgw_PESPay and apmgw_Colombia_Payouts to the relevant APM Payouts table.
- Added
cardLogo
to UI Customization.
API Reference Guide Updates
- Changed “Checkout” product name to Simply Connect throughout.
- Added
upoRegistrationTime
to output ofpaymentMethods
class under /getUserUPOs.
Release 80 (01 August 2022)
Documentation Portal Updates
- Added the following features to the Cashier Features topic:
- Added the following APM guides:
- On the APM Input Fields and APIs page:
- Added apmgw_PayCash, apmgw_Alipay, apmgw_Online_Bank_Transfer, apmgw_Pay4Fun, and apmgw_Aircash to the relevant APM Payments tables.
- Added apmgw_Pay4Fun and apmgw_Online_Bank_Transfer to the relevant APM Payouts table.
- Added apmgw_BankPayouts and apmgw_LATAM_Payouts to the table of APMs Supporting
/accountCapture
. - Updated the Shopify via AsiaBill page for its new version.
- Under Chargebacks in the Risk Guide:
- Added Reason Code 68 for Visa and Mastercard.
- Updated the Dispute Process section.
- Changed “sandbox.safecharge.com” to “sandbox.nuvei.com” throughout.
- Renamed the Webhooks (DMNs) topic and organized the subtopics under it.
API Reference Guide Updates
- Added
onPaymentFormChange
tocheckout()
input and example. - Changed the input field
ccNameOnCard
inaddUPOCreditCard
from mandatory to optional. - Added
cardLogo
to inputs and examples ofcreatePayment()
andcheckout()
. - Added
getUserUPOs()
to Web SDK Methods. - In /openOrder input, moved
billingAddress
,shippingAddress
, anduserDetails
to a new “Additional Input Parameters” section, and changedbillingAddress
to Optional.
Release 79 (04 July 2022)
Documentation Portal Updates
- On the Google Pay (Simply Connect) page, updated the default parameters in the
apmConfig.GooglePay
block. - Added the Payout guide.
- Updated the list of Cards that Return APPROVED for Visa and Mastercard.
- Added Controlling Suggested Amounts from Deposit Cashier Request feature to the Suggested Amounts and Smart Suggested Amounts section.
- Added General APM Recurring Billing topic to the APM subMethod Class page.
API Reference Guide Updates
- Added a section of prerequisites to the REST API introduction.
- Added “Google Pay” JSON scenario to
/payment
. - Added
paymentAccountReference
to the/payment
output. - Added the
externalSchemeDetails
block and thecustomData
parameter to the/addUPOCreditCard
method input. - Added
paymentFlow
andredirectFlowUITheme
to the/payment
input. userTokenId
is now passed to the Gateway for “TokenizationOnly” transactions so these transactions are displayed in the Transaction Report in the Control Panel.
Release 78 (06 June 2022)
Documentation Portal Updates
- Added
userDetails.country
to the German Regulations APMs: Sofort, Trustly, Giropay, and Rapid Transfer to the the relevant APM Payments table. - Added note to the end of the Google Pay UI Button step.
- Added the Authenticating an Events API Webhook Checksum section.
- Added the Merchant Generated QR Code flow to the PIX guide.
- Added the PrestaShop with Simply Connect page for the PrestaShop plugin.
- Added a note to the Account Capture section of the Mazooma guide.
- On the APM Input Fields and APIs page:
- Added apmgw_MCByAstropay, apmgw_NetbankingbyAstropay, apmgw_UPIbyAstropay, apmgw_Dimonex, apmgw_PuntoRed, apmgw_Red_Servi, and apmgw_MTCPay to the relevant APM Payments tables.
- Added apmgw_2C2P_PayoutService to the relevant APM Payouts table.
API Reference Guide Updates
- Added
amount
(as optional) to/accountCapture (API)
input. - Added
acquirerId
to input and output ofpaymentOption.card
under/initPayment
. - Updated the note in
customData
under/payout
input. - Added a note regarding a negative balance to the introduction of updateNetDepositValue.
Release 77 (09 May 2022)
Documentation Portal Updates
- Updated Skrill guide for subMethod.
- Clarified the structure of
transactionId
when sending theexternalSchemeDetails
block. - On the APM Input Fields and APIs page:
- Added apmgw_PayWithCrypto and apmgw_OXXO_PAY to the relevant APM Payments tables.
- Added apmgw_PayWithCrypto to the relevant APM Payouts table.
- Updated the phone parameter length in the relevant APM Payments and the APM Payouts tables for apmgw_INTERAC_Instant.
- Updated the following topics in the Risk Guide:
- Added the “Register a
userTokenId
” and the “Generate auserPaymentOptionId
(UPO)” sections to the PIX Payouts page. - Added the links to the Refund and Void topics from the ACH guide to show that we support Refund/Void for ACH.
- Added apmgw_Local_Payments_Vietnam to the table of APMs Supporting
/accountCapture
. - Updated the User Experience section in the OKTO Cash guide.
- Added link to Refund section to Apple Pay REST API and Google Pay REST API guides.
- Added the following features to the Cashier Features topic:
- Clarified the required length of the phone number in Canada in the Interac Instant guide.
- Added the 3D-Secure v1 Payment topic to the Server-to-Server guide.
(No longer relevant – superseded by a newer change.) - Added the Multi-Settle Option section to the Auth and Settle page.
- Added an “eci parameter is optional” note to the Payments with Decrypted Apple Pay Token and Payments with Decrypted Google Pay Token topics.
- Added a note in the Refunds page to contact the Nuvei Account Manager when processing unrelated refunds.
- In the Google Pay (Simply Connect) page, in the 2. Collect the Card Details topic, added a note to set this default value:
googleMerchantId
: “BCR2DN6TZ6DP7P3X”. - Added a note to the Apple Pay REST API and Google Pay REST API guides that 3D-Secure authentication support is scheduled for release in mid-July.
API Reference Guide Updates
- Updated description of
externalTokenProvider
under externalMpi Class. - Added
cardType
andexternalTokenData
to externalMpi Class. - Updated descriptions of
externalTokenProvider
andmobileToken
under externalToken Class. - Added
totalSettleCount
to the/settleTransaction
method input. - Changed
eci
in externalMPI to Conditional and added a note.
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.
- On the APM Input Fields and APIs page, 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 relevant APM Payments tables.
- Added a new dedicated menu for all APM documentation.
- Added the following APM guides: PIX, PIX Payouts, AlipayHK, Dana, GCash, India Payouts, KakaoPay, TouchnGo, TrueMoney, and Dragonpay.
- 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 (Simply Connect) page.
- Updated steps in the following pages:
- Updated steps in the Google Pay (Web SDK) page.
- Added Google Pay button customizations to the Google Pay (Simply Connect) 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 Simply Connect Demo to the Simply Connect Quick Start.
API Reference Guide Updates
- Added the checkout.submitPayment method.
- Added noButton to
payButton
undercheckout()
input. - Under
/payment
, changeduserDetails
to Conditional and added a note about APMs. - Under /openOrder input, changed
isRebilling
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 Alternative Payments, edited the following APM integration guides, changed “apmgw_Interac_Instant” to “apmgw_INTERAC_Instant” in Interac Instant guide.
- On the APM Input Fields and APIs page, changed apmgw_Interac_Instant to apmgw_INTERAC_Instant.
- Under the Simply Connect topic:
- Added
maskCvv
,useDCC
,cardAuthMode
,onSelectPaymentMethod
, andupoDeleted
to checkout() input table. - Added
checkout.destroy()
to Advanced Controls page.
- Added
API Reference Guide Updates
- Added the following fields/callbacks to
checkout()
input:maskCvv
,useDCC
,cardAuthMode
,onSelectPaymentMethod
andupoDeleted
. - Added the following methods to Simply Connect Methods:
checkout.applyOverlay()
,checkout.removeOverlay()
,checkout.getToken()
,checkout.getToken()
, and
checkout.destroy()
. - Added a note that
/getPayoutStatus
supports payouts performed by credit card and APM.
Release 74 (07 February 2022)
Documentation Portal Updates
- Under Alternative Payments, added the following APM guides:
- Added WIX to the Plugins guide page.
- Added External Subscription Support to the Cashier Features topic.
- Edited the following APM integration guides:
- Added apmgw_eCheckSelect to the table of APMs Supporting
/accountCapture
. - Added Account Capture section to the Mazooma guide.
- Added the Payment (Without UPO) – for Web SDK topic to the ACH guide.
- Added support for Simply Connect and updated Web SDK topics in the ACH guide.
- Added the VIP Pref. (Web SDK/Simply Connect) page.
- Added the Payment with externalMPI topic to the Google Pay (REST API) page.
- Added apmgw_eCheckSelect to the table of APMs Supporting
- On the APM Input Fields and APIs page, added apmgw_exito, apmgw_Banco_Nacional, apmgw_UPI, apmgw_Netbanking_TW, apmgw_South_Korea_LocalCards, and apmgw_OKTO_CASH to the relevant APM Payouts tables.
- 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 Control Panel Events API page.
- Added SAP to the Plugins guide page.
- On the APM Input Fields and APIs page, added Fonix to the relevant APM Payments table.
- Under Alternative Payments, added the following APM guides:
- Under Alternative Payments, edited the following APM integration guides:
- Added the Recurring Transactions section to the Dynamic Apple Pay Button Integration page.
- Added the recurring payments flow to the REST Payments appendix in the Google Pay guide.
- Updated the PlayPlus (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 – Simply Connect to the VIP Preferred guide.
- Updated the Web SDK JSFiddle example and the Simply Connect JSFiddle example for Google Pay.
- Added
prePayment
to checkout() Input Parameters.
API Reference Guide Updates
- Fixed all instances of “dsTransId” to “
dsTransID
“. - Added
prePayment
function tocheckout()
input.
Release 72 (6 December 2021)
Documentation Portal Updates
- On the APM Input Fields and APIs page, added input fields to eCheckSelect in the relevant APM 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 Google Pay Web SDK payment (deposit) and Google Pay Simply Connect payment (deposit) flows to Google Pay.
- 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 Alternative Payments, added the following APM integration guides:
- Under Alternative Payments, 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 Simply Connect 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 Simply Connect Methods section. - Added “Payment with UPO” JSON scenario to
/payment
. - Changed
strict
tostrictDcc
undercheckout()
input 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()
input. - Added
onReady
function tocheckout()
input.
Release 70 (11 October 2021)
Documentation Portal Updates
- Added note to the Webhooks (DMNs) page that Nuvei now supports Paypal for pre-deposit.
- On the APM Input Fields and APIs page:
- Added input fields to PaySafeCard in the relevant APM Payouts table.
- Added Interac_Instant to both tables.
- Added apmgw_P24, apmgw_SafetyPay_Online, and apmgw_SafetyPay_Cash to the relevant APM Payouts tables.
- Deleted the existing entry for apmgw_Open_Banking from the relevant APM Payments table.
- Added apmgw_Open_Banking and apmgw_Finnish_Banks to the relevant APM Payments table.
- Added the missing mandatory user details to apmgw_Faster_Payments in the relevant APM 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 Alternative Payments, added the following APM guides:
- Updated the Subscription Management section on the Subscriptions (Rebilling) page including adding a note that Nuvei’s subscription (rebilling) plan service now supports PayPal, Google Pay and Apple Pay accounts.
- Updated the PayFac endpoint URLs in the Onboarding a Submerchant 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 Simply Connect 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 table of APMs Supporting
/accountCapture
.
API Reference Guide Updates
- Updated and reorganized the Cashier Implementation topic.
- Added the
listValues
parameter to:- The
paymentMethods
array (output) under thegetApms()
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 table of APMs Supporting
/accountCapture
. - Added the Control Panel 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 Simply Connect Quick Start 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 Simply Connect page.
- On the APM Input Fields and APIs page:
- Removed “eCheck” from the relevant APM Payments and the APM Payouts tables.
- Removed “buyerAreaCode” and “buyerMobile” from the relevant APM Payouts table.
- Added “Faster Payments” to the relevant APM Payouts) table.
- Added “Afterpay”, “Clearpay”, “Visa by Astropay”, “PayNearMe”, “Western Union Panama”, and “MercadoPago” to the relevant APM Payments tables.
- Added the “PayNow” (redirect) to both tables.
- 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:
- Credits and Payouts: Updated list of CFT supported and blocked countries as per latest schemes regulations.
- Chargebacks: 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
undercreatePayment()
,authenticate3d()
,/openOrder
,/payment
, and/authorize3d
. - Under
checkout()
andSafeCharge()
input,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() input. - Added new method
accountCapture()
to Web SDK Methods.
Release 68 (26 July 2021)
Documentation Portal Updates
- Replaced the definition of ECI throughout.
- 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.
- On the APM Input Fields and APIs page:
- Corrected name of “apmgw_Astropay” to “apmgw_AstroPay” in the relevant APM Payouts table.
- Updated the details of “Secure Bank Transfer” in the relevant APM Payments table.
- Renamed “Express-Connect” to “eCashout” in the relevant APM Payouts table and removed it from the relevant APM Payments 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 relevant APM Payments 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 Guide.
- Added the Rebilling with WooCommerce topic for the WooCommerce plugin.
- In the Navigation Parameters table, 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 (REST API) guide under Alternative Payments.
- Added the Account Details Capture topic under Alternative Payments.
- 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 on the APM Input Fields and APIs page.
- Updated the content in the following 3D-Secure pages:
- Added the Salesforce plugin.
- 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 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
undercheckout()
input. - Updated description of
blockCards
underSafeCharge()
. - 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 Simply Connect Quick Start.
- 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 on the APM Input Fields and APIs page.
API Reference Guide Updates
- Added SafeCharge() method to Web SDK Methods.
- Added
pmWhitelist
,pmBlacklist
, andblockCards
undercheckout()
input. - Added
subMethod
andsavePM
undercheckout()
input. - Under
/payment
, corrected subMethodDetails tosubMethod
and updated subfield descriptions. - Added
subMethod
class tocreatePayment()
. - 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 Simply Connect Quick Start integration topic, and its supporting UI Customization 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 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 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
, changeddeviceDetails
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
andgetApms()
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
fromcreatePayment()
andauthenticate3d
(). - 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 Webhooks (DMNs) page 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 Mirakl plugin guide.
- 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 Webhooks (DMNs) page.
- 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
toauthenticate3d()
output. - Added
deviceDetails
to /verify3d.