Charging cards
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.
Verified customerRequiredInput1
Card identifier (the visual number printed on the card).
Output12
Canonical card identifier (= visual number). Round-trip unchanged as input to card tools.
Human-readable number printed on the card.
Card status. pending-payment/pending/pending-activation/sent: still provisioning. active: usable. disabled: switched off. cancelled: terminated. limit-exceeded: active but the credit limit has been reached.
card, tag or virtual.
Whether the card is assigned to a user.
userobject | nullREQUIREDCard holder, when assigned.
Card holder, when assigned.
tokenobjectREQUIRED
Whether the card has a token.
Null when no token is assigned.
A charging session is currently active on the card.
The card's current-month credit usage, in the account billing currency. Credit limits are account-level only, so there is no per-card limit.
billingPlanobject | nullREQUIRED
recentActivityobjectREQUIRED
attemptsobject[]REQUIRED
ISO timestamp of the attempt.
Null when the platform recorded no outcome.
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.
No verification neededOptionalInput1
Card identifier (the visual number printed on the card).
Output7
Canonical card identifier (= visual number). Round-trip unchanged as input to card tools.
Human-readable number printed on the card.
Card status. pending-payment/pending/pending-activation/sent: still provisioning. active: usable. disabled: switched off. cancelled: terminated. limit-exceeded: active but the credit limit has been reached.
card, tag or virtual.
Whether the card is assigned to a user.
tokenobjectREQUIRED
Whether the card has a token.
Null when no token is assigned.
A charging session is currently active on the card.
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.
Verified customerRequiredInput
Output3
liveobject[]REQUIRED
userobject | nullREQUIRED
cardobject | nullREQUIRED
operatorobject | nullREQUIREDNetwork/operator the session ran on — often external (roaming-out).
Network/operator the session ran on — often external (roaming-out).
costobjectREQUIRED
locationobject | nullREQUIRED
recentobject[]REQUIRED
userobject | nullREQUIRED
cardobject | nullREQUIRED
operatorobject | nullREQUIREDNetwork/operator the session ran on — often external (roaming-out).
Network/operator the session ran on — often external (roaming-out).
costobjectREQUIRED
locationobject | nullREQUIRED
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.
Verified customerRequiredInput
Output3
statsobject | nullREQUIRED
chargingCardsobjectREQUIRED
Charging cards with status "active".
Charging cards whose token is blocked.
limitsobjectREQUIRED
currentMonthobjectREQUIRED
sessionsobjectREQUIRED
currentMonthobjectREQUIRED
chargingCardsobject[]REQUIRED
Canonical card identifier (= visual number). Round-trip unchanged as input to card tools.
Human-readable number printed on the card.
Card status. pending-payment/pending/pending-activation/sent: still provisioning. active: usable. disabled: switched off. cancelled: terminated. limit-exceeded: active but the credit limit has been reached.
card, tag or virtual.
Whether the card is assigned to a user.
userobject | nullREQUIREDCard holder, when assigned.
Card holder, when assigned.
tokenobjectREQUIRED
Whether the card has a token.
Null when no token is assigned.
A charging session is currently active on the card.
The card's current-month credit usage, in the account billing currency. Credit limits are account-level only, so there is no per-card limit.