Skip to main content
TriggerTransaction
The TriggerTransaction endpoint initiates user interaction with the physical terminal by sending a wake-up signal to the specified device.

Body

application/json

The request payload containing the details to trigger a transaction.

The request payload for the /spark/TriggerTransaction endpoint. This call initiates user interaction with a physical terminal and provides the necessary details for the transaction.

SparkTransactionId
string | null

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

TerminalId
string

The unique ID of the target terminal.

TerminalIdType
integer<int32> | null

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

Amount
number<double>

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

PosDisplay
string | null

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

EReceiptData
string | null

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

TransactionTimeout
integer<int16>

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

Response

200 - application/json
object | null

Success. The transaction was successfully triggered.

The response payload from the /spark/TriggerTransaction endpoint, which confirms the result of the request to initiate user interaction with a physical terminal.

SparkTransactionId
string | null

The unique transaction ID, echoed from the request.

Status
object

An object containing the resulting verdict and an optional error description.