Skip to main content
Cortina SQR uses the Refund command to notify the integrator about the refund request in order to initiate the refund process with the Cortina payment provider.
Said request would be triggered via either of the following options:
  • Nayax’s Dynamic Transaction Monitor by selecting the relevant transaction, right-clicking on it and then selecting “Request Refund”.
  • Nayax’s Lynx API- via the Refund command

​
Request

Nayax’s servers send a POST request to your configured Refundendpoint, which would be of the following format: (customer's URL)/Cortina/StaticQR/Refund The payload includes the full result of the card scan operation: 
{
  "ReasonCode": 999,
  "ReasonText": "General exception",
  "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:
FieldTypeDescription
Transaction Identifiers & References
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.
Financial & Time Details
AmountDoubleThe payment amount (Decimal with max 3 digits for cents).
  • Example: 1 cent = 0.01.
  • 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.
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.
System & External Data
AdditionalDataStringAdditional data string in JSON format. Contact Nayax TPOC to define.
IsGatewayTimeoutBoolIndicates if a gateway timeout occurred (valid in the response).

​
Response

The Refund 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:
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.
Loyalty & Credit Information
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. Uses Decimal place 2.