HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Charge Point / Start Charging Session

Start a charging session

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
integer
required

The EVSE network ID — the slot index used in OCPP messages, shown as Network ID in the admin UI. Note that this differs from other EVSE-scoped endpoints, which expect the unique EVSE database ID.

Body Params

Start session request body

integer
string | null

The ID of the payment method, as returned by the payment method listing (User / Payment Method / Listing) or the contextual payment options lookup (User / payment options). When it is not empty or null, userId is required.

Choosing balance explicitly requires paymentMethodId: "balance". Omitting this field, or sending an empty or null value, does not explicitly select balance. The system attempts automatic selection in this order: the charge point's corporate account, an applicable subscription, the user's default personal payment method, then the user's default corporate account. Balance is the fallback only when none of these applies.

For OCPI or Hubject roaming EVSEs, an omitted, empty or null payment method is rejected; provide an explicit paymentMethodId.

string | null
deprecated

Deprecated: This field will be removed in version 2.0. Use idTag parameter instead.

Migration: Replace all occurrences of externalSessionId with idTag in your start session requests.
The idTag parameter serves the same purpose and stores the value in the session's idTag field.

Backward compatibility: When both externalSessionId and idTag are provided, idTag takes precedence.

string

Optional identifier tag for the charging session (e.g., RFID UID, authorization token).
This value will be stored in the session's idTag field and can be used for filtering sessions.
For operator-initiated sessions, the system also looks for a matching RFID card within the resolved operator's card list and links it to the session when found.
If no matching card is found, the session remains unlinked and the submitted value remains available in the Business Data session export.

integer | null
integer | null

The ID of the booking to link the session to. Returns a 422 error if the booking does not exist or if its status is not Accepted or Reserved.

stopConditions
object | null

Optional session stop conditions. When set, the session will automatically stop when any of the specified limits is reached.

chargingProfile
object

the smart charging profile to apply. See the OCPP documentation for further explanation on the fields

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json