OpenAPI Specification
openapi: 3.0.3
info:
title: Flipdish API - Apps Accounts Payouts 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: Payouts
description: Operations for Payouts.
paths:
/api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}:
get:
tags:
- Payouts
operationId: GetPayout
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
- name: bankAccountId
in: path
required: true
schema:
type: integer
format: int32
description: The bank account id path parameter.
example: 500123
- name: payoutId
in: path
required: true
schema:
type: integer
format: int32
description: The payout id path parameter.
example: 500123
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PayoutDetail'
examples:
GetPayout200Example:
summary: Default GetPayout 200 response
x-microcks-default: true
value:
PayoutId: 500123
BankAccountId: 500123
AccountName: Example Name
PayoutStatus: Pending
CreatedDate: '2026-06-02T12:00:00Z'
PeriodStartTime: '2026-06-02T12:00:00Z'
PeriodEndTime: '2026-06-02T12:00:00Z'
DestinationBank: string
DestinationAccount: string
PayoutType: Internal
Currency: EUR
PayoutStores: []
Amount: 12.5
CutoffDate: '2026-06-02T12:00:00Z'
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetPayout400Example:
summary: Default GetPayout 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:
GetPayout401Example:
summary: Default GetPayout 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:
GetPayout403Example:
summary: Default GetPayout 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:
GetPayout500Example:
summary: Default GetPayout 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 Payout
description: Get Payout via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/{appId}/payouts/summaries:
get:
tags:
- Payouts
operationId: GetPayoutSummaries
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
- name: startDate
in: query
required: false
schema:
type: string
format: date-time
description: The start date query parameter.
example: '2026-06-02T12:00:00Z'
- name: endDate
in: query
required: false
schema:
type: string
format: date-time
description: The end date query parameter.
example: '2026-06-02T12:00:00Z'
- name: payoutRequestIds.bankAccountIds
in: query
description: List of bank account ids to search for
required: false
explode: true
schema:
type: array
items:
type: integer
format: int32
example:
- 3
- name: payoutRequestIds.states
in: query
description: List of {Flipdish.PublicModels.V1.Payouts.PayoutStatus} so search for
required: false
explode: true
schema:
type: array
items:
type: string
enum:
- Pending
- InTransit
- Paid
- Failed
- Cancelled
example:
- Pending
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiArrayResult_PayoutSummary_'
examples:
GetPayoutSummaries200Example:
summary: Default GetPayoutSummaries 200 response
x-microcks-default: true
value:
Data: []
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetPayoutSummaries400Example:
summary: Default GetPayoutSummaries 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:
GetPayoutSummaries401Example:
summary: Default GetPayoutSummaries 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:
GetPayoutSummaries403Example:
summary: Default GetPayoutSummaries 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:
GetPayoutSummaries500Example:
summary: Default GetPayoutSummaries 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 Payout Summaries
description: Get Payout Summaries via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/payouts/summaries).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/{appId}/payouts:
get:
tags:
- Payouts
operationId: GetPayouts
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
- name: startDate
in: query
required: false
schema:
type: string
format: date-time
description: The start date query parameter.
example: '2026-06-02T12:00:00Z'
- name: endDate
in: query
required: false
schema:
type: string
format: date-time
description: The end date query parameter.
example: '2026-06-02T12:00:00Z'
- name: page
in: query
required: false
schema:
type: integer
format: int32
description: The page query parameter.
example: 1
- name: limit
in: query
required: false
schema:
type: integer
format: int32
description: The limit query parameter.
example: 1
- name: payoutRequestIds.bankAccountIds
in: query
description: List of bank account ids to search for
required: false
explode: true
schema:
type: array
items:
type: integer
format: int32
example:
- 3
- name: payoutRequestIds.states
in: query
description: List of {Flipdish.PublicModels.V1.Payouts.PayoutStatus} so search for
required: false
explode: true
schema:
type: array
items:
type: string
enum:
- Pending
- InTransit
- Paid
- Failed
- Cancelled
example:
- Pending
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiPaginationResult_Payout_'
examples:
GetPayouts200Example:
summary: Default GetPayouts 200 response
x-microcks-default: true
value:
Page: 1
Limit: 1
TotalRecordCount: 12.5
Data: []
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetPayouts400Example:
summary: Default GetPayouts 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:
GetPayouts401Example:
summary: Default GetPayouts 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:
GetPayouts403Example:
summary: Default GetPayouts 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:
GetPayouts500Example:
summary: Default GetPayouts 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 Payouts
description: Get Payouts via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/payouts).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/orders:
get:
tags:
- Payouts
operationId: GetPayoutOrders
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
- name: bankAccountId
in: path
required: true
schema:
type: integer
format: int32
description: The bank account id path parameter.
example: 500123
- name: payoutId
in: path
required: true
schema:
type: integer
format: int32
description: The payout id path parameter.
example: 500123
- name: page
in: query
required: false
schema:
type: integer
format: int32
description: The page query parameter.
example: 1
- name: limit
in: query
required: false
schema:
type: integer
format: int32
description: The limit query parameter.
example: 1
- name: storeIds
in: query
required: false
explode: true
schema:
type: array
items:
type: integer
format: int32
description: The store ids query parameter.
example:
- 1
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiPaginationResult_PayoutOrder_'
examples:
GetPayoutOrders200Example:
summary: Default GetPayoutOrders 200 response
x-microcks-default: true
value:
Page: 1
Limit: 1
TotalRecordCount: 12.5
Data: []
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetPayoutOrders400Example:
summary: Default GetPayoutOrders 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:
GetPayoutOrders401Example:
summary: Default GetPayoutOrders 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:
GetPayoutOrders403Example:
summary: Default GetPayoutOrders 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:
GetPayoutOrders500Example:
summary: Default GetPayoutOrders 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 Payout Orders
description: Get Payout Orders via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/orders).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/refunds:
get:
tags:
- Payouts
operationId: GetPayoutRefunds
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
- name: bankAccountId
in: path
required: true
schema:
type: integer
format: int32
description: The bank account id path parameter.
example: 500123
- name: payoutId
in: path
required: true
schema:
type: integer
format: int32
description: The payout id path parameter.
example: 500123
- name: page
in: query
required: false
schema:
type: integer
format: int32
description: The page query parameter.
example: 1
- name: limit
in: query
required: false
schema:
type: integer
format: int32
description: The limit query parameter.
example: 1
- name: storeIds
in: query
required: false
explode: true
schema:
type: array
items:
type: integer
format: int32
description: The store ids query parameter.
example:
- 1
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiPaginationResult_PayoutRefund_'
examples:
GetPayoutRefunds200Example:
summary: Default GetPayoutRefunds 200 response
x-microcks-default: true
value:
Page: 1
Limit: 1
TotalRecordCount: 12.5
Data: []
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetPayoutRefunds400Example:
summary: Default GetPayoutRefunds 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:
GetPayoutRefunds401Example:
summary: Default GetPayoutRefunds 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:
GetPayoutRefunds403Example:
summary: Default GetPayoutRefunds 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:
GetPayoutRefunds500Example:
summary: Default GetPayoutRefunds 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 Payout Refunds
description: Get Payout Refunds via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/refunds).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/chargebacks:
get:
tags:
- Payouts
operationId: GetPayoutChargebacks
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
- name: bankAccountId
in: path
required: true
schema:
type: integer
format: int32
description: The bank account id path parameter.
example: 500123
- name: payoutId
in: path
required: true
schema:
type: integer
format: int32
description: The payout id path parameter.
example: 500123
- name: page
in: query
required: false
schema:
type: integer
format: int32
description: The page query parameter.
example: 1
- name: limit
in: query
required: false
schema:
type: integer
format: int32
description: The limit query parameter.
example: 1
- name: storeIds
in: query
required: false
explode: true
schema:
type: array
items:
type: integer
format: int32
description: The store ids query parameter.
example:
- 1
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiPaginationResult_PayoutChargeback_'
examples:
GetPayoutChargebacks200Example:
summary: Default GetPayoutChargebacks 200 response
x-microcks-default: true
value:
Page: 1
Limit: 1
TotalRecordCount: 12.5
Data: []
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetPayoutChargebacks400Example:
summary: Default GetPayoutChargebacks 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:
GetPayoutChargebacks401Example:
summary: Default GetPayoutChargebacks 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:
GetPayoutChargebacks403Example:
summary: Default GetPayoutChargebacks 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:
GetPayoutChargebacks500Example:
summary: Default GetPayoutChargebacks 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 Payout Chargebacks
description: Get Payout Chargebacks via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/chargebacks).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/othercharges:
get:
tags:
- Payouts
operationId: GetPayoutOtherCharges
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
- name: bankAccountId
in: path
required: true
schema:
type: integer
format: int32
description: The bank account id path parameter.
example: 500123
- name: payoutId
in: path
required: true
schema:
type: integer
format: int32
description: The payout id path parameter.
example: 500123
- name: page
in: query
required: false
schema:
type: integer
format: int32
description: The page query parameter.
example: 1
- name: limit
in: query
required: false
schema:
type: integer
format: int32
description: The limit query parameter.
example: 1
- name: storeIds
in: query
required: false
explode: true
schema:
type: array
items:
type: integer
format: int32
description: The store ids query parameter.
example:
- 1
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiPaginationResult_PayoutOtherCharge_'
examples:
GetPayoutOtherCharges200Example:
summary: Default GetPayoutOtherCharges 200 response
x-microcks-default: true
value:
Page: 1
Limit: 1
TotalRecordCount: 12.5
Data: []
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetPayoutOtherCharges400Example:
summary: Default GetPayoutOtherCharges 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:
GetPayoutOtherCharges401Example:
summary: Default GetPayoutOtherCharges 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:
GetPayoutOtherCharges403Example:
summary: Default GetPayoutOthe
# --- truncated at 32 KB (77 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/openapi/flipdish-payouts-api-openapi.yml