Terminals
Retrieve a terminal
A terminal by ID.
GET
/v1/terminals/{id}scope terminals:readPath parameters
idstringrequiredTerminal ID (
tml_…).
Headers
ZyloPay-VersionstringPin the request to an API version (2026-09-28). Defaults to the version the API key was created with.
Returns
HTTP 200 with the terminal object.
Errors
| Status | Meaning |
|---|---|
400 | Invalid request (invalid_request_error / idempotency_error). |
401 | Missing, invalid, expired or revoked API key (authentication_error). |
403 | The key lacks the scope, the IP is not allowed, or the account is disabled (permission_error). |
429 | Rate limit reached for this key (rate_limit_error); see Retry-After. |
500 | Internal error (api_error). Retry with the same Idempotency-Key. |
Branch on error.code. Every code is listed in error codes.
Example request
curl https://zylopay-api.fly.dev/api/v1/terminals/tml_ZP-4821-K \
-H "Authorization: Bearer $ZYLOPAY_SECRET_KEY"Example response
{
"id": "tml_ZP-4821-K",
"object": "terminal",
"livemode": false,
"label": "ZP-4821-K",
"name": "Counter 1",
"platform": "generic",
"status": "active",
"last_seen_at": "2026-09-28T14:01:58.000Z",
"network": "testnet",
"created": "2026-09-02T09:15:00.000Z"
}