Cancel

Cortina SQR uses the Cancelcommand to notify the integrator in order to initiate the cancellation process with the Cortina payment provider whenever on the bellow scenarios takes place:

Getting a failed Authorization Response (either due to timeout or having an error code in the Authorization Response).
Issues during product selection- inactivity of the consumer/Cancel button being pressed/invalid product selection by the consumer.
Vend failure (issue with product dispensing/service providing) by the machine

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.

Note- this command is relevant for PreAuthorization only. It's equivalent of PreSelection flow is the Void command.

Request

Nayax's servers send a POST request to your configured Cancel endpoint, which would be of the following format:

(customer's URL)/Cortina/StaticQR/Cancel

The payload includes the full result of the card scan operation:

{
  "ReasonCode": 2,
  "ReasonText": "Cashless cancelled by consumer",
  "BasicInfo": {
    "TransactionId": "236584335969834429321847829253667359,",
    "Amount": 0.1,
    "CurrencyCode": "USD",
    "CurrencyNumeric": 376,
    "SiteId": 12
  },
  "MachineInfo": {
    "Id": 869761713,
    "Name": "TestPayStaticQR V2",
    "TerminalId": 987654321,
    "DecimalPlace": 2,
    "Offset": 2,
    "GroupId": "Beverages",
    "OperatorId": 12345,
    "ZipCode": 10001,
    "Country": {
      "Name": "United States of America",
      "NumericCode": 840,
      "Alpha2Code": "US",
      "Alpha3Code": "USA"
    }
  },
  "ActorInfo": {
    "Id": 2001102296,
    "Name": "Far East Dev Zone",
    "OperatorId": 2000305191,
    "OperatorName": "TanyaT_OP",
    "MerchantId": 10011
  },
  "CustomData": {
    "DirectActor": 12312312,
    "Operator": 123121434134,
    "Distributor": "superDistributor",
    "Actor": 12312312,
    "Machine": 131231348
  },
  "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
  }
}

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 Authorization.
`AuthDateTime`	String	The date and time the `/Authorization` took place. Format:`ddMMyyHHmmss`.
`SettDateTime`	Double	The Settlement Date/Time. Irrelevant for the Authorization command.
Machine & Location Details
`SiteId`	Int(16)	Region of the Nayax server.
`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 (String format).
Country & Actor Geo Details
`Name`	String	Country Full Name.
`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.
`Id`	Int(64)	Actor ID.
`Name`	String(255)	Direct Merchant name.
`OperatorId`	Int(64)	Merchant operator ID (Integer format).
`OperatorName`	String	Merchant operator name.
`MerchantId`	Int(64)	Merchant ID. Contact Nayax TPOC to define.
Custom Data (JSON Strings) & System Flags
`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.
`IsGatewayTimeout`	Bool	Indicates if a gateway timeout occurred (valid in the response).

Response

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

{
  "Status": {
    "Verdict": "Approved",
    "StatusMessage": "Cortina V2 Stub Tester"
  }
}

Response Parameters

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

Field	Type	Description
Transaction Status & Error Codes
`Verdict`	String	The constant string representing the final status of the request: `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.
Loyalty & Credit Information
`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. Uses Decimal place 2.