# Charge Express

> Build on the ChargeExpress Fleet API: manage drivers, vehicles, limits, charging and your fleet wallet, and receive signed webhooks.

- [ChargeExpress Fleet API](https://docs.chargeexpressltd.com/index.md): Connect your fleet's own systems to ChargeExpress: drivers, vehicles, limits, charging, wallet and billing, with signed webhooks.
- [Quickstart](https://docs.chargeexpressltd.com/quickstart.md): Create an API key, make your first request, register a webhook endpoint and verify its signature.
- [Sandbox](https://docs.chargeexpressltd.com/guides/sandbox.md): Build and test against a private copy of your fleet with simulated chargers and payments, using a cxk_test_ key.
- [Authentication](https://docs.chargeexpressltd.com/authentication.md): Bearer API keys, sandbox and live environments, scopes, and how to keep keys safe.
- [Errors](https://docs.chargeexpressltd.com/errors.md): The error object, error types, and the codes you can branch on.
- [Pagination](https://docs.chargeexpressltd.com/pagination.md): List endpoints return pages with an opaque cursor.
- [Idempotency](https://docs.chargeexpressltd.com/idempotency.md): Retry POST requests safely with an Idempotency-Key header.
- [Rate limits](https://docs.chargeexpressltd.com/rate-limits.md): Per-key token buckets, the headers that report them, and how to back off.
- [Charging flow](https://docs.chargeexpressltd.com/guides/charging-flow.md): Find charge points, follow your drivers' sessions with webhooks, and read the final energy and cost.
- [Funding flow](https://docs.chargeexpressltd.com/guides/funding-flow.md): Quote a top-up, create a funding, send a person to the checkout, react to wallet.funded, and pay usage invoices.
- [Changelog](https://docs.chargeexpressltd.com/changelog.md): Changes to the ChargeExpress Fleet API.
- [API reference](https://docs.chargeexpressltd.com/api-reference/introduction.md): Every Fleet API endpoint, generated from the OpenAPI document.
- [Retrieve the fleet](https://docs.chargeexpressltd.com/api-reference/fleet/retrieve-the-fleet.md): Requires the `fleet:read` scope.
- [Set the low-balance alert](https://docs.chargeexpressltd.com/api-reference/fleet/set-the-low-balance-alert.md): Requires the `wallet:write` scope.
- [List drivers](https://docs.chargeexpressltd.com/api-reference/drivers/list-drivers.md): Requires the `fleet:read` scope.
- [Add a driver](https://docs.chargeexpressltd.com/api-reference/drivers/add-a-driver.md): Creates (or finds) the driver’s app account by email, joins them to the fleet and emails them a link to set a password.
- [Retrieve a driver](https://docs.chargeexpressltd.com/api-reference/drivers/retrieve-a-driver.md): Requires the `fleet:read` scope.
- [Update a driver](https://docs.chargeexpressltd.com/api-reference/drivers/update-a-driver.md): Suspend or reactivate a driver, or change their employee id and licence.
- [Remove a driver](https://docs.chargeexpressltd.com/api-reference/drivers/remove-a-driver.md): Removes the driver from the fleet and unassigns their vehicles. Their history is kept.
- [Upload a driver photo](https://docs.chargeexpressltd.com/api-reference/drivers/upload-a-driver-photo.md): Requires the `drivers:write` scope.
- [List vehicle types and models](https://docs.chargeexpressltd.com/api-reference/vehicles/list-vehicle-types-and-models.md): Requires the `fleet:read` scope.
- [List vehicles](https://docs.chargeexpressltd.com/api-reference/vehicles/list-vehicles.md): Requires the `fleet:read` scope.
- [Add a vehicle](https://docs.chargeexpressltd.com/api-reference/vehicles/add-a-vehicle.md): Requires the `vehicles:write` scope.
- [Retrieve a vehicle](https://docs.chargeexpressltd.com/api-reference/vehicles/retrieve-a-vehicle.md): Requires the `fleet:read` scope.
- [Update a vehicle](https://docs.chargeexpressltd.com/api-reference/vehicles/update-a-vehicle.md): Requires the `vehicles:write` scope.
- [Retire a vehicle](https://docs.chargeexpressltd.com/api-reference/vehicles/retire-a-vehicle.md): Requires the `vehicles:write` scope.
- [Upload a vehicle image](https://docs.chargeexpressltd.com/api-reference/vehicles/upload-a-vehicle-image.md): Requires the `vehicles:write` scope.
- [Retrieve fleet limits](https://docs.chargeexpressltd.com/api-reference/limits/retrieve-fleet-limits.md): Requires the `fleet:read` scope.
- [Replace fleet limits](https://docs.chargeexpressltd.com/api-reference/limits/replace-fleet-limits.md): Requires the `limits:write` scope.
- [Retrieve a driver’s limits](https://docs.chargeexpressltd.com/api-reference/limits/retrieve-a-driver’s-limits.md): Requires the `fleet:read` scope.
- [Replace a driver’s limit overrides](https://docs.chargeexpressltd.com/api-reference/limits/replace-a-driver’s-limit-overrides.md): A null amount exempts the driver from that fleet default.
- [List charge points](https://docs.chargeexpressltd.com/api-reference/charging/list-charge-points.md): Requires the `fleet:read` scope.
- [List sessions](https://docs.chargeexpressltd.com/api-reference/charging/list-sessions.md): Requires the `fleet:read` scope.
- [Retrieve a session](https://docs.chargeexpressltd.com/api-reference/charging/retrieve-a-session.md): Requires the `fleet:read` scope.
- [Retrieve the wallet](https://docs.chargeexpressltd.com/api-reference/wallet/retrieve-the-wallet.md): Requires the `fleet:read` scope.
- [List wallet transactions](https://docs.chargeexpressltd.com/api-reference/wallet/list-wallet-transactions.md): Requires the `fleet:read` scope.
- [Quote a top-up](https://docs.chargeexpressltd.com/api-reference/wallet/quote-a-top-up.md): Requires the `fleet:read` scope.
- [Start a top-up](https://docs.chargeexpressltd.com/api-reference/wallet/start-a-top-up.md): Returns a checkout_url where a person completes payment with ExpressPay. wallet.funded fires once it is paid.
- [Retrieve a top-up](https://docs.chargeexpressltd.com/api-reference/wallet/retrieve-a-top-up.md): Requires the `fleet:read` scope.
- [List invoices](https://docs.chargeexpressltd.com/api-reference/invoices/list-invoices.md): Requires the `fleet:read` scope.
- [Pay usage invoices](https://docs.chargeexpressltd.com/api-reference/invoices/pay-usage-invoices.md): Creates a funding for the unpaid invoices; a person completes it at checkout_url.
- [Retrieve an invoice](https://docs.chargeexpressltd.com/api-reference/invoices/retrieve-an-invoice.md): Requires the `fleet:read` scope.
- [Download an invoice PDF](https://docs.chargeexpressltd.com/api-reference/invoices/download-an-invoice-pdf.md): Requires the `fleet:read` scope.
- [List webhook endpoints](https://docs.chargeexpressltd.com/api-reference/webhooks/list-webhook-endpoints.md): Requires the `fleet:read` scope.
- [Create a webhook endpoint](https://docs.chargeexpressltd.com/api-reference/webhooks/create-a-webhook-endpoint.md): The response includes the signing secret. It is not shown again.
- [Retrieve a webhook endpoint](https://docs.chargeexpressltd.com/api-reference/webhooks/retrieve-a-webhook-endpoint.md): Requires the `fleet:read` scope.
- [Update a webhook endpoint](https://docs.chargeexpressltd.com/api-reference/webhooks/update-a-webhook-endpoint.md): Requires the `webhooks:write` scope.
- [Delete a webhook endpoint](https://docs.chargeexpressltd.com/api-reference/webhooks/delete-a-webhook-endpoint.md): Requires the `webhooks:write` scope.
- [Rotate the signing secret](https://docs.chargeexpressltd.com/api-reference/webhooks/rotate-the-signing-secret.md): The previous secret keeps signing alongside the new one for 24 hours.
- [Send a test event](https://docs.chargeexpressltd.com/api-reference/webhooks/send-a-test-event.md): Sends one event straight away with a sample payload. Pass `type` to send any event type; the default is `ping`.
- [List events](https://docs.chargeexpressltd.com/api-reference/events/list-events.md): Events from the last 30 days, newest first.
- [Retrieve an event](https://docs.chargeexpressltd.com/api-reference/events/retrieve-an-event.md): Requires the `fleet:read` scope.
- [Redeliver an event](https://docs.chargeexpressltd.com/api-reference/events/redeliver-an-event.md): Requires the `webhooks:write` scope.
- [Simulate a paid top-up](https://docs.chargeexpressltd.com/api-reference/sandbox/simulate-a-paid-top-up.md): Sandbox keys only. Settles a pending sandbox top-up as paid: credit is added and wallet.funded fires.
- [Simulate a failed top-up](https://docs.chargeexpressltd.com/api-reference/sandbox/simulate-a-failed-top-up.md): Sandbox keys only. Marks a pending sandbox top-up as failed and fires wallet.funding_failed.
- [Reset the sandbox](https://docs.chargeexpressltd.com/api-reference/sandbox/reset-the-sandbox.md): Sandbox keys only. Clears sandbox sessions, top-ups, drivers, vehicles and events, then seeds fresh data. Keys and webhook endpoints are kept.
- [Webhooks](https://docs.chargeexpressltd.com/webhooks/overview.md): Receive signed events when things change in your fleet: setup, delivery, retries, ordering, redelivery and the event log.
- [Verifying signatures](https://docs.chargeexpressltd.com/webhooks/verifying-signatures.md): Check the X-ChargeExpress-Signature header so you only act on webhooks ChargeExpress sent.
- [Event types](https://docs.chargeexpressltd.com/webhooks/events.md): Every webhook event type, when it fires, and a sample payload.

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.