Void

Cortina DQR uses the Voidcommand to notify the integrator in order to initiate the cancelation process with the Cortina payment provider whenever on the bellow scenarios takes place:

Issues during vending process (after an “Approved” Inquiry response)- Cancel button being pressed by the consumer/ vend failure (issue with product dispensing/service providing) by the machine.
No Inquiry Response until timeout.

This command is essential for having the payment provider aware that the transaction was cancelled on Nayax’s end (as well as from the consumer’s POV), and is done in order for the payment provider to complete the cancellation on it’s end.

Request

Nayax’s servers send a POST request to your configured Void endpoint, which would be of the following format: (customer's URL)/Cortina/DynamicQR/Void The payload includes the full result of the card scan operation:

{
  "ReasonCode": 3,
  "ReasonText": "Cashless Cancelled by machine",
  "BasicInfo": {
    "TransactionId": "236584335969834429321847829253667359",
    "Amount": 0.1,
    "Currency": "ILS",
    "SiteId": 1,
    "MachineAuTime": "230221121009"
  },
  "DeviceInfo": {
    "Id": 0,
    "HwSerial": "0434324119376524",
    "FWVersion": "",
    "Type": "ONYX"
  },
  "MachineInfo": {
    "Id": 869761713,
    "Name": "TestPayDynamicQR V2",
    "TerminalId": "987654321",
    "DecimalPlace": 2,
    "Offset": "2.00",
    "CountryCode": "US",
    "CountryISOCode": "USA",
    "Country": "UNITED STATES",
    "City": "Abbeville",
    "Address": "TestPayDynamicQR V2",
    "ZipCode": "1223311"
  },
  "ActorInfo": {
    "Id": 2001187922,
    "Name": "TanyaT_OP",
    "MerchantId": "123456789"
  },
  "CustomData": {
    "Actor": "",
    "Machine": {
      "dynamic_qr_channels_rec_ids": "18,19"
    }
  },
  "PaymentInfo": {
    "SrvTranId": "236584335969834429321847829253667359",
    "AuthCode": "333333",
    "AuthAmount": 0.1,
    "SettAmount": 0.1,
    "RRN": "111111",
    "Token": "",
    "AuthDateTime": "230221101008",
    "SettDateTime": "230221101009",
    "TraceNumber": "4444",
    "AuthSource": "55555",
    "IsGatewayTimeout": false
  }
}

Request Parameters

The following table describes the parameters included in the request body:

Field	Type	Description
Transaction Identifiers & References
`TransactionId`	String(36)	The unique identifier for this transaction. Echoes the encrypted ID from `/StartSession` if used. Otherwise, the Nayax Engine generates this value.
`NayaxTransactionId`	Int(64)	The Nayax internal unique ID for the transaction, echoed in further requests.
`SrvTranId`	String	The Integrator’s internal transaction ID. Conditional: Required if `/StartSession` was not used. If used, it should be empty or echo the Transaction ID.
`RRN`	String	Reference Retrieval Number (RRN). Recommended to be visible to the consumer/card holder for support.
`AuthCode`	String(40)	External Authorization Code (usually from the Card Issuer’s bank).
`Token`	String(256)	A unique token for the transaction. For Nayax internal use only.
`TraceNumber`	String	Trace number. For Nayax internal use only.
`AuthSource`	String(5)	For Nayax internal use only.
Financial & Time Details
`Amount`	Double	The 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`).
`AuthAmount`	Double	The original amount requested in the `/Authorization` request. Conditional on `/Authorization` response.
`SettAmount`	Double	The original amount requested in the `/Settlement` or `/Sale` process. Irrelevant for the Authorization command.
`AuthDateTime`	String	The date and time the `/Authorization` took place. Format:`ddMMyyHHmmss`.
`SettDateTime`	Double	The Settlement Date/Time. Irrelevant for the Authorization command.
Card & Payment Details
`CardNumber`	String	Card details provided based on transaction type: Full Track 2 for card-present Authorization/Sale. Card PAN only for other transaction types.
`EntryMode`	String(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.
`ExpYear`	String	Card expiration year (YY format). Conditional (only when Interface is 1 or 10).
`ExpMonth`	String	Card expiration month (MM format). Conditional (only when Interface is 1 or 10).
`EMVData`	String	EMV tags data in TLV (Tag-Length-Value) format.
`IDNumber`	String	Cardholder ID Number.
`RandomNumber`	String	Further information is unavailable.
`PrimaryId`	String	Primary Brand ID.
`PrimaryDescription`	String	Primary Brand Description.
`SecondaryId`	String	Secondary Brand ID.
`SecondaryDescription`	String	Secondary Brand Description.
`CardHolderName`	String	Card Holder Name.
Machine & Location Details
`SiteId`	Int(16)	Region of the Nayax server.
`HwSerial`	String	Nayax Device Hardware serial number.
`FWVersion`	String	Device Firmware version.
`Type`	String	Nayax Device Type.
`Id`	Int(64)	Machine entity unique ID.
`Name`	String(255)	Machine Name.
`TerminalId`	String(255)	Terminal identifier. Contact Nayax TPOC to define.
`DecimalPlace`	Int(64)	Decimal point location for amounts.
`Offset`	String(255)	UTC timezone offset.
`GroupId`	String	For Nayax internal use only.
`OperatorId`	String(255)	Merchant ID.
`Region`	String(255)	Machine Region.
`City`	String(255)	Machine City.
`ZipCode`	String(255)	Machine Zip Code.
`Name`	String	Country Full Name (for machine location).
`NumericCode`	String(3)	ISO-3166-1 Numeric-3 code.
`Alpha2Code`	String(2)	ISO-3166-1 Alpha-2 code.
`Alpha3Code`	String(3)	ISO-3166-1 Alpha-3 code.
`State`	String	Actor geo state code.
`City`	String(255)	Actor geo City.
`CountryCode`	String	Actor geo Country code (ISO3).
`ZipCode`	String(255)	Actor geo Zip code.
`Address`	String(255)	Actor geo Address.
`Longitude`	String	Machine Location Longitude.
`Latitude`	String	Machine Location Latitude.
Custom Data (JSON Strings)
`DirectActor`	String	Direct actor custom data (String in JSON format).
`Operator`	String	Operator custom data (String in JSON format).
`Distributor`	String	Distributor custom data (String in JSON format).
`Actor`	String	Actor custom data (String in JSON format).
`Machine`	String	Machine custom data (String in JSON format).
`AdditionalData`	String	General custom data string in JSON format.
System & Response Flags
`IsGatewayTimeout`	Bool	Indicates if a gateway timeout occurred (valid in the response).

Response

The Void Response that the customer’s payment method would send to Nayax’s servers.
The payload should look as follows:

{
  "Status": {
    "Verdict": "Approved",
    "Code": 0,
    "StatusMessage": "Cortina V2 Stub Tester"
  },
  "PaymentInfo": {
    "SrvTranId": "236584335969834429321847829253667359",
    "AuthCode": "333333",
    "AuthAmount": 0.1,
    "SettAmount": 0.1,
    "RRN": "111111",
    "Token": "",
    "AuthDateTime": "230221101008",
    "SettDateTime": "230221101009",
    "TraceNumber": "4444",
    "AuthSource": "55555",
    "IsGatewayTimeout": false
  }
}

Response Parameters

The following table describes the fields returned in the API response:

Field	Type	Description
Transaction Status & Error Codes
`Verdict`	String	The final status of the request. Must be one of the constant string values: `Approved` `Declined`
`Code`	Int(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).
`StatusMessage`	String(255)	A free text field containing the transaction status message or additional varying data regarding the outcome.
`CustomDeclineCode`	String	Used 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
`AuthAmount`	Double	The original amount requested in the `/Authorization` Request.
`SettAmount`	Double	The original amount requested in the `/Settlement` or `/Sale` process. Irrelevant for Authorization.
`AuthDateTime`	String	The date and time the `/Authorization` took place. Format:`ddMMyyHHmmss`.
`SettDateTime`	Double	The Settlement Date/Time. Irrelevant for the Authorization command.
Transaction Identifiers & References
`SrvTranId`	String	The Integrator’s internal transaction ID. Conditional: Required if `/StartSession` was not used. If used, it should be empty or echo the Transaction ID.
`AuthCode`	String(40)	External Authorization Code (usually from the Card Issuer’s bank).
`RRN`	String	Reference Retrieval Number (RRN). Recommended to be visible to the consumer/card holder for support.
`Token`	String(256)	A unique token for the transaction. For Nayax internal use only.
`TraceNumber`	String	Trace number. For Nayax internal use only.
`AuthSource`	String(5)	For Nayax internal use only.
`InitiateTranReference`	Int(64)	Conditional: Reflects the original Nayax Transaction ID for prepaid loyalty card re-attempts.
Loyalty & System Details
`RegularCreditType`	Int(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).
`RegularCredit`	Double	The regular credit value (amount or transaction count) based on the `RegularCreditType`. Uses Decimal place 2.
`RevalueCredit`	Int(32)	The revalue credit amount. Only present if the associated card is configured as revalue-able.
`IsRevalueCard`	Bool	Indication if card is allowed revalue.
`IsGatewayTimeout`	Bool	Indicates if a gateway timeout occurred (valid in the response).
`ProviderExternalData`	String	External data from the provider in JSON format string.

Guides

API Reference

Request

Request Parameters

Response

Response Parameters

Guides

API Reference

​Request

​Request Parameters

​Response

​Response Parameters

Request

Request Parameters

Response

Response Parameters