Create a Payment (Auth, PreAuth or Sale)
POST/payment
Creates a payment request for transaction types Auth, PreAuth or Sale.
Request
- application/json
Body
required
Array [
]
Possible values: <= 255 characters
ID of the API request in the merchant system.
Processing entityId
provided by Nuvei.
Possible values: <= 45 characters
ID of the transaction in the merchant system.
Possible values: <= 20 characters
For recurring/rebilling and MIT, represents the reference to the original transaction ID of the initial transaction.
Possible values: <= 50 characters
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.
currencyConversion
object
Possible values: [MCP
]
The original amount of the transaction in the currency that the merchant requested.
Possible values: >= 3 characters
and <= 3 characters
The 3-letter ISO currency code of the currency that the merchant requested in the transaction.
The transaction amount.
Possible values: >= 3 characters
and <= 3 characters
Possible values: [Auth
, Sale
, PreAuth
]
Determines the transaction type that is sent to the Gateway, when it comes to performing the fiscal transaction. Default is Sale.
Indicates whether the transaction was done over email/phone or is a regular transaction. Values: true = Moto transaction | false = no Moto Transaction
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
Possible values: [recurring
, installments
, addCard
, maintainCard
, accountVerification
]
For Authentication Zero scenarios, this optional field defines the authentication type.
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.
Default value: 0
Default value: 0
Default value: 0
Default value: 0
paymentOption
object
required
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 will return a redirect URL to which the End User should be redirected to fill in missing details. If set to false
a validation error will be returned. The default value is false
card
object
Possible values: <= 70 characters
The card holder name.
Possible values: non-empty
and <= 20 characters
The full card number.
Possible values: >= 2 characters
and <= 2 characters
, Value must match regular expression ^(0[1-9]|1[0-2])$
The card expiration month.
Possible values: >= 2 characters
and <= 4 characters
, Value must match regular expression ^(\d{4}|\d{2})$
The card expiration year.
Possible values: >= 3 characters
and <= 4 characters
, Value must match regular expression ^([0-9]{3}|[0-9]{4})$
The CVV/CVC security code.
Possible values: <= 50 characters
Merchant Reference for a business entity (token, subscription, etc.)
threeD
object
challenge
object
Possible values: [Challenge
, Exemption
, NoPreference
]
Possible values: [LowValueTransaction
, TransactionRiskAnalysis
]
userAccount
object
Number of Add Card attempts in the last 24 hours.
Date when the shipping address used for this transaction was first used with the 3DS Requestor in the format: YYYYMMDD.
Possible values: [01
, 02
, 03
, 04
]
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
, 05
]
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
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.
Possible values: [01
, 02
, 03
, 04
]
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
The date on which the payment account was enrolled in the cardholder's account with the 3DS Requestor.
Possible values: [01
, 02
, 03
, 04
, 05
]
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
]
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
Date that cardholder's account with the 3DS Requestor had a password change or account reset in format: YYYYMMDD.
Number of purchases with this cardholder account during the previous six months.
Date that the cardholder opened the account with the 3DS Requestor in the format: YYYYMMDD.
Possible values: [01
, 02
, 03
, 04
, 05
]
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
]
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
Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year.
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
Possible values: >= 1
For a prepaid or gift card purchase, the total number of individual prepaid or gift cards/codes purchased.
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).
Possible values: >= 3 characters
and <= 3 characters
For a prepaid or gift card purchase, the 3-letter ISO currency code of the gift card.
delivery
object
Possible values: [01
, 02
, 03
, 04
]
Indicates the merchandise delivery time frame. Values: 01 = Electronic Delivery | 02 = Same day shipping | 03 = Overnight shipping | 04 = Two-day or more shipping
preOrder
object
Possible values: [01
, 02
]
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
]
Indicates whether the cardholder is reordering previously purchased merchandise. Values: 01 = First time ordered | 02 = Reordered
Possible values: [01
, 02
, 03
, 04
, 05
, 06
, 07
]
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.)
The URL of the merchant’s fully qualified website.
URL to which the issuer should send the fingerprinting notification response
URL to which the issuer should send a notification after the 3D-Secure challenge step
Possible values: [01
, 02
, 03
, 04
, 05
]
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
]
Default value: 02
The device channel. Values: 01 = SDK | 02 = Browser
Possible values: <= 100
paymentToken
object
Payment Token ID
additionalData
object
threeD
object
challenge
object
Possible values: [Challenge
, Exemption
, NoPreference
]
Possible values: [LowValueTransaction
, TransactionRiskAnalysis
]
userAccount
object
Number of Add Card attempts in the last 24 hours.
Date when the shipping address used for this transaction was first used with the 3DS Requestor in the format: YYYYMMDD.
Possible values: [01
, 02
, 03
, 04
]
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
, 05
]
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
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.
Possible values: [01
, 02
, 03
, 04
]
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
The date on which the payment account was enrolled in the cardholder's account with the 3DS Requestor.
Possible values: [01
, 02
, 03
, 04
, 05
]
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
]
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
Date that cardholder's account with the 3DS Requestor had a password change or account reset in format: YYYYMMDD.
Number of purchases with this cardholder account during the previous six months.
Date that the cardholder opened the account with the 3DS Requestor in the format: YYYYMMDD.
Possible values: [01
, 02
, 03
, 04
, 05
]
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
]
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
Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year.
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
Possible values: >= 1
For a prepaid or gift card purchase, the total number of individual prepaid or gift cards/codes purchased.
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).
Possible values: >= 3 characters
and <= 3 characters
For a prepaid or gift card purchase, the 3-letter ISO currency code of the gift card.
delivery
object
Possible values: [01
, 02
, 03
, 04
]
Indicates the merchandise delivery time frame. Values: 01 = Electronic Delivery | 02 = Same day shipping | 03 = Overnight shipping | 04 = Two-day or more shipping
preOrder
object
Possible values: [01
, 02
]
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
]
Indicates whether the cardholder is reordering previously purchased merchandise. Values: 01 = First time ordered | 02 = Reordered
Possible values: [01
, 02
, 03
, 04
, 05
, 06
, 07
]
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.)
The URL of the merchant’s fully qualified website.
URL to which the issuer should send the fingerprinting notification response
URL to which the issuer should send a notification after the 3D-Secure challenge step
Possible values: [01
, 02
, 03
, 04
, 05
]
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
]
Default value: 02
The device channel. Values: 01 = SDK | 02 = Browser
Possible values: <= 100
temporaryPaymentToken
object
Payment Token ID
Possible values: <= 50 characters
Merchant Reference for a business entity (token, subscription, etc.)
threeD
object
challenge
object
Possible values: [Challenge
, Exemption
, NoPreference
]
Possible values: [LowValueTransaction
, TransactionRiskAnalysis
]
userAccount
object
Number of Add Card attempts in the last 24 hours.
Date when the shipping address used for this transaction was first used with the 3DS Requestor in the format: YYYYMMDD.
Possible values: [01
, 02
, 03
, 04
]
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
, 05
]
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
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.
Possible values: [01
, 02
, 03
, 04
]
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
The date on which the payment account was enrolled in the cardholder's account with the 3DS Requestor.
Possible values: [01
, 02
, 03
, 04
, 05
]
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
]
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
Date that cardholder's account with the 3DS Requestor had a password change or account reset in format: YYYYMMDD.
Number of purchases with this cardholder account during the previous six months.
Date that the cardholder opened the account with the 3DS Requestor in the format: YYYYMMDD.
Possible values: [01
, 02
, 03
, 04
, 05
]
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
]
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
Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year.
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
Possible values: >= 1
For a prepaid or gift card purchase, the total number of individual prepaid or gift cards/codes purchased.
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).
Possible values: >= 3 characters
and <= 3 characters
For a prepaid or gift card purchase, the 3-letter ISO currency code of the gift card.
delivery
object
Possible values: [01
, 02
, 03
, 04
]
Indicates the merchandise delivery time frame. Values: 01 = Electronic Delivery | 02 = Same day shipping | 03 = Overnight shipping | 04 = Two-day or more shipping
preOrder
object
Possible values: [01
, 02
]
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
]
Indicates whether the cardholder is reordering previously purchased merchandise. Values: 01 = First time ordered | 02 = Reordered
Possible values: [01
, 02
, 03
, 04
, 05
, 06
, 07
]
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.)
The URL of the merchant’s fully qualified website.
URL to which the issuer should send the fingerprinting notification response
URL to which the issuer should send a notification after the 3D-Secure challenge step
Possible values: [01
, 02
, 03
, 04
, 05
]
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
]
Default value: 02
The device channel. Values: 01 = SDK | 02 = Browser
Possible values: <= 100
alternativePaymentMethod
object
Possible values: non-empty
and <= 50 characters
data
object
Possible values: <= 50 characters
Merchant Reference for a business entity (token, subscription, etc.)
Possible values: [none
, initial
, subsequent
, tokenOnly
, buyerToken
]
eWallet
object
Possible values: [ApplePay
, GooglePay
]
The name of the external token provider Possible values: [ApplePay, GooglePay]
Possible values: <= 5000 characters
This encrypted token (REQUIRED for Apple Pay and Google Pay) represents a customer payment method generated by the external token provider
items
object[]
dynamicDescriptor
object
Possible values: <= 25 characters
The merchant name, as is displayed for the transaction on the consumer's card statement.
Possible values: <= 255 characters
The merchant contact information, as is displayed for the transaction on the consumer's card statement. It can also be an email address.
urlDetails
object
The URL to which notifications for outcome of the financial transactions is sent.
The URL to which the end user is redirected for a successful transaction with an APM.
The URL to which the end user is redirected for an unsuccessful transaction with an APM.
The URL to which the end user is redirected for a pending transaction with an APM.
rebill
object
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
Recurring Frequency in days. REQUIRED if step = init
Possible values: [init
, recurring
, MIT
]
deviceDetails
object
Supported device types include: DESKTOP, SMARTPHONE, TABLET, TV, UNKNOWN (if device type cannot be recognized).
The customer's IP address
browser
object
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.
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
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
Determines whether the browser is JavaScript enabled (from navigator.javaScriptEnabled
property). Values: TRUE, FALSE
Value representing the browser language as defined in IETF BCP47. Returned from navigator.language
property.
Total height of the cardholder's screen in pixels. Value is returned from the screen.height
property.
Total width of the cardholder's screen in pixels. Value is returned from the screen
.width property.
Time difference between UTC time and the cardholder browser local time, in minutes. Values: Value is returned from the getTimezoneOffset()
method.
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
buyerDetails
object
Possible values: <= 255 characters
Possible values: <= 30 characters
Possible values: <= 40 characters
Possible values: <= 100 characters
Possible values: <= 5 characters
The user's locale and default language.
Format is YYYY-MM-DD.
Possible values: <= 100 characters
Possible values: <= 18 characters
Possible values: <= 18 characters
Possible values: <= 18 characters
Possible values: <= 25 characters
The user's national ID number.
billingAddress
object
Possible values: <= 60 characters
Possible values: <= 60 characters
Possible values: <= 60 characters
Possible values: <= 6 characters
Possible values: <= 10 characters
Possible values: <= 30 characters
Possible values: >= 2 characters
and <= 2 characters
Possible values: <= 18 characters
Set to “true” when address matches shipping address.
shippingAddress
object
Possible values: <= 60 characters
Possible values: <= 60 characters
Possible values: <= 60 characters
Possible values: <= 6 characters
Possible values: <= 10 characters
Possible values: <= 30 characters
Possible values: >= 2 characters
and <= 2 characters
Possible values: <= 30 characters
Possible values: <= 40 characters
Possible values: <= 18 characters
Possible values: <= 18 characters
Responses
- 200
- 400
- 401
- 403
- 500
OK
- application/json
- Schema
- Example (from schema)
- Card non-3D authorizedOnly
- Declined card non-3D PreAuth Transaction
- Approved Card 3D Fingerprint
Schema
Possible values: <= 20 characters
Nuvei Digital Payments Gateway Transaction ID
Possible values: <= 50 characters
The transaction ID of the transaction in the event that an external service is used.
The transaction amount.
Possible values: [Auth
, Sale
, PreAuth
, Settle
, Void
, Refund
, InitAuth3D
, Auth3D
, Sale3D
]
Determines the transaction type that is sent to the Gateway, when it comes to performing the fiscal transaction. Default is Sale.
result
object
required
Possible values: [approved
, authorizedOnly
, declined
, error
, pending
, redirect
, challenge
, fingerprint
, authenticated
, authenticationNotSupported
]
errors
object
Possible values: <= 11 characters
Possible values: <= 400 characters
Possible values: <= 128 characters
The authorization code of the transaction.
Possible values: <= 1 characters
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
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.
partialApproval
object
Possible values: >= 3 characters
and <= 3 characters
Possible values: <= 2000 characters
paymentOption
object
card
object
Possible values: <= 70 characters
The card holder name.
Possible values: <= 20 characters
The masked credit card number.
Possible values: <= 8 characters
The first six digits from the credit card number for identifying the processing bank. The rest of the number is not displayed.
Possible values: <= 4 characters
The last four digits of the card number.
Possible values: <= 2 characters
The card expiration month.
Possible values: <= 4 characters
The card expiration year.
Possible values: <= 2 characters
The ID of the acquirer that processed the transaction.
Possible values: <= 20 characters
The type of card used in the transaction. Values: Credit, Debit
Possible values: <= 20 characters
The card brand used in the transaction. Values: VISA, MASTERCARD, AMEX
Possible values: <= 29 characters
Payment Token ID
Possible values: <= 50 characters
Merchant Reference for a business entity (token, subscription, etc.)
threeD
object
The URL to which to post the fingerprintPayload to perform device fingerprinting.
The payload to be posted to the fingerprintUrl to perform the device fingerprinting.
The transaction ID of the Directory Server (part of the fingerprintPayload).
The URL of the Access Control Server to perform the challenge request.
The payload to be posted to the acsUrl to perform the challenge request.
The transaction ID of the Access Control Server (part of the cReq).
Possible values: <= 10 characters
The full version of the 3DS protocol for the transaction.
The transaction ID received from the MPI for 3D-Secure v2.
Possible values: <= 2 characters
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.
Possible values: <= 40 characters
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.
Possible values: [Y
, N
, E
, P
, R
, U
]
Indicates if this consumer defined this merchant as whitelist or not. If the consumer defined the merchant, then this is the reason the challenge did not happen. Values: Y = 3DS Requestor is whitelisted by cardholder | N = 3DS Requestor is not whitelisted by cardholder | E = Not eligible as determined by issuer | P = Pending confirmation by cardholder | R = Cardholder rejected | U = Whitelist status unknown, unavailable, or does not apply
Possible values: [Y
, N
]
The 3D Secure 2.0 challenge indication. Values: N = not required | Y = required
Possible values: >= 2 characters
and <= 2 characters
The type of authentication performed during the 3D Secure 2.0 challenge. If the merchant wants to react differently for each authentication type, then they can, per the value returned. Values: 01 = Static | 02 = Dynamic | 03 = OOB | 04 = Decoupled | 05–79 = Reserved for EMVCo future use (values invalid until defined by EMVCo) | 80–99 = Reserved for DS use
Possible values: [Y
, N
, U
, A
, C
, D
, R
, I
]
Indicates whether a transaction qualifies as an authenticated transaction or account verification. Note: The Final CRes message can contain only a value of Y or N. Values: Y = Authentication Verification Successful | N = Not Authenticated /Account Not Verified; Transaction denied | U = Authentication/ Account Verification Could Not Be Performed; Technical or other problem, as indicated in ARes or RReq | A = Attempts Processing Performed; Not Authenticated/Verified, but a proof of attempted authentication/verification is provided | C = Challenge Required; Additional authentication is required using the CReq/CRes | D = Challenge Required; Decoupled Authentication confirmed | R = Authentication/ Account Verification Rejected; Issuer is rejecting | I = Informational only (issuer approved SCA exemption)
Possible values: [Challenge
, Frictionless
, Exemption
, NoLiability
, Stop
]
The 3D-Secure flow required by the issuer. Values: 1 = Challenge | 2 = Frictionless | 3 = Exemption | 4 = NoLiability | 5 = Stop
Possible values: >= 2 characters
and <= 2 characters
The text provided by the ACS/Issuer to the cardholder during a frictionless transaction that was not authenticated by the ACS/Issuer. For example: “Additional authentication is needed for this transaction. Please contact [Issuer Name] at xxx-xxx-xxxx.” If this parameter is populated, the merchant must display the information to the cardholder.
The Merchant ID provided by Nuvei.
This value is returned following a 3D-Secure v2 challenge and describes the reason for challenge. Press here for more information.
The acquirer's request from the merchant to perform a certain flow. Values: ChallengeRequest, ExemptionRequest
The description of the acquirer's decision. Press here to see a table that presents the possible values.
Reason description for a canceled 3D-Secure authorization as received from the issuer.
Reason ID for a canceled 3D-Secure authorization as received from the issuer.
Indicates if there is 3D-Secure liability shift. If equal to “1” – Liability shift is present. If equal to “0”, empty or null – No liability shift has occurred.
alternativePaymentMethod
object
Possible values: non-empty
and <= 50 characters
data
object
Possible values: <= 50 characters
Merchant Reference for a business entity (token, subscription, etc.)
Payment Token ID
eWallet
object
Possible values: [ApplePay
, GooglePay
]
The name of the external token provider Possible values: [ApplePay, GooglePay]
Possible values: <= 100 characters
Possible values: <= 2 characters
The card expiration month.
Possible values: <= 4 characters
The card expiration year.
Possible values: <= 70 characters
The card holder name.
Possible values: <= 20 characters
The masked credit card number.
Possible values: <= 8 characters
The first six digits from the credit card number for identifying the processing bank. The rest of the number is not displayed.
Possible values: <= 4 characters
The last four digits of the card number.
Possible values: <= 2 characters
The ID of the acquirer that processed the transaction.
Possible values: <= 20 characters
The type of card used in the transaction. Values: Credit, Debit
Possible values: <= 20 characters
The card brand used in the transaction. Values: VISA, MASTERCARD, AMEX
providerResponseDetails
object
Possible values: <= 100 characters
Possible values: <= 400 characters
additionalTransactionInfo
object
{
"paymentId": "2f00eba7-66ad-4d8b-8d54-b8c9183e664f",
"transactionId": "string",
"externalTransactionId": "string",
"amount": 0,
"currency": "string",
"transactionType": "Auth",
"result": {
"status": "approved",
"errors": {
"code": "7000.1000",
"reason": "Internal Processing Error"
}
},
"authCode": "string",
"cvv2Code": "string",
"avsCode": "string",
"partialApproval": {
"requestedAmount": 0,
"requestedCurrency": "string"
},
"redirectUrl": "string",
"paymentOption": {
"card": {
"cardHolderName": "string",
"maskedCardNumber": "string",
"bin": "string",
"last4Digits": "string",
"expirationMonth": "string",
"expirationYear": "string",
"acquirerId": "string",
"cardType": "string",
"cardBrand": "string",
"paymentAccountReference": "string",
"paymentTokenId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"merchantReference": "12391284AF87C7D2",
"threeD": {
"fingerprintUrl": "string",
"fingerprintPayload": "string",
"dsTransId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"isExemptionRequestInAuthentication": true,
"acsUrl": "string",
"cReq": "string",
"acsTransId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"version": "2.1.0",
"serverTransId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"eci": "2",
"cavv": "string",
"whiteListStatus": "Y",
"acsChallengeMandate": "Y",
"authenticationType": "string",
"authenticationResult": "Y",
"flow": "Challenge",
"reasonId": "string",
"reason": "string",
"cardholderInfoText": "string",
"merchantId": "string",
"challengePreferenceReason": "string",
"acquirerDecision": "string",
"decisionReason": "string",
"challengeCancelReason": "string",
"challengeCancelReasonId": "string",
"isLiabilityOnIssuer": true
}
},
"alternativePaymentMethod": {
"name": "ACH",
"data": {
"accountNumber": "11345739548759",
"routingNumber": "847937857"
},
"merchantReference": "12391284AF87C7D2",
"paymentTokenId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"eWallet": {
"provider": "ApplePay",
"eciIndicator": "string",
"expirationMonth": "string",
"expirationYear": "string",
"cardHolderName": "string",
"maskedCardNumber": "string",
"bin": "string",
"last4Digits": "string",
"acquirerId": "string",
"cardType": "string",
"cardBrand": "string"
}
},
"providerResponseDetails": {
"code": "string",
"reason": "string"
},
"additionalTransactionInfo": {
"additionalTransactionBankId": "string",
"referenceId": "string"
}
}
{
"paymentId": "49900038994789921",
"transactionId": "2110000000011875910",
"amount": 58.5,
"currency": "USD",
"transactionType": "Auth",
"result": {
"status": "authorizedOnly"
},
"authCode": "006121",
"partialApproval": {
"requestedAmount": 58.5,
"requestedCurrency": "USD"
},
"paymentOption": {
"card": {
"maskedCardNumber": "4****8239",
"bin": "484511",
"last4Digits": "8239",
"expirationMonth": "05",
"expirationYear": "24",
"acquirerId": "103",
"cardType": "Credit",
"cardBrand": "VISA",
"paymentTokenId": "048fa83e-8b2a-4a9c-a2ee-23a137fd2ea3"
}
}
}
{
"paymentId": "49900038994789921",
"transactionId": "2110000000011875913",
"externalTransactionId": "211011875913",
"amount": 57.05,
"currency": "USD",
"transactionType": "PreAuth",
"result": {
"status": "declined",
"errors": {
"code": "1400.1000",
"reason": "Invalid Card Number"
}
},
"paymentOption": {
"card": {
"maskedCardNumber": "5****6627",
"bin": "522529",
"last4Digits": "6627",
"expirationMonth": "05",
"expirationYear": "24",
"acquirerId": "99",
"cardType": "Credit",
"cardBrand": "MASTERCARD"
}
},
"providerResponseDetails": {
"code": "14",
"reason": "Invalid Card Number"
}
}
{
"paymentId": "49900038994789921",
"transactionId": "2110000000011875915",
"amount": 47.86,
"currency": "USD",
"transactionType": "InitAuth3D",
"result": {
"status": "fingerprint"
},
"partialApproval": {
"requestedAmount": 47.86,
"requestedCurrency": "USD"
},
"paymentOption": {
"card": {
"maskedCardNumber": "4***9987",
"bin": "489537",
"last4Digits": "9987",
"expirationMonth": "03",
"expirationYear": "24",
"acquirerId": "103",
"cardType": "Credit",
"cardBrand": "VISA",
"threeD": {
"fingerprintUrl": "https://3dsn-qa.nuvei.com/api/ThreeDSMethod/threeDSMethodURL/",
"fingerprintPayload": "eyJ0aHJlZURTU2VydmVyVHJhbnNJRCI6IjQzNTlmOWZlLTVhODEtNDEzNS1iMWE2LTc1ZjcxZDAwYTY2NyIsInRocmVlRFNNZXRob2ROb3RpZmljYXRpb25VUkwiOiJ3d3cuZmluZ2VycHJpbnROb3RpZmljYXRpb24uODM1MS5jb20ifQ==",
"version": "2.2.0",
"challengePreferenceReason": "NoPreference",
"acquirerDecision": "ExemptionRequest",
"decisionReason": "NoPreference"
}
}
}
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Invalid Value
- Missing Mandatory Field Value
Schema
Possible values: <= 20 characters
Nuvei Digital Payments Gateway Transaction ID
Possible values: <= 50 characters
The transaction ID of the transaction in the event that an external service is used.
The transaction amount.
Possible values: [Auth
, Sale
, PreAuth
, Settle
, Void
, Refund
, InitAuth3D
, Auth3D
, Sale3D
]
Determines the transaction type that is sent to the Gateway, when it comes to performing the fiscal transaction. Default is Sale.
result
object
required
Possible values: [approved
, authorizedOnly
, declined
, error
, pending
, redirect
, challenge
, fingerprint
, authenticated
, authenticationNotSupported
]
errors
object
Possible values: <= 11 characters
Possible values: <= 400 characters
Possible values: <= 128 characters
The authorization code of the transaction.
Possible values: <= 1 characters
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
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.
partialApproval
object
Possible values: >= 3 characters
and <= 3 characters
Possible values: <= 2000 characters
paymentOption
object
card
object
Possible values: <= 70 characters
The card holder name.
Possible values: <= 20 characters
The masked credit card number.
Possible values: <= 8 characters
The first six digits from the credit card number for identifying the processing bank. The rest of the number is not displayed.
Possible values: <= 4 characters
The last four digits of the card number.
Possible values: <= 2 characters
The card expiration month.
Possible values: <= 4 characters
The card expiration year.
Possible values: <= 2 characters
The ID of the acquirer that processed the transaction.
Possible values: <= 20 characters
The type of card used in the transaction. Values: Credit, Debit
Possible values: <= 20 characters
The card brand used in the transaction. Values: VISA, MASTERCARD, AMEX
Possible values: <= 29 characters
Payment Token ID
Possible values: <= 50 characters
Merchant Reference for a business entity (token, subscription, etc.)
threeD
object
The URL to which to post the fingerprintPayload to perform device fingerprinting.
The payload to be posted to the fingerprintUrl to perform the device fingerprinting.
The transaction ID of the Directory Server (part of the fingerprintPayload).
The URL of the Access Control Server to perform the challenge request.
The payload to be posted to the acsUrl to perform the challenge request.
The transaction ID of the Access Control Server (part of the cReq).
Possible values: <= 10 characters
The full version of the 3DS protocol for the transaction.
The transaction ID received from the MPI for 3D-Secure v2.
Possible values: <= 2 characters
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.
Possible values: <= 40 characters
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.
Possible values: [Y
, N
, E
, P
, R
, U
]
Indicates if this consumer defined this merchant as whitelist or not. If the consumer defined the merchant, then this is the reason the challenge did not happen. Values: Y = 3DS Requestor is whitelisted by cardholder | N = 3DS Requestor is not whitelisted by cardholder | E = Not eligible as determined by issuer | P = Pending confirmation by cardholder | R = Cardholder rejected | U = Whitelist status unknown, unavailable, or does not apply
Possible values: [Y
, N
]
The 3D Secure 2.0 challenge indication. Values: N = not required | Y = required
Possible values: >= 2 characters
and <= 2 characters
The type of authentication performed during the 3D Secure 2.0 challenge. If the merchant wants to react differently for each authentication type, then they can, per the value returned. Values: 01 = Static | 02 = Dynamic | 03 = OOB | 04 = Decoupled | 05–79 = Reserved for EMVCo future use (values invalid until defined by EMVCo) | 80–99 = Reserved for DS use
Possible values: [Y
, N
, U
, A
, C
, D
, R
, I
]
Indicates whether a transaction qualifies as an authenticated transaction or account verification. Note: The Final CRes message can contain only a value of Y or N. Values: Y = Authentication Verification Successful | N = Not Authenticated /Account Not Verified; Transaction denied | U = Authentication/ Account Verification Could Not Be Performed; Technical or other problem, as indicated in ARes or RReq | A = Attempts Processing Performed; Not Authenticated/Verified, but a proof of attempted authentication/verification is provided | C = Challenge Required; Additional authentication is required using the CReq/CRes | D = Challenge Required; Decoupled Authentication confirmed | R = Authentication/ Account Verification Rejected; Issuer is rejecting | I = Informational only (issuer approved SCA exemption)
Possible values: [Challenge
, Frictionless
, Exemption
, NoLiability
, Stop
]
The 3D-Secure flow required by the issuer. Values: 1 = Challenge | 2 = Frictionless | 3 = Exemption | 4 = NoLiability | 5 = Stop
Possible values: >= 2 characters
and <= 2 characters
The text provided by the ACS/Issuer to the cardholder during a frictionless transaction that was not authenticated by the ACS/Issuer. For example: “Additional authentication is needed for this transaction. Please contact [Issuer Name] at xxx-xxx-xxxx.” If this parameter is populated, the merchant must display the information to the cardholder.
The Merchant ID provided by Nuvei.
This value is returned following a 3D-Secure v2 challenge and describes the reason for challenge. Press here for more information.
The acquirer's request from the merchant to perform a certain flow. Values: ChallengeRequest, ExemptionRequest
The description of the acquirer's decision. Press here to see a table that presents the possible values.
Reason description for a canceled 3D-Secure authorization as received from the issuer.
Reason ID for a canceled 3D-Secure authorization as received from the issuer.
Indicates if there is 3D-Secure liability shift. If equal to “1” – Liability shift is present. If equal to “0”, empty or null – No liability shift has occurred.
alternativePaymentMethod
object
Possible values: non-empty
and <= 50 characters
data
object
Possible values: <= 50 characters
Merchant Reference for a business entity (token, subscription, etc.)
Payment Token ID
eWallet
object
Possible values: [ApplePay
, GooglePay
]
The name of the external token provider Possible values: [ApplePay, GooglePay]
Possible values: <= 100 characters
Possible values: <= 2 characters
The card expiration month.
Possible values: <= 4 characters
The card expiration year.
Possible values: <= 70 characters
The card holder name.
Possible values: <= 20 characters
The masked credit card number.
Possible values: <= 8 characters
The first six digits from the credit card number for identifying the processing bank. The rest of the number is not displayed.
Possible values: <= 4 characters
The last four digits of the card number.
Possible values: <= 2 characters
The ID of the acquirer that processed the transaction.
Possible values: <= 20 characters
The type of card used in the transaction. Values: Credit, Debit
Possible values: <= 20 characters
The card brand used in the transaction. Values: VISA, MASTERCARD, AMEX
providerResponseDetails
object
Possible values: <= 100 characters
Possible values: <= 400 characters
additionalTransactionInfo
object
{
"paymentId": "2f00eba7-66ad-4d8b-8d54-b8c9183e664f",
"transactionId": "string",
"externalTransactionId": "string",
"amount": 0,
"currency": "string",
"transactionType": "Auth",
"result": {
"status": "approved",
"errors": {
"code": "7000.1000",
"reason": "Internal Processing Error"
}
},
"authCode": "string",
"cvv2Code": "string",
"avsCode": "string",
"partialApproval": {
"requestedAmount": 0,
"requestedCurrency": "string"
},
"redirectUrl": "string",
"paymentOption": {
"card": {
"cardHolderName": "string",
"maskedCardNumber": "string",
"bin": "string",
"last4Digits": "string",
"expirationMonth": "string",
"expirationYear": "string",
"acquirerId": "string",
"cardType": "string",
"cardBrand": "string",
"paymentAccountReference": "string",
"paymentTokenId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"merchantReference": "12391284AF87C7D2",
"threeD": {
"fingerprintUrl": "string",
"fingerprintPayload": "string",
"dsTransId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"isExemptionRequestInAuthentication": true,
"acsUrl": "string",
"cReq": "string",
"acsTransId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"version": "2.1.0",
"serverTransId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"eci": "2",
"cavv": "string",
"whiteListStatus": "Y",
"acsChallengeMandate": "Y",
"authenticationType": "string",
"authenticationResult": "Y",
"flow": "Challenge",
"reasonId": "string",
"reason": "string",
"cardholderInfoText": "string",
"merchantId": "string",
"challengePreferenceReason": "string",
"acquirerDecision": "string",
"decisionReason": "string",
"challengeCancelReason": "string",
"challengeCancelReasonId": "string",
"isLiabilityOnIssuer": true
}
},
"alternativePaymentMethod": {
"name": "ACH",
"data": {
"accountNumber": "11345739548759",
"routingNumber": "847937857"
},
"merchantReference": "12391284AF87C7D2",
"paymentTokenId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"eWallet": {
"provider": "ApplePay",
"eciIndicator": "string",
"expirationMonth": "string",
"expirationYear": "string",
"cardHolderName": "string",
"maskedCardNumber": "string",
"bin": "string",
"last4Digits": "string",
"acquirerId": "string",
"cardType": "string",
"cardBrand": "string"
}
},
"providerResponseDetails": {
"code": "string",
"reason": "string"
},
"additionalTransactionInfo": {
"additionalTransactionBankId": "string",
"referenceId": "string"
}
}
{
"result": {
"status": "error",
"errors": {
"code": "5000.1000",
"reason": "[paymentOption.card.expirationMonth] must match \"^(0[1-9]|1[0-2])$\""
}
}
}
{
"result": {
"status": "error",
"errors": {
"code": "5000.1000",
"reason": "[processingEntityId] must not be null"
}
}
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- Authorization Error
Schema
Possible values: <= 20 characters
Nuvei Digital Payments Gateway Transaction ID
Possible values: <= 50 characters
The transaction ID of the transaction in the event that an external service is used.
The transaction amount.
Possible values: [Auth
, Sale
, PreAuth
, Settle
, Void
, Refund
, InitAuth3D
, Auth3D
, Sale3D
]
Determines the transaction type that is sent to the Gateway, when it comes to performing the fiscal transaction. Default is Sale.
result
object
required
Possible values: [approved
, authorizedOnly
, declined
, error
, pending
, redirect
, challenge
, fingerprint
, authenticated
, authenticationNotSupported
]
errors
object
Possible values: <= 11 characters
Possible values: <= 400 characters
Possible values: <= 128 characters
The authorization code of the transaction.
Possible values: <= 1 characters
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
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.
partialApproval
object
Possible values: >= 3 characters
and <= 3 characters
Possible values: <= 2000 characters
paymentOption
object
card
object
Possible values: <= 70 characters
The card holder name.
Possible values: <= 20 characters
The masked credit card number.
Possible values: <= 8 characters
The first six digits from the credit card number for identifying the processing bank. The rest of the number is not displayed.
Possible values: <= 4 characters
The last four digits of the card number.
Possible values: <= 2 characters
The card expiration month.
Possible values: <= 4 characters
The card expiration year.
Possible values: <= 2 characters
The ID of the acquirer that processed the transaction.
Possible values: <= 20 characters
The type of card used in the transaction. Values: Credit, Debit
Possible values: <= 20 characters
The card brand used in the transaction. Values: VISA, MASTERCARD, AMEX
Possible values: <= 29 characters
Payment Token ID
Possible values: <= 50 characters
Merchant Reference for a business entity (token, subscription, etc.)
threeD
object
The URL to which to post the fingerprintPayload to perform device fingerprinting.
The payload to be posted to the fingerprintUrl to perform the device fingerprinting.
The transaction ID of the Directory Server (part of the fingerprintPayload).
The URL of the Access Control Server to perform the challenge request.
The payload to be posted to the acsUrl to perform the challenge request.
The transaction ID of the Access Control Server (part of the cReq).
Possible values: <= 10 characters
The full version of the 3DS protocol for the transaction.
The transaction ID received from the MPI for 3D-Secure v2.
Possible values: <= 2 characters
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.
Possible values: <= 40 characters
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.
Possible values: [Y
, N
, E
, P
, R
, U
]
Indicates if this consumer defined this merchant as whitelist or not. If the consumer defined the merchant, then this is the reason the challenge did not happen. Values: Y = 3DS Requestor is whitelisted by cardholder | N = 3DS Requestor is not whitelisted by cardholder | E = Not eligible as determined by issuer | P = Pending confirmation by cardholder | R = Cardholder rejected | U = Whitelist status unknown, unavailable, or does not apply
Possible values: [Y
, N
]
The 3D Secure 2.0 challenge indication. Values: N = not required | Y = required
Possible values: >= 2 characters
and <= 2 characters
The type of authentication performed during the 3D Secure 2.0 challenge. If the merchant wants to react differently for each authentication type, then they can, per the value returned. Values: 01 = Static | 02 = Dynamic | 03 = OOB | 04 = Decoupled | 05–79 = Reserved for EMVCo future use (values invalid until defined by EMVCo) | 80–99 = Reserved for DS use
Possible values: [Y
, N
, U
, A
, C
, D
, R
, I
]
Indicates whether a transaction qualifies as an authenticated transaction or account verification. Note: The Final CRes message can contain only a value of Y or N. Values: Y = Authentication Verification Successful | N = Not Authenticated /Account Not Verified; Transaction denied | U = Authentication/ Account Verification Could Not Be Performed; Technical or other problem, as indicated in ARes or RReq | A = Attempts Processing Performed; Not Authenticated/Verified, but a proof of attempted authentication/verification is provided | C = Challenge Required; Additional authentication is required using the CReq/CRes | D = Challenge Required; Decoupled Authentication confirmed | R = Authentication/ Account Verification Rejected; Issuer is rejecting | I = Informational only (issuer approved SCA exemption)
Possible values: [Challenge
, Frictionless
, Exemption
, NoLiability
, Stop
]
The 3D-Secure flow required by the issuer. Values: 1 = Challenge | 2 = Frictionless | 3 = Exemption | 4 = NoLiability | 5 = Stop
Possible values: >= 2 characters
and <= 2 characters
The text provided by the ACS/Issuer to the cardholder during a frictionless transaction that was not authenticated by the ACS/Issuer. For example: “Additional authentication is needed for this transaction. Please contact [Issuer Name] at xxx-xxx-xxxx.” If this parameter is populated, the merchant must display the information to the cardholder.
The Merchant ID provided by Nuvei.
This value is returned following a 3D-Secure v2 challenge and describes the reason for challenge. Press here for more information.
The acquirer's request from the merchant to perform a certain flow. Values: ChallengeRequest, ExemptionRequest
The description of the acquirer's decision. Press here to see a table that presents the possible values.
Reason description for a canceled 3D-Secure authorization as received from the issuer.
Reason ID for a canceled 3D-Secure authorization as received from the issuer.
Indicates if there is 3D-Secure liability shift. If equal to “1” – Liability shift is present. If equal to “0”, empty or null – No liability shift has occurred.
alternativePaymentMethod
object
Possible values: non-empty
and <= 50 characters
data
object
Possible values: <= 50 characters
Merchant Reference for a business entity (token, subscription, etc.)
Payment Token ID
eWallet
object
Possible values: [ApplePay
, GooglePay
]
The name of the external token provider Possible values: [ApplePay, GooglePay]
Possible values: <= 100 characters
Possible values: <= 2 characters
The card expiration month.
Possible values: <= 4 characters
The card expiration year.
Possible values: <= 70 characters
The card holder name.
Possible values: <= 20 characters
The masked credit card number.
Possible values: <= 8 characters
The first six digits from the credit card number for identifying the processing bank. The rest of the number is not displayed.
Possible values: <= 4 characters
The last four digits of the card number.
Possible values: <= 2 characters
The ID of the acquirer that processed the transaction.
Possible values: <= 20 characters
The type of card used in the transaction. Values: Credit, Debit
Possible values: <= 20 characters
The card brand used in the transaction. Values: VISA, MASTERCARD, AMEX
providerResponseDetails
object
Possible values: <= 100 characters
Possible values: <= 400 characters
additionalTransactionInfo
object
{
"paymentId": "2f00eba7-66ad-4d8b-8d54-b8c9183e664f",
"transactionId": "string",
"externalTransactionId": "string",
"amount": 0,
"currency": "string",
"transactionType": "Auth",
"result": {
"status": "approved",
"errors": {
"code": "7000.1000",
"reason": "Internal Processing Error"
}
},
"authCode": "string",
"cvv2Code": "string",
"avsCode": "string",
"partialApproval": {
"requestedAmount": 0,
"requestedCurrency": "string"
},
"redirectUrl": "string",
"paymentOption": {
"card": {
"cardHolderName": "string",
"maskedCardNumber": "string",
"bin": "string",
"last4Digits": "string",
"expirationMonth": "string",
"expirationYear": "string",
"acquirerId": "string",
"cardType": "string",
"cardBrand": "string",
"paymentAccountReference": "string",
"paymentTokenId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"merchantReference": "12391284AF87C7D2",
"threeD": {
"fingerprintUrl": "string",
"fingerprintPayload": "string",
"dsTransId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"isExemptionRequestInAuthentication": true,
"acsUrl": "string",
"cReq": "string",
"acsTransId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"version": "2.1.0",
"serverTransId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"eci": "2",
"cavv": "string",
"whiteListStatus": "Y",
"acsChallengeMandate": "Y",
"authenticationType": "string",
"authenticationResult": "Y",
"flow": "Challenge",
"reasonId": "string",
"reason": "string",
"cardholderInfoText": "string",
"merchantId": "string",
"challengePreferenceReason": "string",
"acquirerDecision": "string",
"decisionReason": "string",
"challengeCancelReason": "string",
"challengeCancelReasonId": "string",
"isLiabilityOnIssuer": true
}
},
"alternativePaymentMethod": {
"name": "ACH",
"data": {
"accountNumber": "11345739548759",
"routingNumber": "847937857"
},
"merchantReference": "12391284AF87C7D2",
"paymentTokenId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"eWallet": {
"provider": "ApplePay",
"eciIndicator": "string",
"expirationMonth": "string",
"expirationYear": "string",
"cardHolderName": "string",
"maskedCardNumber": "string",
"bin": "string",
"last4Digits": "string",
"acquirerId": "string",
"cardType": "string",
"cardBrand": "string"
}
},
"providerResponseDetails": {
"code": "string",
"reason": "string"
},
"additionalTransactionInfo": {
"additionalTransactionBankId": "string",
"referenceId": "string"
}
}
{
"result": {
"status": "error",
"errors": {
"code": "7300.3000",
"reason": "Authorization error."
}
}
}
Forbidden
- application/json
- Schema
- Example (from schema)
- Authorization Error
Schema
Possible values: <= 20 characters
Nuvei Digital Payments Gateway Transaction ID
Possible values: <= 50 characters
The transaction ID of the transaction in the event that an external service is used.
The transaction amount.
Possible values: [Auth
, Sale
, PreAuth
, Settle
, Void
, Refund
, InitAuth3D
, Auth3D
, Sale3D
]
Determines the transaction type that is sent to the Gateway, when it comes to performing the fiscal transaction. Default is Sale.
result
object
required
Possible values: [approved
, authorizedOnly
, declined
, error
, pending
, redirect
, challenge
, fingerprint
, authenticated
, authenticationNotSupported
]
errors
object
Possible values: <= 11 characters
Possible values: <= 400 characters
Possible values: <= 128 characters
The authorization code of the transaction.
Possible values: <= 1 characters
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
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.
partialApproval
object
Possible values: >= 3 characters
and <= 3 characters
Possible values: <= 2000 characters
paymentOption
object
card
object
Possible values: <= 70 characters
The card holder name.
Possible values: <= 20 characters
The masked credit card number.
Possible values: <= 8 characters
The first six digits from the credit card number for identifying the processing bank. The rest of the number is not displayed.
Possible values: <= 4 characters
The last four digits of the card number.
Possible values: <= 2 characters
The card expiration month.
Possible values: <= 4 characters
The card expiration year.
Possible values: <= 2 characters
The ID of the acquirer that processed the transaction.
Possible values: <= 20 characters
The type of card used in the transaction. Values: Credit, Debit
Possible values: <= 20 characters
The card brand used in the transaction. Values: VISA, MASTERCARD, AMEX
Possible values: <= 29 characters
Payment Token ID
Possible values: <= 50 characters
Merchant Reference for a business entity (token, subscription, etc.)
threeD
object
The URL to which to post the fingerprintPayload to perform device fingerprinting.
The payload to be posted to the fingerprintUrl to perform the device fingerprinting.
The transaction ID of the Directory Server (part of the fingerprintPayload).
The URL of the Access Control Server to perform the challenge request.
The payload to be posted to the acsUrl to perform the challenge request.
The transaction ID of the Access Control Server (part of the cReq).
Possible values: <= 10 characters
The full version of the 3DS protocol for the transaction.
The transaction ID received from the MPI for 3D-Secure v2.
Possible values: <= 2 characters
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.
Possible values: <= 40 characters
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.
Possible values: [Y
, N
, E
, P
, R
, U
]
Indicates if this consumer defined this merchant as whitelist or not. If the consumer defined the merchant, then this is the reason the challenge did not happen. Values: Y = 3DS Requestor is whitelisted by cardholder | N = 3DS Requestor is not whitelisted by cardholder | E = Not eligible as determined by issuer | P = Pending confirmation by cardholder | R = Cardholder rejected | U = Whitelist status unknown, unavailable, or does not apply
Possible values: [Y
, N
]
The 3D Secure 2.0 challenge indication. Values: N = not required | Y = required
Possible values: >= 2 characters
and <= 2 characters
The type of authentication performed during the 3D Secure 2.0 challenge. If the merchant wants to react differently for each authentication type, then they can, per the value returned. Values: 01 = Static | 02 = Dynamic | 03 = OOB | 04 = Decoupled | 05–79 = Reserved for EMVCo future use (values invalid until defined by EMVCo) | 80–99 = Reserved for DS use
Possible values: [Y
, N
, U
, A
, C
, D
, R
, I
]
Indicates whether a transaction qualifies as an authenticated transaction or account verification. Note: The Final CRes message can contain only a value of Y or N. Values: Y = Authentication Verification Successful | N = Not Authenticated /Account Not Verified; Transaction denied | U = Authentication/ Account Verification Could Not Be Performed; Technical or other problem, as indicated in ARes or RReq | A = Attempts Processing Performed; Not Authenticated/Verified, but a proof of attempted authentication/verification is provided | C = Challenge Required; Additional authentication is required using the CReq/CRes | D = Challenge Required; Decoupled Authentication confirmed | R = Authentication/ Account Verification Rejected; Issuer is rejecting | I = Informational only (issuer approved SCA exemption)
Possible values: [Challenge
, Frictionless
, Exemption
, NoLiability
, Stop
]
The 3D-Secure flow required by the issuer. Values: 1 = Challenge | 2 = Frictionless | 3 = Exemption | 4 = NoLiability | 5 = Stop
Possible values: >= 2 characters
and <= 2 characters
The text provided by the ACS/Issuer to the cardholder during a frictionless transaction that was not authenticated by the ACS/Issuer. For example: “Additional authentication is needed for this transaction. Please contact [Issuer Name] at xxx-xxx-xxxx.” If this parameter is populated, the merchant must display the information to the cardholder.
The Merchant ID provided by Nuvei.
This value is returned following a 3D-Secure v2 challenge and describes the reason for challenge. Press here for more information.
The acquirer's request from the merchant to perform a certain flow. Values: ChallengeRequest, ExemptionRequest
The description of the acquirer's decision. Press here to see a table that presents the possible values.
Reason description for a canceled 3D-Secure authorization as received from the issuer.
Reason ID for a canceled 3D-Secure authorization as received from the issuer.
Indicates if there is 3D-Secure liability shift. If equal to “1” – Liability shift is present. If equal to “0”, empty or null – No liability shift has occurred.
alternativePaymentMethod
object
Possible values: non-empty
and <= 50 characters
data
object
Possible values: <= 50 characters
Merchant Reference for a business entity (token, subscription, etc.)
Payment Token ID
eWallet
object
Possible values: [ApplePay
, GooglePay
]
The name of the external token provider Possible values: [ApplePay, GooglePay]
Possible values: <= 100 characters
Possible values: <= 2 characters
The card expiration month.
Possible values: <= 4 characters
The card expiration year.
Possible values: <= 70 characters
The card holder name.
Possible values: <= 20 characters
The masked credit card number.
Possible values: <= 8 characters
The first six digits from the credit card number for identifying the processing bank. The rest of the number is not displayed.
Possible values: <= 4 characters
The last four digits of the card number.
Possible values: <= 2 characters
The ID of the acquirer that processed the transaction.
Possible values: <= 20 characters
The type of card used in the transaction. Values: Credit, Debit
Possible values: <= 20 characters
The card brand used in the transaction. Values: VISA, MASTERCARD, AMEX
providerResponseDetails
object
Possible values: <= 100 characters
Possible values: <= 400 characters
additionalTransactionInfo
object
{
"paymentId": "2f00eba7-66ad-4d8b-8d54-b8c9183e664f",
"transactionId": "string",
"externalTransactionId": "string",
"amount": 0,
"currency": "string",
"transactionType": "Auth",
"result": {
"status": "approved",
"errors": {
"code": "7000.1000",
"reason": "Internal Processing Error"
}
},
"authCode": "string",
"cvv2Code": "string",
"avsCode": "string",
"partialApproval": {
"requestedAmount": 0,
"requestedCurrency": "string"
},
"redirectUrl": "string",
"paymentOption": {
"card": {
"cardHolderName": "string",
"maskedCardNumber": "string",
"bin": "string",
"last4Digits": "string",
"expirationMonth": "string",
"expirationYear": "string",
"acquirerId": "string",
"cardType": "string",
"cardBrand": "string",
"paymentAccountReference": "string",
"paymentTokenId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"merchantReference": "12391284AF87C7D2",
"threeD": {
"fingerprintUrl": "string",
"fingerprintPayload": "string",
"dsTransId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"isExemptionRequestInAuthentication": true,
"acsUrl": "string",
"cReq": "string",
"acsTransId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"version": "2.1.0",
"serverTransId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"eci": "2",
"cavv": "string",
"whiteListStatus": "Y",
"acsChallengeMandate": "Y",
"authenticationType": "string",
"authenticationResult": "Y",
"flow": "Challenge",
"reasonId": "string",
"reason": "string",
"cardholderInfoText": "string",
"merchantId": "string",
"challengePreferenceReason": "string",
"acquirerDecision": "string",
"decisionReason": "string",
"challengeCancelReason": "string",
"challengeCancelReasonId": "string",
"isLiabilityOnIssuer": true
}
},
"alternativePaymentMethod": {
"name": "ACH",
"data": {
"accountNumber": "11345739548759",
"routingNumber": "847937857"
},
"merchantReference": "12391284AF87C7D2",
"paymentTokenId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"eWallet": {
"provider": "ApplePay",
"eciIndicator": "string",
"expirationMonth": "string",
"expirationYear": "string",
"cardHolderName": "string",
"maskedCardNumber": "string",
"bin": "string",
"last4Digits": "string",
"acquirerId": "string",
"cardType": "string",
"cardBrand": "string"
}
},
"providerResponseDetails": {
"code": "string",
"reason": "string"
},
"additionalTransactionInfo": {
"additionalTransactionBankId": "string",
"referenceId": "string"
}
}
{
"result": {
"status": "error",
"errors": {
"code": "7300.3000",
"reason": "Authorization error."
}
}
}
Internal server error
- application/json
- Schema
- Example (from schema)
- Internal Processing Error
Schema
Possible values: <= 20 characters
Nuvei Digital Payments Gateway Transaction ID
Possible values: <= 50 characters
The transaction ID of the transaction in the event that an external service is used.
The transaction amount.
Possible values: [Auth
, Sale
, PreAuth
, Settle
, Void
, Refund
, InitAuth3D
, Auth3D
, Sale3D
]
Determines the transaction type that is sent to the Gateway, when it comes to performing the fiscal transaction. Default is Sale.
result
object
required
Possible values: [approved
, authorizedOnly
, declined
, error
, pending
, redirect
, challenge
, fingerprint
, authenticated
, authenticationNotSupported
]
errors
object
Possible values: <= 11 characters
Possible values: <= 400 characters
Possible values: <= 128 characters
The authorization code of the transaction.
Possible values: <= 1 characters
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
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.
partialApproval
object
Possible values: >= 3 characters
and <= 3 characters
Possible values: <= 2000 characters
paymentOption
object
card
object
Possible values: <= 70 characters
The card holder name.
Possible values: <= 20 characters
The masked credit card number.
Possible values: <= 8 characters
The first six digits from the credit card number for identifying the processing bank. The rest of the number is not displayed.
Possible values: <= 4 characters
The last four digits of the card number.
Possible values: <= 2 characters
The card expiration month.
Possible values: <= 4 characters
The card expiration year.
Possible values: <= 2 characters
The ID of the acquirer that processed the transaction.
Possible values: <= 20 characters
The type of card used in the transaction. Values: Credit, Debit
Possible values: <= 20 characters
The card brand used in the transaction. Values: VISA, MASTERCARD, AMEX
Possible values: <= 29 characters
Payment Token ID
Possible values: <= 50 characters
Merchant Reference for a business entity (token, subscription, etc.)
threeD
object
The URL to which to post the fingerprintPayload to perform device fingerprinting.
The payload to be posted to the fingerprintUrl to perform the device fingerprinting.
The transaction ID of the Directory Server (part of the fingerprintPayload).
The URL of the Access Control Server to perform the challenge request.
The payload to be posted to the acsUrl to perform the challenge request.
The transaction ID of the Access Control Server (part of the cReq).
Possible values: <= 10 characters
The full version of the 3DS protocol for the transaction.
The transaction ID received from the MPI for 3D-Secure v2.
Possible values: <= 2 characters
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.
Possible values: <= 40 characters
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.
Possible values: [Y
, N
, E
, P
, R
, U
]
Indicates if this consumer defined this merchant as whitelist or not. If the consumer defined the merchant, then this is the reason the challenge did not happen. Values: Y = 3DS Requestor is whitelisted by cardholder | N = 3DS Requestor is not whitelisted by cardholder | E = Not eligible as determined by issuer | P = Pending confirmation by cardholder | R = Cardholder rejected | U = Whitelist status unknown, unavailable, or does not apply
Possible values: [Y
, N
]
The 3D Secure 2.0 challenge indication. Values: N = not required | Y = required
Possible values: >= 2 characters
and <= 2 characters
The type of authentication performed during the 3D Secure 2.0 challenge. If the merchant wants to react differently for each authentication type, then they can, per the value returned. Values: 01 = Static | 02 = Dynamic | 03 = OOB | 04 = Decoupled | 05–79 = Reserved for EMVCo future use (values invalid until defined by EMVCo) | 80–99 = Reserved for DS use
Possible values: [Y
, N
, U
, A
, C
, D
, R
, I
]
Indicates whether a transaction qualifies as an authenticated transaction or account verification. Note: The Final CRes message can contain only a value of Y or N. Values: Y = Authentication Verification Successful | N = Not Authenticated /Account Not Verified; Transaction denied | U = Authentication/ Account Verification Could Not Be Performed; Technical or other problem, as indicated in ARes or RReq | A = Attempts Processing Performed; Not Authenticated/Verified, but a proof of attempted authentication/verification is provided | C = Challenge Required; Additional authentication is required using the CReq/CRes | D = Challenge Required; Decoupled Authentication confirmed | R = Authentication/ Account Verification Rejected; Issuer is rejecting | I = Informational only (issuer approved SCA exemption)
Possible values: [Challenge
, Frictionless
, Exemption
, NoLiability
, Stop
]
The 3D-Secure flow required by the issuer. Values: 1 = Challenge | 2 = Frictionless | 3 = Exemption | 4 = NoLiability | 5 = Stop
Possible values: >= 2 characters
and <= 2 characters
The text provided by the ACS/Issuer to the cardholder during a frictionless transaction that was not authenticated by the ACS/Issuer. For example: “Additional authentication is needed for this transaction. Please contact [Issuer Name] at xxx-xxx-xxxx.” If this parameter is populated, the merchant must display the information to the cardholder.
The Merchant ID provided by Nuvei.
This value is returned following a 3D-Secure v2 challenge and describes the reason for challenge. Press here for more information.
The acquirer's request from the merchant to perform a certain flow. Values: ChallengeRequest, ExemptionRequest
The description of the acquirer's decision. Press here to see a table that presents the possible values.
Reason description for a canceled 3D-Secure authorization as received from the issuer.
Reason ID for a canceled 3D-Secure authorization as received from the issuer.
Indicates if there is 3D-Secure liability shift. If equal to “1” – Liability shift is present. If equal to “0”, empty or null – No liability shift has occurred.
alternativePaymentMethod
object
Possible values: non-empty
and <= 50 characters
data
object
Possible values: <= 50 characters
Merchant Reference for a business entity (token, subscription, etc.)
Payment Token ID
eWallet
object
Possible values: [ApplePay
, GooglePay
]
The name of the external token provider Possible values: [ApplePay, GooglePay]
Possible values: <= 100 characters
Possible values: <= 2 characters
The card expiration month.
Possible values: <= 4 characters
The card expiration year.
Possible values: <= 70 characters
The card holder name.
Possible values: <= 20 characters
The masked credit card number.
Possible values: <= 8 characters
The first six digits from the credit card number for identifying the processing bank. The rest of the number is not displayed.
Possible values: <= 4 characters
The last four digits of the card number.
Possible values: <= 2 characters
The ID of the acquirer that processed the transaction.
Possible values: <= 20 characters
The type of card used in the transaction. Values: Credit, Debit
Possible values: <= 20 characters
The card brand used in the transaction. Values: VISA, MASTERCARD, AMEX
providerResponseDetails
object
Possible values: <= 100 characters
Possible values: <= 400 characters
additionalTransactionInfo
object
{
"paymentId": "2f00eba7-66ad-4d8b-8d54-b8c9183e664f",
"transactionId": "string",
"externalTransactionId": "string",
"amount": 0,
"currency": "string",
"transactionType": "Auth",
"result": {
"status": "approved",
"errors": {
"code": "7000.1000",
"reason": "Internal Processing Error"
}
},
"authCode": "string",
"cvv2Code": "string",
"avsCode": "string",
"partialApproval": {
"requestedAmount": 0,
"requestedCurrency": "string"
},
"redirectUrl": "string",
"paymentOption": {
"card": {
"cardHolderName": "string",
"maskedCardNumber": "string",
"bin": "string",
"last4Digits": "string",
"expirationMonth": "string",
"expirationYear": "string",
"acquirerId": "string",
"cardType": "string",
"cardBrand": "string",
"paymentAccountReference": "string",
"paymentTokenId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"merchantReference": "12391284AF87C7D2",
"threeD": {
"fingerprintUrl": "string",
"fingerprintPayload": "string",
"dsTransId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"isExemptionRequestInAuthentication": true,
"acsUrl": "string",
"cReq": "string",
"acsTransId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"version": "2.1.0",
"serverTransId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"eci": "2",
"cavv": "string",
"whiteListStatus": "Y",
"acsChallengeMandate": "Y",
"authenticationType": "string",
"authenticationResult": "Y",
"flow": "Challenge",
"reasonId": "string",
"reason": "string",
"cardholderInfoText": "string",
"merchantId": "string",
"challengePreferenceReason": "string",
"acquirerDecision": "string",
"decisionReason": "string",
"challengeCancelReason": "string",
"challengeCancelReasonId": "string",
"isLiabilityOnIssuer": true
}
},
"alternativePaymentMethod": {
"name": "ACH",
"data": {
"accountNumber": "11345739548759",
"routingNumber": "847937857"
},
"merchantReference": "12391284AF87C7D2",
"paymentTokenId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"eWallet": {
"provider": "ApplePay",
"eciIndicator": "string",
"expirationMonth": "string",
"expirationYear": "string",
"cardHolderName": "string",
"maskedCardNumber": "string",
"bin": "string",
"last4Digits": "string",
"acquirerId": "string",
"cardType": "string",
"cardBrand": "string"
}
},
"providerResponseDetails": {
"code": "string",
"reason": "string"
},
"additionalTransactionInfo": {
"additionalTransactionBankId": "string",
"referenceId": "string"
}
}
{
"result": {
"status": "error",
"errors": {
"code": "7000.1000",
"reason": "Internal Processing Error."
}
}
}