RevKeen Docs
Api reference

List terminal devices

List all terminal devices registered for the authenticated merchant. Use this endpoint to discover device IDs before initiating a terminal payment.


Related endpoints

  • GET /terminal-devices/{id} — Retrieve a terminal device

Common errors

  • 401 unauthenticated — missing, malformed, or revoked API key.

Pagination

Offset-based with limit (default 25, max 100) and offset. The response pagination block includes total and hasMore. See the pagination guide for SDK auto-paging helpers.

GET
/terminal-devices
x-api-key<token>

Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.

In: header

Query Parameters

status?string

Filter by device status

Value in"online" | "offline" | "pairing"
terminal_paired?|

Filter by terminal pairing status

Response Body

application/json

application/json

curl "https://api.revkeen.com/v2/terminal-devices" \  -H "x-api-key: $REVKEEN_API_KEY"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "device_name": "string",
      "terminal_serial": "string",
      "terminal_ip": "string",
      "platform": "macos",
      "status": "online",
      "terminal_paired": true,
      "terminal_reachable": true,
      "app_version": "string",
      "last_heartbeat_at": "string"
    }
  ],
  "meta": {
    "count": 0
  }
}
{
  "error": "string",
  "message": "string"
}