Resolve the branding a driver payment page shows

get/v1/branding/driver

No authentication

Public, for driver pages and the applications serving them. On a ready payment domain (hostname, else this request's Host header) the domain's tenant decides, and a station must belong to that tenant (404 otherwise, so a domain never shows another tenant's charger). On Ivora's own hosts the station's tenant decides. Without either, or for a tenant with no branding, Ivora's default. Any other public hostname (unknown, pending or disabled) answers 404 so its pages show no brand.

Query parameters

hostnamestring | null
Hostname the driver page is served on. Defaults to this request's Host header.
3–253 characters
stationstring | null
OCPP connection name of the charger the page is for (the QR path's <station> part).
Pattern ^[A-Za-z0-9][A-Za-z0-9_-]{0,199}$

Returns · 200

display_namestringRequired
logo_urlstring | nullRequired
Null when the tenant set a name but no logo: show the name as text.
primary_colorstring | nullRequired
support_emailstring | nullRequired
support_urlstring | nullRequired
checkout_originstringRequired
Origin of the driver payment pages for this brand: the tenant's ready payment domain, else the default payment host. QR codes encode <checkout_origin>/checkout/<station>-<evse>.
sourceenumRequired
How the brand was chosen: the payment domain the page is served on, the charger's tenant, or Ivora's default.
One of payment_domain, station, tenant, default

Errors

401 Unauthorized 403 Forbidden 404 Not found 409 Conflict 422 Invalid request 429 Rate limited 502 Upstream error 503 Unavailable

GET /v1/branding/driver

curl --fail-with-body "https://api.ivoracharge.com/v1/branding/driver"

Response · 200

{
  "display_name": "string",
  "logo_url": "https://app.example.com/return",
  "primary_color": "string",
  "support_email": "string",
  "support_url": "https://app.example.com/return",
  "checkout_origin": "https://pay.example.com",
  "source": "payment_domain"
}

Try it is not available here yetRequests from this page are off until the production API at https://api.ivoracharge.com is public. Use the code samples from your application server; Ivora grants production access. Keys are created in Developer tools.