Skip to main content
Cortina SQR uses the Salecommand to notify the integrator about the result of a card tap after a product has been selected in order to initiate the authorization process with the Cortina payment provider. This command is essential for proceeding to transaction confirmation or rejection handling.

​
Request

Nayax’s servers send a POST request to your configured Saleendpoint, which would be of the following format: (customer's URL)/Cortina/StaticQR/Sale The payload includes the full result of the card scan operation: 
{
  "BasicInfo": {
    "TransactionId": "105603",
    "NayaxTransactionId": 6890622040,
    "Amount": 2.0,
    "CurrencyCode": "GBP",
    "CurrencyNumeric": "826",
    "SiteId": 6,
    "MachineAuTime": "041125210717",
    "TimeoutMS": 15000,
    "PaymentMethodID": 233,
    "BillingProviderId": 0,
    "NayaxRRN": "104210717194"
  },
  "MachineInfo": {
    "Id": 968382276,
    "Name": "1844-PEPPA PIG 3 SEATER CAROUSEL-PARK CENTRE - BELFAST",
    "ExternalId": "0612133524110088",
    "Type": "Amusement",
    "TerminalId": "",
    "DecimalPlace": 2,
    "Offset": "0.00",
    "City": "Belfast",
    "ZipCode": "BT12 6HN",
    "Country": {
      "Name": "UNITED KINGDOM",
      "NumericCode": "826",
      "Alpha2Code": "GB",
      "Alpha3Code": "GBR"
    },
    "GeoLocation": {
      "State": "Northern Ireland",
      "City": "Belfast",
      "CountryCode": "GB",
      "ZipCode": "BT12 6HN",
      "Address": "Donegall Road",
      "Latitude": 54.5886358,
      "Longitude": -5.9645663
    }
  },
  "ActorInfo": {
    "Id": 2001384616,
    "Name": "ABCD",
    "Country": {
      "Name": "UNITED KINGDOM",
      "NumericCode": "826",
      "Alpha2Code": "GB",
      "Alpha3Code": "GBR"
    },
    "GeoLocation": {
      "State": "Northern Ireland",
      "City": "Banbridge",
      "CountryCode": "GB",
      "ZipCode": "BT32 3QD",
      "Address": "abcde"
    },
    "MCC": 5813
  },
  "CustomData": {
    "Actor": "",
    "Machine": ""
  },
  "DeviceInfo": {
    "HwSerial": "0123456123456123",
    "FWVersion": "4.1.24.4-RC01 - Jun 24 2024",
    "Type": "ONYX"
  },
  "Products": [
    {
      "Code": -1,
      "CatalogProductId": "",
      "Name": "Unknown",
      "Price": 2.0,
      "UnitOfMeasurement": "Unit",
      "Measurement": 1.0,
      "Group": "Unknown",
      "ProductGroupId": "52"
    }
  ]
}

​
Request Parameters

The following table describes the parameters included in the request body:
FieldTypeDescription
Transaction Identifiers & Status
TransactionIdString(36)The unique identifier for this transaction.
  • Echoes the encrypted ID from /StartSession if used.
  • Otherwise, the Nayax Engine generates this value.
NayaxTransactionIdInt(64)The Nayax internal unique ID for the transaction, echoed in further requests.
SrvTranIdStringThe Integrator’s internal transaction ID.
  • Conditional: Required if /StartSession was not used.
  • If used, it should be empty or echo the Transaction ID.
RRNStringReference Retrieval Number (RRN). Recommended to be visible to the consumer/card holder for support.
AuthCodeString(40)External Authorization Code (usually from the Card Issuer’s bank).
TokenString(256)A unique token for the transaction. For Nayax internal use only.
TraceNumberStringTrace number. For Nayax internal use only.
AuthSourceString(5)For Nayax internal use only.
InitiateTranReferenceInt(64)Conditional: Reflects the original Nayax Transaction ID for prepaid loyalty card re-attempts.
Financial & Time Details
AmountDoubleThe payment amount (Decimal with max 3 digits for cents).
  • Example: 1 cent = 0.01.
  • Note: Currencies with no decimal places are still represented as a double (e.g., 234 JYN = 234.0).
AuthAmountDoubleThe original amount requested in the /Authorization request. Conditional on /Authorization response.
SettAmountDoubleThe original amount requested in the /Settlement or /Sale process. Irrelevant for Authorization.
AuthDateTimeStringThe date and time the /Authorization took place. Format:ddMMyyHHmmss.
SettDateTimeDoubleThe Settlement Date/Time. Irrelevant for the Authorization command.
Machine & Location Details
SiteIdInt(16)Region of the Nayax server.
IdInt(64)Machine entity unique ID.
NameString(255)Machine Name.
TerminalIdString(255)Terminal identifier. Contact Nayax TPOC to define.
DecimalPlaceInt(64)Decimal point location for amounts.
OffsetString(255)UTC timezone offset.
GroupIdStringFor Nayax internal use only.
OperatorIdString(255)Merchant ID (String format).
Country & Actor Geo Details
NameStringCountry Full Name.
NumericCodeString(3)ISO-3166-1 Numeric-3 code.
Alpha2CodeString(2)ISO-3166-1 Alpha-2 code.
Alpha3CodeString(3)ISO-3166-1 Alpha-3 code.
IntraStringThe Intra Region (e.g., ‘European Union’) used for geographical diversification across countries.
IdInt(64)Actor ID.
NameString(255)Direct Merchant name.
OperatorIdInt(64)Merchant operator ID (Integer format).
OperatorNameStringMerchant operator name.
MerchantIdInt(64)Merchant ID. Contact Nayax TPOC to define.
DynamicURLStringActor level URL configuration.
Custom Data (JSON Strings) & System Flags
DirectActorStringDirect actor custom data (String in JSON format).
OperatorStringOperator custom data (String in JSON format).
DistributorStringDistributor custom data (String in JSON format).
ActorStringActor custom data (String in JSON format).
MachineStringMachine custom data (String in JSON format).
AdditionalDataStringGeneral custom data string in JSON format.
IsGatewayTimeoutBoolIndicates if a gateway timeout occurred (valid in the response).
Card & Payment Details
CardNumberStringCard details provided based on transaction type:
  • Full Track 2 for card-present Authorization/Sale.
  • Card PAN only for other transaction types.
EntryModeString(4)How the card details were read:
  • MCR: Magnetic Stripe Read (swipe)
  • CON: Contact Chip (insert)
  • CLS: Contactless Chip (tap)
  • NFC: Phone/Mobile contactless
  • QR: QR code read by DOT
  • Consult Nayax POC for specific edge cases.
ExpYearStringCard expiration year (YY format). Conditional (only when Interface is 1 or 10).
ExpMonthStringCard expiration month (MM format). Conditional (only when Interface is 1 or 10).
EMVDataStringEMV tags data in TLV (Tag-Length-Value) format.
CVV2StringCard Verification Value 2 (CVV2).
IDNumberStringCardholder ID Number.
RandomNumberStringFurther information is unavailable.
PrimaryIdStringPrimary Brand ID.
PrimaryDescriptionStringPrimary Brand Description.
SecondaryIdStringSecondary Brand ID.
SecondaryDescriptionStringSecondary Brand Description.
CardHolderNameStringCard Holder Name.

​
Response

The Sale Response that the customer’s payment method would send to Nayax’s servers.
The payload should look as follows: 
{
  "Status": {
    "Verdict": "Approved",
    "StatusMessage": "transaction approved"
  },
  "PaymentInfo": {
    "SrvTranId": "string",
    "AuthCode": "string",
    "AuthAmount": 0,
    "SettAmount": 0,
    "RRN": "string",
    "Token": "string",
    "AuthDateTime": "string",
    "SettDateTime": "string",
    "TraceNumber": "string",
    "AuthSource": "string",
    "AdditionalData": "string",
    "IsGatewayTimeout": true
  }
}

​
Response Parameters

The following table describes the fields returned in the API response:
FieldTypeDescription
Transaction Status & Error Codes
VerdictStringThe constant string representing the final status of the request:
  • Approved
  • Declined
CodeInt(32)The Decline Code. Conditional—only present if Verdict is ‘Declined’. Valid codes include:
  • 1: Insufficient funds
  • 5: Suspected Fraud
  • 6: General system failure
  • 7: Invalid amount
  • 8 / 998: Format/parsing error or Validation error
  • 992: Timeout exception
  • 997: Missing mandatory parameters
  • 999: General exception
  • See full list for other status and internal errors (e.g., 40, 990, 1011).
StatusMessageString(255)A free text field containing the transaction status message or additional varying data regarding the outcome.
CustomDeclineCodeStringUsed for specifying a custom decline code (e.g., related to Soft Decline or Switch Interface). May reflect the acquirer’s response code.
Financial & Time Details
AuthAmountDoubleThe original amount requested in the /Sale Request.
SettAmountDoubleThe original amount requested in the /Sale Request.
AuthDateTimeStringThe date and time the /Authorization took place. Format:ddMMyyHHmmss.
SettDateTimeDoubleThe Settlement Date/Time. Irrelevant for the Authorization command.
Transaction Identifiers & References
SrvTranIdStringThe Integrator’s internal transaction ID.
  • Conditional: Required if /StartSession was not used.
  • If used, it should be empty or echo the Transaction ID.
AuthCodeString(40)External Authorization Code (usually from the Card Issuer’s bank).
RRNStringReference Retrieval Number (RRN). Recommended to be visible to the consumer/card holder for support.
TokenString(256)A unique token for the transaction. For Nayax internal use only.
TraceNumberStringTrace number. For Nayax internal use only.
AuthSourceString(5)For Nayax internal use only.
InitiateTranReferenceInt(64)Conditional: Reflects the original Nayax Transaction ID for prepaid loyalty card re-attempts.
Loyalty & System Details
RegularCreditTypeInt(32)Defines the unit of measure for RegularCredit (Enum values):
  • 0: Credit is counted in transactions (count).
  • 1: Credit is counted as an amount (currency).
RegularCreditDoubleThe regular credit value (amount or transaction count) based on the RegularCreditType. Uses Decimal place 2.
RevalueCreditInt(32)The revalue credit amount. Only present if the associated card is configured as revalue-able.
IsRevalueCardBoolIndication if card is allowed revalue.
IsGatewayTimeoutBoolIndicates if a gateway timeout occurred (valid in the response).
ProviderExternalDataStringExternal data from the provider in JSON format string.