RevKeenDocs
StatusSupport
API Reference

Retrieve a terminal device

Get a terminal device by ID, including its current status and heartbeat information. --- **Related endpoints** - `GET /terminal-devices` — List terminal devices **Common errors** - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.

GET
/terminal-devices/{id}

Get a terminal device by ID, including its current status and heartbeat information.

Related endpoints

  • GET /terminal-devices — List terminal devices

Common errors

  • 404 resource_missing — the referenced resource does not exist or is not visible to your key.

Authorization

x-api-key<token>

Your RevKeen merchant API key. Create and manage keys in Dashboard → Settings → Developer. Use rk_sandbox_* for staging/test and rk_live_* for production. The same key may be sent as Authorization: Bearer <key> if that suits your HTTP client better. A missing, invalid, expired, or revoked key returns 401 with a WWW-Authenticate: Bearer challenge; a valid key without the required scope returns 403.

In: header

Path Parameters

id*string

Terminal device ID

Formatuuid

Response Body

application/json

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl "https://api.revkeen.com/v2/terminal-devices/00000000-0000-0000-0000-000000000000" \
  -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": "2019-08-24T14:15:22Z"  }}

Update sync state PUT

Update or create sync state for a specific resource type. Used by worker after sync jobs. --- **Related endpoints** - `GET /sync-state/{source}/{merchantId}` — Get sync states for integration **Common errors** - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `403 authorization_error` — the caller is identified but the action is denied. Codes include `insufficient_permissions`, `ip_not_allowed`, `merchant_mismatch`, and `origin_not_allowed`. - `409 conflict` — Idempotency-Key collision with a different body, or a concurrent state-transition conflict. **Idempotency** Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).

List terminal devices GET

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 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. **Pagination** Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.