Skip to main content

Retrieve Transaction Details

GET 
/entities/{processing-entity-id}/transactions/{transaction-id}

Retrieves the transaction details by transactionId or merchantTransactionId.

Request​

Path Parameters

    transaction-id stringrequired

    Possible values: <= 50 characters

    The transaction ID

    Example: 2110000000011875900
    processing-entity-id uuidrequired

    Processing entityId provided by Nuvei.

    Example: 369bbe6d-4cbd-4d33-9205-2c83541cddab

Query Parameters

    source string

    Possible values: [Nuvei, Merchant]

    Source of the transactionId - Nuvei (default value) or Merchant

    Default value: Nuvei
    Example: Nuvei

Responses​

OK

Schema

    buyerDetails

    object

    buyerId string

    Unique customer identifier in your system.

    Possible values: <= 255 characters

    firstName string

    Possible values: <= 30 characters

    lastName string

    Possible values: <= 40 characters

    companyName string

    Possible values: <= 100 characters

    locale string

    The user's locale and default language.

    Possible values: <= 5 characters

    dateOfBirth date

    Format is YYYY-MM-DD.

    email string

    Possible values: <= 100 characters

    phone string

    Possible values: <= 18 characters

    phone2 string

    Possible values: <= 18 characters

    workPhone string

    Possible values: <= 18 characters

    nationalIdentificationNumber password

    The user's national ID number.

    Possible values: <= 25 characters

    billingAddress

    object

    address string

    Possible values: <= 60 characters

    addressLine2 string

    Possible values: <= 60 characters

    addressLine3 string

    Possible values: <= 60 characters

    state string

    Possible values: <= 6 characters

    zip string

    Possible values: <= 10 characters

    city string

    Possible values: <= 30 characters

    countryCode stringrequired

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

    phone string

    Possible values: <= 18 characters

    addressMatch boolean

    Set to “true” when address matches shipping address.

    Default value: false

    shippingAddress

    object

    sameAsBilling boolean
    Default value: false
    address string

    Possible values: <= 60 characters

    addressLine2 string

    Possible values: <= 60 characters

    addressLine3 string

    Possible values: <= 60 characters

    state string

    Possible values: <= 6 characters

    zip string

    Possible values: <= 10 characters

    city string

    Possible values: <= 30 characters

    countryCode string

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

    firstName string

    Possible values: <= 30 characters

    lastName string

    Possible values: <= 40 characters

    phone string

    Possible values: <= 18 characters

    phone2 string

    Possible values: <= 18 characters

    deviceDetails

    object

    deviceName string
    deviceOS string
    deviceType string

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

    ipAddress string

    The customer's IP address.

    browser

    object

    acceptHeader string

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

    colorDepth integer

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

    javaEnabled boolean

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

    javaScriptEnabled boolean

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

    language string

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

    screenHeight integer

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

    screenWidth integer

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

    timeZone string

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

    userAgent string

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

    currencyConversion

    object

    convertedCurrency string
    convertedAmount number
    originalAmount number

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

    originalCurrencyCode string

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

    rate number

    markup

    object

    markup number
    markupAmount number
    amountWithoutMarkup number
    markupAmountUSD number
    isCurrencyConverted boolean

    merchantDetails

    object

    clientName string
    multiClientName string

    transactionDetails

    object

    date date-time
    originalTransactionDate date-time
    transactionStatus string

    The Gateway transaction status. Values: APPROVED, DECLINED, ERROR

    transactionType string

    The type of transaction. Values: auth, sale, payout, refund, settle, void, auth3D, sale3D.

    authCode string

    The authorization code of the transaction.

    merchantTransactionId string

    ID of the transaction in the merchant system.

    custom string

    Can be used to pass any type of information.

    credited string
    transactionId string

    The Gateway transaction ID.

    relatedTransactionId string

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

    processedAmount string

    The amount that was actually deposited in the transaction.

    processedCurrency string

    The currency used in the processed transaction request.

    creditType string

    The credit type that was performed.

    acquiringBankName string

    The acquiring bank name.

    isVoided string

    Indicates if the transaction was voided.

    errorDescription string

    paymentOption

    object

    card

    object

    threeD

    object

    eci string

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

    isLiabilityOnIssuer string

    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.

    flow string
    isExemptionRequestInAuthentication boolean
    challengePreferenceReason string
    exemptionRequest string
    whiteListStatus boolean
    authenticationType string
    authenticationResult string
    challengeStatus string
    challengeCancelReason string
    merchantPreference string
    merchantPreferenceReason string
    avsCode string

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

    cvv2Code string

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

    cardHolderName string

    The card holder name.

    maskedCardNumber string

    The masked credit card number.

    expirationMonth string

    The card expiration month.

    expirationYear string

    The card expiration year.

    bin integer

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

    issuerBankName string
    issuingCountry string
    isPrepaid boolean

    Indicates if the card is prepaid or not.

    cardBrand string

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

    cardType string

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

    paymentTokenId string

    partialApproval

    object

    requestedCurrency string
    requestedAmount string

    productDetails

    object

    productId string

    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 traffic management rules are usually built based on this field value.

    subscription

    object

    step string
    type string
    Id string

    subMerchant

    object

    id string

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

    Possible values: <= 15 characters

    city string

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

    Possible values: <= 20 characters

    countryCode string

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

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

    fraudDetails

    object

    fraudScore string

    Refers to a number between 0 and 1 that indicates the probability of a transaction becoming fraudulent, which is calculated using a risk machine learning model.

    dynamicDescriptor

    object

    merchantName string

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

    Possible values: <= 25 characters

    merchantContactInformation string

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

    Possible values: <= 255 characters

    result

    object

    required

    status ResultStatus (string)required

    Status of the request: success | error

    Possible values: [success, error]

    errors

    object

    Object describing the error in case such occurred during processing of the request.

    code stringrequired

    Code of the error in case such occurred during processing of the request.

    Possible values: <= 11 characters

    reason string

    Description of the error in case such occurred during processing of the request.

    Possible values: <= 400 characters

Loading...