Charging cards

charging-cards-detailsREAD-ONLY

Full status of a single charging card for an authorized caller, by identifier (visual number): card and token status, holder, credit limit and current-month usage, billing plan, active session, and the card's most recent authorization attempts. Callers with account-level card read access may read any card on their account; other callers only their own. Requires an authorization token. The `identifier` is round-tripped from charging-cards-summary / -overview.

Customer
Verified customer
Conversation token
Required
Permissions
-
Schema
Input1
identifierstringREQUIRED
Output12
identifierstring | nullREQUIRED
visualNumberstring | nullREQUIRED
statusenumREQUIRED
typestring | nullREQUIRED
nameOnCardstring | nullREQUIRED
assignedToUserbooleanREQUIRED
userobject | nullREQUIRED
namestring | nullREQUIRED
tokenobjectREQUIRED
assignedbooleanREQUIRED
statusenum | nullREQUIRED
roamingModestring | nullREQUIRED
activeSessionbooleanREQUIRED
usagenumberREQUIRED
billingPlanobject | nullREQUIRED
idstringREQUIRED
namestring | nullREQUIRED
recentActivityobjectREQUIRED
attemptsobject[]REQUIRED
atstring | nullREQUIRED
resultenum | nullREQUIRED
detailstringREQUIRED
charging-cards-overviewREAD-ONLY

Public status of a charging card by its identifier (visual number): whether it is assigned to a user, its status, token status, roaming mode and whether a session is active. No account, holder or financial data and no authentication required — a first-line card check. For limits, usage and recent activity use charging-cards-details with an authorization token. The `identifier` is round-tripped from charging-cards-summary / -details.

Customer
No verification needed
Conversation token
Optional
Permissions
-
Schema
Input1
identifierstringREQUIRED
Output7
identifierstring | nullREQUIRED
visualNumberstring | nullREQUIRED
statusenumREQUIRED
typestring | nullREQUIRED
assignedToUserbooleanREQUIRED
tokenobjectREQUIRED
assignedbooleanREQUIRED
statusenum | nullREQUIRED
roamingModestring | nullREQUIRED
activeSessionbooleanREQUIRED
charging-cards-sessionsREAD-ONLY

Lists charging sessions the account's users ran at charging networks (the customer view): which user and card, the operator/network and location, energy, duration and cost. Returns live (in-progress) and recent (completed) sessions. Callers with account-level card session read access see all the account's sessions; other callers see only their own. For sessions that took place on the account's own charge points, use charge-points-sessions.

Customer
Verified customer
Conversation token
Required
Permissions
-
Schema
Input
No parameters.
Output3
accountIdstring | nullREQUIRED
liveobject[]REQUIRED
statusstringREQUIRED
userobject | nullREQUIRED
namestring | nullREQUIRED
cardobject | nullREQUIRED
visualstring | nullREQUIRED
operatorobject | nullREQUIRED
namestring | nullREQUIRED
startedAtstring | nullREQUIRED
endedAtstring | nullREQUIRED
kwhnumber | nullREQUIRED
durationSecondsnumber | nullREQUIRED
costobjectREQUIRED
amountnumber | nullREQUIRED
currencystring | nullREQUIRED
locationobject | nullREQUIRED
addressstring | nullREQUIRED
citystring | nullREQUIRED
countrystring | nullREQUIRED
recentobject[]REQUIRED
statusstringREQUIRED
userobject | nullREQUIRED
namestring | nullREQUIRED
cardobject | nullREQUIRED
visualstring | nullREQUIRED
operatorobject | nullREQUIRED
namestring | nullREQUIRED
startedAtstring | nullREQUIRED
endedAtstring | nullREQUIRED
kwhnumber | nullREQUIRED
durationSecondsnumber | nullREQUIRED
costobjectREQUIRED
amountnumber | nullREQUIRED
currencystring | nullREQUIRED
locationobject | nullREQUIRED
addressstring | nullREQUIRED
citystring | nullREQUIRED
countrystring | nullREQUIRED
charging-cards-summaryREAD-ONLY

Returns a charging-cards summary: card counts (total, active, blocked), current-month credit usage/limit and MSP session totals (energy, duration), plus a per-card list with token state (active, blocked, credit-limit-exceeded, roaming mode), card holder, current-month usage and billing plan. Callers with account-level card read access see every charging card on the account; other callers see only their own.

Customer
Verified customer
Conversation token
Required
Permissions
-
Schema
Input
No parameters.
Output3
accountIdstring | nullREQUIRED
statsobject | nullREQUIRED
chargingCardsobjectREQUIRED
totalnumberREQUIRED
activenumberREQUIRED
blockednumberREQUIRED
limitsobjectREQUIRED
currentMonthobjectREQUIRED
usagenumberREQUIRED
limitnumber | nullREQUIRED
currencystring | nullREQUIRED
sessionsobjectREQUIRED
currentMonthobjectREQUIRED
countnumberREQUIRED
kwhnumberREQUIRED
durationSecondsnumberREQUIRED
chargingCardsobject[]REQUIRED
identifierstring | nullREQUIRED
visualNumberstring | nullREQUIRED
statusenumREQUIRED
typestring | nullREQUIRED
nameOnCardstring | nullREQUIRED
assignedToUserbooleanREQUIRED
userobject | nullREQUIRED
namestring | nullREQUIRED
tokenobjectREQUIRED
assignedbooleanREQUIRED
statusenum | nullREQUIRED
roamingModestring | nullREQUIRED
activeSessionbooleanREQUIRED
usagenumberREQUIRED
billingPlanobject | nullREQUIRED
idstringREQUIRED
namestring | nullREQUIRED