• Documentation
  • API Reference
  • Documentation
  • API Reference
Expand All Collapse All
  • Payment Overview
    • Introduction
    • Choosing an Integration Method
  • Accept Payment
    • Payment Page
      • Quick Start
      • Input Parameters
      • Output Parameters
    • Web SDK
      • Quick Start
      • Nuvei Fields
        • Styling
      • Additional Functions
      • APM Payments
      • Tokenization-Only Flow
      • Scenarios
      • Using ReactJS
        • Full Samples
        • Sandbox Examples
      • FAQs
    • Checkout
      • Quick Start
        • UI Customization
        • Payment Customization
        • Advanced Controls
        • Checkout Examples
      • Server-to-Server
      • Payment Scenarios
      • Mobile SDKs (Beta Release)
        • Android Mobile SDK (Beta Release)
        • iOS Mobile SDK (Beta Release)
      • Flow Diagrams
      • Plugins
        • Magento
          • Rebilling with Magento
        • WooCommerce
          • Rebilling with WooCommerce
        • PrestaShop
          • PrestaShop with Web SDK
          • PrestaShop with Checkout
        • OpenCart
        • Shopify (via AsiaBill)
        • Mirakl
        • Salesforce
        • SAP
        • WIX
      • Marketplaces
    • Features
      • Authentication
      • Financial Operations
        • Refund
        • Void
        • Auth and Settle
        • Partial Approval
        • Currency Conversion (DCC and MCP)
        • Payout
      • Card Operations
        • Card-on-File
        • PCI and Tokenization
        • Zero-Authorization
        • Merchant-Initiated Transactions (MIT)
        • Blocking Cards
      • Subscription (Rebilling)
      • 3D-Secure
        • 3D-Secure Explained
        • 3DS Implementations
          • 3DS MPI-Only Web SDK
          • 3DS MPI-Only REST
          • 3DS External MPI
          • 3DS Responses
        • 3DS Functions
          • 3D-Secure Fingerprinting
          • 3D-Secure Authentication Challenge
      • Webhooks (DMNs)
        • Payment Transaction Requests
        • Control Panel Events API
    • Guides
      • Testing Cards, APIs and APMs
        • Testing Cards
        • Testing APIs with Postman
        • Testing APMs
      • Response Handling
      • Alternative Payment Guides (APMs)
      • Airline Ticket Guides
        • Airline Addendum
        • External Authorization Addendum
      • Payment Facilitators (PayFac)
      • Cashier
        • Cashier Events Guide
        • Cashier Features
      • Withdrawal Guide
      • Risk Guide
        • Nuvei Services
        • Transaction Types
        • Credits and Payouts
        • Fraud to Sale Programs
        • Compliance Programs
        • Chargebacks
      • eKYC Guide
      • Server SDKs
        • Java SDK
        • .NET SDK
        • PHP SDK
        • Node.JS SDK
      • Fast Track Onboarding Developer Guide
      • Currency Conversion Guides
        • Multiple Currency Pricing (MCP)
        • Dynamic Currency Conversion (DCC)
          • DCC in Cashier or Payment Page
          • DCC in REST API Workflows
          • DCC in Web SDK Workflows
      • Website Compliance Guides
    • Additional Links
      • FAQs
      • API Reference
      • Release Notes
      • Country and Currency Codes

    Output Parameters

    On this page:
    • Overview
    • Transaction Parameters
    • Payment Parameters
    • General Items
    • Other Parameters

    Overview

    When Nuvei redirects your customers to a Success, Pending, or Error page, the URL of the page includes output parameters.  These contain customer, transaction, and payment data, similar to DMN notifications.

    The tables below provide a list of the parameters sent by Nuvei back to the customer’s browser, upon completing the payment process.

    Transaction Parameters

    ParameterDescription
    statusStatus of the executed transaction: Approved, Declined, etc.
    totalAmountTotal transaction charge.
    transactionIdA 64-bit unique integer ID generated by Nuvei, used for tracking purposes.
    clientUniqueIdCustom data parameter. If this parameter is not specified, the default value is the name of the merchant’s account.
    errCodeThe error code of a failed transaction. For more information, see Error Handling.
    exErrCodeThe extended error code of a failed transaction. For more information, see Error Handling.
    authCodeThe authentication code received by Nuvei for the transaction.
    reasonThe reason for a failed transaction, where relevant. For more information, see Error Handling.
    tokenThe token of the credit card that was returned by Nuvei. This value represents the customer's credit card number stored on Nuvei's database.
    reasonCodeThe failed transaction’s reason’s code. For more information, see Error Handling.
    responsechecksumDeprecated output checksum parameter.
    advanceResponseChecksumOutput checksum parameter.
    cardCompanyThe name of the credit card company.
    The possible values are: Visa, Amex, MasterCard, Diners, Diners, Discover, JCB, LaserCard, Maestro, Solo, and Switch.
    eciAn Electronic Commerce Indicator (ECI) value is the result of a 3DS authentication request, returned by a Directory Server ("issuer ACS") (namely Visa, MasterCard, JCB, and American Express). Possible ECI values:
    Visa:
    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:
    1 – The issuer or cardholder does not participate in a 3D-Secure program.
    2 – The cardholder was successfully authenticated.
    6 – Payment authentication was not performed.
    7 – The cardholder was successfully authenticated for the initial MIT transaction.

    Payment Parameters

    ParameterDescription
    nameOnCardThe name on the credit card.
    first_nameThe customer's first name.
    last_nameThe customer's last name.
    address1The address of the customer.
    cityThe city of the customer.
    countryThe country of the customer.
    emailThe email address of the customer.
    zipThe ZIP code of the customer when available.
    phone1The phone number of the customer.
    currencyThe currency used in the transaction.

    General Items

    ParameterDescription
    total_discountTotal discount for current order.
    total_handlingTotal handling for current order.
    total_shippingTotal shipping for current order.
    total_taxTotal tax for current order.
    item_number_NThe number of item number N.
    item_amount_NThe cost of item number N.
    item_quantity_NThe quantity of item number N.
    item_discount_NThe discount for item number N.
    item_handling_NThe handling costs for item number N.
    item_shipping_NThe shipping costs for item number N.
    promoCodeThis value is a promotional code you define that you can use to apply discounts to your products or services.

    Other Parameters

    ParameterDescription
    customDataCustom data sent to Nuvei.
    merchant_unique_idThe merchant_unique_id value as provided by the merchant to Nuvei in the HTTPS request.
    merchant_site_idThe unique ID (identifier) of the Transaction in the merchant’s database as provided by the merchant to the PPP in the HTTPS request.
    merchant_idThe unique merchant ID supplied by Nuvei.
    requestVersionThe processed Nuvei request’s version.
    messageA message sent from Nuvei regarding the transaction.
    errorAn error message sent from Nuvei.
    instantDmnStatusThe status of the Instant DMN notification. This parameter is only returned when Instant DMN notifications are active.
    ppp_TransactionIdThe ID number of the transaction’s history table in the Nuvei database.
    userIdThe UserId value transferred by the merchant in the HTTPS request.
    ProductIdThe purchased product’s ID as provided by the merchant in the HTTPS request.
    ppp_statusThe status of the transaction.
    OK indicates that the transaction was approved.
    PENDING occurs only for APM transactions in which the final status is not immediately returned.
    FAIL indicates that the transaction was declined or there was an error.
    merchantLocaleThe language and country of the user in ISO code in the following format:
    [language ISO]_[country ISO]
    For example: en_US
    unknownParametersAll unknown parameters sent with the current transaction.
    webMasterIdAffiliate parameter (an additional parameter that the merchant can send to PPP).
    customFieldn*The merchant can send up to 15 custom fields to Nuvei to update miscellaneous data.

     

    Parameter Description
    status Status of the executed transaction: Approved, Declined, etc.
    totalAmount Total transaction charge.
    transactionId A 64-bit unique integer ID generated by Nuvei, used for tracking purposes.
    clientUniqueId Custom data parameter. If this parameter is not specified, the default value is the name of the merchant’s account.
    errCode The error code of a failed transaction. For more information, see Error Handling.
    exErrCode The extended error code of a failed transaction. For more information, see Error Handling.
    authCode The authentication code received by Nuvei for the transaction.
    reason The reason for a failed transaction, where relevant. For more information, see Error Handling.
    token The token of the credit card that was returned by Nuvei. This value represents the customer’s credit card number stored on Nuvei’s database.
    reasonCode The failed transaction’s reason’s code. For more information, see Error Handling.
    responsechecksum Deprecated output checksum parameter.
    advanceResponseChecksum Output checksum parameter.
    cardCompany The name of the credit card company.
    The possible values are: Visa, Amex, MasterCard, Diners, Diners, Discover, JCB, LaserCard, Maestro, Solo, and Switch.
    eci An Electronic Commerce Indicator (ECI) value is the result of a 3DS authentication request, returned by a Directory Server (“issuer ACS”) (namely Visa, MasterCard, JCB, and American Express).
    Possible ECI values:
    ECI = 5(VISA), 2(MC): The cardholder was successfully authenticated.
    ECI = 6(VISA), 1(MC): The issuer or cardholder does not participate in a 3D-Secure program.
    ECI = 7(VISA), 6(MC): Payment authentication was not performed.
     

     

    Parameter Description
    nameOnCard The name on the credit card.
    first_name The customer’s first name.
    last_name The customer’s last name.
    address1 The address of the customer.
    city The city of the customer.
    country The country of the customer.
    email The email address of the customer.
    zip The zip code of the customer when available.
    phone1 The phone number of the customer.
    currency The currency used in the transaction.
     

     

    Parameter Description
    total_discount Total discount for current order.
    total_handling Total handling for current order.
    total_shipping Total shipping for current order.
    total_tax Total tax for current order.
    item_number_N The number of item number N.
    item_amount_N The cost of item number N.
    item_quantity_N The quantity of item number N.
    item_discount_N The discount for item number N.
    item_handling_N The handling costs for item number N.
    item_shipping_N The shipping costs for item number N.
    promoCode This value is a promotional code you define that you can use to apply discounts to your products or services.
     

     

    Parameter Description
    customData Custom data sent to Nuvei.
    merchant_unique_id The merchant_unique_id value as provided by the merchant to Nuvei in the HTTPS request.
    merchant_site_id The unique ID (identifier) of the Transaction in the merchant’s database as provided by the merchant to the PPP in the HTTPS request.
    merchant_id The unique merchant ID supplied by Nuvei.
    requestVersion The processed Nuvei request’s version.
    message A message sent from Nuvei regarding the transaction.
    error An error message sent from Nuvei.
    instantDmnStatus The status of the Instant DMN notification. This parameter is only returned when Instant DMN notifications are active.
    ppp_TransactionId The ID number of the transaction’s history table in the Nuvei database.
    userId The UserId value transferred by the merchant in the HTTPS request.
    ProductId The purchased product’s ID as provided by the merchant in the HTTPS request.
    ppp_status The status of the transaction.
    OK indicates that the transaction was approved.
    PENDING occurs only for APM transactions in which the final status is not immediately returned.
    FAIL indicates that the transaction was declined or there was an error.
    merchantLocale The language and country of the user in ISO code in the following format:
    [language ISO]_[country ISO]
    For example: en_US
    unknownParameters All unknown parameters sent with the current transaction.
    webMasterId Affiliate parameter – additional parameter which merchant can send to PPP.
    customFieldn* The merchant can send up to 15 custom fields to Nuvei to update miscellaneous data.
    2022 Nuvei. All rights reserved.