Get Transaction Details by transactionId or merchantTransactionId.
GET/transaction/{processingEntityId}/{transactionId}
Gets transaction details by transactionId
or merchantTransactionId
.
Request
Path Parameters
Possible values: <= 20 characters
The transaction ID
Processing entityId
provided by Nuvei.
Query Parameters
Possible values: [Nuvei
, Merchant
]
Default value: Nuvei
Source of the transactionId - Nuvei (default value) or Merchant
Responses
- 200
- 400
- 401
- 403
OK
- application/json
- Schema
- Example (from schema)
Schema
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: <= 30 characters
Possible values: <= 40 characters
Possible values: <= 18 characters
Possible values: <= 18 characters
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.
currencyConversion
object
The original amount of the transaction in the currency that the merchant requested.
The 3-letter ISO currency code of the currency that the merchant requested in the transaction.
markup
object
merchantDetails
object
transactionDetails
object
ID of the transaction in the merchant system.
For recurring/rebilling and MIT, represents the reference to the original transaction ID of the initial transaction.
paymentOption
object
card
object
threeD
object
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.
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.
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.
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.
The card holder name.
The masked credit card number.
The card expiration month.
The card expiration year.
The first six digits from the credit card number for identifying the processing bank. The rest of the number is not displayed.
Indicates if the card is prepaid or not.
The card brand used in the transaction. Values: VISA, MASTERCARD, AMEX
The type of card used in the transaction. Values: Credit, Debit
partialApproval
object
productDetails
object
A free text field used to identify the product/service sold. If this parameter is left empty, need to insert a concatenation of all item names. It's not related to rebilling system product id. Risk rules and traffice management rules are usually built based on this field value.
subscription
object
subMerchant
object
Possible values: <= 15 characters
Represents the internal merchant’s ID, which is forwarded to Visa and Mastercard
Possible values: <= 20 characters
The payment facilitator’s sub-merchant’s city name.
Possible values: >= 2 characters
and <= 2 characters
The payment facilitator’s sub-merchant’s 2-letter ISO country code
fraudDetails
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.
result
object
required
Possible values: [error
, success
, pending
]
errors
object
Possible values: <= 11 characters
Possible values: <= 400 characters
{
"buyerDetails": {
"buyerId": "string",
"firstName": "string",
"lastName": "string",
"companyName": "string",
"locale": "string",
"dateOfBirth": "2024-09-11",
"email": "string",
"phone": "string",
"phone2": "string",
"workPhone": "string",
"nationalIdentificationNumber": "string",
"billingAddress": {
"address": "string",
"addressLine2": "string",
"addressLine3": "string",
"state": "string",
"zip": "string",
"city": "string",
"countryCode": "string",
"phone": "string",
"addressMatch": false
},
"shippingAddress": {
"sameAsBilling": false,
"address": "string",
"addressLine2": "string",
"addressLine3": "string",
"state": "string",
"zip": "string",
"city": "string",
"countryCode": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"phone2": "string"
}
},
"deviceDetails": {
"deviceName": "string",
"deviceOS": "string",
"deviceType": "string",
"ipAddress": "string",
"browser": {
"acceptHeader": "string",
"colorDepth": 0,
"javaEnabled": true,
"javaScriptEnabled": true,
"language": "string",
"screenHeight": 0,
"screenWidth": 0,
"timeZone": "string",
"userAgent": "string"
}
},
"currencyConversion": {
"convertedCurrency": "string",
"convertedAmount": 0,
"originalAmount": 0,
"originalCurrencyCode": "string",
"rate": 0,
"markup": {
"markup": 0,
"markupAmount": 0,
"amountWithoutMarkup": 0,
"markupAmountUSD": 0
},
"isCurrencyConverted": true
},
"merchantDetails": {
"clientName": "string",
"multiClientName": "string"
},
"transactionDetails": {
"date": "2024-09-11T11:55:03.920Z",
"originalTransactionDate": "2024-09-11T11:55:03.920Z",
"transactionStatus": "string",
"transactionType": "string",
"authCode": "string",
"merchantTransactionId": "string",
"custom": "string",
"credited": "string",
"transactionId": "string",
"relatedTransactionId": "string",
"processedAmount": "string",
"processedCurrency": "string",
"creditType": "string",
"acquiringBankName": "string",
"isVoided": "string",
"errorDescription": "string"
},
"paymentOption": {
"card": {
"threeD": {
"eci": "string",
"isLiabilityOnIssuer": "string",
"flow": "string",
"isExemptionRequestInAuthentication": true,
"challengePreferenceReason": "string",
"exemptionRequest": "string",
"whiteListStatus": true,
"authenticationType": "string",
"authenticationResult": "string",
"challengeStatus": "string",
"challengeCancelReason": "string",
"merchantPreference": "string",
"merchantPreferenceReason": "string"
},
"avsCode": "string",
"cvv2Code": "string",
"cardHolderName": "string",
"maskedCardNumber": "string",
"expirationMonth": "string",
"expirationYear": "string",
"bin": 0,
"issuerBankName": "string",
"issuingCountry": "string",
"isPrepaid": true,
"cardBrand": "string",
"cardType": "string",
"paymentTokenId": "string"
}
},
"partialApproval": {
"requestedCurrency": "string",
"requestedAmount": "string"
},
"productDetails": {
"productId": "string"
},
"subscription": {
"step": "string",
"type": "string",
"Id": "string"
},
"subMerchant": {
"id": "string",
"city": "string",
"countryCode": "string"
},
"fraudDetails": {
"fraudScore": "string"
},
"dynamicDescriptor": {
"merchantName": "string",
"merchantContactInformation": "string"
},
"result": {
"status": "error",
"errors": {
"code": "7000.1000",
"reason": "Internal Processing Error"
}
}
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
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: <= 30 characters
Possible values: <= 40 characters
Possible values: <= 18 characters
Possible values: <= 18 characters
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.
currencyConversion
object
The original amount of the transaction in the currency that the merchant requested.
The 3-letter ISO currency code of the currency that the merchant requested in the transaction.
markup
object
merchantDetails
object
transactionDetails
object
ID of the transaction in the merchant system.
For recurring/rebilling and MIT, represents the reference to the original transaction ID of the initial transaction.
paymentOption
object
card
object
threeD
object
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.
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.
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.
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.
The card holder name.
The masked credit card number.
The card expiration month.
The card expiration year.
The first six digits from the credit card number for identifying the processing bank. The rest of the number is not displayed.
Indicates if the card is prepaid or not.
The card brand used in the transaction. Values: VISA, MASTERCARD, AMEX
The type of card used in the transaction. Values: Credit, Debit
partialApproval
object
productDetails
object
A free text field used to identify the product/service sold. If this parameter is left empty, need to insert a concatenation of all item names. It's not related to rebilling system product id. Risk rules and traffice management rules are usually built based on this field value.
subscription
object
subMerchant
object
Possible values: <= 15 characters
Represents the internal merchant’s ID, which is forwarded to Visa and Mastercard
Possible values: <= 20 characters
The payment facilitator’s sub-merchant’s city name.
Possible values: >= 2 characters
and <= 2 characters
The payment facilitator’s sub-merchant’s 2-letter ISO country code
fraudDetails
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.
result
object
required
Possible values: [error
, success
, pending
]
errors
object
Possible values: <= 11 characters
Possible values: <= 400 characters
{
"buyerDetails": {
"buyerId": "string",
"firstName": "string",
"lastName": "string",
"companyName": "string",
"locale": "string",
"dateOfBirth": "2024-09-11",
"email": "string",
"phone": "string",
"phone2": "string",
"workPhone": "string",
"nationalIdentificationNumber": "string",
"billingAddress": {
"address": "string",
"addressLine2": "string",
"addressLine3": "string",
"state": "string",
"zip": "string",
"city": "string",
"countryCode": "string",
"phone": "string",
"addressMatch": false
},
"shippingAddress": {
"sameAsBilling": false,
"address": "string",
"addressLine2": "string",
"addressLine3": "string",
"state": "string",
"zip": "string",
"city": "string",
"countryCode": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"phone2": "string"
}
},
"deviceDetails": {
"deviceName": "string",
"deviceOS": "string",
"deviceType": "string",
"ipAddress": "string",
"browser": {
"acceptHeader": "string",
"colorDepth": 0,
"javaEnabled": true,
"javaScriptEnabled": true,
"language": "string",
"screenHeight": 0,
"screenWidth": 0,
"timeZone": "string",
"userAgent": "string"
}
},
"currencyConversion": {
"convertedCurrency": "string",
"convertedAmount": 0,
"originalAmount": 0,
"originalCurrencyCode": "string",
"rate": 0,
"markup": {
"markup": 0,
"markupAmount": 0,
"amountWithoutMarkup": 0,
"markupAmountUSD": 0
},
"isCurrencyConverted": true
},
"merchantDetails": {
"clientName": "string",
"multiClientName": "string"
},
"transactionDetails": {
"date": "2024-09-11T11:55:03.923Z",
"originalTransactionDate": "2024-09-11T11:55:03.923Z",
"transactionStatus": "string",
"transactionType": "string",
"authCode": "string",
"merchantTransactionId": "string",
"custom": "string",
"credited": "string",
"transactionId": "string",
"relatedTransactionId": "string",
"processedAmount": "string",
"processedCurrency": "string",
"creditType": "string",
"acquiringBankName": "string",
"isVoided": "string",
"errorDescription": "string"
},
"paymentOption": {
"card": {
"threeD": {
"eci": "string",
"isLiabilityOnIssuer": "string",
"flow": "string",
"isExemptionRequestInAuthentication": true,
"challengePreferenceReason": "string",
"exemptionRequest": "string",
"whiteListStatus": true,
"authenticationType": "string",
"authenticationResult": "string",
"challengeStatus": "string",
"challengeCancelReason": "string",
"merchantPreference": "string",
"merchantPreferenceReason": "string"
},
"avsCode": "string",
"cvv2Code": "string",
"cardHolderName": "string",
"maskedCardNumber": "string",
"expirationMonth": "string",
"expirationYear": "string",
"bin": 0,
"issuerBankName": "string",
"issuingCountry": "string",
"isPrepaid": true,
"cardBrand": "string",
"cardType": "string",
"paymentTokenId": "string"
}
},
"partialApproval": {
"requestedCurrency": "string",
"requestedAmount": "string"
},
"productDetails": {
"productId": "string"
},
"subscription": {
"step": "string",
"type": "string",
"Id": "string"
},
"subMerchant": {
"id": "string",
"city": "string",
"countryCode": "string"
},
"fraudDetails": {
"fraudScore": "string"
},
"dynamicDescriptor": {
"merchantName": "string",
"merchantContactInformation": "string"
},
"result": {
"status": "error",
"errors": {
"code": "7000.1000",
"reason": "Internal Processing Error"
}
}
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
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: <= 30 characters
Possible values: <= 40 characters
Possible values: <= 18 characters
Possible values: <= 18 characters
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.
currencyConversion
object
The original amount of the transaction in the currency that the merchant requested.
The 3-letter ISO currency code of the currency that the merchant requested in the transaction.
markup
object
merchantDetails
object
transactionDetails
object
ID of the transaction in the merchant system.
For recurring/rebilling and MIT, represents the reference to the original transaction ID of the initial transaction.
paymentOption
object
card
object
threeD
object
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.
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.
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.
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.
The card holder name.
The masked credit card number.
The card expiration month.
The card expiration year.
The first six digits from the credit card number for identifying the processing bank. The rest of the number is not displayed.
Indicates if the card is prepaid or not.
The card brand used in the transaction. Values: VISA, MASTERCARD, AMEX
The type of card used in the transaction. Values: Credit, Debit
partialApproval
object
productDetails
object
A free text field used to identify the product/service sold. If this parameter is left empty, need to insert a concatenation of all item names. It's not related to rebilling system product id. Risk rules and traffice management rules are usually built based on this field value.
subscription
object
subMerchant
object
Possible values: <= 15 characters
Represents the internal merchant’s ID, which is forwarded to Visa and Mastercard
Possible values: <= 20 characters
The payment facilitator’s sub-merchant’s city name.
Possible values: >= 2 characters
and <= 2 characters
The payment facilitator’s sub-merchant’s 2-letter ISO country code
fraudDetails
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.
result
object
required
Possible values: [error
, success
, pending
]
errors
object
Possible values: <= 11 characters
Possible values: <= 400 characters
{
"buyerDetails": {
"buyerId": "string",
"firstName": "string",
"lastName": "string",
"companyName": "string",
"locale": "string",
"dateOfBirth": "2024-09-11",
"email": "string",
"phone": "string",
"phone2": "string",
"workPhone": "string",
"nationalIdentificationNumber": "string",
"billingAddress": {
"address": "string",
"addressLine2": "string",
"addressLine3": "string",
"state": "string",
"zip": "string",
"city": "string",
"countryCode": "string",
"phone": "string",
"addressMatch": false
},
"shippingAddress": {
"sameAsBilling": false,
"address": "string",
"addressLine2": "string",
"addressLine3": "string",
"state": "string",
"zip": "string",
"city": "string",
"countryCode": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"phone2": "string"
}
},
"deviceDetails": {
"deviceName": "string",
"deviceOS": "string",
"deviceType": "string",
"ipAddress": "string",
"browser": {
"acceptHeader": "string",
"colorDepth": 0,
"javaEnabled": true,
"javaScriptEnabled": true,
"language": "string",
"screenHeight": 0,
"screenWidth": 0,
"timeZone": "string",
"userAgent": "string"
}
},
"currencyConversion": {
"convertedCurrency": "string",
"convertedAmount": 0,
"originalAmount": 0,
"originalCurrencyCode": "string",
"rate": 0,
"markup": {
"markup": 0,
"markupAmount": 0,
"amountWithoutMarkup": 0,
"markupAmountUSD": 0
},
"isCurrencyConverted": true
},
"merchantDetails": {
"clientName": "string",
"multiClientName": "string"
},
"transactionDetails": {
"date": "2024-09-11T11:55:03.925Z",
"originalTransactionDate": "2024-09-11T11:55:03.925Z",
"transactionStatus": "string",
"transactionType": "string",
"authCode": "string",
"merchantTransactionId": "string",
"custom": "string",
"credited": "string",
"transactionId": "string",
"relatedTransactionId": "string",
"processedAmount": "string",
"processedCurrency": "string",
"creditType": "string",
"acquiringBankName": "string",
"isVoided": "string",
"errorDescription": "string"
},
"paymentOption": {
"card": {
"threeD": {
"eci": "string",
"isLiabilityOnIssuer": "string",
"flow": "string",
"isExemptionRequestInAuthentication": true,
"challengePreferenceReason": "string",
"exemptionRequest": "string",
"whiteListStatus": true,
"authenticationType": "string",
"authenticationResult": "string",
"challengeStatus": "string",
"challengeCancelReason": "string",
"merchantPreference": "string",
"merchantPreferenceReason": "string"
},
"avsCode": "string",
"cvv2Code": "string",
"cardHolderName": "string",
"maskedCardNumber": "string",
"expirationMonth": "string",
"expirationYear": "string",
"bin": 0,
"issuerBankName": "string",
"issuingCountry": "string",
"isPrepaid": true,
"cardBrand": "string",
"cardType": "string",
"paymentTokenId": "string"
}
},
"partialApproval": {
"requestedCurrency": "string",
"requestedAmount": "string"
},
"productDetails": {
"productId": "string"
},
"subscription": {
"step": "string",
"type": "string",
"Id": "string"
},
"subMerchant": {
"id": "string",
"city": "string",
"countryCode": "string"
},
"fraudDetails": {
"fraudScore": "string"
},
"dynamicDescriptor": {
"merchantName": "string",
"merchantContactInformation": "string"
},
"result": {
"status": "error",
"errors": {
"code": "7000.1000",
"reason": "Internal Processing Error"
}
}
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
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: <= 30 characters
Possible values: <= 40 characters
Possible values: <= 18 characters
Possible values: <= 18 characters
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.
currencyConversion
object
The original amount of the transaction in the currency that the merchant requested.
The 3-letter ISO currency code of the currency that the merchant requested in the transaction.
markup
object
merchantDetails
object
transactionDetails
object
ID of the transaction in the merchant system.
For recurring/rebilling and MIT, represents the reference to the original transaction ID of the initial transaction.
paymentOption
object
card
object
threeD
object
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.
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.
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.
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.
The card holder name.
The masked credit card number.
The card expiration month.
The card expiration year.
The first six digits from the credit card number for identifying the processing bank. The rest of the number is not displayed.
Indicates if the card is prepaid or not.
The card brand used in the transaction. Values: VISA, MASTERCARD, AMEX
The type of card used in the transaction. Values: Credit, Debit
partialApproval
object
productDetails
object
A free text field used to identify the product/service sold. If this parameter is left empty, need to insert a concatenation of all item names. It's not related to rebilling system product id. Risk rules and traffice management rules are usually built based on this field value.
subscription
object
subMerchant
object
Possible values: <= 15 characters
Represents the internal merchant’s ID, which is forwarded to Visa and Mastercard
Possible values: <= 20 characters
The payment facilitator’s sub-merchant’s city name.
Possible values: >= 2 characters
and <= 2 characters
The payment facilitator’s sub-merchant’s 2-letter ISO country code
fraudDetails
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.
result
object
required
Possible values: [error
, success
, pending
]
errors
object
Possible values: <= 11 characters
Possible values: <= 400 characters
{
"buyerDetails": {
"buyerId": "string",
"firstName": "string",
"lastName": "string",
"companyName": "string",
"locale": "string",
"dateOfBirth": "2024-09-11",
"email": "string",
"phone": "string",
"phone2": "string",
"workPhone": "string",
"nationalIdentificationNumber": "string",
"billingAddress": {
"address": "string",
"addressLine2": "string",
"addressLine3": "string",
"state": "string",
"zip": "string",
"city": "string",
"countryCode": "string",
"phone": "string",
"addressMatch": false
},
"shippingAddress": {
"sameAsBilling": false,
"address": "string",
"addressLine2": "string",
"addressLine3": "string",
"state": "string",
"zip": "string",
"city": "string",
"countryCode": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"phone2": "string"
}
},
"deviceDetails": {
"deviceName": "string",
"deviceOS": "string",
"deviceType": "string",
"ipAddress": "string",
"browser": {
"acceptHeader": "string",
"colorDepth": 0,
"javaEnabled": true,
"javaScriptEnabled": true,
"language": "string",
"screenHeight": 0,
"screenWidth": 0,
"timeZone": "string",
"userAgent": "string"
}
},
"currencyConversion": {
"convertedCurrency": "string",
"convertedAmount": 0,
"originalAmount": 0,
"originalCurrencyCode": "string",
"rate": 0,
"markup": {
"markup": 0,
"markupAmount": 0,
"amountWithoutMarkup": 0,
"markupAmountUSD": 0
},
"isCurrencyConverted": true
},
"merchantDetails": {
"clientName": "string",
"multiClientName": "string"
},
"transactionDetails": {
"date": "2024-09-11T11:55:03.930Z",
"originalTransactionDate": "2024-09-11T11:55:03.930Z",
"transactionStatus": "string",
"transactionType": "string",
"authCode": "string",
"merchantTransactionId": "string",
"custom": "string",
"credited": "string",
"transactionId": "string",
"relatedTransactionId": "string",
"processedAmount": "string",
"processedCurrency": "string",
"creditType": "string",
"acquiringBankName": "string",
"isVoided": "string",
"errorDescription": "string"
},
"paymentOption": {
"card": {
"threeD": {
"eci": "string",
"isLiabilityOnIssuer": "string",
"flow": "string",
"isExemptionRequestInAuthentication": true,
"challengePreferenceReason": "string",
"exemptionRequest": "string",
"whiteListStatus": true,
"authenticationType": "string",
"authenticationResult": "string",
"challengeStatus": "string",
"challengeCancelReason": "string",
"merchantPreference": "string",
"merchantPreferenceReason": "string"
},
"avsCode": "string",
"cvv2Code": "string",
"cardHolderName": "string",
"maskedCardNumber": "string",
"expirationMonth": "string",
"expirationYear": "string",
"bin": 0,
"issuerBankName": "string",
"issuingCountry": "string",
"isPrepaid": true,
"cardBrand": "string",
"cardType": "string",
"paymentTokenId": "string"
}
},
"partialApproval": {
"requestedCurrency": "string",
"requestedAmount": "string"
},
"productDetails": {
"productId": "string"
},
"subscription": {
"step": "string",
"type": "string",
"Id": "string"
},
"subMerchant": {
"id": "string",
"city": "string",
"countryCode": "string"
},
"fraudDetails": {
"fraudScore": "string"
},
"dynamicDescriptor": {
"merchantName": "string",
"merchantContactInformation": "string"
},
"result": {
"status": "error",
"errors": {
"code": "7000.1000",
"reason": "Internal Processing Error"
}
}
}