← Partners & API

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.

Start integration setup

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 file
Base 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

MethodPathPurposeAccess
POST/api/v1/meters/registerRegister a customer meter. With a write-scoped key the meter is recorded as verified.public / write
POST/api/v1/meters/verifyCheck whether a meter number, IMEI or RFID is already registered.public
GET/api/v1/meters/:numberMeter status and tariff. Holder details and recent tokens with a key.public / read
PATCH/api/v1/meters/:numberUpdate status (verified, suspended…), DisCo or tariff.write
GET/api/v1/meters?status=pending-verificationList registered meters, filterable by status.read

Payments & vending

MethodPathPurposeAccess
POST/api/v1/payments/quotePrice a top-up: units, service charge and tariff for an amount.public
POST/api/v1/payments/initializeCreate an order and return the checkout URL.public
GET/api/v1/payments/verify/:referenceVerify an order, settle it and return the token.public
POST/api/v1/payments/webhookPayment provider callback, signature-verified.signed
POST/api/v1/payments/simulateSettle a test order without real money, to try the full flow.write (test key)
GET/api/v1/vendVending log with queued and delivered tokens.read
POST/api/v1/vend/flushDeliver queued units when a meter reconnects.write

Catalogue & platform

MethodPathPurposeAccess
GET/api/v1/productsProduct catalogue and pricing.public
GET/api/v1/updatesProduct and firmware notices.public
POST/api/v1/productsAdd a product to the catalogue.write
PATCH/api/v1/products/:slugChange a product’s details, price or status.write
POST/api/v1/updatesPublish a product or firmware notice.write
GET/api/v1/stockStock on hand by SKU and warehouse.read
PATCH/api/v1/stock/:skuSet or adjust the quantity of one SKU.write
POST/api/v1/stock/uploadUpload a stock CSV (multipart field file).write
GET/api/v1/devicesConnected devices on the account.read
GET/api/v1/statusPlatform health.public
POST/api/v1/contactSubmit an enquiry to the Enapoint desk.public