Sign in

v1

latestOpenAPI 3.0.12026-07-26181265484.9 KB
Transactions

TriggerTransaction

post/TriggerTransaction

Request body

SparkTransactionIdstring nullable

The unique session ID received from Spark during the StartAuthentication process.

TerminalIdstring

The unique ID of the target terminal.

TerminalIdTypeinteger nullable

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

Amountnumber double

The amount to be pre-authorized or charged for the transaction. This value is required for the Pre-Selection flow.

PosDisplaystring nullable

An optional custom message to show on the terminal's display.

EReceiptDatastring nullable

Optional JSON-formatted string representing e-receipt details for machine operators who wish to provide digital receipts.

TransactionTimeoutinteger

The timeout in seconds for the terminal to wait for a card to be presented. This value must be greater than 0.

Example request

{
  "SparkTransactionId": "12c7cec2-c690-4425-9a1f-db0db60e2d8c",
  "TerminalId": "0434334921100366",
  "TerminalIdType": 1,
  "Amount": 15,
  "PosDisplay": ";Charging Station:3;Day:30.52p;Night:9p;Standing charge:52.18p/day; Off-peak:12:30-04:30;",
  "TransactionTimeout": 60
}

Response

Success. The transaction was successfully triggered.

SparkTransactionIdstring nullable

The unique transaction ID, echoed from the request.

Example response

{
  "SparkTransactionId": "12c7cec2-c690-4425-9a1f-db0db60e2d8c",
  "Status": {
    "Verdict": "Approved",
    "ErrorDescription": " No Errors "
  }
}