Skip to main content

Create Payment (Auth, PreAuth or Sale)

POST 
/payments

Creates a payment request for transaction types Auth, PreAuth or Sale.

Request​

Header Parameters

    idempotency-key string

    Idempotency Key for the request

    Example: 31f9952c-0058-458b-8244-4ae110ef1556

Body

required

    processingEntityId uuidrequired

    Processing entityId provided by Nuvei.

    merchantTransactionId string

    ID of the transaction in the merchant system.

    Possible values: <= 45 characters

    relatedTransactionId string

    For recurring/rebilling and MIT, represents the reference to the original transaction ID of the initial transaction.

    Possible values: <= 20 characters

    productId string

    A free text parameter used to identify the product/service sold. If this parameter is not sent or is sent with an empty value, then it contains the concatenation of all item names up until the parameter maximum length. Risk rules and traffic management rules are usually built based on this parameter value.

    Possible values: <= 50 characters

    currencyConversion

    object

    type stringrequired

    Possible values: [MCP]

    originalAmount numberrequired

    The original amount of the transaction in the currency that the merchant requested.

    originalCurrency stringrequired

    The 3-letter ISO currency code of the currency that the merchant requested in the transaction.

    Possible values: >= 3 characters and <= 3 characters

    amount numberrequired

    The transaction amount.

    currency stringrequired

    Possible values: >= 3 characters and <= 3 characters

    transactionType transactionTypeInput (string)

    Determines the transaction type that is sent to the Gateway, when it comes to performing the fiscal transaction. Default is Sale.

    Possible values: [Auth, Sale, PreAuth]

    isMoto boolean

    Indicates whether the transaction was done over email/phone or is a regular transaction. Values: true = Moto transaction | false = no Moto Transaction

    isPartialApproval boolean

    Describes a situation where the deposit was completed and processed with an amount lower than the requested amount due to a consumer's lack of funds within the desired payment method. Partial approval is only supported by Nuvei acquiring. Values: true - Allow partial approval | false - Not allow partial approval

    zeroAmountReason string

    For Authentication Zero scenarios, this optional field defines the authentication type.

    Possible values: [recurring, installments, addCard, maintainCard, accountVerification]

    amountDetails

    object

    The items and amountDetails prices should be summed up in the amount parameter and sent separately. All prices must be in the same currency.

    totalDiscount number
    Default value: 0
    totalHandling number
    Default value: 0
    totalShipping number
    Default value: 0
    totalTax number
    Default value: 0

    paymentOption

    object

    required

    Represents the details of the payment method.

    allowFieldsRecovery boolean

    This parameter controls the functionality for certain APMs to collect values for mandatory parameters that were not provided in the request. The default is false. If set to true, REST API returns a redirect URL to which the End User should be redirected to fill in missing details. If set to false, a validation error is returned. The default value is false

    Default value: false

    card

    object

    cardHolderName string

    The cardholder name.

    Possible values: <= 70 characters

    cardNumber passwordrequired

    The full card number.

    Possible values: non-empty and <= 20 characters

    expirationMonth stringrequired

    The card expiration month.

    Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ^(0[1-9]|1[0-2])$

    Example: 12
    expirationYear stringrequired

    The card expiration year.

    Possible values: >= 2 characters and <= 4 characters, Value must match regular expression ^(\d{4}|\d{2})$

    Example: 2023
    cvv password

    The CVV/CVC security code.

    Possible values: >= 3 characters and <= 4 characters, Value must match regular expression ^([0-9]{3}|[0-9]{4})$

    Example: 123
    merchantReference merchantReference (string)

    Merchant Reference for a business entity (token, subscription, etc.)

    Possible values: <= 50 characters

    Example: 12391284AF87C7D2

    acquirer

    object

    The ID of the acquirer that processed the transaction.

    id string

    Possible values: <= 3 characters, Value must match regular expression ^[0-9]{2,3}$

    Example: 99
    bin string

    The first six digits from the credit card number for identifying the processing bank. The rest of the number is not displayed.

    merchantId string
    merchantName string

    externalMpi

    object

    externalRiskScore integer

    If you wish to request an exemption prior to the Authentication request when Nuvei is your 3D-Secure v2 MPI, you should populate the risk assessment that you have calculated for the transaction. Alternatively, you can use this parameter during an Authorization request without any prior authentication when the transaction amount allows it. Please contact our Risk Team to set the risk score below which an exemption can be given. Valid values are 0–100 where 0 is lowest risk and 100 is the highest risk. NOTE: Nuvei's Fraud Engine considers this value if coordinated in advance with our Risk Team.

    externalChallengePreference string
    cavv string

    Cardholder Authentication Verification Value – cryptographically secure hash of various pieces of information related to the transaction that can be used as a proof for the 3DS authentication.

    dsTransId string

    The transaction ID of the Directory Server (part of the fingerprintPayload).

    eci string

    The Electronic Commerce Indicator (ECI) that indicates the level of security used in a 3D-Secure program when the cardholder provides payment information to the merchant. Visa values: 5 = The cardholder was successfully authenticated. | 6 = The issuer or cardholder does not participate in a 3D-Secure program. | 7 = Payment authentication was not performed. Mastercard values: 2 = The cardholder was successfully authenticated. | 1 = The issuer or cardholder does not participate in a 3D-Secure program. | 6 = Payment authentication was not performed. | 7 = The cardholder was successfully authenticated for the initial MIT.

    subMethod

    object

    email string
    referenceId string
    name string

    threeD

    object

    continueWithoutLiabilityShift boolean
    Default value: false

    challenge

    object

    preference string

    Possible values: [Challenge, Exemption, NoPreference]

    exemptionReason string

    Possible values: [LowValueTransaction, TransactionRiskAnalysis]

    userAccount

    object

    addCardAttempts24H integer

    Number of Add Card attempts in the last 24 hours.

    addressFirstUseDate date

    Date when the shipping address used for this transaction was first used with the 3DS Requestor in the format: YYYYMMDD.

    addressFirstUseIndicator string

    Indicates when the shipping address used for this transaction was first used with the 3DS Requestor. Values: 01 = This transaction | 02 = Less than 30 days | 03 = 30–60 days | 04 = More than 60 days

    Possible values: [01, 02, 03, 04]

    age string

    Length of time that the cardholder has had the account with the 3DS Requestor. Values: 01 = No account (payment as a guest) | 02 = Created during this transaction | 03 = Less than 30 days | 04 = 30-60 days | 05 = More than 60 days

    Possible values: [01, 02, 03, 04, 05]

    lastChangeDate date

    Date (in YYYYMMDD format) 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.

    lastChangeIndicator string

    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. Values: 01 = Changed during this transaction | 02 = Less than 30 days | 03 = 30-60 days | 04 = More than 60 days

    Possible values: [01, 02, 03, 04]

    cardSavedDate date

    The date on which the payment account was enrolled in the cardholder's account with the 3DS Requestor.

    cardSavedIndicator string

    Indicates the length of time that the payment account was enrolled in the cardholder's account with the 3DS Requestor. Values: 01 = If merchant does not save the card on their end, the deposit was processed without creating an account | 02 = If card is saved as part of this transaction flow | 03 = Card was saved less than 30 days ago | 04 = Card was saved between 30 and 60 days ago, endpoints included | 05 = Card was saved more than 60 days ago

    Possible values: [01, 02, 03, 04, 05]

    nameIndicator string

    Indicates if the cardholderName on the account is identical to the shipping name used for this transaction. Values: 01 = Account Name identical to Shipping Name | 02 = Account Name different than Shipping Name

    Possible values: [01, 02]

    passwordChangeDate date

    Date that cardholder's account with the 3DS Requestor had a password change or account reset in format: YYYYMMDD.

    purchasesCount6M integer

    Number of purchases with this cardholder account during the previous six months.

    registrationDate date

    Date that the cardholder opened the account with the 3DS Requestor in the format: YYYYMMDD.

    resetIndicator string

    Indicates the length of time since the cardholder's account with the 3DS Requestor had a password change or account reset. Values: 01 = No change | 02 = Changed during this transaction | 03 = Less than 30 days | 04 = 30–60 days | 05 = More than 60 days

    Possible values: [01, 02, 03, 04, 05]

    suspiciousActivityIndicator string

    Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account. Values: 01 = No suspicious activity has been observed | 02 = Suspicious activity has been observed

    Possible values: [01, 02]

    transactionsCount1Y integer

    Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year.

    transactionsCount24H integer

    Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours.

    giftCard

    object

    count integer

    For a prepaid or gift card purchase, the total number of individual prepaid or gift cards/codes purchased.

    Possible values: >= 1

    totalAmount number

    For a prepaid or gift card purchase, the total purchase amount of prepaid or gift card(s) in major units (for example, USD 123.45 is 123).

    currency string

    For a prepaid or gift card purchase, the 3-letter ISO currency code of the gift card.

    Possible values: >= 3 characters and <= 3 characters

    delivery

    object

    deliveryEmail string
    timeFrame string

    Indicates the merchandise delivery time frame. Values: 01 = Electronic Delivery | 02 = Same day shipping | 03 = Overnight shipping | 04 = Two-day or more shipping

    Possible values: [01, 02, 03, 04]

    preOrder

    object

    date date
    purchaseIndicator string

    Indicates whether the cardholder is placing an order for merchandise with a future availability or release date. Values: 01 = Merchandise available | 02 = Future availability

    Possible values: [01, 02]

    reorderItemsIndicator ReorderItemsIndicator (string)

    Indicates whether the cardholder is reordering previously purchased merchandise. Values: 01 = First time ordered | 02 = Reordered

    Possible values: [01, 02]

    shippingIndicator ShippingIndicator (string)

    Indicates the selected shipping method for the transaction. Values: 01 = Ship to cardholder billing address | 02 = Ship to another verified address on file with merchant | 03 = Ship to address that is different than the cardholders billing address | 04 = Ship to Store/Pickup at local store (store address shall be populated in shipping address parameters) | 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.)

    Possible values: [01, 02, 03, 04, 05, 06, 07]

    merchantUrl string

    The URL of the merchant’s fully qualified website.

    fingerprintNotificationUrl stringrequired

    URL to which the issuer should send the fingerprinting notification response

    challengeNotificationUrl stringrequired

    URL to which the issuer should send a notification after the 3D-Secure challenge step

    challengeWindowSize ChallengeWindowSize (string)required

    The dimensions of the challenge window. Values: 01 = 250 x 400 | 02 = 390 x 400 | 03 = 500 x 600 | 04 = 600 x 400 | 05 = Full screen

    Possible values: [01, 02, 03, 04, 05]

    platformType PlatformType (string)

    The device channel. Values: 01 = SDK | 02 = Browser

    Possible values: [01, 02]

    Default value: 02
    externalRiskScore integer

    Possible values: <= 100

    paymentToken

    object

    paymentTokenId tokenId (string)required

    Payment Token ID

    additionalData

    object

    property name* password
    usageIntent UsageIntent (string)

    Possible values: [recurring, register]

    threeD

    object

    continueWithoutLiabilityShift boolean
    Default value: false

    challenge

    object

    preference string

    Possible values: [Challenge, Exemption, NoPreference]

    exemptionReason string

    Possible values: [LowValueTransaction, TransactionRiskAnalysis]

    userAccount

    object

    addCardAttempts24H integer

    Number of Add Card attempts in the last 24 hours.

    addressFirstUseDate date

    Date when the shipping address used for this transaction was first used with the 3DS Requestor in the format: YYYYMMDD.

    addressFirstUseIndicator string

    Indicates when the shipping address used for this transaction was first used with the 3DS Requestor. Values: 01 = This transaction | 02 = Less than 30 days | 03 = 30–60 days | 04 = More than 60 days

    Possible values: [01, 02, 03, 04]

    age string

    Length of time that the cardholder has had the account with the 3DS Requestor. Values: 01 = No account (payment as a guest) | 02 = Created during this transaction | 03 = Less than 30 days | 04 = 30-60 days | 05 = More than 60 days

    Possible values: [01, 02, 03, 04, 05]

    lastChangeDate date

    Date (in YYYYMMDD format) 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.

    lastChangeIndicator string

    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. Values: 01 = Changed during this transaction | 02 = Less than 30 days | 03 = 30-60 days | 04 = More than 60 days

    Possible values: [01, 02, 03, 04]

    cardSavedDate date

    The date on which the payment account was enrolled in the cardholder's account with the 3DS Requestor.

    cardSavedIndicator string

    Indicates the length of time that the payment account was enrolled in the cardholder's account with the 3DS Requestor. Values: 01 = If merchant does not save the card on their end, the deposit was processed without creating an account | 02 = If card is saved as part of this transaction flow | 03 = Card was saved less than 30 days ago | 04 = Card was saved between 30 and 60 days ago, endpoints included | 05 = Card was saved more than 60 days ago

    Possible values: [01, 02, 03, 04, 05]

    nameIndicator string

    Indicates if the cardholderName on the account is identical to the shipping name used for this transaction. Values: 01 = Account Name identical to Shipping Name | 02 = Account Name different than Shipping Name

    Possible values: [01, 02]

    passwordChangeDate date

    Date that cardholder's account with the 3DS Requestor had a password change or account reset in format: YYYYMMDD.

    purchasesCount6M integer

    Number of purchases with this cardholder account during the previous six months.

    registrationDate date

    Date that the cardholder opened the account with the 3DS Requestor in the format: YYYYMMDD.

    resetIndicator string

    Indicates the length of time since the cardholder's account with the 3DS Requestor had a password change or account reset. Values: 01 = No change | 02 = Changed during this transaction | 03 = Less than 30 days | 04 = 30–60 days | 05 = More than 60 days

    Possible values: [01, 02, 03, 04, 05]

    suspiciousActivityIndicator string

    Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account. Values: 01 = No suspicious activity has been observed | 02 = Suspicious activity has been observed

    Possible values: [01, 02]

    transactionsCount1Y integer

    Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year.

    transactionsCount24H integer

    Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours.

    giftCard

    object

    count integer

    For a prepaid or gift card purchase, the total number of individual prepaid or gift cards/codes purchased.

    Possible values: >= 1

    totalAmount number

    For a prepaid or gift card purchase, the total purchase amount of prepaid or gift card(s) in major units (for example, USD 123.45 is 123).

    currency string

    For a prepaid or gift card purchase, the 3-letter ISO currency code of the gift card.

    Possible values: >= 3 characters and <= 3 characters

    delivery

    object

    deliveryEmail string
    timeFrame string

    Indicates the merchandise delivery time frame. Values: 01 = Electronic Delivery | 02 = Same day shipping | 03 = Overnight shipping | 04 = Two-day or more shipping

    Possible values: [01, 02, 03, 04]

    preOrder

    object

    date date
    purchaseIndicator string

    Indicates whether the cardholder is placing an order for merchandise with a future availability or release date. Values: 01 = Merchandise available | 02 = Future availability

    Possible values: [01, 02]

    reorderItemsIndicator ReorderItemsIndicator (string)

    Indicates whether the cardholder is reordering previously purchased merchandise. Values: 01 = First time ordered | 02 = Reordered

    Possible values: [01, 02]

    shippingIndicator ShippingIndicator (string)

    Indicates the selected shipping method for the transaction. Values: 01 = Ship to cardholder billing address | 02 = Ship to another verified address on file with merchant | 03 = Ship to address that is different than the cardholders billing address | 04 = Ship to Store/Pickup at local store (store address shall be populated in shipping address parameters) | 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.)

    Possible values: [01, 02, 03, 04, 05, 06, 07]

    merchantUrl string

    The URL of the merchant’s fully qualified website.

    fingerprintNotificationUrl stringrequired

    URL to which the issuer should send the fingerprinting notification response

    challengeNotificationUrl stringrequired

    URL to which the issuer should send a notification after the 3D-Secure challenge step

    challengeWindowSize ChallengeWindowSize (string)required

    The dimensions of the challenge window. Values: 01 = 250 x 400 | 02 = 390 x 400 | 03 = 500 x 600 | 04 = 600 x 400 | 05 = Full screen

    Possible values: [01, 02, 03, 04, 05]

    platformType PlatformType (string)

    The device channel. Values: 01 = SDK | 02 = Browser

    Possible values: [01, 02]

    Default value: 02
    externalRiskScore integer

    Possible values: <= 100

    alternativePaymentMethod

    object

    name stringrequired

    Possible values: non-empty and <= 50 characters

    Example: ACH

    data

    object

    property name* password
    usageIntent UsageIntent (string)

    Possible values: [recurring, register]

    merchantReference merchantReference (string)

    Merchant Reference for a business entity (token, subscription, etc.)

    Possible values: <= 50 characters

    Example: 12391284AF87C7D2

    temporaryPaymentToken

    object

    paymentTokenId tokenId (string)required

    Payment Token ID

    merchantReference merchantReference (string)

    Merchant Reference for a business entity (token, subscription, etc.)

    Possible values: <= 50 characters

    Example: 12391284AF87C7D2

    threeD

    object

    continueWithoutLiabilityShift boolean
    Default value: false

    challenge

    object

    preference string

    Possible values: [Challenge, Exemption, NoPreference]

    exemptionReason string

    Possible values: [LowValueTransaction, TransactionRiskAnalysis]

    userAccount

    object

    addCardAttempts24H integer

    Number of Add Card attempts in the last 24 hours.

    addressFirstUseDate date

    Date when the shipping address used for this transaction was first used with the 3DS Requestor in the format: YYYYMMDD.

    addressFirstUseIndicator string

    Indicates when the shipping address used for this transaction was first used with the 3DS Requestor. Values: 01 = This transaction | 02 = Less than 30 days | 03 = 30–60 days | 04 = More than 60 days

    Possible values: [01, 02, 03, 04]

    age string

    Length of time that the cardholder has had the account with the 3DS Requestor. Values: 01 = No account (payment as a guest) | 02 = Created during this transaction | 03 = Less than 30 days | 04 = 30-60 days | 05 = More than 60 days

    Possible values: [01, 02, 03, 04, 05]

    lastChangeDate date

    Date (in YYYYMMDD format) 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.

    lastChangeIndicator string

    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. Values: 01 = Changed during this transaction | 02 = Less than 30 days | 03 = 30-60 days | 04 = More than 60 days

    Possible values: [01, 02, 03, 04]

    cardSavedDate date

    The date on which the payment account was enrolled in the cardholder's account with the 3DS Requestor.

    cardSavedIndicator string

    Indicates the length of time that the payment account was enrolled in the cardholder's account with the 3DS Requestor. Values: 01 = If merchant does not save the card on their end, the deposit was processed without creating an account | 02 = If card is saved as part of this transaction flow | 03 = Card was saved less than 30 days ago | 04 = Card was saved between 30 and 60 days ago, endpoints included | 05 = Card was saved more than 60 days ago

    Possible values: [01, 02, 03, 04, 05]

    nameIndicator string

    Indicates if the cardholderName on the account is identical to the shipping name used for this transaction. Values: 01 = Account Name identical to Shipping Name | 02 = Account Name different than Shipping Name

    Possible values: [01, 02]

    passwordChangeDate date

    Date that cardholder's account with the 3DS Requestor had a password change or account reset in format: YYYYMMDD.

    purchasesCount6M integer

    Number of purchases with this cardholder account during the previous six months.

    registrationDate date

    Date that the cardholder opened the account with the 3DS Requestor in the format: YYYYMMDD.

    resetIndicator string

    Indicates the length of time since the cardholder's account with the 3DS Requestor had a password change or account reset. Values: 01 = No change | 02 = Changed during this transaction | 03 = Less than 30 days | 04 = 30–60 days | 05 = More than 60 days

    Possible values: [01, 02, 03, 04, 05]

    suspiciousActivityIndicator string

    Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account. Values: 01 = No suspicious activity has been observed | 02 = Suspicious activity has been observed

    Possible values: [01, 02]

    transactionsCount1Y integer

    Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year.

    transactionsCount24H integer

    Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours.

    giftCard

    object

    count integer

    For a prepaid or gift card purchase, the total number of individual prepaid or gift cards/codes purchased.

    Possible values: >= 1

    totalAmount number

    For a prepaid or gift card purchase, the total purchase amount of prepaid or gift card(s) in major units (for example, USD 123.45 is 123).

    currency string

    For a prepaid or gift card purchase, the 3-letter ISO currency code of the gift card.

    Possible values: >= 3 characters and <= 3 characters

    delivery

    object

    deliveryEmail string
    timeFrame string

    Indicates the merchandise delivery time frame. Values: 01 = Electronic Delivery | 02 = Same day shipping | 03 = Overnight shipping | 04 = Two-day or more shipping

    Possible values: [01, 02, 03, 04]

    preOrder

    object

    date date
    purchaseIndicator string

    Indicates whether the cardholder is placing an order for merchandise with a future availability or release date. Values: 01 = Merchandise available | 02 = Future availability

    Possible values: [01, 02]

    reorderItemsIndicator ReorderItemsIndicator (string)

    Indicates whether the cardholder is reordering previously purchased merchandise. Values: 01 = First time ordered | 02 = Reordered

    Possible values: [01, 02]

    shippingIndicator ShippingIndicator (string)

    Indicates the selected shipping method for the transaction. Values: 01 = Ship to cardholder billing address | 02 = Ship to another verified address on file with merchant | 03 = Ship to address that is different than the cardholders billing address | 04 = Ship to Store/Pickup at local store (store address shall be populated in shipping address parameters) | 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.)

    Possible values: [01, 02, 03, 04, 05, 06, 07]

    merchantUrl string

    The URL of the merchant’s fully qualified website.

    fingerprintNotificationUrl stringrequired

    URL to which the issuer should send the fingerprinting notification response

    challengeNotificationUrl stringrequired

    URL to which the issuer should send a notification after the 3D-Secure challenge step

    challengeWindowSize ChallengeWindowSize (string)required

    The dimensions of the challenge window. Values: 01 = 250 x 400 | 02 = 390 x 400 | 03 = 500 x 600 | 04 = 600 x 400 | 05 = Full screen

    Possible values: [01, 02, 03, 04, 05]

    platformType PlatformType (string)

    The device channel. Values: 01 = SDK | 02 = Browser

    Possible values: [01, 02]

    Default value: 02
    externalRiskScore integer

    Possible values: <= 100

    store store (string)

    Possible values: [none, initial, subsequent, tokenOnly, buyerToken]

    networkToken

    object

    provider TokenProvider (string)

    The name of the external token provider Possible values: [ApplePay, GooglePay]

    Possible values: [ApplePay, GooglePay]

    token string

    This encrypted token (REQUIRED for Apple Pay and Google Pay) represents a customer payment method generated by the external token provider

    Possible values: <= 5000 characters

    items

    object[]

  • Array [

    • name stringrequired
    price numberrequired
    quantity integerrequired

  • ]

    • dynamicDescriptor

    object

    merchantName string

    The merchant name, as is displayed for the transaction on the consumer's card statement.

    Possible values: <= 25 characters

    merchantContactInformation string

    The merchant contact information, as is displayed for the transaction on the consumer's card statement. It can also be an email address.

    Possible values: <= 255 characters

    subMerchant

    object

    id string

    Represents the internal merchant’s ID, which is forwarded to Visa and Mastercard

    Possible values: <= 15 characters

    city string

    The payment facilitator’s sub-merchant’s city name.

    Possible values: <= 20 characters

    countryCode string

    The payment facilitator’s sub-merchant’s 2-letter ISO country code.

    Possible values: >= 2 characters and <= 2 characters

    urlDetails

    object

    With this class, a merchant can dynamically provide possible URLs to which the end user is redirected after a payment is made, as well as a dynamic URL for DMNs.

    webhookUrl string

    The URL to which notifications for outcome of the financial transactions is sent.

    successUrl string

    The URL to which the end user is redirected for a successful transaction with an APM.

    failureUrl string

    The URL to which the end user is redirected for an unsuccessful transaction with an APM.

    pendingUrl string

    The URL to which the end user is redirected for a pending transaction with an APM.

    rebill

    object

    expiry date

    Recurring Expiry in the format: YYYYMMDD. REQUIRED if step = init. We recommend setting expiry to a value of no more than 5 years from the date of the initial transaction processing date

    frequency integer

    Recurring Frequency in days. REQUIRED if step = init

    step string

    Indicates the type of transaction performed as part of a rebilling plan.

    Possible values: [init, recurring, MIT]

    deviceDetails

    object

    deviceName string
    deviceOS string
    deviceType string

    Supported device types include: DESKTOP, SMARTPHONE, TABLET, TV, UNKNOWN (if device type cannot be recognized).

    ipAddress string

    The customer's IP address.

    browser

    object

    acceptHeader string

    Exact content of the HTTP accept headers as sent to the 3DS Requestor from the cardholder's browser. If the total length of the accept header sent by the browser exceeds 2048 characters, the 3D-Secure Server truncates the excess portion.

    colorDepth integer

    Value representing the bit depth of the color palette for displaying images, in bits per pixel. Obtained from cardholder browser using the screen.colorDepth property. Values: 1, 4, 8, 15, 16, 24, 32, 48

    javaEnabled boolean

    Represents the ability of the cardholder browser to execute Java. REQUIRED when javaScriptEnabled is TRUE. Value is returned from the navigator.javaEnabled property. Values: TRUE, FALSE

    javaScriptEnabled boolean

    Determines whether the browser is JavaScript enabled (from navigator.javaScriptEnabled property). Values: TRUE, FALSE

    language string

    Value representing the browser language as defined in IETF BCP47. Returned from navigator.language property.

    screenHeight integer

    Total height of the cardholder's screen in pixels. Value is returned from the screen.height property.

    screenWidth integer

    Total width of the cardholder's screen in pixels. Value is returned from the screen.width property.

    timeZone string

    Time difference between UTC time and the cardholder browser local time, in minutes. Values: Value is returned from the getTimezoneOffset() method.

    userAgent string

    Exact content of the HTTP user-agent header. Values: If the total length of the user-agent header sent by the browser exceeds 2048 characters, the 3D-Secure Server truncates the excess portion.

    custom

    object

    property name* password

    buyerDetails

    object

    buyerId string

    Unique customer identifier in your system.

    Possible values: <= 255 characters

    firstName string

    Possible values: <= 30 characters

    lastName string

    Possible values: <= 40 characters

    companyName string

    Possible values: <= 100 characters

    locale string

    The user's locale and default language.

    Possible values: <= 5 characters

    dateOfBirth date

    Format is YYYY-MM-DD.

    email string

    Possible values: <= 100 characters

    phone string

    Possible values: <= 18 characters

    phone2 string

    Possible values: <= 18 characters

    workPhone string

    Possible values: <= 18 characters

    nationalIdentificationNumber password

    The user's national ID number.

    Possible values: <= 25 characters

    billingAddress

    object

    address string

    Possible values: <= 60 characters

    addressLine2 string

    Possible values: <= 60 characters

    addressLine3 string

    Possible values: <= 60 characters

    state string

    Possible values: <= 6 characters

    zip string

    Possible values: <= 10 characters

    city string

    Possible values: <= 30 characters

    countryCode stringrequired

    Possible values: >= 2 characters and <= 2 characters

    phone string

    Possible values: <= 18 characters

    addressMatch boolean

    Set to “true” when address matches shipping address.

    Default value: false

    shippingAddress

    object

    sameAsBilling boolean
    Default value: false
    address string

    Possible values: <= 60 characters

    addressLine2 string

    Possible values: <= 60 characters

    addressLine3 string

    Possible values: <= 60 characters

    state string

    Possible values: <= 6 characters

    zip string

    Possible values: <= 10 characters

    city string

    Possible values: <= 30 characters

    countryCode string

    Possible values: >= 2 characters and <= 2 characters

    firstName string

    Possible values: <= 30 characters

    lastName string

    Possible values: <= 40 characters

    phone string

    Possible values: <= 18 characters

    phone2 string

    Possible values: <= 18 characters

    externalSchemeDetails

    object

    transactionId stringrequired

    Possible values: <= 50 characters

    brand stringrequired

    Possible values: [VISA, MASTERCARD, AMEX, DINERS, DISCOVERY]

Responses​

OK

Schema

    paymentId idType (string)
    Example: 2f00eba7-66ad-4d8b-8d54-b8c9183e664f
    transactionId transactionId (string)

    Nuvei Digital Payments Gateway Transaction ID

    Possible values: <= 20 characters

    externalTransactionId ExternalTransactionId (string)

    The transaction ID of the transaction in the event that an external service is used.

    Possible values: <= 50 characters

    amount number

    The transaction amount.

    currency string

    Possible values: >= 3 characters and <= 3 characters

    transactionType transactionType (string)

    Determines the transaction type that is sent to the Gateway, when it comes to performing the fiscal transaction. Default is Sale.

    Possible values: [Auth, Sale, PreAuth, Settle, Void, Refund, InitAuth3D, Auth3D, Sale3D]

    result

    object

    required

    status stringrequired

    Possible values: [approved, authorizedOnly, declined, error, pending, redirect, challenge, fingerprint, authenticated, authenticationNotSupported]

    errors

    object

    code string

    Possible values: <= 11 characters

    Example: 7000.1000
    reason string

    Possible values: <= 400 characters

    Example: Internal Processing Error
    authCode string

    The authorization code of the transaction.

    Possible values: <= 128 characters

    cvv2Code string

    The CVV2 (card verification value) response. Values: M = CVV2 Match | N = CVV2 No Match | P = Not Processed | U = Issuer is not certified and/or has not provided Visa the encryption keys | S = CVV2 processor is unavailable.

    Possible values: <= 1 characters

    avsCode string

    The address verification service (AVS) response. Values: A = The street address matches, the ZIP code does not. | W = Postal code matches, the street address does not. | Y = Postal code and the street address match. | X = An exact match of both the 9-digit ZIP code and the street address. | Z = Postal code matches, the street code does not. | U = Issuer is unavailable. | S = AVS not supported by issuer. | R = Retry. | B = Not authorized (declined). | N = Both the street address and postal code do not match.

    Possible values: <= 1 characters

    partialApproval

    object

    Partial approval is when the deposit completes with a processed amount lower than the requested amount due to a lack of sufficient funds in the consumer payment method.

    requestedAmount numberrequired
    requestedCurrency stringrequired

    Possible values: >= 3 characters and <= 3 characters

    redirectUrl string

    Possible values: <= 2000 characters

    providerResponseDetails

    object

    code string

    Possible values: <= 100 characters

    reason string

    Possible values: <= 400 characters

    additionalTransactionInfo

    object

    additionalTransactionBankId string
    referenceId string

    paymentOption

    object

    card

    object

    cardHolderName string

    The cardholder name.

    Possible values: <= 70 characters

    maskedCardNumber string

    The masked credit card number.

    Possible values: <= 20 characters

    bin string

    The first six digits from the credit card number for identifying the processing bank. The rest of the number is not displayed.

    Possible values: <= 8 characters

    last4Digits string

    The last four digits of the card number.

    Possible values: <= 4 characters

    expirationMonth string

    The card expiration month.

    Possible values: <= 2 characters

    expirationYear string

    The card expiration year.

    Possible values: <= 4 characters

    acquirerId string

    The ID of the acquirer that processed the transaction.

    Possible values: <= 2 characters

    cardType string

    The type of card used in the transaction. Values: Credit, Debit

    Possible values: <= 20 characters

    cardBrand string

    The card brand used in the transaction. Values: VISA, MASTERCARD, AMEX

    Possible values: <= 20 characters

    paymentAccountReference string

    Possible values: <= 29 characters

    paymentTokenId tokenId (string)

    Payment Token ID

    merchantReference merchantReference (string)

    Merchant Reference for a business entity (token, subscription, etc.)

    Possible values: <= 50 characters

    Example: 12391284AF87C7D2

    threeD

    object

    version string

    The full version of the 3DS protocol for the transaction.

    Possible values: <= 10 characters

    Example: 2.1.0
    fingerprintUrl string

    The URL to which to post the fingerprintPayload to perform device fingerprinting.

    fingerprintPayload string

    The payload to be posted to the fingerprintUrl to perform the device fingerprinting.

    dsTransId uuid

    The transaction ID of the Directory Server (part of the fingerprintPayload).

    alternativePaymentMethod

    object

    name stringrequired

    Possible values: non-empty and <= 50 characters

    Example: ACH

    data

    object

    property name* password
    usageIntent UsageIntent (string)

    Possible values: [recurring, register]

    merchantReference merchantReference (string)

    Merchant Reference for a business entity (token, subscription, etc.)

    Possible values: <= 50 characters

    Example: 12391284AF87C7D2
    paymentTokenId tokenId (string)

    Payment Token ID

    networkToken

    object

    provider TokenProvider (string)

    The name of the external token provider Possible values: [ApplePay, GooglePay]

    Possible values: [ApplePay, GooglePay]

    eciIndicator string

    Possible values: <= 100 characters

    expirationMonth string

    The card expiration month.

    Possible values: <= 2 characters

    expirationYear string

    The card expiration year.

    Possible values: <= 4 characters

    cardHolderName string

    The card holder name.

    Possible values: <= 70 characters

    maskedCardNumber string

    The masked credit card number.

    Possible values: <= 20 characters

    bin string

    The first six digits from the credit card number for identifying the processing bank. The rest of the number is not displayed.

    Possible values: <= 8 characters

    last4Digits string

    The last four digits of the card number.

    Possible values: <= 4 characters

    acquirerId string

    The ID of the acquirer that processed the transaction.

    Possible values: <= 2 characters

    cardType string

    The type of card used in the transaction. Values: Credit, Debit

    Possible values: <= 20 characters

    cardBrand string

    The card brand used in the transaction. Values: VISA, MASTERCARD, AMEX

    Possible values: <= 20 characters

Loading...