Authorization

The unique identifier for this transaction.

• If /StartSession was used, this echoes the ID encrypted in 'TranIDCipher'.
• If /StartSession was not used, the Nayax Engine generates this value.

The Nayax internal unique identifier for the transaction. This ID is echoed in further related requests.

The payment amount (Decimal with max 3 digits for cents).

• Example: 1 cent = 0.01, 20 cents = 0.20.
• Note: Currencies with no decimal places (e.g., JYN) are still represented as a double, e.g., 234 JYN = 234.0.

The currency represented by its ISO 4217 Alpha-3 code (e.g., USD, EUR).

The currency represented by its ISO 4217 Numeric-3 code (e.g., 840 for USD).

The identifier for the Nayax server region hosting the transaction.

The Machine Authorization Timestamp.

The Nayax Server Timeout configuration, specified in milliseconds.

Indication of whether the product was pre-selected before the payment process began.

The Nayax identifier for the specific payment provider used.

The Nayax identifier for the associated billing provider.

Field reserved for Nayax internal use only.

A Reference Number used as an External Transaction Identification for external parties.

• Recommendation: This ID should be visible to the end consumer and their bank/service provider.
• This value must be repeated in the subsequent /Inquiry request.

Boolean indicator. Further information is unavailable.

The minimum age required to permit the transaction.

Boolean indicator. Further information is unavailable.

The transaction type for transit payments (Enum values):

• 1: Prefunded
• 2: Realtime Authorization
• 3: Post-Authorization (Aggregated Transaction)
• 7: Debt Recovery

Indicates the effect on the consumer's Deny List status (Enum values):

• 0: unknown/no effect
• 1: Decline will cause the consumer to be added to the deny list.
• 2: Approval shall cause the consumer to be removed from the deny list.

The Nayax Device Hardware serial number.

The device Firmware version number.

The Nayax Device Type.

The unique machine entity ID allocated in Nayax's back office system.

The Machine Name as configured in Nayax's back office.

The Machine External ID (Machine number - operator) provided by the operator in Nayax's back office.

The Machine Type as defined in Nayax's back office.

The Terminal identifier. Contact Nayax TPOC for definition.

The decimal point location for amounts used on this machine.

• Example: Value of 2 means amounts like 123.45.
• Example: Value of 0 means amounts like 12345 (integer representation).

The UTC timezone offset for the machine's location.

Field reserved for Nayax internal use only.

The Merchant ID as defined in Nayax's back office.

The Region as defined in Nayax's back office.

The machine's City as defined in Nayax's back office.

The machine's Zip Code as defined in Nayax's back office.

The Country Full Name.

The ISO-3166-1 Numeric-3 code for the country (e.g., 840).

The ISO-3166-1 Alpha-2 code for the country (e.g., US).

The ISO-3166-1 Alpha-3 code for the country (e.g., USA).

The Intra Region for geographical diversification.

The Actor geo state code.

The City associated with the actor.

The Country code (ISO3).

The Zip Code associated with the actor.

The Address associated with the actor.

The Machine Location Latitude.

The Machine Location Longitude.

The Actor ID.

The Direct Merchant Name.

The Merchant Operator ID.

The Merchant Operator Name.

The Merchant ID. Contact Nayax TPOC to define.

The Actor level URL configuration.

The Country Full Name.

The ISO-3166-1 Numeric-3 code.

The ISO-3166-1 Alpha-2 code.

The ISO-3166-1 Alpha-3 code.

The Intra Region for geographical diversification.

The Actor geo state code.

The City associated with the actor.

The Country code (ISO3).

The Zip Code associated with the actor.

The Address associated with the actor.

The Machine Location Latitude.

The Machine Location Longitude.

Merchant Category Code. Used to classify merchants by the type of goods or services provided.

The Sub Merchant identifier. Contact Nayax TPOC to define.

Custom data for the Direct Actor in JSON format.

Custom data for the Operator in JSON format.

Custom data for the Distributor in JSON format.

Custom data for the Actor in JSON format.

Custom data for the Machine in JSON format.

Custom data related to a Soft Decline in JSON format.

Card details sent based on transaction type:

• For Card Present Authorization/Sale: The full Track2 data.
• For other transactions: The card PAN only.

Indicates how the card details were read. Common values include:

• MCR: Magnetic Stripe Read (swipe).
• CON: Contact Chip Read (insert).
• CLS: Contactless Chip Read (tap).
• NFC: Phone/Mobile device contactless read.
• QR: Card number read from a QR code.

The card's expiration year (YY format). Conditional: Only sent when Interface is 1 or 10.

The card's expiration month (MM format). Conditional: Only sent when Interface is 1 or 10.

A string containing EMV tags in TLV (Tag-Length-Value) format.

The Card Verification Value 2 (CVV2).

The ID Number associated with the cardholder or transaction.

Further information is unavailable.

The Primary Brand Id.

The Primary Brand Description.

The Secondary Brand Id (if applicable).

The Secondary Brand Description (if applicable).

The Card Holder Name.

Indication if card is a Debit or Prepaid card.

The Integrator's internal transaction ID.

• Conditional: Only mandatory if /StartSession was not used.
• If /StartSession was used, this should be empty or echo the main Transaction ID.

The External Authorization Code (usually from the Card Issuer's bank).

The original amount requested in the /Authorization request.

The original amount requested in the /Settlement or /Sale process. Irrelevant for Authorization.

Reference Retrieval Number. Highly recommended to be visible to the end consumer/card holder.

A unique token for the transaction. For Nayax Internal use only.

The date and time string when the /Authorization took place. Format:ddMMyyHHmmss.

The Settlement Date/Time. Irrelevant for Authorization.

The Trace Number. For Nayax Internal use only.

For Nayax Internal use only.

Additional data sent as a JSON format string.

Indication of whether a gateway timeout occurred.

External data from the provider in JSON format string.

Conditional. Reflects the original Nayax Transaction ID for prepaid loyalty card re-attempts.

Indication of whether the card is allowed to be revalued.

The constant string status of the request:

• Approved
• Declined

Conditional: Only returned if Verdict is Declined. The mandatory decline codes:

• 1: Insufficient funds
• 2: Transaction ID unknown
• 3: Cardholder exceeded daily / weekly / monthly transaction count limit
• 4: Cardholder exceeded transaction amount limit
• 5: Suspected Fraud
• 6: General system failure
• 7: Invalid amount
• 8: Request cannot be parsed (format error)
• 9: Transaction not allowed to cardholder
• 40: For Nayax internal use only.
• 990: CertificateFileName not found
• 991: Failed to decipher message body
• 992: Timeout exception
• 994: Card Brand not supported
• 996: Transaction ID Unknown / Duplicate Transaction ID (Start Session Error)
• 997: Missing mandatory parameters
• 998: Validation / request cannot be parsed
• 999: General exception
• 1010: Public Key Certificate not found
• 1011: Method not Implemented

The transaction status message, provided as a free text field or for additional varying data.

Used to specify a custom decline code (e.g., for Soft Decline or Switch Interface). This value may be the acquirer's response code or composed of other data.

The Integrator's internal transaction ID.

• Conditional: Only mandatory if /StartSession was not used.
• If /StartSession was used, this should be empty or echo the Transaction ID sent in the request.

The External Authorization Code (usually from the Card Issuer's bank).

The original amount requested in the /Authorization Request.

The original amount requested in the /Settlement or /Sale process. Irrelevant for Authorization.

Reference Retrieval Number. Highly recommended to be visible to the end consumer/card holder for support.

A unique token for the transaction. For Nayax Internal use only.

The date and time string when the /Authorization took place. Format:ddMMyyHHmmss.

The Settlement Date/Time. Irrelevant for Authorization.

The Trace Number. For Nayax Internal use only.

For Nayax Internal use only.

Additional data sent as a JSON format string. Contact Nayax TPOC to define.

Indication (valid in response) of whether a gateway timeout occurred.

External data from the provider in JSON format string.

Conditional: Reflects the original Nayax Transaction ID for prepaid loyalty card re-attempts.

Indication of whether the card is allowed to be revalued (have funds added).

Defines what the RegularCredit field represents (Enum values):

• 0: The credit is counted in transactions.
• 1: The credit is counted as an amount.

The Regular Credit amount or number of transactions based on RegularCreditType. Decimal place 2.

The Revalue Credit amount. Only available if the card is configured as revalue-able. Decimal place 2.