Download OpenAPI specification:
Internal API for the MyWay support agent. It answers the questions support gets most: is this car parked?, has this booking been paid?, what does this garage offer?
All endpoints are read-only and read the shared MyWay Firestore of the environment
(vickyparking-dev or vickyparking-prod). The backend (myway-cloud) stays authoritative;
this API only interprets booking and garage documents.
Send the environment's access key in the access-key header on every request.
Requests without a valid key get 401.
| Environment | Base URL |
|---|---|
| Development | https://support-api-gateway-5cvbz26i.ew.gateway.dev |
| Production | https://support-api-gateway-dllekmh7.ew.gateway.dev |
Successful responses look like { "message": "...", "code": "...", "data": ... }.
Errors look like { "errorGroupCode": "...", "httpErrorCode": 404, "errorDetail": { "code": "...", "message": "..." } }.
parkingState: parked, not_parked or unknown. Closed bookings are never parked.
Statuses such as started_parked or overdue_will_depart mean parked; not_started,
started_arrived or ended mean not parked. For plain started (garage without entrance
gate) and subscription sessions the last gate passages decide; with no entrance recorded the
state is unknown.
paymentState: paid (captured, nothing open), not_paid (open amount, failed, expired,
unconfirmed or cancelled), pending (payment method authorised, not captured yet),
refunded, no_payment_required (free, host-settled or written off) or unknown.
kind: park_direct (pay on exit, booking type direct) or reservation
(shortTerm / longTerm).
Write actions from the support endpoint list (update plate or times, set parked, open gates, cancel, create bookings), garage availability and price calculation, occupancy, and the whitelist/workfloor status endpoints are planned for later releases.
Finds bookings for a license plate. The plate is normalised the same way the backend does
(case, spaces, dashes and accents are ignored), so AB-123-C and ab 123c match.
By default only open (not closed) bookings are returned, newest start first.
| licensePlate required | string <= 20 characters License plate in any formatting. |
| includeClosed | string Default: "false" Enum: "true" "false" Also return closed bookings (history). At most 300 documents per plate are scanned. |
| limit | integer [ 1 .. 50 ] Default: 20 |
{- "message": "string",
- "code": "BOOKINGS_RETRIEVED_SUCCESSFULLY",
- "data": [
- {
- "id": "7f3k2LkQ",
- "bookingNumber": 104233,
- "kind": "park_direct",
- "type": "direct",
- "status": "started_parked",
- "parkingState": "parked",
- "paymentStatus": "open",
- "paymentState": "paid",
- "garage": {
- "id": "spot-1",
- "name": "Garage Centrum"
}, - "licensePlate": "AB-123-C",
- "country": "NL",
- "startAt": "2019-08-24T14:15:22Z",
- "endAt": "2019-08-24T14:15:22Z",
- "isActive": true,
- "isClosed": true
}
]
}Location, user contact, price, payment and Park Direct / reservation kind of one booking.
| bookingId required | string Firestore |
{- "message": "string",
- "code": "BOOKING_RETRIEVED_SUCCESSFULLY",
- "data": {
- "id": "7f3k2LkQ",
- "bookingNumber": 104233,
- "kind": "park_direct",
- "type": "direct",
- "status": "started_parked",
- "parkingState": "parked",
- "paymentStatus": "open",
- "paymentState": "paid",
- "garage": {
- "id": "spot-1",
- "name": "Garage Centrum"
}, - "licensePlate": "AB-123-C",
- "country": "NL",
- "startAt": "2019-08-24T14:15:22Z",
- "endAt": "2019-08-24T14:15:22Z",
- "isActive": true,
- "isClosed": true,
- "reference": "string",
- "isValid": true,
- "isAnonymous": true,
- "createdAt": "2019-08-24T14:15:22Z",
- "entranceAt": "2019-08-24T14:15:22Z",
- "exitAt": "2019-08-24T14:15:22Z",
- "closedAt": "2019-08-24T14:15:22Z",
- "location": {
- "id": "string",
- "name": "string",
- "address": {
- "street": "Stationsplein 1",
- "additional": "string",
- "postalCode": "1012 AB",
- "city": "Amsterdam",
- "countryCode": "NL"
}
}, - "user": {
- "id": "string",
- "name": "Sam de Vries",
- "email": "string",
- "phoneNumber": "string",
- "language": "nl"
}, - "price": {
- "amount": 0,
- "amountDue": 0,
- "currency": "string",
- "hourlyRate": {
- "value": 3,
- "currency": "EUR",
- "minimumAmount": 1,
- "dailyMaximum": 25
}
}, - "payment": {
- "paymentStatus": "string",
- "paymentState": "paid",
- "isPaid": true,
- "failedAmount": 0,
- "paymentProvider": "string",
- "paymentMethod": "string"
}, - "externalOperator": "string",
- "platform": "app",
- "groupId": "string",
- "eventName": "string",
- "isParcelDelivery": true,
- "isCloseOnExit": true
}
}| bookingId required | string Firestore |
{- "message": "string",
- "code": "string",
- "data": {
- "id": "string",
- "status": "started_parked",
- "parkingState": "parked",
- "isActive": true,
- "isClosed": true,
- "isValid": true,
- "licensePlate": "string",
- "startAt": "2019-08-24T14:15:22Z",
- "endAt": "2019-08-24T14:15:22Z",
- "entranceAt": "2019-08-24T14:15:22Z",
- "exitAt": "2019-08-24T14:15:22Z"
}
}| bookingId required | string Firestore |
{- "message": "string",
- "code": "string",
- "data": {
- "id": "string",
- "paymentStatus": "open",
- "paymentState": "paid",
- "isPaid": true,
- "amount": 4.5,
- "amountDue": 4.5,
- "failedAmount": 0,
- "currency": "EUR",
- "paymentProvider": "stripe",
- "paymentMethod": "ideal"
}
}Address, capacity, facilities (charging, max height, …), booking types, rates and opening times.
| garageId required | string Firestore |
{- "message": "string",
- "code": "GARAGE_RETRIEVED_SUCCESSFULLY",
- "data": {
- "id": "spot-1",
- "name": "Garage Centrum",
- "address": {
- "street": "Stationsplein 1",
- "additional": "string",
- "postalCode": "1012 AB",
- "city": "Amsterdam",
- "countryCode": "NL"
}, - "location": {
- "latitude": 0,
- "longitude": 0
}, - "capacity": 120,
- "bookingTypes": {
- "parkDirect": true,
- "shortTermReservation": true,
- "longTermReservation": true
}, - "facilities": {
- "chargingPoint": true,
- "maxHeightMeters": 2.1,
- "maxLengthMeters": 0,
- "open24Hours": true,
- "anpr": true,
- "valet": true,
- "disabledFriendly": true,
- "elevator": true,
- "roofed": true,
- "securityCamera": true
}, - "hourlyRate": {
- "value": 3,
- "currency": "EUR",
- "minimumAmount": 1,
- "dailyMaximum": 25
}, - "openingTimes": {
- "property1": {
- "startAt": "7:00",
- "endAt": "23:00",
- "closed": true
}, - "property2": {
- "startAt": "7:00",
- "endAt": "23:00",
- "closed": true
}
}, - "parkWhenClosed": true,
- "subscriptionAlwaysOpen": true,
- "leaveTimeMinutes": 20,
- "gracePeriodMinutes": 15,
- "isPrivate": true,
- "hasEntranceGate": true,
- "hasExitGate": true,
- "externalOperator": "string"
}
}