← Partners & API
Start integration setup
Technical reference
ENA partner API reference
An overview of the endpoints available to approved partners, for the engineers who build the integration. Partner keys are issued after the integration setup, and the full guide with examples is sent to your technical contact.
New to ENA?
Start with the guided setup. You don't need to read this page to apply.
Conventions
Every endpoint uses the same rules, so once one call works the rest follow the same pattern. Test keys begin with ena_test_ and never move real money; live keys begin with ena_live_.
Download the OpenAPI fileBase URLhttps://www.enapoint.com/api/v1
AuthAuthorization: Bearer <key>
Scopesread · write
FormatJSON in, JSON out, UTF-8
MoneyKobo (integer); energy in milli-kWh
ErrorsHTTP status + { "error": "…" }
Tracingx-request-id on every response
CORSEnabled for key-authenticated calls
Endpoints
Access levels: public needs no key, read and write need a partner key with that permission, and signed is reserved for the payment provider.
Meters
| Method | Path | Purpose | Access |
|---|---|---|---|
| POST | /api/v1/meters/register | Register a customer meter. With a write-scoped key the meter is recorded as verified. | public / write |
| POST | /api/v1/meters/verify | Check whether a meter number, IMEI or RFID is already registered. | public |
| GET | /api/v1/meters/:number | Meter status and tariff. Holder details and recent tokens with a key. | public / read |
| PATCH | /api/v1/meters/:number | Update status (verified, suspended…), DisCo or tariff. | write |
| GET | /api/v1/meters?status=pending-verification | List registered meters, filterable by status. | read |
Payments & vending
| Method | Path | Purpose | Access |
|---|---|---|---|
| POST | /api/v1/payments/quote | Price a top-up: units, service charge and tariff for an amount. | public |
| POST | /api/v1/payments/initialize | Create an order and return the checkout URL. | public |
| GET | /api/v1/payments/verify/:reference | Verify an order, settle it and return the token. | public |
| POST | /api/v1/payments/webhook | Payment provider callback, signature-verified. | signed |
| POST | /api/v1/payments/simulate | Settle a test order without real money, to try the full flow. | write (test key) |
| GET | /api/v1/vend | Vending log with queued and delivered tokens. | read |
| POST | /api/v1/vend/flush | Deliver queued units when a meter reconnects. | write |
Catalogue & platform
| Method | Path | Purpose | Access |
|---|---|---|---|
| GET | /api/v1/products | Product catalogue and pricing. | public |
| GET | /api/v1/updates | Product and firmware notices. | public |
| POST | /api/v1/products | Add a product to the catalogue. | write |
| PATCH | /api/v1/products/:slug | Change a product’s details, price or status. | write |
| POST | /api/v1/updates | Publish a product or firmware notice. | write |
| GET | /api/v1/stock | Stock on hand by SKU and warehouse. | read |
| PATCH | /api/v1/stock/:sku | Set or adjust the quantity of one SKU. | write |
| POST | /api/v1/stock/upload | Upload a stock CSV (multipart field file). | write |
| GET | /api/v1/devices | Connected devices on the account. | read |
| GET | /api/v1/status | Platform health. | public |
| POST | /api/v1/contact | Submit an enquiry to the Enapoint desk. | public |