Sign in

v1

latestOpenAPI 3.0.12026-07-26181265484.9 KB
Transactions

ExternalSettlement

post/ExternalSettlement

Request body

NayaxTransactionIdinteger

Nayax Internal Unique identifier for the transaction.

SparkTransactionIdstring nullable

Unique identifier for this transaction, used by Spark.

MachineAuTimestring yyyyMMddHHmmssfff. nullable

The date time string of when the /Authorization took place, in local (machine) time.

SiteIdinteger nullable

Optional. Echo value from Authorization Callback. Represents the Site ID.

TerminalIdstring

Unique Identifier for the Nayax Terminal.

TerminalIdType1 | 2 nullable

Indicates the type of TerminalId. 1 - Nayax HW serial, 2 - Nayax Machine ID

Amountnumber double

The value to be provided to the Terminal for transaction initiation. Decimal (max 2 digits for cents)

EReceiptDatastring nullable

Optional. Transaction's 3rd party data for receipt generation.

Example request

{
  "NayaxTransactionId": 1234567890,
  "SparkTransactionId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "MachineAuTime": "20251212104530123",
  "SiteId": 2,
  "TerminalId": "0434334921100366",
  "TerminalIdType": 1,
  "Amount": 15.75,
  "ProductInfo": [
    {
      "Value": 15.75,
      "Quantity": 1
    }
  ]
}

Response

Success

SparkTransactionIdstring nullable

The Spark unique identifier for this transaction.

AuthCodestring nullable

For Credit card implementation, when the transaction is approved, this is the External (usually Card issuer's) Authorization Code.

MachineAuTimestring yyyyMMddHHmmssfff nullable

The date time string of when the /Authorization or /Sale took place, in local (machine) time.

Amountnumber double

The value Settled by the card issuer during the Settlement phase.

Example response

{
  "SparkTransactionId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "AuthCode": "A1B2C3",
  "MachineAuTime": "20251212104530123",
  "Amount": 15.75
}