Zum Inhalt springen
API-Referenz

Terminals

6 Endpunkte

Terminals auflisten

get/v1/terminals

Gekoppelte PAX IM30.

Antwort 200TerminalList

NameTypBeschreibung
objectPflicht"list"
dataPflichtTerminal[]
has_morePflichtboolean

Mögliche Fehler

  • 400 Anfrage ungültig
  • 401 Nicht angemeldet
  • 403 Berechtigung fehlt
  • 404 Nicht gefunden
  • 409 Zustand passt nicht
  • 429 Zu viele Anfragen
Beispiel
curl -X GET https://api.ladehase.com/v1/terminals \n  -H "Authorization: Bearer lh_test_…"
Antwort 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).

Parameter

NameOrtTyp
idempotency-keyoptionalWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden)Kopfzeilestring

Anfrage

NameTypBeschreibung
nameoptionalstring
location_idPflichtstring
integration_idoptionalstring | null
external_terminal_idoptionalstring | null
maintenance_pinoptionalstring

Antwort 201Terminal

NameTypBeschreibung
idPflichtstringID mit Präfix «trm_»
objectPflicht"terminal"
namePflichtstring
modelPflichtstring
location_idPflichtstring
integration_idPflichtstring | null
external_terminal_idPflichtstring | nullTerminal-ID bei Freika
pairedPflichtboolean
onlinePflichtboolean
app_versionPflichtstring | null
last_seen_atPflichtstring | nullZeitpunkt (ISO 8601, UTC)
created_atPflichtstring

Mögliche Fehler

  • 400 Anfrage ungültig
  • 401 Nicht angemeldet
  • 403 Berechtigung fehlt
  • 404 Nicht gefunden
  • 409 Zustand passt nicht
  • 429 Zu viele Anfragen
Beispiel
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"}'
Antwort 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.

Antwort 200Object

Mögliche Fehler

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

Terminal ändern

patch/v1/terminals/{id}

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

Parameter

NameOrtTyp
idPflichtPfadstring

Anfrage

NameTypBeschreibung
nameoptionalstring
location_idoptionalstring
integration_idoptionalstring | null
external_terminal_idoptionalstring | null
maintenance_pinoptionalstring

Antwort 200Terminal

NameTypBeschreibung
idPflichtstringID mit Präfix «trm_»
objectPflicht"terminal"
namePflichtstring
modelPflichtstring
location_idPflichtstring
integration_idPflichtstring | null
external_terminal_idPflichtstring | nullTerminal-ID bei Freika
pairedPflichtboolean
onlinePflichtboolean
app_versionPflichtstring | null
last_seen_atPflichtstring | nullZeitpunkt (ISO 8601, UTC)
created_atPflichtstring

Mögliche Fehler

  • 400 Anfrage ungültig
  • 401 Nicht angemeldet
  • 403 Berechtigung fehlt
  • 404 Nicht gefunden
  • 409 Zustand passt nicht
  • 429 Zu viele Anfragen
Beispiel
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"}'
Antwort 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.

Parameter

NameOrtTyp
idPflichtPfadstring

Antwort 200Deleted

NameTypBeschreibung
idPflichtstring
objectPflichtstring
deletedPflichttrue

Mögliche Fehler

  • 400 Anfrage ungültig
  • 401 Nicht angemeldet
  • 403 Berechtigung fehlt
  • 404 Nicht gefunden
  • 409 Zustand passt nicht
  • 429 Zu viele Anfragen
Beispiel
curl -X DELETE https://api.ladehase.com/v1/terminals/{id} \n  -H "Authorization: Bearer lh_test_…"
Antwort 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).

Parameter

NameOrtTyp
idPflichtPfadstring
idempotency-keyoptionalWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden)Kopfzeilestring

Antwort 201Object

Mögliche Fehler

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