Skip to navigation
ProxyTokens

Get an authorization token

Returns one token by its gateway id. Soft-deleted tokens are included only with include_deleted=true. 404 if it does not exist for this organization.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

token_idintegerRequired>=1

Query parameters

include_deletedbooleanOptionalDefaults to false

Include soft-deleted tokens.

Response

Successful Response
idinteger
Token id on the gateway.
id_tokenstring
RFID UID or idTag the charger sends.
statusstring

Authorization status, e.g. Accepted or Blocked.

id_token_typestring or nullOptional

OCPP 2.x IdTokenType, e.g. ISO14443.

cache_expiry_date_timedatetime or nullOptional
When chargers must stop trusting a cached authorization.
parent_id_tagstring or nullOptional

OCPP parentIdTag: the token group the token belongs to.

prepaid_balancestring or nullOptional
Remaining prepaid balance, as a decimal string.
real_time_authbooleanOptionalDefaults to false
True when every use must be authorized online.
provider_idinteger or nullOptional
Issuing provider id on the gateway.
descriptionstring or nullOptional

Free-text notes.

deleted_atdatetime or nullOptional

When the token was soft-deleted.

card_numberstring or nullOptional
Number printed on the card.
card_stateenumOptionalDefaults to Active

Card issuance state; Unused cards are refused by Authorize.

Allowed values:
valid_untildatetime or nullOptional

Card validity; past it Authorize answers Expired.

allow_simultaneous_chargingbooleanOptionalDefaults to true
Whether this card may authorize another charge while it has an active transaction.
status_reasonstring or nullOptional
Why the status last changed, e.g. a block reason.
status_changed_atdatetime or nullOptional
When the status last changed.
revisionintegerOptionalDefaults to 1

Increases on every change; pass as expected_revision to guard writes.

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
502
Bad Gateway Error
504
Gateway Timeout Error