RevKeenDocs
StatusSupport
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 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.

GET
/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 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 for SDK auto-paging helpers.

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

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

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
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": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "count": 0  }}

Retrieve a terminal device GET

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.

Cancel a terminal payment POST

Cancel an in-progress terminal payment. Only payments with status `requested` or `in_progress` can be cancelled. --- **Related endpoints** - `POST /terminal-payments` — Initiate a terminal payment - `GET /terminal-payments` — List terminal payments - `GET /terminal-payments/{id}` — Retrieve a terminal payment - `POST /terminal-payments/{id}/refund` — Refund a terminal payment - `POST /terminal-payments/{id}/void` — Void a terminal payment **Common errors** - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. - `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).