Sitzungen

6 Endpunkte

Sitzungen auflisten

get/v1/sessions

Ladungen, neueste zuerst. Filter: state (kommagetrennt), device_id, location_id, access_grant_id, from, to.

Parameter

Name	Ort	Typ
`limit`optional	Abfrage	integer
`starting_after`optional	Abfrage	string
`state`optional	Abfrage	string
`device_id`optional	Abfrage	string
`location_id`optional	Abfrage	string
`access_grant_id`optional	Abfrage	string
`from`optional	Abfrage	string (date-time)
`to`optional	Abfrage	string (date-time)

Antwort 200SessionList

Name	Typ	Beschreibung
`object`Pflicht	"list"
`data`Pflicht	Session[]
`has_more`Pflicht	boolean

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/sessions \n  -H "Authorization: Bearer lh_test_…"

Antwort 200

{
  "object": "list",
  "data": [
    {
      "id": "ses_1a2b3c4d5e6f7a8b9c0d",
      "object": "session",
      "livemode": true,
      "state": "string",
      "mode": "reservation",
      "channel": "qr",
      "location_id": "string",
      "device_id": "string",
      "connector_id": "string",
      "currency": "string",
      "authorized_amount": 1235,
      "amount": 1235,
      "captured_amount": 1235,
      "refunded_amount": 1235,
      "vat_amount": 1235,
      "energy_wh": 0,
      "idle_minutes": 0,
      "stop_reason": "string",
      "receipt_number": "string",
      "started_at": "2026-10-25T08:30:00.000Z",
      "ended_at": "2026-10-25T08:30:00.000Z",
      "settled_at": "2026-10-25T08:30:00.000Z",
      "created_at": "string"
    }
  ],
  "has_more": true
}

Sitzung starten

post/v1/sessions

Startet eine Ladung ohne Zahlung über die API (z. B. für eigene Apps oder Weiterverrechnung). Mit `access_grant_id` gilt der Sondertarif des Zugangs.

Parameter

Name	Ort	Typ
`idempotency-key`optionalWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden)	Kopfzeile	string

Anfrage

Name	Typ	Beschreibung
`device_id`Pflicht	string
`access_grant_id`optional	string
`metadata`optional	object

Antwort 201Session

Name	Typ	Beschreibung
`id`Pflicht	string	ID mit Präfix «ses_»
`object`Pflicht	"session"
`livemode`Pflicht	boolean
`state`Pflicht	string	Zustand gemäss Zustandsautomat (created … settled)
`mode`Pflicht	"reservation" \| "prepaid" \| "access"
`channel`Pflicht	"qr" \| "terminal" \| "api" \| "rfid" \| "access_link"
`location_id`Pflicht	string
`device_id`Pflicht	string
`connector_id`Pflicht	string
`currency`Pflicht	string
`authorized_amount`Pflicht	integer	Reservierter beziehungsweise bezahlter Betrag in Rappen
`amount`Pflicht	integer	Hochgerechneter Betrag (laufend) oder Endbetrag in Rappen
`captured_amount`Pflicht	integer	Belasteter Betrag in Rappen
`refunded_amount`Pflicht	integer	Zurückerstatteter Betrag in Rappen
`vat_amount`Pflicht	integer	MWST-Anteil in Rappen
`energy_wh`Pflicht	integer	Geladene Energie in Wh
`idle_minutes`Pflicht	integer
`stop_reason`Pflicht	string \| null
`receipt_number`Pflicht	string \| null
`started_at`Pflicht	string \| null	Zeitpunkt (ISO 8601, UTC)
`ended_at`Pflicht	string \| null	Zeitpunkt (ISO 8601, UTC)
`settled_at`Pflicht	string \| null	Zeitpunkt (ISO 8601, UTC)
`created_at`Pflicht	string

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/sessions \n  -H "Authorization: Bearer lh_test_…" \n  -H "Content-Type: application/json" \n  -d '{"device_id":"string","access_grant_id":"string","metadata":{}}'

Antwort 201

{
  "id": "ses_1a2b3c4d5e6f7a8b9c0d",
  "object": "session",
  "livemode": true,
  "state": "string",
  "mode": "reservation",
  "channel": "qr",
  "location_id": "string",
  "device_id": "string",
  "connector_id": "string",
  "currency": "string",
  "authorized_amount": 1235,
  "amount": 1235,
  "captured_amount": 1235,
  "refunded_amount": 1235,
  "vat_amount": 1235,
  "energy_wh": 0,
  "idle_minutes": 0,
  "stop_reason": "string",
  "receipt_number": "string",
  "started_at": "2026-10-25T08:30:00.000Z",
  "ended_at": "2026-10-25T08:30:00.000Z",
  "settled_at": "2026-10-25T08:30:00.000Z",
  "created_at": "string"
}

Sitzung abrufen

get/v1/sessions/{id}

Eine Ladung mit Beträgen, Energie und Preisaufstellung.

Parameter

Name	Ort	Typ
`id`Pflicht	Pfad	string

Antwort 200Session

Name	Typ	Beschreibung
`id`Pflicht	string	ID mit Präfix «ses_»
`object`Pflicht	"session"
`livemode`Pflicht	boolean
`state`Pflicht	string	Zustand gemäss Zustandsautomat (created … settled)
`mode`Pflicht	"reservation" \| "prepaid" \| "access"
`channel`Pflicht	"qr" \| "terminal" \| "api" \| "rfid" \| "access_link"
`location_id`Pflicht	string
`device_id`Pflicht	string
`connector_id`Pflicht	string
`currency`Pflicht	string
`authorized_amount`Pflicht	integer	Reservierter beziehungsweise bezahlter Betrag in Rappen
`amount`Pflicht	integer	Hochgerechneter Betrag (laufend) oder Endbetrag in Rappen
`captured_amount`Pflicht	integer	Belasteter Betrag in Rappen
`refunded_amount`Pflicht	integer	Zurückerstatteter Betrag in Rappen
`vat_amount`Pflicht	integer	MWST-Anteil in Rappen
`energy_wh`Pflicht	integer	Geladene Energie in Wh
`idle_minutes`Pflicht	integer
`stop_reason`Pflicht	string \| null
`receipt_number`Pflicht	string \| null
`started_at`Pflicht	string \| null	Zeitpunkt (ISO 8601, UTC)
`ended_at`Pflicht	string \| null	Zeitpunkt (ISO 8601, UTC)
`settled_at`Pflicht	string \| null	Zeitpunkt (ISO 8601, UTC)
`created_at`Pflicht	string

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/sessions/{id} \n  -H "Authorization: Bearer lh_test_…"

Antwort 200

{
  "id": "ses_1a2b3c4d5e6f7a8b9c0d",
  "object": "session",
  "livemode": true,
  "state": "string",
  "mode": "reservation",
  "channel": "qr",
  "location_id": "string",
  "device_id": "string",
  "connector_id": "string",
  "currency": "string",
  "authorized_amount": 1235,
  "amount": 1235,
  "captured_amount": 1235,
  "refunded_amount": 1235,
  "vat_amount": 1235,
  "energy_wh": 0,
  "idle_minutes": 0,
  "stop_reason": "string",
  "receipt_number": "string",
  "started_at": "2026-10-25T08:30:00.000Z",
  "ended_at": "2026-10-25T08:30:00.000Z",
  "settled_at": "2026-10-25T08:30:00.000Z",
  "created_at": "string"
}

Sitzung stoppen

post/v1/sessions/{id}/stop

Stoppt die Ladung. Abgerechnet wird automatisch.

Parameter

Name	Ort	Typ
`id`Pflicht	Pfad	string
`idempotency-key`optionalWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden)	Kopfzeile	string

Antwort 200Session

Name	Typ	Beschreibung
`id`Pflicht	string	ID mit Präfix «ses_»
`object`Pflicht	"session"
`livemode`Pflicht	boolean
`state`Pflicht	string	Zustand gemäss Zustandsautomat (created … settled)
`mode`Pflicht	"reservation" \| "prepaid" \| "access"
`channel`Pflicht	"qr" \| "terminal" \| "api" \| "rfid" \| "access_link"
`location_id`Pflicht	string
`device_id`Pflicht	string
`connector_id`Pflicht	string
`currency`Pflicht	string
`authorized_amount`Pflicht	integer	Reservierter beziehungsweise bezahlter Betrag in Rappen
`amount`Pflicht	integer	Hochgerechneter Betrag (laufend) oder Endbetrag in Rappen
`captured_amount`Pflicht	integer	Belasteter Betrag in Rappen
`refunded_amount`Pflicht	integer	Zurückerstatteter Betrag in Rappen
`vat_amount`Pflicht	integer	MWST-Anteil in Rappen
`energy_wh`Pflicht	integer	Geladene Energie in Wh
`idle_minutes`Pflicht	integer
`stop_reason`Pflicht	string \| null
`receipt_number`Pflicht	string \| null
`started_at`Pflicht	string \| null	Zeitpunkt (ISO 8601, UTC)
`ended_at`Pflicht	string \| null	Zeitpunkt (ISO 8601, UTC)
`settled_at`Pflicht	string \| null	Zeitpunkt (ISO 8601, UTC)
`created_at`Pflicht	string

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/sessions/{id}/stop \n  -H "Authorization: Bearer lh_test_…"

Antwort 200

{
  "id": "ses_1a2b3c4d5e6f7a8b9c0d",
  "object": "session",
  "livemode": true,
  "state": "string",
  "mode": "reservation",
  "channel": "qr",
  "location_id": "string",
  "device_id": "string",
  "connector_id": "string",
  "currency": "string",
  "authorized_amount": 1235,
  "amount": 1235,
  "captured_amount": 1235,
  "refunded_amount": 1235,
  "vat_amount": 1235,
  "energy_wh": 0,
  "idle_minutes": 0,
  "stop_reason": "string",
  "receipt_number": "string",
  "started_at": "2026-10-25T08:30:00.000Z",
  "ended_at": "2026-10-25T08:30:00.000Z",
  "settled_at": "2026-10-25T08:30:00.000Z",
  "created_at": "string"
}

Zeitleiste einer Sitzung

get/v1/sessions/{id}/events

Alle Zustandswechsel und Messwerte (Ladekurve).

Parameter

Name	Ort	Typ
`id`Pflicht	Pfad	string

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/sessions/{id}/events \n  -H "Authorization: Bearer lh_test_…"

Antwort 200

{}

Rückerstatten

post/v1/sessions/{id}/refund

Voll oder teilweise (`amount` in Rappen).

Parameter

Name	Ort	Typ
`id`Pflicht	Pfad	string
`idempotency-key`optionalWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden)	Kopfzeile	string

Anfrage

Name	Typ	Beschreibung
`amount`optional	integer
`reason`optional	string

Antwort 200Session

Name	Typ	Beschreibung
`id`Pflicht	string	ID mit Präfix «ses_»
`object`Pflicht	"session"
`livemode`Pflicht	boolean
`state`Pflicht	string	Zustand gemäss Zustandsautomat (created … settled)
`mode`Pflicht	"reservation" \| "prepaid" \| "access"
`channel`Pflicht	"qr" \| "terminal" \| "api" \| "rfid" \| "access_link"
`location_id`Pflicht	string
`device_id`Pflicht	string
`connector_id`Pflicht	string
`currency`Pflicht	string
`authorized_amount`Pflicht	integer	Reservierter beziehungsweise bezahlter Betrag in Rappen
`amount`Pflicht	integer	Hochgerechneter Betrag (laufend) oder Endbetrag in Rappen
`captured_amount`Pflicht	integer	Belasteter Betrag in Rappen
`refunded_amount`Pflicht	integer	Zurückerstatteter Betrag in Rappen
`vat_amount`Pflicht	integer	MWST-Anteil in Rappen
`energy_wh`Pflicht	integer	Geladene Energie in Wh
`idle_minutes`Pflicht	integer
`stop_reason`Pflicht	string \| null
`receipt_number`Pflicht	string \| null
`started_at`Pflicht	string \| null	Zeitpunkt (ISO 8601, UTC)
`ended_at`Pflicht	string \| null	Zeitpunkt (ISO 8601, UTC)
`settled_at`Pflicht	string \| null	Zeitpunkt (ISO 8601, UTC)
`created_at`Pflicht	string

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/sessions/{id}/refund \n  -H "Authorization: Bearer lh_test_…" \n  -H "Content-Type: application/json" \n  -d '{"amount":0,"reason":"string"}'

Antwort 200

{
  "id": "ses_1a2b3c4d5e6f7a8b9c0d",
  "object": "session",
  "livemode": true,
  "state": "string",
  "mode": "reservation",
  "channel": "qr",
  "location_id": "string",
  "device_id": "string",
  "connector_id": "string",
  "currency": "string",
  "authorized_amount": 1235,
  "amount": 1235,
  "captured_amount": 1235,
  "refunded_amount": 1235,
  "vat_amount": 1235,
  "energy_wh": 0,
  "idle_minutes": 0,
  "stop_reason": "string",
  "receipt_number": "string",
  "started_at": "2026-10-25T08:30:00.000Z",
  "ended_at": "2026-10-25T08:30:00.000Z",
  "settled_at": "2026-10-25T08:30:00.000Z",
  "created_at": "string"
}