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 Direct Merchant Notifications (DMNs).
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
| 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: 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
| 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. |
| 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. |
General Items
| 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. |
Other Parameters
| 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. This parameter is only returned when Instant DMNs 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 (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. |