Documentation Index
Fetch the complete documentation index at: https://devzone.nayax.com/llms.txt
Use this file to discover all available pages before exploring further.
The following sequence illustrates a typical Pay-at-the-Pump workflow, combining payment detection, user interaction, and final settlement.
Step 1: Enable the Reader
The system starts by activating the terminal to wait for a card or mobile wallet.
{
"command": "cardDetect",
"requestId": "fuel-001",
"data": {
"amount": 50000,
"tranType": 1,
"channels": ["CTLS", "CHIP", "SWIPE"]
}
}
Step 2: Confirm Payment Location
Once a card is detected, ask the user if they are paying here or inside.
{
"command": "displayConfirm",
"requestId": "fuel-002",
"data": {
"title": "Choose Payment Method",
"yesLabel": "Pay at Pump",
"noLabel": "Pay in Store",
"yesImage": "payatpump",
"noImage": "payinstore"
}
}
Step 3: Fuel Type Selection
Prompt the user to select their desired fuel grade.
{
"command": "displaySelect",
"requestId": "fuel-003",
"data": {
"title": "Select Fuel Type",
"options": [
{"tag": "87", "label": "Unleaded 87"},
{"tag": "89", "label": "Unleaded 89"},
{"tag": "DSL", "label": "Diesel"}
],
"showTags": true
}
}
Step 4: Authorize Max Amount
Call the authorization command to place a hold on the funds based on the initial cardDetect amount.
{
"command": "authorize",
"requestId": "fuel-004"
}
Step 5: Show Fueling Screen
Update the terminal display to show a looping animation while the pump is active.
{
"command": "displayScreen",
"requestId": "fuel-005",
"data": {
"title": "Fueling...",
"mediaId": "fueling",
"fitImage": "FULL",
"loop": true
}
}
Step 6: Settle Actual Amount
When the nozzle is holstered, call settle with the final transaction amount.
{
"command": "settle",
"requestId": "fuel-006",
"data": {
"transactionId": "TXN-20260113-004000",
"amount": 7850
}
}
Step 7: Print Receipt
Finalize the process by providing a physical or digital record of the transaction.
{
"command": "print",
"requestId": "fuel-007",
"data": {
"printData": "Fuel Receipt\nUnleaded 87\n15.7 gal @ $5.00/gal\nTotal: $78.50"
}
}
