Settlement

Request body

NayaxTransactionIdinteger

The unique transaction ID assigned by Nayax for the transaction being settled.

SparkTransactionIdstring nullable

The unique session ID from the initial /StartAuthentication request. This ID links the settlement to the original transaction.

SiteIdinteger nullable

The identifier of the site where the transaction occurred. This value is an echo from the initial authorization callback.

TerminalIdstring

The serial or external ID of the terminal used for the transaction.

TerminalIdTypeinteger nullable

Defines the ID type used for the TerminalId. Use 1 for the HW Serial and 2 for the Nayax Machine ID.

Amountnumber double

The final transaction amount to be settled, specified in major currency units (e.g., dollars or euros).

EReceiptDatastring nullable

An optional JSON-formatted string containing additional e-receipt details. This data can be used to provide digital receipts to consumers via the Nayax eReceipt platform.

Example request

{
  "NayaxTransactionId": 2004545072,
  "SparkTransactionId": "12c7cec2-c690-4425-9a1f-db0db60e2d8c",
  "SiteId": 2,
  "TerminalId": "0434334921100366",
  "TerminalIdType": 1,
  "Amount": 12.25,
  "EReceiptData": "{\"General\":[{\"Company\":\"Your Payments - Our Solutions\",\"Station Name\":\"B12\"}],\"Service\":[{\"Product\":\"Something Yummy\",\"Price Per Unit\":\"$2.45\",\"Number of Units\":2}]}"
}

Response

Success. The transaction has been successfully settled.

SparkTransactionIdstring nullable

The unique ID used for this transaction session, which is an echo of the value sent in the request.

CardBrandstring nullable

The brand of the card used for the transaction, such as Visa or MasterCard.

CardLast4Digitsstring nullable

The last four digits of the payment card used.

AuthCodestring nullable

The authorization code returned by the payment provider for the transaction.

MachineAuTimestring nullable

The device timestamp at the moment of authorization, formatted as yyyyMMddHHmmssSSS.

AuTimestring nullable

The authorization server's timestamp.

SeTimestring nullable

The timestamp from the settlement server, formatted as yyyyMMddHHmmssSSS.

CurrencyCodestring nullable

The ISO currency code for the transaction, such as EUR.

CurrencyNumericstring nullable

The ISO 4217 numeric currency code, such as 978 for EUR.

FiscalRrnstring nullable

The fiscal reference number for the transaction, used for receipt and audit purposes.

NayaxRRNstring nullable

The internal Nayax settlement reference number.