OpenAPI Specification
openapi: 3.0.3
info:
title: Flipdish API - Apps Accounts Hydra API
version: v1.0
description: Flipdish Open API v1.0 — Apps operations. Flipdish is an online ordering and branded-app platform for restaurants and takeaways. This specification was derived from the official Flipdish Swagger document and grouped by resource domain.
contact:
name: Flipdish Support
email: help@flipdish.com
url: https://help.flipdish.com
x-generated-from: https://api.flipdish.co/swagger/docs/v1.0
x-last-validated: '2026-06-02'
servers:
- url: https://api.flipdish.co
description: Flipdish production API
security:
- oauth2:
- api
tags:
- name: Hydra
description: Operations for Hydra.
paths:
/api/v1.0/hydra/settings:
get:
tags:
- Hydra
operationId: GetSettings
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_HydraConfig_'
examples:
GetSettings200Example:
summary: Default GetSettings 200 response
x-microcks-default: true
value:
Data:
MinimumVersion: string
PaymentOptions:
- Online
DeviceSettings:
Volume: 1
FontSize: 1.0
Brightness: 1
Version: string
BuildNumber: string
GitSha: string
GitBranch: string
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetSettings400Example:
summary: Default GetSettings 400 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'401':
description: Authentication has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetSettings401Example:
summary: Default GetSettings 401 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'403':
description: Successful authentication, but authorization has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetSettings403Example:
summary: Default GetSettings 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'404':
description: NotFound
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetSettings404Example:
summary: Default GetSettings 404 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetSettings500Example:
summary: Default GetSettings 500 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
security:
- oauth2:
- api
summary: Flipdish Get Settings
description: Get Settings via the Flipdish Open API v1.0 (GET /api/v1.0/hydra/settings).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/hydra/ably_token:
get:
tags:
- Hydra
operationId: GetAblyToken
responses:
'200':
description: OK
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetAblyToken400Example:
summary: Default GetAblyToken 400 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'401':
description: Authentication has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetAblyToken401Example:
summary: Default GetAblyToken 401 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'403':
description: Successful authentication, but authorization has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetAblyToken403Example:
summary: Default GetAblyToken 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'404':
description: NotFound
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetAblyToken404Example:
summary: Default GetAblyToken 404 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetAblyToken500Example:
summary: Default GetAblyToken 500 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
security:
- oauth2:
- api
summary: Flipdish Get Ably Token
description: Get Ably Token via the Flipdish Open API v1.0 (GET /api/v1.0/hydra/ably_token).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/hydra/registration:
get:
tags:
- Hydra
operationId: GetRegistration
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_HydraStatus_'
examples:
GetRegistration200Example:
summary: Default GetRegistration 200 response
x-microcks-default: true
value:
Data:
AppId: '500123'
StoreIds:
- 1
IsRegistered: true
PinCode: 1
Images:
- string
UserType: Kiosk
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetRegistration400Example:
summary: Default GetRegistration 400 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'401':
description: Authentication has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetRegistration401Example:
summary: Default GetRegistration 401 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'403':
description: Successful authentication, but authorization has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetRegistration403Example:
summary: Default GetRegistration 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'404':
description: NotFound
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetRegistration404Example:
summary: Default GetRegistration 404 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetRegistration500Example:
summary: Default GetRegistration 500 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
security:
- oauth2:
- api
summary: Flipdish Get Registration
description: Get Registration via the Flipdish Open API v1.0 (GET /api/v1.0/hydra/registration).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/{appId}/emvterminals:
get:
tags:
- Hydra
operationId: Hydra_GetEmvsForAppId
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiArrayResult_EmvTerminalWithAssignments_'
examples:
Hydra_GetEmvsForAppId200Example:
summary: Default Hydra_GetEmvsForAppId 200 response
x-microcks-default: true
value:
Data: []
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
Hydra_GetEmvsForAppId400Example:
summary: Default Hydra_GetEmvsForAppId 400 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'401':
description: Authentication has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
Hydra_GetEmvsForAppId401Example:
summary: Default Hydra_GetEmvsForAppId 401 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'403':
description: Successful authentication, but authorization has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
Hydra_GetEmvsForAppId403Example:
summary: Default Hydra_GetEmvsForAppId 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
Hydra_GetEmvsForAppId500Example:
summary: Default Hydra_GetEmvsForAppId 500 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
security:
- oauth2:
- api
summary: Flipdish Hydra_Get Emvs for App Id
description: Hydra_Get Emvs for App Id via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/emvterminals).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
tags:
- Hydra
operationId: Hydra_CreateEmv
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/EmvTerminal'
examples:
Hydra_CreateEmvRequestExample:
summary: Default Hydra_CreateEmv request
x-microcks-default: true
value:
EmvTerminalId: 500123
TerminalId: '500123'
Url: https://api.flipdish.co/example
Token: string
SoftwareHouseId: '500123'
InstallerId: '500123'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
examples:
Hydra_CreateEmv200Example:
summary: Default Hydra_CreateEmv 200 response
x-microcks-default: true
value: {}
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
Hydra_CreateEmv400Example:
summary: Default Hydra_CreateEmv 400 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'401':
description: Authentication has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
Hydra_CreateEmv401Example:
summary: Default Hydra_CreateEmv 401 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'403':
description: Successful authentication, but authorization has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
Hydra_CreateEmv403Example:
summary: Default Hydra_CreateEmv 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
Hydra_CreateEmv500Example:
summary: Default Hydra_CreateEmv 500 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
security:
- oauth2:
- api
summary: Flipdish Hydra_Create Emv
description: Hydra_Create Emv via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/emvterminals).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/{appId}/hydra/emvterminal:
get:
tags:
- Hydra
operationId: GetEMVTerminalDetails
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_PaymentTerminalDetails_'
examples:
GetEMVTerminalDetails200Example:
summary: Default GetEMVTerminalDetails 200 response
x-microcks-default: true
value:
Data:
TerminalId: '500123'
Status: Active
Currency: EUR
Uri: https://api.flipdish.co/example
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetEMVTerminalDetails400Example:
summary: Default GetEMVTerminalDetails 400 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'401':
description: Authentication has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetEMVTerminalDetails401Example:
summary: Default GetEMVTerminalDetails 401 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'403':
description: Successful authentication, but authorization has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetEMVTerminalDetails403Example:
summary: Default GetEMVTerminalDetails 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'404':
description: NotFound
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetEMVTerminalDetails404Example:
summary: Default GetEMVTerminalDetails 404 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetEMVTerminalDetails500Example:
summary: Default GetEMVTerminalDetails 500 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
security:
- oauth2:
- api
summary: Flipdish Get EMV Terminal Details
description: Get EMV Terminal Details via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/hydra/emvterminal).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/{appId}/kiosksettings/{deviceId}:
get:
tags:
- Hydra
operationId: GetKioskSettings
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
- name: deviceId
in: path
required: true
schema:
type: string
description: The device id path parameter.
example: '500123'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_KioskSettings_'
examples:
GetKioskSettings200Example:
summary: Default GetKioskSettings 200 response
x-microcks-default: true
value:
Data:
HideLogoFromFrontPage: true
TwoColumnMenuLayout: true
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetKioskSettings400Example:
summary: Default GetKioskSettings 400 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'401':
description: Authentication has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetKioskSettings401Example:
summary: Default GetKioskSettings 401 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'403':
description: Successful authentication, but authorization has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetKioskSettings403Example:
summary: Default GetKioskSettings 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetKioskSettings500Example:
summary: Default GetKioskSettings 500 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
security:
- oauth2:
- api
summary: Flipdish Get Kiosk Settings
description: Get Kiosk Settings via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/kiosksettings/{deviceId}).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
tags:
- Hydra
operationId: UpdateKioskSettings
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
- name: deviceId
in: path
required: true
schema:
type: string
description: The device id path parameter.
example: '500123'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/KioskSettings'
examples:
UpdateKioskSettingsRequestExample:
summary: Default UpdateKioskSettings request
x-microcks-default: true
value:
HideLogoFromFrontPage: true
TwoColumnMenuLayout: true
responses:
'200':
description: OK
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
UpdateKioskSettings400Example:
summary: Default UpdateKioskSettings 400 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'401':
description: Authentication has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
UpdateKioskSettings401Example:
summary: Default UpdateKioskSettings 401 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'403':
description: Successful authentication, but authorization has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
UpdateKioskSettings403Example:
summary: Default UpdateKioskSettings 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
UpdateKioskSettings500Example:
summary: Default UpdateKioskSettings 500 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
security:
- oauth2:
- api
summary: Flipdish Update Kiosk Settings
description: Update Kiosk Settings via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/kiosksettings/{deviceId}).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/{appId}/kioskcashsettings/{deviceId}:
get:
tags:
- Hydra
operationId: GetKioskCashPaymentSettings
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
- name: deviceId
in: path
required: true
schema:
type: string
description: The device id path parameter.
example: '500123'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiArrayResult_KioskCashPaymentSettings_'
examples:
GetKioskCashPaymentSettings200Example:
summary: Default GetKioskCashPaymentSettings 200 response
x-microcks-default: true
value:
Data: []
'400':
description: B
# --- truncated at 32 KB (112 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/openapi/flipdish-hydra-api-openapi.yml