Device information and configuration
getInfo
Get device metadata.
getVersion
Get app versions.
getProperty
Get a terminal detail.
getConfig
Get the current configuration.
setConfig
Apply configuration settings.
getLocation
Get the device location.
Card reading
readCard
Read a swiped or tapped card.
abortReadCard
Cancel a card read.
readCardForExternalTransaction
Read a card for an external processor.
Transaction updates
Use one of the methods below at the end of every transaction to record its final status on the Nayax side.updatePinpadTransactionStatus
Report the final status after a card read.
updateExternalTransaction
Record a transaction with no card read.
User input and selection
getUserInput
Prompt for numeric or text input.
abortGetUserInput
Cancel an input prompt.
getUserSelection
Prompt to pick from a list.
abortGetUserSelection
Cancel a selection prompt.
Display and animations
showAnimation
Show an approved or declined animation.
hideAnimation
Hide the current animation.
displaySwipeCard
Prompt the user to swipe a card.
abortSwipe
Cancel a card swipe.
displayQR
Show a QR code on screen.
abortDisplayQR
Cancel a QR code display.
abortDisplay
Cancel prompts and messages.
Diagnostics and events
sendGeneralEvent
Send an event or status update.
uploadLogs
Send diagnostic logs.
Send RequestsSee Get Started for more details on how to structure and send requests.