HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

User / payment options

Get the payment options available to a user for starting a session at the specified EVSE. Options are returned in display order, with at most one option marked as preselected. An empty array means no payment options are available for this context.

The offer is limited to tokenized payment methods, corporate accounts, subscriptions and balance. Preselection is calculated within this supported subset; it may differ from a client that offers additional payment categories.

This read-only lookup does not create or change business state, reserve or authorize a session, or guarantee that a session can start. Preselection is a recommendation, not a payment selection for a subsequent start request. Pass the chosen paymentMethodId explicitly to a start action; choosing balance requires paymentMethodId: "balance".

Both query parameters are required: context must be session_start, and evseId must be an integer database ID greater than or equal to 1. The user route parameter must be an integer database ID. Missing, unsupported or malformed query values and malformed user identifiers return 422 before resource lookup. The route value takes precedence over any user query parameter. The caller must have permission to list payment methods (403 otherwise), and both the user and EVSE must be visible to the authenticated token-owner or impersonated admin. Unknown or inaccessible integer IDs return 404. This lookup does not require permission to start sessions.

⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.1 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed.

This notice applies only to GET users/v1.1/{user}/payment-options; other users v1.1 operations remain version-locked.

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

The context in which the payment options will be used.

Allowed:
integer
required
≥ 1

The ID of the EVSE at which the user intends to start a session.

Responses

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