EVSE / Start Ad Hoc Session

post

https://{tenantUrl}/public-api/actions/evse/v1.0/{evse}/start-ad-hoc-session

⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta.

Start a charging session for an ad hoc driver.

Show the returned checkout to the driver. The session is created right away and starts once the
payment is confirmed.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

evse

integer

required

The unique EVSE ID — the integer shown as ID in the admin UI. Not the ID (QR code), network ID,
or EMI3 EVSE ID.

Body Params

How to display the payment processor's checkout. The platform takes the payment processor from
the ad hoc portal integration and the amount from the EVSE's tariff. The checkout page and the
invoice use the language of the request's Accept-Language header.

returnUrl

string

URL the payment processor returns the driver to after its hosted checkout. Required when the
integration's payment processor is Worldline or Adyen.

paymentMethod

string

enum

Defaults to card

The checkout to open for the driver.

card: the standard checkout, with cards, Apple Pay, Google Pay and the other payment methods
the merchant enabled, except those that need their own pay button.
twint, bancontact: a checkout with only that payment method, for a portal that gives it
its own pay button. Not every payment processor can offer a single payment method; the
action then answers 409.

Allowed:

invoiceDetails

object

Send it when the driver asks for an invoice; it is issued at the end of the session.

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

202The session is created and the checkout is ready to show the driver.

401Access token is missing or invalid

403You do not have permission to perform the action. When the organisation of the admin behind the token has view-only access, every write is refused with the message "Your access is view-only."

404The record is not found

409The request could not be completed due to a conflict with the current state of the resource. The operation may succeed if retried.

422The payload you provided is invalid