Device Information & Configuration
getInfo
Retrieve device metadata, including hardware, manufacturer, and serial number information.
getVersion
Retrieve version information for the apps running on the device.
getProperty
Retrieve specific terminal details, such as serial numbers or hardware identifiers.
getConfig
Retrieve the terminal’s current configuration object.
setConfig
Apply configuration settings to the terminal.
getLocation
Retrieve the device’s current geographic location.
Card Reading
readCard
Read card data from the magnetic stripe or NFC reader.
abortReadCard
Cancel an ongoing readCard operation.
readCardForExternalTransaction
Read card data so an external processor can authorize the transaction.
User Input & Selection
getUserInput
Prompt the user for numeric or alphanumeric input on the terminal.
abortGetUserInput
Cancel an ongoing getUserInput request.
getUserSelection
Prompt the user to choose from a predefined list of options.
abortGetUserSelection
Cancel an active getUserSelection prompt.
Display & Animations
showAnimation
Show an approved or declined animation on the device.
hideAnimation
Cancel or hide the animation currently showing on the device.
displaySwipeCard
Prompt the user to swipe a magnetic card on the terminal.
abortSwipe
Cancel an ongoing card swipe operation.
displayQR
Show a QR code on the terminal’s screen.
abortDisplayQR
Cancel an ongoing QR code display.
abortDisplay
Cancel ongoing display operations, such as prompts or messages.
Diagnostics & Events
sendGeneralEvent
Send operational events or status updates from the terminal.
updatePinpadTransactionStatus
Report a transaction’s outcome back to the device after an external processor authorizes it.
uploadLogs
Send diagnostic logs from the terminal for troubleshooting.
Send RequestsSee Get Started for more details on how to structure and send requests.