logo

Terminals

List of endpoints to interact with terminal(s) from the POS integration prospective.

Retrieve Terminal POS status by ID.

Retrieve the current status and details of a terminal device. This endpoint provides the latest available information about a terminal, updated in near real-time. Depending on the terminal's internet connectivity and operational status, the response may include limited terminal data.

SecurityBearer or Bearer or Bearer or Bearer
Request
path Parameters
id
required
string <uuid>

TerminalId

Responses
200

Success

get/pos-api/v1/terminals/{id}/status
Request samples 
Response samples 
application/json
{
  • "terminalPosStatusId": 1,
  • "terminalPosStatus": "Active",
  • "terminalId": "00000000-0000-0000-0000-000000000000",
  • "timestamp": "0001-01-01T00:00:00",
  • "connectionStatusId": 0,
  • "connectionStatus": "0",
  • "connectionTypeId": null,
  • "connectionType": null,
  • "wifiConnectionStrength": 0,
  • "mobileConnectionStrength": 0,
  • "lastSeenTimestamp": null,
  • "debitPinKeyId": null,
  • "debitPinKey": null,
  • "availabilityStatusId": null,
  • "availabilityStatus": null,
  • "ariseTerminalVersion": null,
  • "batteryLevel": 0,
  • "printerStatusId": null,
  • "printerStatus": null,
  • "deviceSoftwareDetails": null
}
List merchant terminals.
SecurityBearer or Bearer or Bearer or Bearer 
Request 
query Parameters
page
integer <int32> 
 
pageSize
integer <int32> 
 
asc
boolean
 
orderBy
string
 
search
string
 
deliveryStatusId
integer <int32> 
 
serialNumber
string
 
manufacturerIds
Array of integers <int32> 
 
modelIds
Array of integers <int32> 
 
Responses 
200
Success


get/pos-api/v1/terminals
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "total": 3
}
➔ Next to Ping