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 configuredRefundendpoint, which would be of the following format:
(customer's URL)/Cortina/DynamicQR/Refund
The payload includes the full result of the card scan operation:
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.
|
NayaxTransactionId | Int(64) | The Nayax internal unique ID for the transaction, echoed in further requests. |
SrvTranId | String | The Integrator’s internal 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. |
InitiateTranReference | String | Conditional: Reflects the original Nayax Transaction ID for prepaid loyalty card re-attempts. Provided as a String in JSON format. |
| Financial & Time Details | ||
Amount | Double | The payment amount (Decimal with max 3 digits for cents).
|
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. |
CurrencyCode | String(3) | Currency code in ISO 4217 Alpha-3 format. |
CurrencyNumeric | String(3) | Currency code in ISO 4217 Numeric-3 format. |
| Card & Payment Details | ||
CardNumber | String | Card details provided based on transaction type:
|
EntryMode | String(4) | How the card details were read:
|
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. |
IsRevalueCard | Bool | Indication if card is allowed revalue. |
| System & External Data | ||
IsGatewayTimeout | Bool | Indicates if a gateway timeout occurred (valid in the response). |
AdditionalData | String | Additional data string in JSON format. Contact Nayax TPOC to define. |
ProviderExternalData | String | External data from the provider in JSON format string. |
Response
The Refund Response that the customer’s payment method would send to Nayax’s servers.The payload should look as follows:
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:
|
Code | Int(32) | The Decline Code. Conditional—only present if Verdict is ‘Declined’. Valid codes include:
|
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 /GenerateQR request. |
SettAmount | Double | The original amount requested in /Settlement or /Sale process. Conditional on /Inquiry request. |
AuthDateTime | String | The date and time the /Authorization or /Sale took place. Format:ddMMyyHHmmss. |
SettDateTime | String | The date and time the /Settlement or /Sale took place. Format:ddMMyyHHmmss. |
| Transaction Identifiers & References | ||
SrvTranId | String | The Integrator’s internal transaction ID.
|
AuthCode | String(40) | External Authorization Code (usually from the Card Issuer’s bank). |
RRN | String | Reference Retrieval Number (RRN).
|
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):
|
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. |
AdditionalData | String | Additional data string in JSON format. |