Skip to content

Concepts

Sessions and states

How a charging session runs from scan to settlement, which states exist and when a session ends.

A session (ses_…) is one charge from payment or authorisation to settlement. It belongs to exactly one charge point and freezes the current tariff version at the start. Later tariff changes do not affect running sessions.

Flow

  1. The driver scans the QR code or selects the charge point on the terminal. Ladehase creates a session (created).
  2. They reserve an amount or buy a package (awaiting_payment).
  3. Once the payment is authorised (authorized), Ladehase releases the charge point and waits for the car (waiting_for_vehicle).
  4. The car charges (charging). Ladehase measures the energy and projects the amount.
  5. The cable is unplugged or charging is stopped (completed).
  6. Ladehase captures the final amount, releases the rest of the reservation and issues the receipt (settled).

States

StateMeaning
createdSession created, no payment yet.
awaiting_paymentPayment in progress at the payment partner.
authorizedPaid or released through an access grant.
waiting_for_vehicleCharge point released, car not plugged in or not charging yet.
chargingThe car is charging.
suspendedCharging paused, for example by the car or load management.
idleCar full, cable still plugged in. An idle fee may apply here.
stoppingStop requested, Ladehase waits for the charging station to confirm.
completedCharging finished, settlement follows.
settledSettled. Final state.
payment_failedPayment failed. Final state.
expiredNo car plugged in within the time limit, reservation released. Final state.
canceledCancelled, reservation released. Final state.
errorFault. Either resolved (on to completed) or cancelled (canceled).

There is at most one active session per connector. A second request for the same connector returns 409 with the code conflict.

Stop reasons

The stop_reason field tells you why charging ended:

  • unplugged: cable unplugged
  • amount_reached: reservation reached (minus safety margin)
  • package_reached: package used up
  • driver: ended by the driver
  • operator: ended by the operator
  • api: ended through the API
  • max_duration: maximum duration reached
  • device_error: fault at the charging station

Billing modes

The mode field shows how the session is billed:

  • reservation: reserve an amount, capture by consumption, release the rest.
  • prepaid: package paid in advance. Unused credit is refunded or forfeited depending on the setting.
  • access: charging through an access grant, free or at a special tariff.

Session amounts

FieldMeaning
authorized_amountReserved or prepaid amount in Rappen.
amountProjected running amount or final amount in Rappen.
captured_amountAmount actually captured in Rappen.
refunded_amountRefunded amount in Rappen.
vat_amountIncluded VAT in Rappen.
energy_whEnergy charged in watt hours.

GET /v1/sessions/{id}/events returns the session timeline with all events.

Found a mistake? Write to developer@ladehase.com.