Overview

This topic describes all the parameters that can be sent to the Cashier Deposit page via an HTTP request.

Basic Parameters

Mandatory column values:

All: Mandatory for all transaction types (every request).
No: The parameter is not mandatory.

To improve risk analysis and to ensure successful 3DS authentication, it is recommended to collect and submit as many parameters as possible, in addition to the mandatory risk fields.

Parameter	Type	Size	Mandatory	Description
merchant_id	Integer	64bits	All	The merchant’s ID provided by Nuvei.
merchant_site_id	Integer	64bits	All	The merchant website’s ID provided by Nuvei.
checksum	String	Char(102400)	All	A hashing of the request to secure and authenticate the request.
time_stamp	String	Char(19)	All	Current GMT time in the following format: YYY-MM-DD.HH:MM:SS.
currency	String	Char(3)	All	The currency used in the transaction.
invoice_id	String	Char(100)	No	A unique invoice identifier provided by the merchant or randomly generated.
payment_method	String	Char(256)	No	The type of payment method selected by the customer. Possible values: Credit Card: cc_card Google Pay: ppp_GooglePay Apple Pay: ppp_ApplePay Alternative PM: For the values of specific APMs, press here.
payment_method_mode	-	-	-	Value: filter This parameter filters out any payment method that is not the payment method sent in `payment_method`.
payment_methods	String	Char(256)	No	The types of payment methods selected by the customer (comma separated). Possible values: Credit Card: cc_card Google Pay: ppp_GooglePay Apple Pay: ppp_ApplePay Alternative PM: For the values of specific APMs, press here.
merchantLocale	String	Char(5)	No	The language and country of the user in ISO code in the following format: [language ISO]_[country ISO] Unless specified, the default is English. Possible values: Albanian: sq_SQ Arabic: ar_AA Belarusian: be_BE Bulgarian: bg_BG Catalan: ca_CA Chinese (PRC): zh_CN Croatian: hr_HR Czech: cs_CS Danish: da_DK English (Australia): en_AU English (Canada): en_CA English (UK): en_UK English (US): en_US Dutch (Standard): nl_NL Estonian: et_ET Finnish: fi_FI French: fr_FR German: de_DE Greek: el_EL Hebrew: iw_IL Hindi:hi_HI Hungarian: hu_HU Icelandic: is_IS Indonesian: in_ID Irish: ga_GA Italian: it_IT Japanese: ja_JP Korean: ko_KR Latvian: lv_LV Lithuan: lt_LT Malay: ms_MS Maltese: mt_MT Norwegian: no_NO Polish: pl_PL Portuguese: pt_BR Romanian: ro_RO Russian: ru_RU Spanish: es_ES Serbian: sr_SR Slovak: sk_SK Slovenian: sl_SI Spanish: es_ES Swedish: sv_SE Thai: th_TH Turkish: tr_TR Ukrainian: uk_UK Vietnamese: vi_VL
userid	String	Char(50)	No	The customer’s ID as per the merchant’s user ID.
theme_id	Integer	64bits	No	Use this field overrides
customData	String	Char(255)	No	General data about the customer provided by the merchant.
merchant_unique_id	String	Char(64)	No	The unique ID (identifier) of the transaction in the merchant’s database.
encoding	String	Char (20)	No*	The type of character encoding. Default value is ISO-8859-1. * If encoding=UTF-8, then this fields is mandatory.
webMasterId	String	Char(255)	No	This is an affiliate parameter that the merchant can send to Cashier.
allow_installments	Integer	64 bits	No	Indicates whether payment may be made in installments or not, if this feature is supported by the merchant. The possible value of this parameter is either ‘1’ (yes) or ‘0’ (no).
max_num_installments	Integer	64 bits	No	Indicates the maximum amount of installments with which the payment can be made.
processingChannel	String	Char (4)	No	Sends “MOTO” value whenever the processing channel is from MOTO type (mail or telephone order)
planId	Integer	64 bits	No	Subscription Plan ID
showMessageKeys	String	Char(5)	No	Possible values: True: Present the message keys in brackets. False: Do not present the message keys in brackets.
withdrawableBalance	Double	64 bits	No	The maximum amount that the merchant allows the user to withdraw on a specific transaction. Currently, this feature is not supported for currency conversion transactions. Applies only to withdraw.
current_balance	Double	64 bits	No	The Customer's account balance. Relevant only for deposit. Currently, this feature is not supported for currency conversion transactions.
pm_hints	String	Char(5)	No	Determines whether additional payment method information appears. Possible values: True: Enabled – Additional payment method information appears. False: Disabled – Additional payment method information does not appear. Merchants can edit the additional information for each payment method using a message key. If a message key is not available for a specific payment method, contact the Nuvei Integration Team.
funds_anticipation_type	String		No	The time interval during which the merchant receives the funds. Relevant only for card transactions in Brazil.
verificationDetails	String	-	Mandatory for PIX APM Bank Detail Verification requests. URL-encoded string of `bankAccounts` array of the following parameters for at least one bank account: `bankId` `branchId` `bankAccountNumber` For details, see the PIX APM guide.

Item Details

“N” represents the item count number. The first item is item_name_1 up to item_name_n.

Parameter	Type	Size	Mandatory	Description
item_name_N	String	Char(400)	Yes	The name of item number N. Currently, item names can only include ISO-8859-1 character set encoding.
item_type_N	String	enum(12)	No	The type of item number N. Possible values: Discount Product Physical Digital Gift_card Store_credit Surcharge If `item_type_N`=Discount, then the value of `item_amount_N` needs to be reduced from the "regular" amounts when calculating the total amount. For Example: item_amount_1=10 item_amount_2=2 item_quantity_2=2 item_type_2=Discount total_amount=6 (10-2*2)
item_number_N	String	Char(400)	No	The first part of the items list, the serial number. Counted from item_number_1 to item_number_N.
item_amount_N	Double	64 bits	Yes	The cost of the item numbered in `item_number_N`.
item_shipping_N	Double	64 bits	No	Shipping costs of the item numbered in `item_number_N`.
item_shipping_tax_N	Double	64 bits	No	The tax rate (percentage) of the item's shipping fee. Possible values: 1–100
item_handling_N	Double	64 bits	No	Handling costs of the item numbered in `item_number_N`.
item_discount_N	Double	64 bits	No	Discount amount of the item numbered in `item_number_N`.
item_quantity_N	Integer	64 bits	Yes	Number of pieces of the item numbered in `item_number_N`. Default value is 1.
item_open_amount_N	String	Char(5)	No	True: Allows the customer to change the default deposit amount. False (default): The customer cannot change the default amount.
item_min_amount_N	Double	64 bits	Conditional	The minimum amount that the customer can deposit. The format is a maximum of 7 digits before the decimal and 2 digits after. Mandatory if `item_open_amount_N`=True.
item_max_amount_N	Double	64 bits	Conditional	The maximum amount that the customer can deposit. The format is a maximum of 7 digits before the decimal and 2 digits after. Mandatory if `item_open_amount_N`=True.
item_tax_N	Double	64 bits	No	Item's tax rate. Possible values: 1–100 Default value: 0
item_tax_included_N	Integer	64 bits	No	Possible values: 1: Item amount includes the tax. 0: Item amount does not include the tax.
item_short_description_N	String	-	No	Free text description of the item.
item_long_description_N	String	-	No	Free text description of the item.
group_Id_N	String	-	No	Item's classification (food, pharmacy, and so on.)
item_image_url_N	String	-	No	URL with a picture of the item.
item_description_url_N	String	-	No	URL with product information (such as iPhone 6)
numberofitems	Double	64 bits	Conditional	Number of items to process. Default is 1. Mandatory if `numberofitems` is greater than 1.
discount	Double	64 bits	No	Additional discount amount, regardless of any discount(s) for the transaction.
shipping	Double	64 bits	No	Total shipping costs.
handling	Double	64 bits	No	Total handling costs.
total_amount	Double	64 bits	Yes	Total transaction charge.
total_tax	Double	64 bits	No	The VAT percentage to be applied to the transaction.
shipping_tax	Double	64 bits	No	The tax rate (percentage) of the cart's shipping fee. Possible values: 1–101
productId	String	Char(50)	No	Merchant’s product ID. If this parameter is left empty, Cashier inserts a concatenation of all item names.
promoCode	String	Char(512)	No	This value is a promotional code you define that you can use to apply discounts to your products or services. To activate this field, contact Nuvei Technical Support.
nettelerAccount	String	-	Neteller	The customer's Neteller account number.
nettelerSecureId	String	-	Neteller	The customer's Neteller SecureId.
qiwi_phonenumber	String	-	Qiwi	The customer's phone number registered with Qiwi.
suggestedAmount1	String	64 bits	No	Pre-defined amount button that is presented on the Payment Page. `item_open_amount_N` must be True to support this field.
suggestedAmount2	String	65 bits	No	Pre-defined amount button that is presented on the Payment Page. `item_open_amount_N` must be True to support this field.
suggestedAmount3	String	66 bits	No	Pre-defined amount button that is presented on the Payment Page. `item_open_amount_N` must be True to support this field.
airline_BoardingFee	Double	64 bits	No	Paid by airlines for the use of airport facilities.
consumption_tax_amount	Double	64 bits	No	Tax on the purchase of goods or services.
tax_amount_base	Double	64 bits	No	Taxable amount as determined by the tax authority.
tip_amount	Double	64 bits	No	A sum of money customarily given by a customer in addition to the basic price of the service.
creditCardDepositAmount	Double	64 bits	No	The monetary amount that the customer has deposited in the current calendar year. Note: Please contact Nuvei Integration to check if you can use this parameter in your customer's payment page as part of the credit card regulation.
MaxCreditCardDepositAmount	Double	64 bits	No	The maximum monetary amount that the customer is allowed to deposit in the current calendar year. Note: Please contact Nuvei Integration to check if you can use this parameter in your customer's payment page as part of the credit card regulation.

User Token

Parameter	Type	Size	Mandatory	Description
user_token	String	Char(256)	No	This parameter determines if the payment page requires existing customers to register for each transaction. register – Always register, even if registered already auto – Register only new users readonly – Cannot register new payment option, only use existing one. registeronly – Always register. Does not show existing payment options previously added by the user readonlyupo – User can select only existing specific UPO specified in userPaymentOptionId
user_token_id	String	Char(255)	Yes	ID for the user, based on which we manage the user’s payment methods.
userPaymentOptionId	String		No	This ID specifies the user payment option to use for the transaction when user_token = readonlyupo

Customer Details

Parameter	Type	Mandatory	Description
first_name	String(30)	No	Customer’s first name.
last_name	String(40)	No	Customer’s last name.
title	String(20)	No	Free text field for an honorific title before the customer's name. For example: Mr., Mrs.
email	String(100)	Yes	Customer’s email address.
address1	String(60)	No	Customer’s address.
address2	String(60)	No	Customer’s address.
city	String(30)	No	Customer’s city.
country	String(20)	Yes	Customer’s 2-letter ISO country code.
state	String(20)	No	Customer’s Country Subdivision Codes.
zip	String(10)	No	Customer’s ZIP code.
phone1	String(18)	Conditional	Customer’s phone1. Note: REQUIRED for 3DS Card Authentication only if `email` not provided.
phone2	String(18)	No	Customer’s phone2.
phone3	String(18)	No	Customer’s phone3.
personal_id	String(13)	No	The customer’s ID number issued by their respective country.
dateOfBirth	String(10)	No	The date of birth of the registering user (YYYY-MM-DD).
existingCustomer	String	No	Indicates if the customer is an existing customer or not. Possible values: True/False
currentNumberOfTransactions	String	No	The number of the customer’s past transactions.
customerSince	String	No	The date from which the customer is listed in the merchant system.

3D-Secure v2

The Nuvei payment page handles the SCA 3D-Secure v2 process for the merchant. The merchant only needs to add parameters to the call for the web cashier URL to assist in completing the SCA process.
To learn more about 3D-Secure v2, see the 3D-Secure Explained topic.

Even though most of the parameters below are optional, it is highly recommended to pass as many details as possible in the call to increase the chances of a frictionless authentication rather than invoking a challenge of the end user.

The following table displays the parameters that need to be added to fully support the 3D-Secure v2 process.

Parameter	Type	Mandatory	Description
deliveryEmail	String(254)	No	For electronic delivery, the email address to which the merchandise is delivered. [email protected]
deliveryTimeFrame	String(2)	No	This parameter indicates the merchandise delivery time frame. 01 = Electronic delivery 02 = Same day shipping 03 = Overnight shipping 04 = Two-day or more shipping
giftCardAmount	String(15)	No	For prepaid or gift card purchase, this represents the purchase amount total of prepaid or gift card(s) in major units (for example, USD 123.45 is 123).
giftCardCount	String(2)	No	For prepaid or gift card purchase, this represents the total count of individual prepaid or gift cards/codes purchased.
giftCardCurrency	String(3)	No	For prepaid or gift card purchase, this represents the ISO 4217 three-letter currency code of the gift card.
preOrderDate	String(8)	No	For a pre-ordered purchase, this represents the expected date that the merchandise is available. Format: YYYMMDD
preOrderInd	String(2)	No	This indicates whether the cardholder is placing an order for merchandise with a future availability or release date. 01 = Merchandise available 02 = Future availability
reorderItemsInd	String(2)	No	This indicates whether the cardholder is reordering previously purchased merchandise. 01 = First time ordered 02 = Reordered
shipIndicator	String(2)	No	Indicates shipping method chosen for the transaction. Merchants must choose the Shipping Indicator code that most accurately describes the cardholder’s specific transaction, not their general business. If one or more items are included in the sale, use the Shipping Indicator code for the physical goods, or if all digital goods, use the Shipping Indicator code that describes the most expensive item. 01 = Ship to cardholder’s billing address 02 = Ship to another verified address on file with merchant 03 = Ship to address that is different than the cardholder’s billing address 04 = “Ship to Store” / Pickup at local store (store address shall be populated in shipping address fields) 05 = Digital goods (includes online services, electronic gift cards and redemption codes) 06 = Travel and Event tickets, not shipped 07 = Other (for example, gaming, digital services not shipped, e-media subscriptions, etc.)
threeDSChallengeWindowSize	String(2)	No	Challenge Window Size 01 = 250 x 400 02 = 390 x 400 03 = 500 x 600 04 = 600 x 400 05 = Full screen Note: If no value is sent, the default value is 03.
accountAge	String(2)	No	Length of time that the cardholder has had the account with the 3DS Requestor. 01 = No account (guest checkout) 02 = Created during this transaction 03 = Less than 30 days 04 = 30–60 days 05 = More than 60 days
accountLastChangeDate	String(8)	No	Date that the cardholder’s account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. Format: YYYMMDD
accountLastChangeInd	String(2)	No	Length of time since the cardholder’s account information with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. 01 = Changed during this transaction 02 = Less than 30 days 03 = 30–60 days 04 = More than 60 days
accountRegistrationDate	String(8)	No	Date that the cardholder opened the account with the 3DS Requestor. Format: YYYMMDD
accountPasswordChangeDate	String(8)	No	Date that cardholder’s account with the 3DS Requestor had a password change or account reset. Format: YYYMMDD
accountResetInd	String	No	Indicates the length of time since the cardholder’s account with the 3DS Requestor had a password change or account reset. 01 = No change 02 = Changed during this transaction 03 = Less than 30 days 04 = 30–60 days 05 = More than 60 days
accountPurchasesCount6M	String(4)	No	Number of purchases with this cardholder account during the previous six months.
accountAddCardAttempts24H	String(3)	No	Number of Add Card attempts in the last 24 hours.
accountTransactionsCount24H	String(3)	No	Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours.
accountTransactionsCount1Y	String(3)	No	Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year.
accountAddressFirstUseDate	String(8)	No	Date when the shipping address used for this transaction was first used with the 3DS Requestor. Format: YYYMMDD
accountAddressFirstUseInd	String(2)	No	Indicates when the shipping address used for this transaction was first used with the 3DS Requestor. 01 = This transaction 02 = Less than 30 days 03 = 30–60 days 04 = More than 60 days
accountNameInd	String(2)	No	Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. 01 = Account Name identical to shipping Name 02 = Account Name different than shipping Name
accountSuspiciousActivityInd	String(2)	No	Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account. 01 = No suspicious activity has been observed 02 = Suspicious activity has been observed

Shipping Details

The following details are required whenever product shipping is involved.

Parameter	Type	Size	Mandatory	Description
shippingFirstName	String	30	No	Recipient’s first name.
shippingLastName	String	40	No	Recipient’s last name.
title	String	20	No	Free text field for an honorific title before the recipient’s name, such as Mr. or Mrs.
shippingAddress	String	60	No	Recipient’s address.
shippingCity	String	30	No	Recipient’s city.
shippingCountry	String	20	No	Recipient’s country in an ISO code (see Country Codes).
shippingZip	String	10	No	Recipient’s ZIP code.
shippingCompanyName	String	255	No	Name of the company, in case the goods are sent to a company.
shippingState	String	2	No	Customer’s shipping Country Subdivision Codes.
shippingStreetNumber	String	20	No	Number of the customer's house.
AddressType	String		No	Possible values: Standard ShipTo PickUpPoint InStore

Parameter	Type	Size	Mandatory	Description
skip_review_tab	String	Char(5)	No	A switch (true/false) indicating whether or not to skip the Cashier’s review page.
skip_billing_tab	String	Char(5)	No	When set to True, the payment page is skipped and instead the customer is redirected to the the payment method's page, but only if a redirect payment method was provided in `payment_method`) Note: To redirect the customer to the payment method's page, the merchant must provide all data that is required by the payment method.
success_url	String	Char(2048)	No	The customer is redirected to this URL on successful transaction.
error_url	String	Char(2048)	No	The customer is redirected to this URL on error.
pending_url	String	Char(2048)	No	The customer is redirected to this URL when response is pending.
back_url	String	Char(2048)	No	The customer is redirected to this URL when user presses the ‘Back’ button.
notify_url	String	Char(2048)	No	The DMN URL. See DMNs.
isNative	Boolean	1	No	Possible values: 1 = Opens the redirect APM in the same window (IFrame). 0 = Opens a redirect-based APM in a new window.
quick_deposit	Boolean	1	No	For more information, please contact Nuvei’s Integration Team.

If some of the payment page’s mandatory parameters are missing, the customer’s browser is redirected to the error page URL.

Merchant Custom Fields

Parameter	Type	Size	Mandatory	Description
descriptorMerchantName	String	Char(25)	No	Allows the merchant to define a dynamic descriptor for the merchant’s name.
descriptorMerchantPhone	String	Char(13)	No	Allows the merchant to define a dynamic descriptor for the merchant’s phone number.
customSiteName	String	Char(50)	No	The merchant’s site name that should replace the default MerchantSite name. This parameter is useful for merchants operating many websites that are distinguished only by name.
customField1 customField2 customField3 ... customField15	String	Char(64)	No	Custom fields for the merchant to update miscellaneous data. This is sent to the Cashier in the HTTP request and returned in its response.

Input Parameters