Log inTalk to us
Developer tools

Check your EVSEs for payment terminals

get/v1/tenants/{tenant_id}/ocpi/payment-terminals/readiness
Requires an API key

Per EVSE: whether a payment terminal may start sessions there and, if not, why. A terminal's start is refused where a session would end without a price, since the card is charged for its charge record. Requires stations:read.

Path parameters

  • tenant_idintegerRequired

Returns · 200

  • tenant_idintegerRequired
  • publishedbooleanRequired
    Whether your locations are published over OCPI now.
  • terminals_activearray of stringRequired
    The partner IDs of the payment terminals active for you now.
  • checked_atstringRequired
  • dataarray of EvseReadinessRequired
    Every EVSE of yours, by location, station and EVSE.
    Child attributes
    • location_idstringRequired
    • station_idintegerRequired
    • evse_uidstringRequired
      The OCPI EVSE uid partners command.
    • evse_idstring | nullRequired
      The EVSE ID partners show; null while you have no OCPI settings.
    • readybooleanRequired
      Every check passes: published, every connector's tariff prices its charge records, the charger online, a plug-in seen (OCPP 1.6 Preparing or 2.x Occupied) and a protocol Ivora starts remotely.
    • problemsarray of ReadinessProblemRequired
      Child attributes
      • codeenumRequired
        not_published, no_tariff, tariff_not_published, tariff_complex and location_tax also refuse a terminal's start: its charge record would not be priced.
        One of not_published, no_tariff, tariff_not_published, tariff_complex, location_tax, offline, no_plug_signal, remote_start_unsupported
      • messagestringRequired
    • connectorsarray of ReadinessConnectorRequired
      Child attributes
      • connector_idstringRequired
        The OCPI connector ID.
      • tariff_idstring | nullRequired
        The tariff that prices the connector's charge records: its own, else its location's default, else the project's; null when none applies.
      • tariff_problemenum | nullRequired
        Why this connector's sessions would not be priced; null when they would.
        One of location_tax, no_tariff, tariff_complex, tariff_not_published
      • ocpp_statusenum | nullRequired
        The status the terminal receives as ocpp_status: the charger's OCPP 1.6 status, or OCPP 2.x Occupied mapped from the session at it (Preparing, Charging, SuspendedEV, SuspendedEVSE or Finishing); Unavailable while the charger is offline.
        One of Available, Preparing, Charging, SuspendedEV, SuspendedEVSE, Finishing, Reserved, Unavailable, Faulted
GET /v1/tenants/{tenant_id}/ocpi/payment-terminals/readiness
curl --fail-with-body "https://api.ivoracharge.com/v1/tenants/1042/ocpi/payment-terminals/readiness" \
  -H "Authorization: Bearer $IVORA_API_KEY"
Response · 200JSON
{
  "tenant_id": 1042,
  "published": false,
  "terminals_active": [
    "string"
  ],
  "checked_at": "2026-09-30T17:00:00Z",
  "data": [
    {
      "location_id": 7,
      "station_id": 1,
      "evse_uid": "string",
      "evse_id": "evse_0123456789abcdef",
      "ready": false,
      "problems": [
        {
          "code": "not_published",
          "message": "string"
        }
      ],
      "connectors": [
        {
          "connector_id": 1,
          "tariff_id": 42,
          "tariff_problem": "location_tax",
          "ocpp_status": "Available"
        }
      ]
    }
  ]
}
Requires an approved production API keyProduction access starts with a request, a short meeting with Ivora and a card on file, after which Ivora staff grant your account access. How to request access
Try itproduction · api.ivoracharge.com

Paste a production api key (iv_live_…). Create keys in Developer tools. The key stays in this page's memory, is sent only to https://api.ivoracharge.com and clears when you reload. Test keys are refused.