Skip to main content

Getting Started

Logos Connect Public API is a public API to interact with Wash and Fuel Points. Each request operates within the context of an instance (your site/organization), identified by an instanceId in the URL.

Authentication​

Every request must include an API key as a bearer token:

Authorization: Bearer {API_KEY}

API keys are issued by Logos Payment Solutions and are scoped to specific roles (e.g. Fuel, Wash, CreditNote) and a specific instance. A key will only work for the operations and instance it was granted access to. Contact Logos Payment Solutions to request a key for your integration.

Versioning​

The API is versioned via the URL path, e.g. /api/v1/instances/{instanceId}/....

Request headers​

Authorize/terminate requests also require:

HeaderRequiredDescription
X-Operation-IdYesA unique ID (UUID) you generate to identify this operation across the whole system for traceability.
X-Customer-IdNoThe ID of the end user. Not required, but recommended for traceability.

Custom status codes​

When authorizing or terminating fuel/wash operations, the response includes both an HTTP status code and a more specific custom status code in the response body, so consumers can distinguish e.g. which conflict occurred (machine in the wrong state vs. unknown site, etc.):

CodeId
Success200
BadRequest400
Unauthorized401
Forbidden403
SystemError10000
UnknownSiteId10011
UnknownCarWash10012
ProductNotFound10021
ProductNotValid10501
UnableToStartWash10502
UnableToStopWash10503
CarWashWrongState10604
CarWashUnavailable10606
UnknownPumpId10701
PumpNotReady10702
PumpFailedToRelease10703
UnableToStartPump10704
UnableToStopPump10705
DispenserWrongState10706

Events​

Operations are asynchronous: an authorize/terminate call only acknowledges that the request was received, while the actual outcome (and further state changes) arrive as webhook events. See the Events guide.