Settlementcommand to notify the integrator about the result of a settlement process on the device’s end (meaning a product has been vended) in order to initiate the settlement 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 configuredSettlementendpoint, which would be of the following format:
(customer's URL)/Cortina/StaticQR/Settlement
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. |
| 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 Authorization. |
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. |
| 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. |
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. |
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) | ||
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). |
Response
The Settlement 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 constant string representing the final status of the request:
|
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. |
| Loyalty & Credit Information | ||
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. |