Skip to content
API reference

Terminals

6 endpoints

The endpoint descriptions come directly from the API and are in German.

Terminals auflisten

get/v1/terminals

Gekoppelte PAX IM30.

Response 200TerminalList

NameTypeDescription
objectrequired"list"
datarequiredTerminal[]
has_morerequiredboolean

Possible errors

  • 400 Anfrage ungültig
  • 401 Nicht angemeldet
  • 403 Berechtigung fehlt
  • 404 Nicht gefunden
  • 409 Zustand passt nicht
  • 429 Zu viele Anfragen
Example
curl -X GET https://api.ladehase.com/v1/terminals \n  -H "Authorization: Bearer lh_test_…"
Response 200
{
  "object": "list",
  "data": [
    {
      "id": "trm_6b0c2d8e1f3a5b7c",
      "object": "terminal",
      "name": "string",
      "model": "string",
      "location_id": "string",
      "integration_id": "string",
      "external_terminal_id": "string",
      "paired": true,
      "online": true,
      "app_version": "string",
      "last_seen_at": "2026-10-25T08:30:00.000Z",
      "created_at": "string"
    }
  ],
  "has_more": true
}

Terminal anlegen

post/v1/terminals

Neues PAX IM30 für einen Standort. Antwort enthält den Wartungs-PIN (nur einmal sichtbar).

Parameters

NameInType
idempotency-keyoptionalWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden)Headerstring

Request

NameTypeDescription
nameoptionalstring
location_idrequiredstring
integration_idoptionalstring | null
external_terminal_idoptionalstring | null
maintenance_pinoptionalstring

Response 201Terminal

NameTypeDescription
idrequiredstringID mit Präfix «trm_»
objectrequired"terminal"
namerequiredstring
modelrequiredstring
location_idrequiredstring
integration_idrequiredstring | null
external_terminal_idrequiredstring | nullTerminal-ID bei Freika
pairedrequiredboolean
onlinerequiredboolean
app_versionrequiredstring | null
last_seen_atrequiredstring | nullZeitpunkt (ISO 8601, UTC)
created_atrequiredstring

Possible errors

  • 400 Anfrage ungültig
  • 401 Nicht angemeldet
  • 403 Berechtigung fehlt
  • 404 Nicht gefunden
  • 409 Zustand passt nicht
  • 429 Zu viele Anfragen
Example
curl -X POST https://api.ladehase.com/v1/terminals \n  -H "Authorization: Bearer lh_test_…" \n  -H "Content-Type: application/json" \n  -d '{"name":"PAX IM30","location_id":"string","integration_id":"string","external_terminal_id":"string","maintenance_pin":"string"}'
Response 201
{
  "id": "trm_6b0c2d8e1f3a5b7c",
  "object": "terminal",
  "name": "string",
  "model": "string",
  "location_id": "string",
  "integration_id": "string",
  "external_terminal_id": "string",
  "paired": true,
  "online": true,
  "app_version": "string",
  "last_seen_at": "2026-10-25T08:30:00.000Z",
  "created_at": "string"
}

Freika-Terminals

get/v1/terminals/available

Terminals im verbundenen Freika-Konto zur Auswahl beim Koppeln.

Response 200Object

Possible errors

  • 400 Anfrage ungültig
  • 401 Nicht angemeldet
  • 403 Berechtigung fehlt
  • 404 Nicht gefunden
  • 409 Zustand passt nicht
  • 429 Zu viele Anfragen
Example
curl -X GET https://api.ladehase.com/v1/terminals/available \n  -H "Authorization: Bearer lh_test_…"
Response 200
{}

Terminal ändern

patch/v1/terminals/{id}

Name, Standort, Freika-Terminal, Wartungs-PIN.

Parameters

NameInType
idrequiredPathstring

Request

NameTypeDescription
nameoptionalstring
location_idoptionalstring
integration_idoptionalstring | null
external_terminal_idoptionalstring | null
maintenance_pinoptionalstring

Response 200Terminal

NameTypeDescription
idrequiredstringID mit Präfix «trm_»
objectrequired"terminal"
namerequiredstring
modelrequiredstring
location_idrequiredstring
integration_idrequiredstring | null
external_terminal_idrequiredstring | nullTerminal-ID bei Freika
pairedrequiredboolean
onlinerequiredboolean
app_versionrequiredstring | null
last_seen_atrequiredstring | nullZeitpunkt (ISO 8601, UTC)
created_atrequiredstring

Possible errors

  • 400 Anfrage ungültig
  • 401 Nicht angemeldet
  • 403 Berechtigung fehlt
  • 404 Nicht gefunden
  • 409 Zustand passt nicht
  • 429 Zu viele Anfragen
Example
curl -X PATCH https://api.ladehase.com/v1/terminals/{id} \n  -H "Authorization: Bearer lh_test_…" \n  -H "Content-Type: application/json" \n  -d '{"name":"PAX IM30","location_id":"string","integration_id":"string","external_terminal_id":"string","maintenance_pin":"string"}'
Response 200
{
  "id": "trm_6b0c2d8e1f3a5b7c",
  "object": "terminal",
  "name": "string",
  "model": "string",
  "location_id": "string",
  "integration_id": "string",
  "external_terminal_id": "string",
  "paired": true,
  "online": true,
  "app_version": "string",
  "last_seen_at": "2026-10-25T08:30:00.000Z",
  "created_at": "string"
}

Terminal entfernen

delete/v1/terminals/{id}

Die App muss danach neu gekoppelt werden.

Parameters

NameInType
idrequiredPathstring

Response 200Deleted

NameTypeDescription
idrequiredstring
objectrequiredstring
deletedrequiredtrue

Possible errors

  • 400 Anfrage ungültig
  • 401 Nicht angemeldet
  • 403 Berechtigung fehlt
  • 404 Nicht gefunden
  • 409 Zustand passt nicht
  • 429 Zu viele Anfragen
Example
curl -X DELETE https://api.ladehase.com/v1/terminals/{id} \n  -H "Authorization: Bearer lh_test_…"
Response 200
{
  "id": "string",
  "object": "string",
  "deleted": true
}

Kopplungscode

post/v1/terminals/{id}/pairing_codes

Code und QR-Inhalt zum Koppeln der Terminal-App (15 Minuten gültig).

Parameters

NameInType
idrequiredPathstring
idempotency-keyoptionalWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden)Headerstring

Response 201Object

Possible errors

  • 400 Anfrage ungültig
  • 401 Nicht angemeldet
  • 403 Berechtigung fehlt
  • 404 Nicht gefunden
  • 409 Zustand passt nicht
  • 429 Zu viele Anfragen
Example
curl -X POST https://api.ladehase.com/v1/terminals/{id}/pairing_codes \n  -H "Authorization: Bearer lh_test_…"
Response 201
{}