On this page:
- 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 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 Event Callbacks 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
class.
- 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()
, andcheckout.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.
[/vc_column_text][/vc_column][/vc_row]
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
class. - 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 the/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
class withemail
andcountry
. - Added a note that
countryCode
is needed instead ofcountry
for certain APMs.
- Added
- For
/addUPOAPM
:- Added
billingAddress
class 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
class 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 APM Refunds appendix to the Refund page.
- Added the APM Refunds bullet to the Introduction to APMs page.
- Added new test cards for Discover, Diners, and CUP to the Testing Cards page.
- On the Input Parameters page (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
classes.
- 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
class. - 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
class 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, 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
class. - 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 to the Payment Page Output Transaction Parameters and DMN Parameters tables.
- 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
- 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 the Event Callbacks 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
- Added the following APM guides:
- Added the WIX plugin 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 the SAP plugin guide.
- On the APM Input Fields and APIs page, added Fonix to the relevant APM Payments table.
- Added the following APM guides:
- 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.