{
"openapi": "3.0.3",
"info": {
"title": "Flipdish API - Payments",
"version": "v1.0",
"description": "Flipdish Open API v1.0 \u2014 Payments 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": "BankAccount",
"description": "Operations for Bank Account."
},
{
"name": "Invoices",
"description": "Operations for Invoices."
},
{
"name": "PaymentIntents",
"description": "Operations for Payment Intents."
},
{
"name": "Payments",
"description": "Operations for Payments."
},
{
"name": "PayoutReports",
"description": "Operations for Payout Reports."
},
{
"name": "Payouts",
"description": "Operations for Payouts."
},
{
"name": "PayoutsExport",
"description": "Operations for Payouts Export."
},
{
"name": "ProcessingFeeConfigs",
"description": "Operations for Processing Fee Configs."
},
{
"name": "Receipts",
"description": "Operations for Receipts."
},
{
"name": "StripeCustomConnect",
"description": "Operations for Stripe Custom Connect."
},
{
"name": "Subscriptions",
"description": "Operations for Subscriptions."
}
],
"paths": {
"/api/v1.0/{appId}/bankaccounts": {
"get": {
"tags": [
"BankAccount"
],
"operationId": "GetBankAccounts",
"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_BankAccountSummary_"
},
"examples": {
"GetBankAccounts200Example": {
"summary": "Default GetBankAccounts 200 response",
"x-microcks-default": true,
"value": {
"Data": []
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetBankAccounts400Example": {
"summary": "Default GetBankAccounts 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": {
"GetBankAccounts401Example": {
"summary": "Default GetBankAccounts 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": {
"GetBankAccounts403Example": {
"summary": "Default GetBankAccounts 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": {
"GetBankAccounts500Example": {
"summary": "Default GetBankAccounts 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 Bank Accounts",
"description": "Get Bank Accounts via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/bankaccounts).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
},
"post": {
"tags": [
"BankAccount"
],
"operationId": "CreateBankAccount",
"parameters": [
{
"name": "appId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The app id path parameter.",
"example": "500123"
}
],
"requestBody": {
"required": false,
"content": {}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiResult_BankAccountDetail_"
},
"examples": {
"CreateBankAccount200Example": {
"summary": "Default CreateBankAccount 200 response",
"x-microcks-default": true,
"value": {
"Data": {
"Id": 500123,
"StoreNames": [
"Example Name"
],
"AccountState": "Unverified",
"StripeConnectedAccountInfo": {
"AccountStatus": "Disabled",
"StripeId": "500123",
"CardPaymentStatus": "Inactive",
"PayoutScheduleInterval": "Manual",
"PayoutsEnabled": true,
"PayoutsPaused": true,
"PaymentsEnabled": true
},
"BankAddress": "string",
"BankCountryCode": "IE",
"AccountHolderAddress": "string",
"AccountHolderCountryCode": "IE",
"VatNumber": "string",
"CurrencyCode": "EUR",
"StoreIds": [
1
],
"BankName": "Example Name",
"AccountName": "Example Name",
"Iban": "string",
"Swift": "string",
"NationalClearingCode": "string",
"PopulatedAccountFields": [],
"RejectionReason": "string",
"BusinessType": "Individual"
}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"CreateBankAccount400Example": {
"summary": "Default CreateBankAccount 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": {
"CreateBankAccount401Example": {
"summary": "Default CreateBankAccount 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": {
"CreateBankAccount403Example": {
"summary": "Default CreateBankAccount 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": {
"CreateBankAccount500Example": {
"summary": "Default CreateBankAccount 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 Create Bank Account",
"description": "Create Bank Account via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/bankaccounts).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/bankaccounts/{bankAccountId}": {
"get": {
"tags": [
"BankAccount"
],
"operationId": "GetBankAccountById",
"parameters": [
{
"name": "bankAccountId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
},
"description": "The bank account id path parameter.",
"example": 500123
},
{
"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_BankAccountDetail_"
},
"examples": {
"GetBankAccountById200Example": {
"summary": "Default GetBankAccountById 200 response",
"x-microcks-default": true,
"value": {
"Data": {
"Id": 500123,
"StoreNames": [
"Example Name"
],
"AccountState": "Unverified",
"StripeConnectedAccountInfo": {
"AccountStatus": "Disabled",
"StripeId": "500123",
"CardPaymentStatus": "Inactive",
"PayoutScheduleInterval": "Manual",
"PayoutsEnabled": true,
"PayoutsPaused": true,
"PaymentsEnabled": true
},
"BankAddress": "string",
"BankCountryCode": "IE",
"AccountHolderAddress": "string",
"AccountHolderCountryCode": "IE",
"VatNumber": "string",
"CurrencyCode": "EUR",
"StoreIds": [
1
],
"BankName": "Example Name",
"AccountName": "Example Name",
"Iban": "string",
"Swift": "string",
"NationalClearingCode": "string",
"PopulatedAccountFields": [],
"RejectionReason": "string",
"BusinessType": "Individual"
}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetBankAccountById400Example": {
"summary": "Default GetBankAccountById 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": {
"GetBankAccountById401Example": {
"summary": "Default GetBankAccountById 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": {
"GetBankAccountById403Example": {
"summary": "Default GetBankAccountById 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": {
"GetBankAccountById500Example": {
"summary": "Default GetBankAccountById 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 Bank Account by Id",
"description": "Get Bank Account by Id via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/bankaccounts/{bankAccountId}).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
},
"post": {
"tags": [
"BankAccount"
],
"operationId": "UpdateBankAccount",
"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
}
],
"requestBody": {
"required": false,
"content": {}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"UpdateBankAccount400Example": {
"summary": "Default UpdateBankAccount 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": {
"UpdateBankAccount401Example": {
"summary": "Default UpdateBankAccount 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": {
"UpdateBankAccount403Example": {
"summary": "Default UpdateBankAccount 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": {
"UpdateBankAccount500Example": {
"summary": "Default UpdateBankAccount 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 Bank Account",
"description": "Update Bank Account via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/bankaccounts/{bankAccountId}).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
},
"delete": {
"tags": [
"BankAccount"
],
"operationId": "DeleteBankAccount",
"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
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"DeleteBankAccount400Example": {
"summary": "Default DeleteBankAccount 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": {
"DeleteBankAccount401Example": {
"summary": "Default DeleteBankAccount 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": {
"DeleteBankAccount403Example": {
"summary": "Default DeleteBankAccount 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": {
"DeleteBankAccount500Example": {
"summary": "Default DeleteBankAccount 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 Delete Bank Account",
"description": "Delete Bank Account via the Flipdish Open API v1.0 (DELETE /api/v1.0/{appId}/bankaccounts/{bankAccountId}).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/bankaccounts/field-definitions": {
"get": {
"tags": [
"BankAccount"
],
"operationId": "GetFieldDefinitions",
"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_AccountFieldsDefinitions_"
},
"examples": {
"GetFieldDefinitions200Example": {
"summary": "Default GetFieldDefinitions 200 response",
"x-microcks-default": true,
"value": {
"Data": {
"DefinitionsPerCountry": {}
}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetFieldDefinitions400Example": {
"summary": "Default GetFieldDefinitions 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": {
"GetFieldDefinitions401Example": {
"summary": "Default GetFieldDefinitions 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": {
"GetFieldDefinitions403Example": {
"summary": "Default GetFieldDefinitions 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": {
"GetFieldDefinitions500Example": {
"summary": "Default GetFieldDefinitions 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 Field Definitions",
"description": "Get Field Definitions via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/bankaccounts/field-definitions).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/bankaccounts/countries-field-definitions": {
"get": {
"tags": [
"BankAccount"
],
"operationId": "GetCountriesWithFieldDefinitions",
"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_CountryWithAccountFieldsDefinitions_"
},
"examples": {
"GetCountriesWithFieldDefinitions200Example": {
"summary": "Default GetCountriesWithFieldDefinitions 200 response",
"x-microcks-default": true,
"value": {
"Data": []
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetCountriesWithFieldDefinitions400Example": {
"summary": "Default GetCountriesWithFieldDefinitions 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": {
"GetCountriesWithFieldDefinitions401Example": {
"summary": "Default GetCountriesWithFieldDefinitions 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": {
"GetCountriesWithFieldDefinitions403Example": {
"summary": "Default GetCountriesWithFieldDefinitions 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": {
"GetCountriesWithFieldDefinitions500Example": {
"summary": "Default GetCountriesWithFieldDefinitions 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 Countries with Field Definitions",
"description": "Get Countries with Field Definitions via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/bankaccounts/countries-field-definitions).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/bankaccounts/{bankAccountId}/state/{state}": {
"post": {
"tags": [
"BankAccount"
],
"operationId": "UpdateBankAccountState",
"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": "state",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The state path parameter.",
"example": "string"
}
],
"requestBody": {
"required": false,
"content": {}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"UpdateBankAccountState400Example": {
"summary": "Default UpdateBankAccountState 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": {
"UpdateBankAccountState401Example": {
"summary": "Default UpdateBankAccountState 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": {
"UpdateBankAccountState403Example": {
"summary": "Default UpdateBankAccountState 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": {
"UpdateBankAccountState500Example": {
"summary": "Default UpdateBankAccountState 500 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth2": [
"api"
]
}
],
"summary": "Flipdish Update Bank Account State",
"description": "Update Bank Account State via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/bankaccounts/{bankAccountId}/state/{state}).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/bankaccounts/{bankAccountId}/store/{storeId}": {
"post": {
"tags": [
"BankAccount"
],
"operationId": "AttachBankAccountToStore",
"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": "storeId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
},
"description": "The store id path parameter.",
"example": 500123
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"AttachBankAccountToStore400Example": {
"summary": "Default AttachBankAccountToStore 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": {
"AttachBankAccountToStore401Example": {
"summary": "Default AttachBankAccountToStore 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": {
"AttachBankAccountToStore403Example": {
"summary": "Default AttachBankAccountToStore 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": {
"AttachBankAccountToStore500Example": {
"summary": "Default AttachBankAccountToStore 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 Attach Bank Account to Store",
"description": "Attach Bank Account to Store via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/bankaccounts/{bankAccountId}/store/{storeId}).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/invoices/InvoicePdf": {
"get": {
"tags": [
"Invoices"
],
"operationId": "InvoicePdf",
"parameters": [
{
"name": "invoiceNumber",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "The invoice number query parameter.",
"example": "string"
},
{
"name": "appId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The app id path parameter.",
"example": "500123"
}
],
"responses": {
"200": {
"description": "OK"
},
"204": {
"description": "NoContent",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiErrorResult"
},
"examples": {
"InvoicePdf204Example": {
"summary": "Default InvoicePdf 204 response",
"x-microcks-default": true,
"value": {
"Message": "string",
"ErrorCode": 1,
"StackTrace": "string",
"Errors": []
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"InvoicePdf400Example": {
"summary": "Default InvoicePdf 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": {
"InvoicePdf401Example": {
"summary": "Default InvoicePdf 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": {
"InvoicePdf403Example": {
"summary": "Default InvoicePdf 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": {
"InvoicePdf500Example": {
"summary": "Default InvoicePdf 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 Invoice Pdf",
"description": "Invoice Pdf via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/invoices/InvoicePdf).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/invoices/ListInvoices": {
"get": {
"tags": [
"Invoices"
],
"operationId": "ListInvoices",
"parameters": [
{
"name": "storeId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
},
"description": "The store id query parameter.",
"example": 500123
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
},
"description": "The limit query parameter.",
"example": 1
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
},
"description": "The page query parameter.",
"example": 1
},
{
"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/RestApiFinanceSearchPaginationResult_Invoice_"
},
"examples": {
"ListInvoices200Example": {
"summary": "Default ListInvoices 200 response",
"x-microcks-default": true,
"value": {
"NextPage": "string",
"Limit": 1,
"TotalRecordCount": 12.5,
"Data": []
}
}
}
}
}
},
"204": {
"description": "NoContent",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiFinanceSearchPaginationResult_Invoice_"
},
"examples": {
"ListInvoices204Example": {
"summary": "Default ListInvoices 204 response",
"x-microcks-default": true,
"value": {
"NextPage": "string",
"Limit": 1,
"TotalRecordCount": 12.5,
"Data": []
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"ListInvoices400Example": {
"summary": "Default ListInvoices 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": {
"ListInvoices401Example": {
"summary": "Default ListInvoices 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": {
"ListInvoices403Example": {
"summary": "Default ListInvoices 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": {
"ListInvoices500Example": {
"summary": "Default ListInvoices 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 List Invoices",
"description": "List Invoices via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/invoices/ListInvoices).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/invoices": {
"get": {
"tags": [
"Invoices"
],
"operationId": "GetInvoices",
"parameters": [
{
"name": "appId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The app id path parameter.",
"example": "500123"
},
{
"name": "subscriptionId",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"description": "The subscription id query parameter.",
"example": "500123"
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
},
"description": "The limit query parameter.",
"example": 1
},
{
"name": "pageId",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"description": "The page id query parameter.",
"example": "500123"
},
{
"name": "excludeNotOwnedInvoices",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
},
"description": "The exclude not owned invoices query parameter.",
"example": true
},
{
"name": "dateFrom",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
},
"description": "The date from query parameter.",
"example": "2026-06-02T12:00:00Z"
},
{
"name": "dateTo",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
},
"description": "The date to query parameter.",
"example": "2026-06-02T12:00:00Z"
},
{
"name": "invoiceNumber",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"description": "The invoice number query parameter.",
"example": "string"
},
{
"name": "storeId",
"in": "query",
"required": false,
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"description": "The store id query parameter.",
"example": [
500123
]
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiFinanceSearchPaginationResult_SubscriptionInvoice_"
},
"examples": {
"GetInvoices200Example": {
"summary": "Default GetInvoices 200 response",
"x-microcks-default": true,
"value": {
"NextPage": "string",
"Limit": 1,
"TotalRecordCount": 12.5,
"Data": []
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetInvoices400Example": {
"summary": "Default GetInvoices 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": {
"GetInvoices401Example": {
"summary": "Default GetInvoices 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": {
"GetInvoices403Example": {
"summary": "Default GetInvoices 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": {
"GetInvoices500Example": {
"summary": "Default GetInvoices 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 Invoices",
"description": "Get Invoices via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/invoices).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/invoices/ListSubscriptionInvoices": {
"get": {
"tags": [
"Invoices"
],
"operationId": "ListSubscriptionInvoices",
"parameters": [
{
"name": "appId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The app id path parameter.",
"example": "500123"
},
{
"name": "subscriptionId",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"description": "The subscription id query parameter.",
"example": "500123"
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
},
"description": "The limit query parameter.",
"example": 1
},
{
"name": "pageId",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"description": "The page id query parameter.",
"example": "500123"
},
{
"name": "excludeNotOwnedInvoices",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
},
"description": "The exclude not owned invoices query parameter.",
"example": true
},
{
"name": "dateFrom",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
},
"description": "The date from query parameter.",
"example": "2026-06-02T12:00:00Z"
},
{
"name": "dateTo",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
},
"description": "The date to query parameter.",
"example": "2026-06-02T12:00:00Z"
},
{
"name": "invoiceNumber",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"description": "The invoice number query parameter.",
"example": "string"
},
{
"name": "storeId",
"in": "query",
"required": false,
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"description": "The store id query parameter.",
"example": [
500123
]
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiFinanceSearchPaginationResult_SubscriptionInvoice_"
},
"examples": {
"ListSubscriptionInvoices200Example": {
"summary": "Default ListSubscriptionInvoices 200 response",
"x-microcks-default": true,
"value": {
"NextPage": "string",
"Limit": 1,
"TotalRecordCount": 12.5,
"Data": []
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"ListSubscriptionInvoices400Example": {
"summary": "Default ListSubscriptionInvoices 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": {
"ListSubscriptionInvoices401Example": {
"summary": "Default ListSubscriptionInvoices 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": {
"ListSubscriptionInvoices403Example": {
"summary": "Default ListSubscriptionInvoices 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": {
"ListSubscriptionInvoices500Example": {
"summary": "Default ListSubscriptionInvoices 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 List Subscription Invoices",
"description": "List Subscription Invoices via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/invoices/ListSubscriptionInvoices).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/payment_intents/{paymentIntentId}": {
"get": {
"tags": [
"PaymentIntents"
],
"operationId": "GetPaymentIntent",
"parameters": [
{
"name": "paymentIntentId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The payment intent id path parameter.",
"example": "500123"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiResult_PaymentIntent_"
},
"examples": {
"GetPaymentIntent200Example": {
"summary": "Default GetPaymentIntent 200 response",
"x-microcks-default": true,
"value": {
"Data": {
"Id": "500123",
"Description": "string",
"Currency": "EUR",
"Status": "Active",
"Created": "2026-06-02T12:00:00Z",
"LastPaymentError": {
"Code": "string",
"DeclineCode": "string",
"Message": "string"
}
}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetPaymentIntent400Example": {
"summary": "Default GetPaymentIntent 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": {
"GetPaymentIntent401Example": {
"summary": "Default GetPaymentIntent 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": {
"GetPaymentIntent403Example": {
"summary": "Default GetPaymentIntent 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": {
"GetPaymentIntent500Example": {
"summary": "Default GetPaymentIntent 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 Payment Intent",
"description": "Get Payment Intent via the Flipdish Open API v1.0 (GET /api/v1.0/payment_intents/{paymentIntentId}).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/payments/payment/{orderId}/refundable": {
"get": {
"tags": [
"Payments"
],
"operationId": "GetOrderPaymentInformation",
"parameters": [
{
"name": "orderId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
},
"description": "The order id path parameter.",
"example": 500123
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiResult_OrderPaymentInformation_"
},
"examples": {
"GetOrderPaymentInformation200Example": {
"summary": "Default GetOrderPaymentInformation 200 response",
"x-microcks-default": true,
"value": {
"Data": {
"OrderId": 500123,
"PaymentRefundable": true
}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetOrderPaymentInformation400Example": {
"summary": "Default GetOrderPaymentInformation 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": {
"GetOrderPaymentInformation401Example": {
"summary": "Default GetOrderPaymentInformation 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": {
"GetOrderPaymentInformation403Example": {
"summary": "Default GetOrderPaymentInformation 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": {
"GetOrderPaymentInformation500Example": {
"summary": "Default GetOrderPaymentInformation 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 Order Payment Information",
"description": "Get Order Payment Information via the Flipdish Open API v1.0 (GET /api/v1.0/payments/payment/{orderId}/refundable).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/overview": {
"get": {
"tags": [
"PayoutReports"
],
"operationId": "GetPayoutReport3Overview",
"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/RestApiResult_PayoutReport3Overview_"
},
"examples": {
"GetPayoutReport3Overview200Example": {
"summary": "Default GetPayoutReport3Overview 200 response",
"x-microcks-default": true,
"value": {
"Data": {
"PayoutReport3OverviewHeader": {
"PayoutId": 500123,
"BankAccountId": 500123,
"IsManualPayout": true,
"AccountName": "Example Name",
"PayoutStatus": "Active",
"CreatedDate": "2026-06-02T12:00:00Z",
"PeriodStartTime": "2026-06-02T12:00:00Z",
"PeriodEndTime": "2026-06-02T12:00:00Z",
"DestinationBank": "string",
"DestinationAccount": "string",
"Amount": 12.5,
"Currency": "EUR",
"BankAccountHasChanged": true
},
"PayoutStores": []
}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetPayoutReport3Overview400Example": {
"summary": "Default GetPayoutReport3Overview 400 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetPayoutReport3Overview401Example": {
"summary": "Default GetPayoutReport3Overview 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": {
"GetPayoutReport3Overview403Example": {
"summary": "Default GetPayoutReport3Overview 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": {
"GetPayoutReport3Overview404Example": {
"summary": "Default GetPayoutReport3Overview 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": {
"GetPayoutReport3Overview500Example": {
"summary": "Default GetPayoutReport3Overview 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 Report3 Overview",
"description": "Get Payout Report3 Overview via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/overview).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/stores": {
"get": {
"tags": [
"PayoutReports"
],
"operationId": "GetPayoutReport3Stores",
"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": "stores",
"in": "query",
"required": false,
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"description": "The stores query parameter.",
"example": [
1
]
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiResult_PayoutReport3StorePayouts_"
},
"examples": {
"GetPayoutReport3Stores200Example": {
"summary": "Default GetPayoutReport3Stores 200 response",
"x-microcks-default": true,
"value": {
"Data": {
"Stores": []
}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetPayoutReport3Stores400Example": {
"summary": "Default GetPayoutReport3Stores 400 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetPayoutReport3Stores401Example": {
"summary": "Default GetPayoutReport3Stores 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": {
"GetPayoutReport3Stores403Example": {
"summary": "Default GetPayoutReport3Stores 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": {
"GetPayoutReport3Stores404Example": {
"summary": "Default GetPayoutReport3Stores 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": {
"GetPayoutReport3Stores500Example": {
"summary": "Default GetPayoutReport3Stores 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 Report3 Stores",
"description": "Get Payout Report3 Stores via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/stores).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/export/orders": {
"get": {
"tags": [
"PayoutReports"
],
"operationId": "PayoutReport3ExportPayoutOrders",
"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": "stores",
"in": "query",
"required": false,
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"description": "The stores query parameter.",
"example": [
1
]
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiResult_FileCreationResult_"
},
"examples": {
"PayoutReport3ExportPayoutOrders200Example": {
"summary": "Default PayoutReport3ExportPayoutOrders 200 response",
"x-microcks-default": true,
"value": {
"Data": {
"FileId": "500123",
"Location": "string"
}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"PayoutReport3ExportPayoutOrders400Example": {
"summary": "Default PayoutReport3ExportPayoutOrders 400 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"PayoutReport3ExportPayoutOrders401Example": {
"summary": "Default PayoutReport3ExportPayoutOrders 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": {
"PayoutReport3ExportPayoutOrders403Example": {
"summary": "Default PayoutReport3ExportPayoutOrders 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": {
"PayoutReport3ExportPayoutOrders404Example": {
"summary": "Default PayoutReport3ExportPayoutOrders 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": {
"PayoutReport3ExportPayoutOrders500Example": {
"summary": "Default PayoutReport3ExportPayoutOrders 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 Payout Report3 Export Payout Orders",
"description": "Payout Report3 Export Payout Orders via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/export/orders).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/export/stores": {
"get": {
"tags": [
"PayoutReports"
],
"operationId": "PayoutReport3ExportPayoutStores",
"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": "stores",
"in": "query",
"required": false,
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"description": "The stores query parameter.",
"example": [
1
]
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiResult_FileCreationResult_"
},
"examples": {
"PayoutReport3ExportPayoutStores200Example": {
"summary": "Default PayoutReport3ExportPayoutStores 200 response",
"x-microcks-default": true,
"value": {
"Data": {
"FileId": "500123",
"Location": "string"
}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"PayoutReport3ExportPayoutStores400Example": {
"summary": "Default PayoutReport3ExportPayoutStores 400 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"PayoutReport3ExportPayoutStores401Example": {
"summary": "Default PayoutReport3ExportPayoutStores 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": {
"PayoutReport3ExportPayoutStores403Example": {
"summary": "Default PayoutReport3ExportPayoutStores 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": {
"PayoutReport3ExportPayoutStores404Example": {
"summary": "Default PayoutReport3ExportPayoutStores 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": {
"PayoutReport3ExportPayoutStores500Example": {
"summary": "Default PayoutReport3ExportPayoutStores 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 Payout Report3 Export Payout Stores",
"description": "Payout Report3 Export Payout Stores via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/export/stores).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/details": {
"get": {
"tags": [
"PayoutReports"
],
"operationId": "GetPayoutReport3Details",
"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": "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/RestApiResult_PayoutReport3Details_"
},
"examples": {
"GetPayoutReport3Details200Example": {
"summary": "Default GetPayoutReport3Details 200 response",
"x-microcks-default": true,
"value": {
"Data": {
"Amount": 12.5,
"Currency": "EUR",
"Summary": {
"Revenue": 1.0,
"RevenueOfWhichCash": 1.0,
"UnpaidRevenue": 1.0,
"RevenueForFeeCalculations": 12.5,
"FlipdishFees": 12.5,
"Adjustments": 1.0,
"ThirdPartyIntegrationFeesAndTips": 12.5,
"Total": 12.5
},
"Revenue": {
"GrossSales": {},
"SalesTax": {},
"DeliveryCharges": {},
"OtherCharges": {},
"Tips": {},
"TotalRevenue": {},
"RevenueForFeeCalculations": {},
"DrsCharges": {}
},
"FlipdishFees": {
"WebAndAppCash": 1.0,
"WebAndAppCashRevenueIncludingTips": 1.0,
"WebAndAppCard": 1.0,
"WebAndAppCardRevenueIncludingTips": 1.0,
"KioskCash": 1.0,
"KioskCashRevenue": 1.0,
"KioskCard": 1.0,
"KioskCardRevenue": 1.0,
"QropCash": 1.0,
"QropCashRevenue": 1.0,
"QropCard": 1.0,
"QropCardRevenue": 1.0,
"PosCard": 1.0,
"PosCardRevenue": 1.0,
"PosCardOnFlipdishOrders": 1.0,
"OtherIntegrationFees": 12.5,
"OtherIntegrationFeesExcludingVat": 12.5,
"OtherIntegrationFeesVatAmount": 12.5,
"OtherIntegrationTips": 1.0,
"RefundedFeesOnRefundedSales": 12.5,
"Vat": 1.0,
"RefundedFeesOnPosSales": 12.5,
"Total": 12.5,
"ThirdPartyIntegrationFeesAndTips": 12.5,
"WebAndAppCardOnXOrders": 1,
"WebAndAppCashOnXOrders": 1,
"KioskCardOnXOrders": 1,
"KioskCashOnXOrders": 1,
"QropCardOnXOrders": 1,
"QropCashOnXOrders": 1,
"PosCardOnXOrders": 1
},
"Adjustments": {
"OpeningBalanceDate": "2026-06-02T12:00:00Z",
"ClosingBalanceDate": "2026-06-02T12:00:00Z",
"OpeningBalance": 1.0,
"RefundsOnCardOrders": 1.0,
"RefundsOnCashOrders": 1.0,
"CashCustomerFees": 12.5,
"Chargebacks": 1.0,
"OtherTransactions": 1.0,
"ClosingBalance": 1.0,
"BalanceRepaid": 500123,
"RefundsOnCardOrdersBracketsAmount": 12.5,
"RefundsOnCardOrdersBracketsOutOfAmount": 12.5,
"RefundsOnCashOrdersBracketsAmount": 12.5,
"RefundsOnCashOrdersBracketsOutOfAmount": 12.5,
"CashCustomerFeesBracketsAmount": 12.5,
"CashCustomerFeesBracketsOutOfAmount": 12.5,
"BalanceChange": 1.0,
"PreviousPayoutId": 500123,
"NextPayoutId": 500123,
"RefundedFeesOnChargebacks": 12.5,
"TotalChargebackCost": 12.5
}
}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetPayoutReport3Details400Example": {
"summary": "Default GetPayoutReport3Details 400 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetPayoutReport3Details401Example": {
"summary": "Default GetPayoutReport3Details 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": {
"GetPayoutReport3Details403Example": {
"summary": "Default GetPayoutReport3Details 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": {
"GetPayoutReport3Details404Example": {
"summary": "Default GetPayoutReport3Details 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": {
"GetPayoutReport3Details500Example": {
"summary": "Default GetPayoutReport3Details 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 Report3 Details",
"description": "Get Payout Report3 Details via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/details).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/export/possales": {
"get": {
"tags": [
"PayoutReports"
],
"operationId": "PayoutReport3ExportPayoutPosSales",
"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": "stores",
"in": "query",
"required": false,
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"description": "The stores query parameter.",
"example": [
1
]
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiResult_FileCreationResult_"
},
"examples": {
"PayoutReport3ExportPayoutPosSales200Example": {
"summary": "Default PayoutReport3ExportPayoutPosSales 200 response",
"x-microcks-default": true,
"value": {
"Data": {
"FileId": "500123",
"Location": "string"
}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"PayoutReport3ExportPayoutPosSales400Example": {
"summary": "Default PayoutReport3ExportPayoutPosSales 400 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"PayoutReport3ExportPayoutPosSales401Example": {
"summary": "Default PayoutReport3ExportPayoutPosSales 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": {
"PayoutReport3ExportPayoutPosSales403Example": {
"summary": "Default PayoutReport3ExportPayoutPosSales 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": {
"PayoutReport3ExportPayoutPosSales404Example": {
"summary": "Default PayoutReport3ExportPayoutPosSales 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": {
"PayoutReport3ExportPayoutPosSales500Example": {
"summary": "Default PayoutReport3ExportPayoutPosSales 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 Payout Report3 Export Payout Pos Sales",
"description": "Payout Report3 Export Payout Pos Sales via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/export/possales).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/export/chargebacks": {
"get": {
"tags": [
"PayoutReports"
],
"operationId": "PayoutReport3ExportPayoutChargebacks",
"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": "stores",
"in": "query",
"required": false,
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"description": "The stores query parameter.",
"example": [
1
]
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiResult_FileCreationResult_"
},
"examples": {
"PayoutReport3ExportPayoutChargebacks200Example": {
"summary": "Default PayoutReport3ExportPayoutChargebacks 200 response",
"x-microcks-default": true,
"value": {
"Data": {
"FileId": "500123",
"Location": "string"
}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"PayoutReport3ExportPayoutChargebacks400Example": {
"summary": "Default PayoutReport3ExportPayoutChargebacks 400 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"PayoutReport3ExportPayoutChargebacks401Example": {
"summary": "Default PayoutReport3ExportPayoutChargebacks 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": {
"PayoutReport3ExportPayoutChargebacks403Example": {
"summary": "Default PayoutReport3ExportPayoutChargebacks 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": {
"PayoutReport3ExportPayoutChargebacks404Example": {
"summary": "Default PayoutReport3ExportPayoutChargebacks 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": {
"PayoutReport3ExportPayoutChargebacks500Example": {
"summary": "Default PayoutReport3ExportPayoutChargebacks 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 Payout Report3 Export Payout Chargebacks",
"description": "Payout Report3 Export Payout Chargebacks via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/export/chargebacks).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/export/refundedOrders": {
"get": {
"tags": [
"PayoutReports"
],
"operationId": "PayoutReport3ExportPayoutRefundedOrders",
"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": "stores",
"in": "query",
"required": false,
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"description": "The stores query parameter.",
"example": [
1
]
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiResult_FileCreationResult_"
},
"examples": {
"PayoutReport3ExportPayoutRefundedOrders200Example": {
"summary": "Default PayoutReport3ExportPayoutRefundedOrders 200 response",
"x-microcks-default": true,
"value": {
"Data": {
"FileId": "500123",
"Location": "string"
}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"PayoutReport3ExportPayoutRefundedOrders400Example": {
"summary": "Default PayoutReport3ExportPayoutRefundedOrders 400 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"PayoutReport3ExportPayoutRefundedOrders401Example": {
"summary": "Default PayoutReport3ExportPayoutRefundedOrders 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": {
"PayoutReport3ExportPayoutRefundedOrders403Example": {
"summary": "Default PayoutReport3ExportPayoutRefundedOrders 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": {
"PayoutReport3ExportPayoutRefundedOrders404Example": {
"summary": "Default PayoutReport3ExportPayoutRefundedOrders 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": {
"PayoutReport3ExportPayoutRefundedOrders500Example": {
"summary": "Default PayoutReport3ExportPayoutRefundedOrders 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 Payout Report3 Export Payout Refunded Orders",
"description": "Payout Report3 Export Payout Refunded Orders via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/export/refundedOrders).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/refundedOrders": {
"get": {
"tags": [
"PayoutReports"
],
"operationId": "GetPayoutReport3RefundedOrders",
"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": "storeIds",
"in": "query",
"required": false,
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"description": "The store ids query parameter.",
"example": [
1
]
},
{
"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
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiPaginationResult_PayoutReport3RefundedOrder_"
},
"examples": {
"GetPayoutReport3RefundedOrders200Example": {
"summary": "Default GetPayoutReport3RefundedOrders 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": {
"GetPayoutReport3RefundedOrders400Example": {
"summary": "Default GetPayoutReport3RefundedOrders 400 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetPayoutReport3RefundedOrders401Example": {
"summary": "Default GetPayoutReport3RefundedOrders 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": {
"GetPayoutReport3RefundedOrders403Example": {
"summary": "Default GetPayoutReport3RefundedOrders 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": {
"GetPayoutReport3RefundedOrders404Example": {
"summary": "Default GetPayoutReport3RefundedOrders 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": {
"GetPayoutReport3RefundedOrders500Example": {
"summary": "Default GetPayoutReport3RefundedOrders 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 Report3 Refunded Orders",
"description": "Get Payout Report3 Refunded Orders via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/refundedOrders).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/properties": {
"get": {
"tags": [
"PayoutReports"
],
"operationId": "GetPayoutReport3PropertyDetails",
"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": "propertyIds",
"in": "query",
"required": false,
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "The property ids query parameter.",
"example": [
"string"
]
},
{
"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/RestApiResult_PayoutReport3PropertyDetails_"
},
"examples": {
"GetPayoutReport3PropertyDetails200Example": {
"summary": "Default GetPayoutReport3PropertyDetails 200 response",
"x-microcks-default": true,
"value": {
"Data": {
"AvailableProperties": [],
"SelectedPropertyIds": [
"string"
],
"MatchedStoreIds": [
1
],
"Details": {
"Amount": 12.5,
"Currency": "EUR",
"Summary": {},
"Revenue": {},
"FlipdishFees": {},
"Adjustments": {}
}
}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetPayoutReport3PropertyDetails400Example": {
"summary": "Default GetPayoutReport3PropertyDetails 400 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetPayoutReport3PropertyDetails401Example": {
"summary": "Default GetPayoutReport3PropertyDetails 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": {
"GetPayoutReport3PropertyDetails403Example": {
"summary": "Default GetPayoutReport3PropertyDetails 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": {
"GetPayoutReport3PropertyDetails404Example": {
"summary": "Default GetPayoutReport3PropertyDetails 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": {
"GetPayoutReport3PropertyDetails500Example": {
"summary": "Default GetPayoutReport3PropertyDetails 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 Report3 Property Details",
"description": "Get Payout Report3 Property Details via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/properties).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/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 GetPayoutOtherCharges 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": {
"GetPayoutOtherCharges500Example": {
"summary": "Default GetPayoutOtherCharges 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 Other Charges",
"description": "Get Payout Other Charges via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/othercharges).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/payouts/export": {
"get": {
"tags": [
"PayoutsExport"
],
"operationId": "ExportPayouts",
"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": {
"type": "string"
},
"examples": {
"ExportPayouts200Example": {
"summary": "Default ExportPayouts 200 response",
"x-microcks-default": true,
"value": "string"
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"ExportPayouts400Example": {
"summary": "Default ExportPayouts 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": {
"ExportPayouts401Example": {
"summary": "Default ExportPayouts 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": {
"ExportPayouts403Example": {
"summary": "Default ExportPayouts 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": {
"ExportPayouts500Example": {
"summary": "Default ExportPayouts 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 Export Payouts",
"description": "Export Payouts via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/payouts/export).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/export": {
"get": {
"tags": [
"PayoutsExport"
],
"operationId": "ExportPayoutStores",
"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": "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": {
"type": "string"
},
"examples": {
"ExportPayoutStores200Example": {
"summary": "Default ExportPayoutStores 200 response",
"x-microcks-default": true,
"value": "string"
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"ExportPayoutStores400Example": {
"summary": "Default ExportPayoutStores 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": {
"ExportPayoutStores401Example": {
"summary": "Default ExportPayoutStores 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": {
"ExportPayoutStores403Example": {
"summary": "Default ExportPayoutStores 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": {
"ExportPayoutStores500Example": {
"summary": "Default ExportPayoutStores 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 Export Payout Stores",
"description": "Export Payout Stores via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/export).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/orders/export": {
"get": {
"tags": [
"PayoutsExport"
],
"operationId": "ExportPayoutOrders",
"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": "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": {
"type": "string"
},
"examples": {
"ExportPayoutOrders200Example": {
"summary": "Default ExportPayoutOrders 200 response",
"x-microcks-default": true,
"value": "string"
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"ExportPayoutOrders400Example": {
"summary": "Default ExportPayoutOrders 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": {
"ExportPayoutOrders401Example": {
"summary": "Default ExportPayoutOrders 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": {
"ExportPayoutOrders403Example": {
"summary": "Default ExportPayoutOrders 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": {
"ExportPayoutOrders500Example": {
"summary": "Default ExportPayoutOrders 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 Export Payout Orders",
"description": "Export Payout Orders via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/orders/export).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/refunds/export": {
"get": {
"tags": [
"PayoutsExport"
],
"operationId": "ExportPayoutRefunds",
"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": "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": {
"type": "string"
},
"examples": {
"ExportPayoutRefunds200Example": {
"summary": "Default ExportPayoutRefunds 200 response",
"x-microcks-default": true,
"value": "string"
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"ExportPayoutRefunds400Example": {
"summary": "Default ExportPayoutRefunds 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": {
"ExportPayoutRefunds401Example": {
"summary": "Default ExportPayoutRefunds 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": {
"ExportPayoutRefunds403Example": {
"summary": "Default ExportPayoutRefunds 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": {
"ExportPayoutRefunds500Example": {
"summary": "Default ExportPayoutRefunds 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 Export Payout Refunds",
"description": "Export Payout Refunds via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/refunds/export).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/chargebacks/export": {
"get": {
"tags": [
"PayoutsExport"
],
"operationId": "ExportPayoutChargebacks",
"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": "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": {
"type": "string"
},
"examples": {
"ExportPayoutChargebacks200Example": {
"summary": "Default ExportPayoutChargebacks 200 response",
"x-microcks-default": true,
"value": "string"
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"ExportPayoutChargebacks400Example": {
"summary": "Default ExportPayoutChargebacks 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": {
"ExportPayoutChargebacks401Example": {
"summary": "Default ExportPayoutChargebacks 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": {
"ExportPayoutChargebacks403Example": {
"summary": "Default ExportPayoutChargebacks 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": {
"ExportPayoutChargebacks500Example": {
"summary": "Default ExportPayoutChargebacks 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 Export Payout Chargebacks",
"description": "Export Payout Chargebacks via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/chargebacks/export).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/othercharges/export": {
"get": {
"tags": [
"PayoutsExport"
],
"operationId": "ExportPayoutOtherCharges",
"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": "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": {
"type": "string"
},
"examples": {
"ExportPayoutOtherCharges200Example": {
"summary": "Default ExportPayoutOtherCharges 200 response",
"x-microcks-default": true,
"value": "string"
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"ExportPayoutOtherCharges400Example": {
"summary": "Default ExportPayoutOtherCharges 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": {
"ExportPayoutOtherCharges401Example": {
"summary": "Default ExportPayoutOtherCharges 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": {
"ExportPayoutOtherCharges403Example": {
"summary": "Default ExportPayoutOtherCharges 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": {
"ExportPayoutOtherCharges500Example": {
"summary": "Default ExportPayoutOtherCharges 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 Export Payout Other Charges",
"description": "Export Payout Other Charges via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/othercharges/export).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/processingfeeconfigs": {
"get": {
"tags": [
"ProcessingFeeConfigs"
],
"operationId": "GetProcessingFeeConfigsByStoreIds",
"parameters": [
{
"name": "storeIds",
"in": "query",
"required": true,
"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/RestApiArrayResult_ProcessingFeeConfig_"
},
"examples": {
"GetProcessingFeeConfigsByStoreIds200Example": {
"summary": "Default GetProcessingFeeConfigsByStoreIds 200 response",
"x-microcks-default": true,
"value": {
"Data": []
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetProcessingFeeConfigsByStoreIds400Example": {
"summary": "Default GetProcessingFeeConfigsByStoreIds 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": {
"GetProcessingFeeConfigsByStoreIds401Example": {
"summary": "Default GetProcessingFeeConfigsByStoreIds 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": {
"GetProcessingFeeConfigsByStoreIds403Example": {
"summary": "Default GetProcessingFeeConfigsByStoreIds 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": {
"GetProcessingFeeConfigsByStoreIds500Example": {
"summary": "Default GetProcessingFeeConfigsByStoreIds 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 Processing Fee Configs by Store Ids",
"description": "Get Processing Fee Configs by Store Ids via the Flipdish Open API v1.0 (GET /api/v1.0/processingfeeconfigs).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/receipts/{orderId}": {
"get": {
"tags": [
"Receipts"
],
"operationId": "GetReceipt",
"parameters": [
{
"name": "orderId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
},
"description": "The order id path parameter.",
"example": 500123
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetReceiptByOrderIdQueryResponse"
},
"examples": {
"GetReceipt200Example": {
"summary": "Default GetReceipt 200 response",
"x-microcks-default": true,
"value": {
"PreviousOrder": {
"DeliveryType": "string",
"DeliveryLocationAddressString": "string",
"PaymentAccountType": "string",
"OrderId": 500123,
"ReceiptCode": "string",
"RestaurantName": "Example Name",
"LocalOrderId": "500123",
"TableServiceCategory": "string",
"PickupLocationOptionValue": "string",
"CustomerName": "Example Name",
"PhoneNumberInternationalFormatString": "+353000000000",
"DeliveryInstructions": "string",
"Currency": "EUR",
"ProcessingFee": 12.5,
"ServiceChargePercentage": 1.0,
"ServiceChargeAmount": 12.5,
"TipAmount": 12.5,
"DeliveryAmount": 12.5,
"DepositReturnFeeAmount": 12.5,
"TotalTax": 12.5,
"TotalAmount": 12.5,
"Items": [],
"TaxRates": [],
"WhiteLabelId": 500123
},
"DepositReturnFeesSummary": [],
"TsRequestedForLocal": "2026-06-02T12:00:00Z",
"TsOrderPlacedLocal": "2026-06-02T12:00:00Z",
"LogoUrl": "https://api.flipdish.co/example",
"Address": "string",
"VatNumber": "string",
"PaymentMethodDescription": "string",
"OrgId": "500123",
"CountryCode": "IE"
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetReceipt400Example": {
"summary": "Default GetReceipt 400 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetReceipt401Example": {
"summary": "Default GetReceipt 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": {
"GetReceipt403Example": {
"summary": "Default GetReceipt 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": {
"GetReceipt404Example": {
"summary": "Default GetReceipt 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": {
"GetReceipt500Example": {
"summary": "Default GetReceipt 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 Receipt",
"description": "Get Receipt via the Flipdish Open API v1.0 (GET /api/v1.0/receipts/{orderId}).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/customconnect/{storeId}": {
"get": {
"tags": [
"StripeCustomConnect"
],
"operationId": "GetCustomConnect",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
},
"description": "The store id path parameter.",
"example": 500123
},
{
"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_StripeCustomConnectedAccount_"
},
"examples": {
"GetCustomConnect200Example": {
"summary": "Default GetCustomConnect 200 response",
"x-microcks-default": true,
"value": {
"Data": []
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetCustomConnect400Example": {
"summary": "Default GetCustomConnect 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": {
"GetCustomConnect401Example": {
"summary": "Default GetCustomConnect 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": {
"GetCustomConnect403Example": {
"summary": "Default GetCustomConnect 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": {
"GetCustomConnect500Example": {
"summary": "Default GetCustomConnect 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 Custom Connect",
"description": "Get Custom Connect via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/customconnect/{storeId}).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/customconnect/refresh-link": {
"get": {
"tags": [
"StripeCustomConnect"
],
"operationId": "StripeCustomConnect_Refresh",
"parameters": [
{
"name": "linkRequestId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
},
"description": "The link request id query parameter.",
"example": 500123
},
{
"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": {
"type": "object"
},
"examples": {
"StripeCustomConnect_Refresh200Example": {
"summary": "Default StripeCustomConnect_Refresh 200 response",
"x-microcks-default": true,
"value": {}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"StripeCustomConnect_Refresh400Example": {
"summary": "Default StripeCustomConnect_Refresh 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": {
"StripeCustomConnect_Refresh401Example": {
"summary": "Default StripeCustomConnect_Refresh 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": {
"StripeCustomConnect_Refresh403Example": {
"summary": "Default StripeCustomConnect_Refresh 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": {
"StripeCustomConnect_Refresh500Example": {
"summary": "Default StripeCustomConnect_Refresh 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 Stripe Custom Connect_Refresh",
"description": "Stripe Custom Connect_Refresh via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/customconnect/refresh-link).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/customconnect/verification-status": {
"get": {
"tags": [
"StripeCustomConnect"
],
"operationId": "GetVerificationStatus",
"parameters": [
{
"name": "appId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The app id path parameter.",
"example": "500123"
},
{
"name": "stripeConnectedAccountId",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "The stripe connected account id query parameter.",
"example": "500123"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiResult_StripeConnectedAccount_"
},
"examples": {
"GetVerificationStatus200Example": {
"summary": "Default GetVerificationStatus 200 response",
"x-microcks-default": true,
"value": {
"Data": {
"FlipdishConnectedAccountId": 500123,
"StripeId": "500123",
"WhitelabelConfigId": 500123,
"CardPaymentsStatus": "Inactive",
"TransfersStatus": "Inactive",
"AccountStatus": "Disabled",
"PayoutsEnabled": true,
"PaymentsEnabled": true
}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetVerificationStatus400Example": {
"summary": "Default GetVerificationStatus 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": {
"GetVerificationStatus401Example": {
"summary": "Default GetVerificationStatus 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": {
"GetVerificationStatus403Example": {
"summary": "Default GetVerificationStatus 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": {
"GetVerificationStatus500Example": {
"summary": "Default GetVerificationStatus 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 Verification Status",
"description": "Get Verification Status via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/customconnect/verification-status).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/customconnect/bank-account": {
"post": {
"tags": [
"StripeCustomConnect"
],
"operationId": "CreateBankAccountAndConnectedAccount",
"parameters": [
{
"name": "appId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The app id path parameter.",
"example": "500123"
}
],
"requestBody": {
"required": false,
"content": {}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiResult_BankAccountDetail_"
},
"examples": {
"CreateBankAccountAndConnectedAccount200Example": {
"summary": "Default CreateBankAccountAndConnectedAccount 200 response",
"x-microcks-default": true,
"value": {
"Data": {
"Id": 500123,
"StoreNames": [
"Example Name"
],
"AccountState": "Unverified",
"StripeConnectedAccountInfo": {
"AccountStatus": "Disabled",
"StripeId": "500123",
"CardPaymentStatus": "Inactive",
"PayoutScheduleInterval": "Manual",
"PayoutsEnabled": true,
"PayoutsPaused": true,
"PaymentsEnabled": true
},
"BankAddress": "string",
"BankCountryCode": "IE",
"AccountHolderAddress": "string",
"AccountHolderCountryCode": "IE",
"VatNumber": "string",
"CurrencyCode": "EUR",
"StoreIds": [
1
],
"BankName": "Example Name",
"AccountName": "Example Name",
"Iban": "string",
"Swift": "string",
"NationalClearingCode": "string",
"PopulatedAccountFields": [],
"RejectionReason": "string",
"BusinessType": "Individual"
}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"CreateBankAccountAndConnectedAccount400Example": {
"summary": "Default CreateBankAccountAndConnectedAccount 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": {
"CreateBankAccountAndConnectedAccount401Example": {
"summary": "Default CreateBankAccountAndConnectedAccount 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": {
"CreateBankAccountAndConnectedAccount403Example": {
"summary": "Default CreateBankAccountAndConnectedAccount 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": {
"CreateBankAccountAndConnectedAccount500Example": {
"summary": "Default CreateBankAccountAndConnectedAccount 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 Create Bank Account and Connected Account",
"description": "Create Bank Account and Connected Account via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/customconnect/bank-account).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/customconnect/{bankAccountId}/create-update-account": {
"post": {
"tags": [
"StripeCustomConnect"
],
"operationId": "CreateStripeConnectedAccount",
"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
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiResult_StripeConnectedAccount_"
},
"examples": {
"CreateStripeConnectedAccount200Example": {
"summary": "Default CreateStripeConnectedAccount 200 response",
"x-microcks-default": true,
"value": {
"Data": {
"FlipdishConnectedAccountId": 500123,
"StripeId": "500123",
"WhitelabelConfigId": 500123,
"CardPaymentsStatus": "Inactive",
"TransfersStatus": "Inactive",
"AccountStatus": "Disabled",
"PayoutsEnabled": true,
"PaymentsEnabled": true
}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"CreateStripeConnectedAccount400Example": {
"summary": "Default CreateStripeConnectedAccount 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": {
"CreateStripeConnectedAccount401Example": {
"summary": "Default CreateStripeConnectedAccount 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": {
"CreateStripeConnectedAccount403Example": {
"summary": "Default CreateStripeConnectedAccount 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": {
"CreateStripeConnectedAccount500Example": {
"summary": "Default CreateStripeConnectedAccount 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 Create Stripe Connected Account",
"description": "Create Stripe Connected Account via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/customconnect/{bankAccountId}/create-update-account).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/customconnect/bank-account/{bankAccountId}/businesstype": {
"post": {
"tags": [
"StripeCustomConnect"
],
"operationId": "SetBankAccountBusinessType",
"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
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"enum": [
"Individual",
"Company",
"NonProfit",
"GovernmentEntity"
],
"type": "string"
},
"examples": {
"SetBankAccountBusinessTypeRequestExample": {
"summary": "Default SetBankAccountBusinessType request",
"x-microcks-default": true,
"value": "Individual"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiResult_BankAccountDetail_"
},
"examples": {
"SetBankAccountBusinessType200Example": {
"summary": "Default SetBankAccountBusinessType 200 response",
"x-microcks-default": true,
"value": {
"Data": {
"Id": 500123,
"StoreNames": [
"Example Name"
],
"AccountState": "Unverified",
"StripeConnectedAccountInfo": {
"AccountStatus": "Disabled",
"StripeId": "500123",
"CardPaymentStatus": "Inactive",
"PayoutScheduleInterval": "Manual",
"PayoutsEnabled": true,
"PayoutsPaused": true,
"PaymentsEnabled": true
},
"BankAddress": "string",
"BankCountryCode": "IE",
"AccountHolderAddress": "string",
"AccountHolderCountryCode": "IE",
"VatNumber": "string",
"CurrencyCode": "EUR",
"StoreIds": [
1
],
"BankName": "Example Name",
"AccountName": "Example Name",
"Iban": "string",
"Swift": "string",
"NationalClearingCode": "string",
"PopulatedAccountFields": [],
"RejectionReason": "string",
"BusinessType": "Individual"
}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"SetBankAccountBusinessType400Example": {
"summary": "Default SetBankAccountBusinessType 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": {
"SetBankAccountBusinessType401Example": {
"summary": "Default SetBankAccountBusinessType 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": {
"SetBankAccountBusinessType403Example": {
"summary": "Default SetBankAccountBusinessType 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": {
"SetBankAccountBusinessType500Example": {
"summary": "Default SetBankAccountBusinessType 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 Set Bank Account Business Type",
"description": "Set Bank Account Business Type via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/customconnect/bank-account/{bankAccountId}/businesstype).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/customconnect/{bankAccountId}/update-bank-account-details": {
"post": {
"tags": [
"StripeCustomConnect"
],
"operationId": "UpdateBankAccountDetails",
"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
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BankAccountDetailsUpdateRequest"
},
"examples": {
"UpdateBankAccountDetailsRequestExample": {
"summary": "Default UpdateBankAccountDetails request",
"x-microcks-default": true,
"value": {
"BankAddress": "string",
"AccountHolderAddress": "string",
"VatNumber": "string",
"StoreIds": [
1
],
"BankName": "Example Name",
"AccountName": "Example Name",
"Iban": "string",
"Swift": "string",
"NationalClearingCode": "string",
"PopulatedAccountFields": [],
"RejectionReason": "string",
"BusinessType": "Individual"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiResult_StripeConnectedAccount_"
},
"examples": {
"UpdateBankAccountDetails200Example": {
"summary": "Default UpdateBankAccountDetails 200 response",
"x-microcks-default": true,
"value": {
"Data": {
"FlipdishConnectedAccountId": 500123,
"StripeId": "500123",
"WhitelabelConfigId": 500123,
"CardPaymentsStatus": "Inactive",
"TransfersStatus": "Inactive",
"AccountStatus": "Disabled",
"PayoutsEnabled": true,
"PaymentsEnabled": true
}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"UpdateBankAccountDetails400Example": {
"summary": "Default UpdateBankAccountDetails 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": {
"UpdateBankAccountDetails401Example": {
"summary": "Default UpdateBankAccountDetails 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": {
"UpdateBankAccountDetails403Example": {
"summary": "Default UpdateBankAccountDetails 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": {
"UpdateBankAccountDetails500Example": {
"summary": "Default UpdateBankAccountDetails 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 Bank Account Details",
"description": "Update Bank Account Details via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/customconnect/{bankAccountId}/update-bank-account-details).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/customconnect/{stripeConnectedAccountId}/create-account-link": {
"post": {
"tags": [
"StripeCustomConnect"
],
"operationId": "CreateStripeConnectedAccountLink",
"parameters": [
{
"name": "appId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The app id path parameter.",
"example": "500123"
},
{
"name": "stripeConnectedAccountId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The stripe connected account id path parameter.",
"example": "500123"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StripeAccountLinkRequest"
},
"examples": {
"CreateStripeConnectedAccountLinkRequestExample": {
"summary": "Default CreateStripeConnectedAccountLink request",
"x-microcks-default": true,
"value": {
"StripeId": "500123",
"ReturnUrl": "https://api.flipdish.co/example",
"Collect": "CurrentlyDue",
"Type": "Onboarding"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiResult_StripeConnectedAccount_"
},
"examples": {
"CreateStripeConnectedAccountLink200Example": {
"summary": "Default CreateStripeConnectedAccountLink 200 response",
"x-microcks-default": true,
"value": {
"Data": {
"FlipdishConnectedAccountId": 500123,
"StripeId": "500123",
"WhitelabelConfigId": 500123,
"CardPaymentsStatus": "Inactive",
"TransfersStatus": "Inactive",
"AccountStatus": "Disabled",
"PayoutsEnabled": true,
"PaymentsEnabled": true
}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"CreateStripeConnectedAccountLink400Example": {
"summary": "Default CreateStripeConnectedAccountLink 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": {
"CreateStripeConnectedAccountLink401Example": {
"summary": "Default CreateStripeConnectedAccountLink 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": {
"CreateStripeConnectedAccountLink403Example": {
"summary": "Default CreateStripeConnectedAccountLink 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": {
"CreateStripeConnectedAccountLink500Example": {
"summary": "Default CreateStripeConnectedAccountLink 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 Create Stripe Connected Account Link",
"description": "Create Stripe Connected Account Link via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/customconnect/{stripeConnectedAccountId}/create-account-link).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/customconnect/update-payout-schedule/{stripeConnectedAccountId}/{interval}": {
"post": {
"tags": [
"StripeCustomConnect"
],
"operationId": "UpdatePayoutSchedule",
"parameters": [
{
"name": "appId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The app id path parameter.",
"example": "500123"
},
{
"name": "stripeConnectedAccountId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The stripe connected account id path parameter.",
"example": "500123"
},
{
"name": "interval",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The interval path parameter.",
"example": "string"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiResult_ModelBase_"
},
"examples": {
"UpdatePayoutSchedule200Example": {
"summary": "Default UpdatePayoutSchedule 200 response",
"x-microcks-default": true,
"value": {
"Data": {}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"UpdatePayoutSchedule400Example": {
"summary": "Default UpdatePayoutSchedule 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": {
"UpdatePayoutSchedule401Example": {
"summary": "Default UpdatePayoutSchedule 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": {
"UpdatePayoutSchedule403Example": {
"summary": "Default UpdatePayoutSchedule 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": {
"UpdatePayoutSchedule500Example": {
"summary": "Default UpdatePayoutSchedule 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 Payout Schedule",
"description": "Update Payout Schedule via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/customconnect/update-payout-schedule/{stripeConnectedAccountId}/{interval}).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/subscriptions/{subscriptionId}": {
"get": {
"tags": [
"Subscriptions"
],
"operationId": "GetSubscriptionById",
"parameters": [
{
"name": "appId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The app id path parameter.",
"example": "500123"
},
{
"name": "subscriptionId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The subscription id path parameter.",
"example": "500123"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiResult_Subscription_"
},
"examples": {
"GetSubscriptionById200Example": {
"summary": "Default GetSubscriptionById 200 response",
"x-microcks-default": true,
"value": {
"Data": {
"Products": [],
"NextInvoiceAmount": 12.5,
"NextInvoiceBillingDate": "2026-06-02T12:00:00Z",
"UpcomingInvoiceItems": [],
"UpcomingInvoiceDiscounts": [],
"UpcomingInvoice": {
"Amount": 12.5,
"NextBillingDate": "2026-06-02T12:00:00Z",
"Subtotal": 12.5,
"TotalExcludingTax": 12.5,
"AmountDue": 12.5,
"Tax": 1.0,
"Items": [],
"Discounts": []
},
"SubscriptionId": "500123",
"Name": "Example Name",
"Status": "Incomplete",
"Currency": "EUR",
"User": "string",
"DefaultPaymentDescription": "string",
"CancellationRequestDate": "2026-06-02T12:00:00Z",
"CancellationDate": "2026-06-02T12:00:00Z"
}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetSubscriptionById400Example": {
"summary": "Default GetSubscriptionById 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": {
"GetSubscriptionById401Example": {
"summary": "Default GetSubscriptionById 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": {
"GetSubscriptionById403Example": {
"summary": "Default GetSubscriptionById 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": {
"GetSubscriptionById404Example": {
"summary": "Default GetSubscriptionById 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": {
"GetSubscriptionById500Example": {
"summary": "Default GetSubscriptionById 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 Subscription by Id",
"description": "Get Subscription by Id via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/subscriptions/{subscriptionId}).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/subscriptions/hasPaymentMethod": {
"get": {
"tags": [
"Subscriptions"
],
"operationId": "HasCustomerGotPaymentMethodOnFile",
"parameters": [
{
"name": "appId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The app id path parameter.",
"example": "500123"
},
{
"name": "email",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"description": "The email query parameter.",
"example": "owner@example.com"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiResult_HasPaymentMethodResponse_"
},
"examples": {
"HasCustomerGotPaymentMethodOnFile200Example": {
"summary": "Default HasCustomerGotPaymentMethodOnFile 200 response",
"x-microcks-default": true,
"value": {
"Data": {
"HasPaymentMethod": true
}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"HasCustomerGotPaymentMethodOnFile400Example": {
"summary": "Default HasCustomerGotPaymentMethodOnFile 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": {
"HasCustomerGotPaymentMethodOnFile401Example": {
"summary": "Default HasCustomerGotPaymentMethodOnFile 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": {
"HasCustomerGotPaymentMethodOnFile403Example": {
"summary": "Default HasCustomerGotPaymentMethodOnFile 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": {
"HasCustomerGotPaymentMethodOnFile500Example": {
"summary": "Default HasCustomerGotPaymentMethodOnFile 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 Has Customer Got Payment Method on File",
"description": "Has Customer Got Payment Method on File via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/subscriptions/hasPaymentMethod).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/subscriptions": {
"get": {
"tags": [
"Subscriptions"
],
"operationId": "GetSubscriptionsForApp",
"parameters": [
{
"name": "appId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The app id path parameter.",
"example": "500123"
},
{
"name": "excludeNotOwnedSubscriptions",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
},
"description": "The exclude not owned subscriptions query parameter.",
"example": true
},
{
"name": "storeId",
"in": "query",
"required": false,
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"description": "The store id query parameter.",
"example": [
500123
]
},
{
"name": "excludeCancelledSubscriptions",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
},
"description": "The exclude cancelled subscriptions query parameter.",
"example": true
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiArrayResult_SubscriptionSummary_"
},
"examples": {
"GetSubscriptionsForApp200Example": {
"summary": "Default GetSubscriptionsForApp 200 response",
"x-microcks-default": true,
"value": {
"Data": []
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetSubscriptionsForApp400Example": {
"summary": "Default GetSubscriptionsForApp 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": {
"GetSubscriptionsForApp401Example": {
"summary": "Default GetSubscriptionsForApp 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": {
"GetSubscriptionsForApp403Example": {
"summary": "Default GetSubscriptionsForApp 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": {
"GetSubscriptionsForApp500Example": {
"summary": "Default GetSubscriptionsForApp 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 Subscriptions for App",
"description": "Get Subscriptions for App via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/subscriptions).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
}
},
"components": {
"schemas": {
"AccountFieldDefinition": {
"description": "Represents the format of a bank account field",
"type": "object",
"properties": {
"Key": {
"description": "Depending on the Key, the field's value will be stored in a different field in PayeeBankAccountData",
"enum": [
"Iban",
"AccountNumber",
"RoutingNumber",
"BSB",
"BranchCode",
"BankCode",
"InstitutionNumber",
"TransitNumber",
"ClearingCode",
"IfscCode",
"Clabe",
"SortCode",
"Swift"
],
"type": "string",
"example": "Iban"
},
"DisplayName": {
"description": "Display name of the field",
"type": "string",
"example": "Example Name"
},
"Type": {
"description": "There are some fields that are of type known to the frontend (IBAN, Swift) -- for those frontend should use its own validation library, e.g. ibantools",
"enum": [
"None",
"Iban"
],
"type": "string",
"example": "None"
},
"MinLength": {
"format": "int32",
"description": "Minimum length of the field",
"type": "integer",
"nullable": true,
"example": 1
},
"MaxLength": {
"format": "int32",
"description": "Maximum length of the field",
"type": "integer",
"nullable": true,
"example": 1
},
"DigitsOnly": {
"description": "Is the field digits (numeric) only",
"type": "boolean",
"example": true
},
"Regex": {
"description": "Regex for validating the field (if specified)",
"type": "string",
"example": "string"
}
}
},
"AccountFieldKeyValuePair": {
"description": "Represents one populated account field (its key and value)",
"type": "object",
"properties": {
"Key": {
"description": "Depending on the Key, the field's value will be stored in a different field in PayeeBankAccountData",
"enum": [
"Iban",
"AccountNumber",
"RoutingNumber",
"BSB",
"BranchCode",
"BankCode",
"InstitutionNumber",
"TransitNumber",
"ClearingCode",
"IfscCode",
"Clabe",
"SortCode",
"Swift"
],
"type": "string",
"example": "Iban"
},
"Value": {
"description": "The value of the field",
"type": "string",
"example": "string"
}
}
},
"AccountFieldsDefinitions": {
"description": "List of field definitions per country",
"type": "object",
"properties": {
"DefinitionsPerCountry": {
"description": "List of field definitions per country",
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountFieldDefinition"
}
}
}
}
},
"BalanceDetails": {
"description": "Period opening and closing balance",
"type": "object",
"properties": {
"OpeningBalance": {
"format": "double",
"description": "OpeningBalance.",
"type": "number",
"example": 1.0
},
"ClosingBalance": {
"format": "double",
"description": "ClosingBalance.",
"type": "number",
"example": 1.0
}
}
},
"BankAccountDetail": {
"description": "",
"type": "object",
"properties": {
"Id": {
"format": "int32",
"description": "Id of this account",
"type": "integer",
"example": 500123
},
"StoreNames": {
"description": "Store Names that are attached to this account",
"type": "array",
"items": {
"type": "string"
},
"example": [
"Example Name"
]
},
"AccountState": {
"description": "Status of Account",
"enum": [
"Unverified",
"AwatingVerification",
"Verified",
"Grandfathered"
],
"type": "string",
"example": "Unverified"
},
"StripeConnectedAccountInfo": {
"$ref": "#/components/schemas/StripeConnectedAccountInfo"
},
"BankAddress": {
"description": "Address lf the bank",
"type": "string",
"example": "string"
},
"BankCountryCode": {
"description": "CountryCode of the Bank Account",
"type": "string",
"example": "IE"
},
"AccountHolderAddress": {
"description": "Account Holders Address",
"type": "string",
"example": "string"
},
"AccountHolderCountryCode": {
"description": "Account Holders Country Code",
"type": "string",
"example": "IE"
},
"VatNumber": {
"description": "Account Holders Vat Number",
"type": "string",
"example": "string"
},
"CurrencyCode": {
"description": "Currency of Account",
"enum": [
"EUR",
"USD",
"GBP",
"CAD",
"AUD",
"DJF",
"ZAR",
"ETB",
"AED",
"BHD",
"DZD",
"EGP",
"IQD",
"JOD",
"KWD",
"LBP",
"LYD",
"MAD",
"OMR",
"QAR",
"SAR",
"SYP",
"TND",
"YER",
"CLP",
"INR",
"AZN",
"RUB",
"BYN",
"BGN",
"NGN",
"BDT",
"CNY",
"BAM",
"CZK",
"DKK",
"CHF",
"MVR",
"BTN",
"XCD",
"BZD",
"HKD",
"IDR",
"JMD",
"MYR",
"NZD",
"PHP",
"SGD",
"TTD",
"XDR",
"ARS",
"BOB",
"COP",
"CRC",
"CUP",
"DOP",
"GTQ",
"HNL",
"MXN",
"NIO",
"PAB",
"PEN",
"PYG",
"UYU",
"VEF",
"IRR",
"XOF",
"CDF",
"XAF",
"HTG",
"ILS",
"HRK",
"HUF",
"AMD",
"ISK",
"JPY",
"GEL",
"KZT",
"KHR",
"KRW",
"KGS",
"LAK",
"MKD",
"MNT",
"BND",
"MMK",
"NOK",
"NPR",
"PKR",
"PLN",
"AFN",
"BRL",
"MDL",
"RON",
"RWF",
"SEK",
"LKR",
"SOS",
"ALL",
"RSD",
"KES",
"TJS",
"THB",
"ERN",
"TMT",
"BWP",
"TRY",
"UAH",
"UZS",
"VND",
"MOP",
"TWD",
"BMD"
],
"type": "string",
"example": "EUR"
},
"StoreIds": {
"description": "List of stores to attach to Account",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
},
"example": [
1
]
},
"BankName": {
"description": "Name of Bank",
"type": "string",
"example": "Example Name"
},
"AccountName": {
"description": "Name of this account",
"type": "string",
"example": "Example Name"
},
"Iban": {
"description": "IBAN of this account",
"type": "string",
"example": "string"
},
"Swift": {
"description": "SWIFT of this bank account",
"type": "string",
"example": "string"
},
"NationalClearingCode": {
"description": "National Clearing Code (BSB in Australia, Routing Number in USA/Canada, NCC in NZ)",
"type": "string",
"example": "string"
},
"PopulatedAccountFields": {
"description": "A list of one or more populated account fields (field key-value pairs).\r\nIf this list contains at least one item, the Iban, Swift and NationalClearingCode fields will be ignored.",
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountFieldKeyValuePair"
},
"example": []
},
"RejectionReason": {
"description": "Reason for Rejection",
"type": "string",
"example": "string"
},
"BusinessType": {
"description": "Business Type",
"enum": [
"Individual",
"Company",
"NonProfit",
"GovernmentEntity"
],
"type": "string",
"nullable": true,
"example": "Individual"
}
}
},
"BankAccountDetailsUpdateRequest": {
"description": "Represents a request to update bank account information details",
"type": "object",
"properties": {
"BankAddress": {
"description": "Address of the bank account",
"type": "string",
"example": "string"
},
"AccountHolderAddress": {
"description": "Address of the payee",
"type": "string",
"example": "string"
},
"VatNumber": {
"description": "Account Holders Vat Number",
"type": "string",
"example": "string"
},
"StoreIds": {
"description": "List of stores to attach to Account",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
},
"example": [
1
]
},
"BankName": {
"description": "Name of Bank",
"type": "string",
"example": "Example Name"
},
"AccountName": {
"description": "Name of this account",
"type": "string",
"example": "Example Name"
},
"Iban": {
"description": "IBAN of this account",
"type": "string",
"example": "string"
},
"Swift": {
"description": "SWIFT of this bank account",
"type": "string",
"example": "string"
},
"NationalClearingCode": {
"description": "National Clearing Code (BSB in Australia, Routing Number in USA/Canada, NCC in NZ)",
"type": "string",
"example": "string"
},
"PopulatedAccountFields": {
"description": "A list of one or more populated account fields (field key-value pairs).\r\nIf this list contains at least one item, the Iban, Swift and NationalClearingCode fields will be ignored.",
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountFieldKeyValuePair"
},
"example": []
},
"RejectionReason": {
"description": "Reason for Rejection",
"type": "string",
"example": "string"
},
"BusinessType": {
"description": "Business Type",
"enum": [
"Individual",
"Company",
"NonProfit",
"GovernmentEntity"
],
"type": "string",
"nullable": true,
"example": "Individual"
}
}
},
"BankAccountSummary": {
"description": "",
"type": "object",
"properties": {
"Id": {
"format": "int32",
"description": "Id of this account",
"type": "integer",
"example": 500123
},
"StoreNames": {
"description": "Store Names that are attached to this account",
"type": "array",
"items": {
"type": "string"
},
"example": [
"Example Name"
]
},
"StoreIds": {
"description": "Store Ids that are attached to this account",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
},
"example": [
1
]
},
"AccountState": {
"description": "Status of Account",
"enum": [
"Unverified",
"AwatingVerification",
"Verified",
"Grandfathered"
],
"type": "string",
"example": "Unverified"
},
"CurrencyCode": {
"description": "Currency of Account",
"type": "string",
"example": "EUR"
},
"VatNumber": {
"description": "Account Holders Vat Number",
"type": "string",
"example": "string"
},
"AccountHolderAddress": {
"description": "Account Holders Address",
"type": "string",
"example": "string"
},
"AccountHolderCountryCode": {
"description": "Account Holders Country Code",
"type": "string",
"example": "IE"
},
"StripeConnectedAccountInfo": {
"$ref": "#/components/schemas/StripeConnectedAccountInfo"
},
"AccountName": {
"description": "Name of this account",
"type": "string",
"example": "Example Name"
},
"Iban": {
"description": "IBAN of this account",
"type": "string",
"example": "string"
},
"Swift": {
"description": "SWIFT of this bank account",
"type": "string",
"example": "string"
},
"NationalClearingCode": {
"description": "National Clearing Code (BSB in Australia, Routing Number in USA/Canada, NCC in NZ)",
"type": "string",
"example": "string"
},
"PopulatedAccountFields": {
"description": "A list of one or more populated account fields (field key-value pairs).\r\nIf this list contains at least one item, the Iban, Swift and NationalClearingCode fields will be ignored.",
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountFieldKeyValuePair"
},
"example": []
},
"RejectionReason": {
"description": "Reason for Rejection",
"type": "string",
"example": "string"
},
"BusinessType": {
"description": "Business Type",
"enum": [
"Individual",
"Company",
"NonProfit",
"GovernmentEntity"
],
"type": "string",
"nullable": true,
"example": "Individual"
}
}
},
"ChargebackDetails": {
"description": "Chargebacks breakdown",
"type": "object",
"properties": {
"ChargebackAmount": {
"format": "double",
"description": "Chargeback amount",
"type": "number",
"example": 12.5
},
"PosSalesChargebackAmount": {
"format": "double",
"description": "POS Chargeback amount",
"type": "number",
"example": 12.5
},
"ChargebackRefundedFees": {
"format": "double",
"description": "Chargeback refunded feeds",
"type": "number",
"example": 12.5
},
"ChargebacksCount": {
"format": "int32",
"description": "Number of chargebacks",
"type": "integer",
"example": 3
},
"TotalChargebackCost": {
"format": "double",
"description": "Total amount",
"type": "number",
"example": 12.5
}
}
},
"CountryWithAccountFieldsDefinitions": {
"description": "List of field definitions per country",
"type": "object",
"properties": {
"CountryCode": {
"description": "Country 2-letter ISO code",
"type": "string",
"example": "IE"
},
"DisplayName": {
"description": "Display name of the country",
"type": "string",
"example": "Example Name"
},
"SupportType": {
"description": "Country support type (supported-by-stripe-cc, supported-by-flipdish,not-supported)",
"type": "string",
"example": "string"
},
"FieldDefinitions": {
"description": "Bank Account field definitions",
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountFieldDefinition"
},
"example": []
}
}
},
"DepositReturnFeesSummary": {
"type": "object",
"properties": {
"Count": {
"format": "int32",
"type": "integer",
"example": 3
},
"Fee": {
"format": "double",
"type": "number",
"example": 12.5
},
"Total": {
"format": "double",
"type": "number",
"example": 12.5
}
}
},
"FileCreationResult": {
"description": "FileCreationResult.",
"type": "object",
"properties": {
"FileId": {
"description": "FileId.",
"type": "string",
"example": "500123"
},
"Location": {
"description": "Location.",
"type": "string",
"example": "string"
}
}
},
"FlipdishError": {
"type": "object",
"description": "Standard Flipdish API error response. Errors are returned as a JSON object with a human-readable message and a programmatic error code (see https://developers.flipdish.com/docs/error-handling).",
"properties": {
"error": {
"type": "object",
"description": "Error detail object.",
"properties": {
"errorMessage": {
"type": "string",
"description": "Descriptive explanation of the issue.",
"example": "Invalid or missing parameters."
},
"errorCode": {
"type": "string",
"description": "Unique identifier for programmatic error handling.",
"example": "BadRequest"
},
"details": {
"type": "string",
"description": "Additional context returned in non-production environments.",
"example": "Validation failed for field 'storeId'."
}
}
}
}
},
"FlipdishFeesDetails": {
"description": "Fees breakdown",
"type": "object",
"properties": {
"OnlineSalesFees": {
"format": "double",
"description": "Fees on online sales",
"type": "number",
"example": 12.5
},
"CashSalesFees": {
"format": "double",
"description": "Fees on cash sales",
"type": "number",
"example": 12.5
},
"PosSalesFees": {
"format": "double",
"description": "Fees of POS sales",
"type": "number",
"example": 12.5
},
"TotalSalesFees": {
"format": "double",
"description": "Total online and cash sales",
"type": "number",
"example": 12.5
},
"OnlineSalesRefundedFees": {
"format": "double",
"description": "Fees on refunds for online sales",
"type": "number",
"example": 12.5
},
"CashSalesRefundedFees": {
"format": "double",
"description": "Fees on refunds for cash sales",
"type": "number",
"example": 12.5
},
"PosSalesRefundedFees": {
"format": "double",
"description": "Fees on refunds for POS sales",
"type": "number",
"example": 12.5
},
"SalesFeesVat": {
"format": "double",
"description": "VAT on sales fees",
"type": "number",
"example": 12.5
},
"TotalFees": {
"format": "double",
"description": "Total fees",
"type": "number",
"example": 12.5
}
}
},
"GetReceiptByOrderIdQueryResponse": {
"type": "object",
"properties": {
"PreviousOrder": {
"$ref": "#/components/schemas/PreviousOrder"
},
"DepositReturnFeesSummary": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DepositReturnFeesSummary"
},
"example": []
},
"TsRequestedForLocal": {
"format": "date-time",
"type": "string",
"example": "2026-06-02T12:00:00Z"
},
"TsOrderPlacedLocal": {
"format": "date-time",
"type": "string",
"example": "2026-06-02T12:00:00Z"
},
"LogoUrl": {
"type": "string",
"example": "https://api.flipdish.co/example"
},
"Address": {
"type": "string",
"example": "string"
},
"VatNumber": {
"type": "string",
"example": "string"
},
"PaymentMethodDescription": {
"type": "string",
"example": "string"
},
"OrgId": {
"type": "string",
"example": "500123"
},
"CountryCode": {
"type": "string",
"example": "IE"
}
}
},
"HasPaymentMethodResponse": {
"description": "Has Payment Method Response",
"required": [
"HasPaymentMethod"
],
"type": "object",
"properties": {
"HasPaymentMethod": {
"description": "Has Payment Method",
"type": "boolean",
"example": true
}
}
},
"Invoice": {
"description": "Represents an ordering invoice for a period of time.",
"type": "object",
"properties": {
"InvoiceNumber": {
"description": "Invoice Number",
"type": "string",
"example": "string"
},
"StartDay": {
"format": "date-time",
"description": "The start day of the invoice period.",
"type": "string",
"example": "2026-06-02T12:00:00Z"
},
"EndDay": {
"format": "date-time",
"description": "The end day of the invoice period.",
"type": "string",
"example": "2026-06-02T12:00:00Z"
}
}
},
"InvoiceDiscount": {
"description": "Invoice Discount",
"required": [
"Name",
"Amount"
],
"type": "object",
"properties": {
"Name": {
"description": "Name",
"type": "string",
"example": "Example Name"
},
"Amount": {
"format": "double",
"description": "Amount",
"type": "number",
"example": 12.5
}
}
},
"InvoiceItem": {
"description": "Invoice Item",
"required": [
"Description",
"Quantity",
"UnitAmountExcludingTax",
"Tax",
"Amount",
"Period"
],
"type": "object",
"properties": {
"Description": {
"description": "Description",
"type": "string",
"example": "string"
},
"Quantity": {
"format": "int64",
"description": "Quantity",
"type": "integer",
"example": 3
},
"UnitAmountExcludingTax": {
"format": "double",
"description": "Unit Amount Excluding Tax",
"type": "number",
"example": 12.5
},
"Tax": {
"format": "double",
"description": "Tax",
"type": "number",
"example": 1.0
},
"Amount": {
"format": "double",
"description": "Amount",
"type": "number",
"example": 12.5
},
"Period": {
"$ref": "#/components/schemas/InvoicePeriod"
}
}
},
"InvoicePeriod": {
"description": "Invoice Period",
"type": "object",
"properties": {
"Start": {
"format": "date-time",
"description": "Start",
"type": "string",
"example": "2026-06-02T12:00:00Z"
},
"End": {
"format": "date-time",
"description": "End",
"type": "string",
"example": "2026-06-02T12:00:00Z"
}
}
},
"LastPaymentError": {
"description": "List's the issues with the last failed payment intent",
"type": "object",
"properties": {
"Code": {
"description": "For some errors that could be handled programmatically, a short string indicating the error code reported.",
"type": "string",
"example": "string"
},
"DeclineCode": {
"description": "For card errors resulting from a card issuer decline, a short string indicating the card issuer\u2019s reason for the decline if they provide one.",
"type": "string",
"example": "string"
},
"Message": {
"description": "A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.",
"type": "string",
"example": "string"
}
}
},
"ModelBase": {
"description": "Model base",
"type": "object",
"properties": {}
},
"OrderPaymentInformation": {
"description": "Order Payment Information",
"type": "object",
"properties": {
"OrderId": {
"format": "int32",
"description": "ID of the Order",
"type": "integer",
"example": 500123
},
"PaymentRefundable": {
"description": "Signifies if the payment is refundable",
"type": "boolean",
"example": true
}
}
},
"OtherChargesDetails": {
"description": "Breakdown of other charges",
"type": "object",
"properties": {
"TotalOtherCharges": {
"format": "double",
"description": "Total amount of other charges",
"type": "number",
"example": 12.5
},
"ChargesCount": {
"format": "int32",
"description": "Number of other charges",
"type": "integer",
"example": 3
}
}
},
"PaymentIntent": {
"description": "Represents stripe PaymentIntent",
"type": "object",
"properties": {
"Id": {
"description": "Id of payment intent",
"type": "string",
"example": "500123"
},
"Description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
"type": "string",
"example": "string"
},
"Currency": {
"description": "Three-letter ISO currency\r\ncode, in lowercase. Must be a supported\r\ncurrency.",
"type": "string",
"example": "EUR"
},
"Status": {
"description": "Status of this PaymentIntent, one of requires_payment_method,\r\nrequires_confirmation, requires_action, processing,\r\nrequires_capture, canceled, or succeeded. Read more about each\r\nPaymentIntent status.\r\nOne of: canceled, processing, requires_action,\r\nrequires_capture, requires_confirmation, requires_payment_method,\r\nor succeeded.",
"type": "string",
"example": "Active"
},
"Created": {
"format": "date-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
"type": "string",
"example": "2026-06-02T12:00:00Z"
},
"LastPaymentError": {
"$ref": "#/components/schemas/LastPaymentError"
}
}
},
"Payout": {
"description": "Holds the information for a whitelabel payout.",
"type": "object",
"properties": {
"PayoutId": {
"format": "int32",
"description": "The id of the payout.",
"type": "integer",
"example": 500123
},
"PayeeBankAccountId": {
"format": "int32",
"description": "Bank account identifier",
"type": "integer",
"example": 500123
},
"AccountName": {
"description": "Account name of the payout destination",
"type": "string",
"example": "Example Name"
},
"PayoutStatus": {
"description": "Status of the payout",
"enum": [
"Pending",
"InTransit",
"Paid",
"Failed",
"Cancelled"
],
"type": "string",
"example": "Pending"
},
"CreatedDate": {
"format": "date-time",
"description": "Date payout was created",
"type": "string",
"example": "2026-06-02T12:00:00Z"
},
"PeriodStartTime": {
"format": "date-time",
"description": "This payout includes operations after at this date (inclusive)",
"type": "string",
"example": "2026-06-02T12:00:00Z"
},
"PeriodEndTime": {
"format": "date-time",
"description": "This payout includes operations before at this date (exclusive)",
"type": "string",
"example": "2026-06-02T12:00:00Z"
},
"DestinationBank": {
"description": "Destination bank name",
"type": "string",
"example": "string"
},
"DestinationAccount": {
"description": "Last 4 digits of the destination bank IBAN",
"type": "string",
"example": "string"
},
"Amount": {
"format": "double",
"description": "Payout amount",
"type": "number",
"example": 12.5
},
"PayoutType": {
"description": "Type of payout source",
"enum": [
"Internal",
"Stripe"
],
"type": "string",
"example": "Internal"
},
"Currency": {
"description": "Payout currency",
"enum": [
"EUR",
"USD",
"GBP",
"CAD",
"AUD",
"DJF",
"ZAR",
"ETB",
"AED",
"BHD",
"DZD",
"EGP",
"IQD",
"JOD",
"KWD",
"LBP",
"LYD",
"MAD",
"OMR",
"QAR",
"SAR",
"SYP",
"TND",
"YER",
"CLP",
"INR",
"AZN",
"RUB",
"BYN",
"BGN",
"NGN",
"BDT",
"CNY",
"BAM",
"CZK",
"DKK",
"CHF",
"MVR",
"BTN",
"XCD",
"BZD",
"HKD",
"IDR",
"JMD",
"MYR",
"NZD",
"PHP",
"SGD",
"TTD",
"XDR",
"ARS",
"BOB",
"COP",
"CRC",
"CUP",
"DOP",
"GTQ",
"HNL",
"MXN",
"NIO",
"PAB",
"PEN",
"PYG",
"UYU",
"VEF",
"IRR",
"XOF",
"CDF",
"XAF",
"HTG",
"ILS",
"HRK",
"HUF",
"AMD",
"ISK",
"JPY",
"GEL",
"KZT",
"KHR",
"KRW",
"KGS",
"LAK",
"MKD",
"MNT",
"BND",
"MMK",
"NOK",
"NPR",
"PKR",
"PLN",
"AFN",
"BRL",
"MDL",
"RON",
"RWF",
"SEK",
"LKR",
"SOS",
"ALL",
"RSD",
"KES",
"TJS",
"THB",
"ERN",
"TMT",
"BWP",
"TRY",
"UAH",
"UZS",
"VND",
"MOP",
"TWD",
"BMD"
],
"type": "string",
"example": "EUR"
},
"CutoffDate": {
"format": "date-time",
"description": "Payouts before this date do not have a details breakdown",
"type": "string",
"example": "2026-06-02T12:00:00Z"
},
"OnlineSalesAmount": {
"format": "double",
"description": "Payout online sales amount",
"type": "number",
"example": 12.5
},
"OnlineSalesDeliveryCharges": {
"format": "double",
"description": "Payout online sales delivery charges",
"type": "number",
"example": 1.0
},
"OnlineSalesTips": {
"format": "double",
"description": "Payout online sales tips",
"type": "number",
"example": 1.0
},
"OnlineSalesServiceCharges": {
"format": "double",
"description": "Payout online sales service charges",
"type": "number",
"example": 1.0
},
"OnlineSalesRefundedFees": {
"format": "double",
"description": "Payout online sales refunded fees",
"type": "number",
"example": 12.5
},
"OnlineSalesFees": {
"format": "double",
"description": "Payout online sales fees",
"type": "number",
"example": 12.5
},
"PosSalesFees": {
"format": "double",
"description": "Payout online sales fees",
"type": "number",
"example": 12.5
},
"OnlineSalesRefundedAmount": {
"format": "double",
"description": "Payout online sales refunded amount",
"type": "number",
"example": 12.5
},
"PosSalesRefundedAmount": {
"format": "double",
"description": "POS Payout online sales refunded amount",
"type": "number",
"example": 12.5
},
"OnlineSalesTax": {
"format": "double",
"description": "Payout online sales tax",
"type": "number",
"example": 1.0
},
"TotalOnlineRevenue": {
"format": "double",
"description": "Payout total online revenue",
"type": "number",
"example": 12.5
},
"CashSalesFees": {
"format": "double",
"description": "Payout cash sales fees",
"type": "number",
"example": 12.5
},
"CashSalesRefundedFees": {
"format": "double",
"description": "Payout cash sales refunded fees",
"type": "number",
"example": 12.5
},
"CustomerCashFees": {
"format": "double",
"description": "Payout cash fees charged to customer",
"type": "number",
"example": 12.5
},
"SalesFeesVat": {
"format": "double",
"description": "Payout sales fees vat",
"type": "number",
"example": 12.5
},
"TotalFees": {
"format": "double",
"description": "Payout total fees",
"type": "number",
"example": 12.5
},
"TotalOnlineRevenueAdjustments": {
"format": "double",
"description": "Payout total online revenue adjustments",
"type": "number",
"example": 12.5
},
"ChargebackAmount": {
"format": "double",
"description": "Payout chargeback amount",
"type": "number",
"example": 12.5
},
"PosSalesChargebackAmount": {
"format": "double",
"description": "POS Payout chargeback amount",
"type": "number",
"example": 12.5
},
"ChargebackRefundedFees": {
"format": "double",
"description": "Payout chargeback refunded fees",
"type": "number",
"example": 12.5
},
"TotalChargebackCost": {
"format": "double",
"description": "Payout chargebacks total cost",
"type": "number",
"example": 12.5
},
"TotalOtherCharges": {
"format": "double",
"description": "Payout other charges total",
"type": "number",
"example": 12.5
},
"OpeningBalance": {
"format": "double",
"description": "Payout opening balance",
"type": "number",
"example": 1.0
},
"ClosingBalance": {
"format": "double",
"description": "Payout closing balance",
"type": "number",
"example": 1.0
},
"PayGreenSalesAmount": {
"format": "double",
"description": "Amount of sales through PayGreen (restaurant vouchers)",
"type": "number",
"nullable": true,
"example": 12.5
},
"DeliveryIntegrationFee": {
"format": "double",
"description": "Third party integration delivery fee",
"type": "number",
"example": 12.5
},
"DeliveryIntegrationTipFee": {
"format": "double",
"description": "Third party integration delivery tip fee",
"type": "number",
"example": 12.5
},
"TotalThirdPartyFees": {
"format": "double",
"description": "Total third party integration fees",
"type": "number",
"example": 12.5
},
"PosSalesAmount": {
"format": "double",
"description": "POS sales amount",
"type": "number",
"example": 12.5
},
"PosSalesTax": {
"format": "double",
"description": "POS sales tax",
"type": "number",
"example": 1.0
},
"TipsOnPosSales": {
"format": "double",
"description": "Tips on POS sales",
"type": "number",
"example": 1.0
},
"BankAccountHasChanged": {
"description": "Indicates whether the bank account has changed since the previous payout",
"type": "boolean",
"example": true
}
}
},
"PayoutChargeback": {
"description": "Holds the information for a chargeback related to a payout",
"type": "object",
"properties": {
"OrderId": {
"format": "int32",
"description": "The id of the order the chargeback was for",
"type": "integer",
"example": 500123
},
"OrderCurrency": {
"description": "Order currency",
"enum": [
"EUR",
"USD",
"GBP",
"CAD",
"AUD",
"DJF",
"ZAR",
"ETB",
"AED",
"BHD",
"DZD",
"EGP",
"IQD",
"JOD",
"KWD",
"LBP",
"LYD",
"MAD",
"OMR",
"QAR",
"SAR",
"SYP",
"TND",
"YER",
"CLP",
"INR",
"AZN",
"RUB",
"BYN",
"BGN",
"NGN",
"BDT",
"CNY",
"BAM",
"CZK",
"DKK",
"CHF",
"MVR",
"BTN",
"XCD",
"BZD",
"HKD",
"IDR",
"JMD",
"MYR",
"NZD",
"PHP",
"SGD",
"TTD",
"XDR",
"ARS",
"BOB",
"COP",
"CRC",
"CUP",
"DOP",
"GTQ",
"HNL",
"MXN",
"NIO",
"PAB",
"PEN",
"PYG",
"UYU",
"VEF",
"IRR",
"XOF",
"CDF",
"XAF",
"HTG",
"ILS",
"HRK",
"HUF",
"AMD",
"ISK",
"JPY",
"GEL",
"KZT",
"KHR",
"KRW",
"KGS",
"LAK",
"MKD",
"MNT",
"BND",
"MMK",
"NOK",
"NPR",
"PKR",
"PLN",
"AFN",
"BRL",
"MDL",
"RON",
"RWF",
"SEK",
"LKR",
"SOS",
"ALL",
"RSD",
"KES",
"TJS",
"THB",
"ERN",
"TMT",
"BWP",
"TRY",
"UAH",
"UZS",
"VND",
"MOP",
"TWD",
"BMD"
],
"type": "string",
"example": "EUR"
},
"PayoutId": {
"format": "int32",
"description": "The id of the payout the order is related to",
"type": "integer",
"example": 500123
},
"OrderDate": {
"format": "date-time",
"description": "The date the order was placed",
"type": "string",
"example": "2026-06-02T12:00:00Z"
},
"OrderType": {
"description": "Order type (online or cash)",
"enum": [
"Cash",
"Online"
],
"type": "string",
"example": "Cash"
},
"ChargebackDate": {
"format": "date-time",
"description": "The date the chargeback was done",
"type": "string",
"example": "2026-06-02T12:00:00Z"
},
"StoreId": {
"format": "int32",
"description": "Store id",
"type": "integer",
"example": 500123
},
"ChargebackAmount": {
"format": "double",
"description": "Chargeback amount",
"type": "number",
"example": 12.5
},
"RefundedFees": {
"format": "double",
"description": "Amount of refunded fees",
"type": "number",
"example": 12.5
}
}
},
"PayoutDetail": {
"description": "Holds the information for a whitelabel payout with details broken down by Store",
"type": "object",
"properties": {
"PayoutId": {
"format": "int32",
"description": "The id of the payout.",
"type": "integer",
"example": 500123
},
"BankAccountId": {
"format": "int32",
"description": "Bank account identifier",
"type": "integer",
"example": 500123
},
"AccountName": {
"description": "Account name of the payout destination",
"type": "string",
"example": "Example Name"
},
"PayoutStatus": {
"description": "Status of the payout",
"enum": [
"Pending",
"InTransit",
"Paid",
"Failed",
"Cancelled"
],
"type": "string",
"example": "Pending"
},
"CreatedDate": {
"format": "date-time",
"description": "Date payout was created",
"type": "string",
"example": "2026-06-02T12:00:00Z"
},
"PeriodStartTime": {
"format": "date-time",
"description": "This payout includes operations after at this date (inclusive)",
"type": "string",
"example": "2026-06-02T12:00:00Z"
},
"PeriodEndTime": {
"format": "date-time",
"description": "This payout includes operations before at this date (exclusive)",
"type": "string",
"example": "2026-06-02T12:00:00Z"
},
"DestinationBank": {
"description": "Destination bank name",
"type": "string",
"example": "string"
},
"DestinationAccount": {
"description": "Last 4 digits of the destination bank IBAN",
"type": "string",
"example": "string"
},
"PayoutType": {
"description": "Type of payout source",
"enum": [
"Internal",
"Stripe"
],
"type": "string",
"example": "Internal"
},
"Currency": {
"description": "Payout currency",
"enum": [
"EUR",
"USD",
"GBP",
"CAD",
"AUD",
"DJF",
"ZAR",
"ETB",
"AED",
"BHD",
"DZD",
"EGP",
"IQD",
"JOD",
"KWD",
"LBP",
"LYD",
"MAD",
"OMR",
"QAR",
"SAR",
"SYP",
"TND",
"YER",
"CLP",
"INR",
"AZN",
"RUB",
"BYN",
"BGN",
"NGN",
"BDT",
"CNY",
"BAM",
"CZK",
"DKK",
"CHF",
"MVR",
"BTN",
"XCD",
"BZD",
"HKD",
"IDR",
"JMD",
"MYR",
"NZD",
"PHP",
"SGD",
"TTD",
"XDR",
"ARS",
"BOB",
"COP",
"CRC",
"CUP",
"DOP",
"GTQ",
"HNL",
"MXN",
"NIO",
"PAB",
"PEN",
"PYG",
"UYU",
"VEF",
"IRR",
"XOF",
"CDF",
"XAF",
"HTG",
"ILS",
"HRK",
"HUF",
"AMD",
"ISK",
"JPY",
"GEL",
"KZT",
"KHR",
"KRW",
"KGS",
"LAK",
"MKD",
"MNT",
"BND",
"MMK",
"NOK",
"NPR",
"PKR",
"PLN",
"AFN",
"BRL",
"MDL",
"RON",
"RWF",
"SEK",
"LKR",
"SOS",
"ALL",
"RSD",
"KES",
"TJS",
"THB",
"ERN",
"TMT",
"BWP",
"TRY",
"UAH",
"UZS",
"VND",
"MOP",
"TWD",
"BMD"
],
"type": "string",
"example": "EUR"
},
"PayoutStores": {
"description": "Payout information broken down by Store",
"type": "array",
"items": {
"$ref": "#/components/schemas/PayoutStore"
},
"example": []
},
"Amount": {
"format": "double",
"description": "Payout amount",
"type": "number",
"example": 12.5
},
"CutoffDate": {
"format": "date-time",
"description": "Payouts before this date do not have a details breakdown",
"type": "string",
"example": "2026-06-02T12:00:00Z"
}
}
},
"PayoutOrder": {
"description": "Holds the information for an order related to a payout",
"type": "object",
"properties": {
"OrderId": {
"format": "int32",
"description": "The id of the order",
"type": "integer",
"example": 500123
},
"PayoutId": {
"format": "int32",
"description": "The id of the payout the order is related to",
"type": "integer",
"example": 500123
},
"OrderDate": {
"format": "date-time",
"description": "The date the order was placed",
"type": "string",
"example": "2026-06-02T12:00:00Z"
},
"OrderType": {
"description": "Order type (online or cash)",
"enum": [
"Cash",
"Online"
],
"type": "string",
"example": "Cash"
},
"OrderCurrency": {
"description": "Order currency",
"enum": [
"EUR",
"USD",
"GBP",
"CAD",
"AUD",
"DJF",
"ZAR",
"ETB",
"AED",
"BHD",
"DZD",
"EGP",
"IQD",
"JOD",
"KWD",
"LBP",
"LYD",
"MAD",
"OMR",
"QAR",
"SAR",
"SYP",
"TND",
"YER",
"CLP",
"INR",
"AZN",
"RUB",
"BYN",
"BGN",
"NGN",
"BDT",
"CNY",
"BAM",
"CZK",
"DKK",
"CHF",
"MVR",
"BTN",
"XCD",
"BZD",
"HKD",
"IDR",
"JMD",
"MYR",
"NZD",
"PHP",
"SGD",
"TTD",
"XDR",
"ARS",
"BOB",
"COP",
"CRC",
"CUP",
"DOP",
"GTQ",
"HNL",
"MXN",
"NIO",
"PAB",
"PEN",
"PYG",
"UYU",
"VEF",
"IRR",
"XOF",
"CDF",
"XAF",
"HTG",
"ILS",
"HRK",
"HUF",
"AMD",
"ISK",
"JPY",
"GEL",
"KZT",
"KHR",
"KRW",
"KGS",
"LAK",
"MKD",
"MNT",
"BND",
"MMK",
"NOK",
"NPR",
"PKR",
"PLN",
"AFN",
"BRL",
"MDL",
"RON",
"RWF",
"SEK",
"LKR",
"SOS",
"ALL",
"RSD",
"KES",
"TJS",
"THB",
"ERN",
"TMT",
"BWP",
"TRY",
"UAH",
"UZS",
"VND",
"MOP",
"TWD",
"BMD"
],
"type": "string",
"example": "EUR"
},
"Sales": {
"format": "double",
"description": "Order sales amount",
"type": "number",
"example": 1.0
},
"SalesTax": {
"format": "double",
"description": "Order sales tax amount",
"type": "number",
"example": 1.0
},
"DeliveryCharges": {
"format": "double",
"description": "Order delivery charges",
"type": "number",
"example": 1.0
},
"Tips": {
"format": "double",
"description": "Order tips amount",
"type": "number",
"example": 1.0
},
"Voucher": {
"format": "double",
"description": "Order voucher amount",
"type": "number",
"example": 1.0
},
"FlatFeeExcludingVat": {
"format": "double",
"description": "Order flat fee amount excluding VAT",
"type": "number",
"example": 12.5
},
"FlatFeeExcludingVAT": {
"format": "double",
"description": "Order flat fee amount excluding VAT",
"type": "number",
"example": 12.5
},
"FlatFeeIncludingVat": {
"format": "double",
"description": "Order flat fee amount including VAT",
"type": "number",
"example": 12.5
},
"PercentageFeeExcludingVat": {
"format": "double",
"description": "Order percentage fee excluding VAT",
"type": "number",
"example": 12.5
},
"PercentageFeeExcludingVAT": {
"format": "double",
"description": "Order percentage fee excluding VAT",
"type": "number",
"example": 12.5
},
"Vat": {
"format": "double",
"description": "Order VAT amount",
"type": "number",
"example": 1.0
},
"TotalFees": {
"format": "double",
"description": "Total order fees amount",
"type": "number",
"example": 12.5
},
"CashFeeChargedToCustomer": {
"format": "double",
"description": "Cash fee charged to customer",
"type": "number",
"example": 12.5
},
"NetSales": {
"format": "double",
"description": "Order net sales amount",
"type": "number",
"example": 1.0
},
"StoreId": {
"format": "int32",
"description": "Store id",
"type": "integer",
"example": 500123
},
"ServiceChargeAmount": {
"format": "double",
"description": "Order ServiceChargeAmount amount",
"type": "number",
"example": 12.5
},
"ServiceChargePercentage": {
"format": "double",
"description": "Order ServiceChargePercentage amount",
"type": "number",
"example": 1.0
}
}
},
"PayoutOtherCharge": {
"description": "Holds the information for a charge related to a payout",
"type": "object",
"properties": {
"ChargeId": {
"format": "int32",
"description": "The id of the charge",
"type": "integer",
"example": 500123
},
"Amount": {
"format": "double",
"description": "Charge amount",
"type": "number",
"example": 12.5
},
"Currency": {
"description": "Currency of the charge",
"enum": [
"EUR",
"USD",
"GBP",
"CAD",
"AUD",
"DJF",
"ZAR",
"ETB",
"AED",
"BHD",
"DZD",
"EGP",
"IQD",
"JOD",
"KWD",
"LBP",
"LYD",
"MAD",
"OMR",
"QAR",
"SAR",
"SYP",
"TND",
"YER",
"CLP",
"INR",
"AZN",
"RUB",
"BYN",
"BGN",
"NGN",
"BDT",
"CNY",
"BAM",
"CZK",
"DKK",
"CHF",
"MVR",
"BTN",
"XCD",
"BZD",
"HKD",
"IDR",
"JMD",
"MYR",
"NZD",
"PHP",
"SGD",
"TTD",
"XDR",
"ARS",
"BOB",
"COP",
"CRC",
"CUP",
"DOP",
"GTQ",
"HNL",
"MXN",
"NIO",
"PAB",
"PEN",
"PYG",
"UYU",
"VEF",
"IRR",
"XOF",
"CDF",
"XAF",
"HTG",
"ILS",
"HRK",
"HUF",
"AMD",
"ISK",
"JPY",
"GEL",
"KZT",
"KHR",
"KRW",
"KGS",
"LAK",
"MKD",
"MNT",
"BND",
"MMK",
"NOK",
"NPR",
"PKR",
"PLN",
"AFN",
"BRL",
"MDL",
"RON",
"RWF",
"SEK",
"LKR",
"SOS",
"ALL",
"RSD",
"KES",
"TJS",
"THB",
"ERN",
"TMT",
"BWP",
"TRY",
"UAH",
"UZS",
"VND",
"MOP",
"TWD",
"BMD"
],
"type": "string",
"example": "EUR"
},
"PayoutId": {
"format": "int32",
"description": "The id of the payout the order is related to",
"type": "integer",
"example": 500123
},
"ChargeDate": {
"format": "date-time",
"description": "The date the order was placed",
"type": "string",
"example": "2026-06-02T12:00:00Z"
},
"ChargeType": {
"description": "Charge type",
"enum": [
"Other",
"Fees",
"Chargeback",
"TipFailure",
"ExternalDisbursement",
"Goods",
"RestaurantSales",
"Tips"
],
"type": "string",
"example": "Other"
},
"ChargeDescription": {
"description": "Charge description",
"type": "string",
"example": "string"
},
"StoreId": {
"format": "int32",
"description": "Store id",
"type": "integer",
"example": 500123
}
}
},
"PayoutRefund": {
"description": "Holds the information for a refund related to a payout",
"type": "object",
"properties": {
"OrderId": {
"format": "int32",
"description": "The id of the order the refund was for",
"type": "integer",
"example": 500123
},
"OrderCurrency": {
"description": "Order currency",
"enum": [
"EUR",
"USD",
"GBP",
"CAD",
"AUD",
"DJF",
"ZAR",
"ETB",
"AED",
"BHD",
"DZD",
"EGP",
"IQD",
"JOD",
"KWD",
"LBP",
"LYD",
"MAD",
"OMR",
"QAR",
"SAR",
"SYP",
"TND",
"YER",
"CLP",
"INR",
"AZN",
"RUB",
"BYN",
"BGN",
"NGN",
"BDT",
"CNY",
"BAM",
"CZK",
"DKK",
"CHF",
"MVR",
"BTN",
"XCD",
"BZD",
"HKD",
"IDR",
"JMD",
"MYR",
"NZD",
"PHP",
"SGD",
"TTD",
"XDR",
"ARS",
"BOB",
"COP",
"CRC",
"CUP",
"DOP",
"GTQ",
"HNL",
"MXN",
"NIO",
"PAB",
"PEN",
"PYG",
"UYU",
"VEF",
"IRR",
"XOF",
"CDF",
"XAF",
"HTG",
"ILS",
"HRK",
"HUF",
"AMD",
"ISK",
"JPY",
"GEL",
"KZT",
"KHR",
"KRW",
"KGS",
"LAK",
"MKD",
"MNT",
"BND",
"MMK",
"NOK",
"NPR",
"PKR",
"PLN",
"AFN",
"BRL",
"MDL",
"RON",
"RWF",
"SEK",
"LKR",
"SOS",
"ALL",
"RSD",
"KES",
"TJS",
"THB",
"ERN",
"TMT",
"BWP",
"TRY",
"UAH",
"UZS",
"VND",
"MOP",
"TWD",
"BMD"
],
"type": "string",
"example": "EUR"
},
"PayoutId": {
"format": "int32",
"description": "The id of the payout the order is related to",
"type": "integer",
"example": 500123
},
"OrderDate": {
"format": "date-time",
"description": "The date the order was placed",
"type": "string",
"example": "2026-06-02T12:00:00Z"
},
"OrderType": {
"description": "Order type (online or cash)",
"enum": [
"Cash",
"Online"
],
"type": "string",
"example": "Cash"
},
"RefundDate": {
"format": "date-time",
"description": "The date the refund was done",
"type": "string",
"example": "2026-06-02T12:00:00Z"
},
"StoreId": {
"format": "int32",
"description": "Store id",
"type": "integer",
"example": 500123
},
"TotalRefund": {
"format": "double",
"description": "Total refund amount",
"type": "number",
"example": 12.5
},
"RefundedFees": {
"format": "double",
"description": "Refunded fees amount",
"type": "number",
"example": 12.5
},
"RefundedAmount": {
"format": "double",
"description": "Refunded amount",
"type": "number",
"example": 12.5
},
"CashFeeRefundedToCustomer": {
"format": "double",
"description": "Cash fee refunded to customer",
"type": "number",
"example": 12.5
}
}
},
"PayoutReport3Details": {
"type": "object",
"properties": {
"Amount": {
"format": "double",
"type": "number",
"example": 12.5
},
"Currency": {
"type": "string",
"example": "EUR"
},
"Summary": {
"$ref": "#/components/schemas/PayoutReport3DetailsSummary"
},
"Revenue": {
"$ref": "#/components/schemas/PayoutReport3DetailsRevenue"
},
"FlipdishFees": {
"$ref": "#/components/schemas/PayoutReport3DetailsFlipdishFees"
},
"Adjustments": {
"$ref": "#/components/schemas/PayoutReport3DetailsAdjustments"
}
}
},
"PayoutReport3DetailsAdjustments": {
"type": "object",
"properties": {
"OpeningBalanceDate": {
"format": "date-time",
"type": "string",
"example": "2026-06-02T12:00:00Z"
},
"ClosingBalanceDate": {
"format": "date-time",
"type": "string",
"example": "2026-06-02T12:00:00Z"
},
"OpeningBalance": {
"format": "double",
"type": "number",
"example": 1.0
},
"RefundsOnCardOrders": {
"format": "double",
"type": "number",
"example": 1.0
},
"RefundsOnCashOrders": {
"format": "double",
"type": "number",
"example": 1.0
},
"CashCustomerFees": {
"format": "double",
"type": "number",
"example": 12.5
},
"Chargebacks": {
"format": "double",
"type": "number",
"example": 1.0
},
"OtherTransactions": {
"format": "double",
"type": "number",
"example": 1.0
},
"ClosingBalance": {
"format": "double",
"type": "number",
"example": 1.0
},
"BalanceRepaid": {
"format": "double",
"type": "number",
"example": 500123
},
"RefundsOnCardOrdersBracketsAmount": {
"format": "double",
"type": "number",
"example": 12.5
},
"RefundsOnCardOrdersBracketsOutOfAmount": {
"format": "double",
"type": "number",
"example": 12.5
},
"RefundsOnCashOrdersBracketsAmount": {
"format": "double",
"type": "number",
"example": 12.5
},
"RefundsOnCashOrdersBracketsOutOfAmount": {
"format": "double",
"type": "number",
"example": 12.5
},
"CashCustomerFeesBracketsAmount": {
"format": "double",
"type": "number",
"example": 12.5
},
"CashCustomerFeesBracketsOutOfAmount": {
"format": "double",
"type": "number",
"example": 12.5
},
"BalanceChange": {
"format": "double",
"type": "number",
"example": 1.0
},
"PreviousPayoutId": {
"format": "int32",
"type": "integer",
"nullable": true,
"example": 500123
},
"NextPayoutId": {
"format": "int32",
"type": "integer",
"nullable": true,
"example": 500123
},
"RefundedFeesOnChargebacks": {
"format": "double",
"type": "number",
"example": 12.5
},
"TotalChargebackCost": {
"format": "double",
"type": "number",
"example": 12.5
}
}
},
"PayoutReport3DetailsFlipdishFees": {
"type": "object",
"properties": {
"WebAndAppCash": {
"format": "double",
"type": "number",
"example": 1.0
},
"WebAndAppCashRevenueIncludingTips": {
"format": "double",
"type": "number",
"example": 1.0
},
"WebAndAppCard": {
"format": "double",
"type": "number",
"example": 1.0
},
"WebAndAppCardRevenueIncludingTips": {
"format": "double",
"type": "number",
"example": 1.0
},
"KioskCash": {
"format": "double",
"type": "number",
"example": 1.0
},
"KioskCashRevenue": {
"format": "double",
"type": "number",
"example": 1.0
},
"KioskCard": {
"format": "double",
"type": "number",
"example": 1.0
},
"KioskCardRevenue": {
"format": "double",
"type": "number",
"example": 1.0
},
"QropCash": {
"format": "double",
"type": "number",
"example": 1.0
},
"QropCashRevenue": {
"format": "double",
"type": "number",
"example": 1.0
},
"QropCard": {
"format": "double",
"type": "number",
"example": 1.0
},
"QropCardRevenue": {
"format": "double",
"type": "number",
"example": 1.0
},
"PosCard": {
"format": "double",
"type": "number",
"example": 1.0
},
"PosCardRevenue": {
"format": "double",
"type": "number",
"example": 1.0
},
"PosCardOnFlipdishOrders": {
"format": "double",
"type": "number",
"example": 1.0
},
"OtherIntegrationFees": {
"format": "double",
"type": "number",
"example": 12.5
},
"OtherIntegrationFeesExcludingVat": {
"format": "double",
"type": "number",
"example": 12.5
},
"OtherIntegrationFeesVatAmount": {
"format": "double",
"type": "number",
"example": 12.5
},
"OtherIntegrationTips": {
"format": "double",
"type": "number",
"example": 1.0
},
"RefundedFeesOnRefundedSales": {
"format": "double",
"type": "number",
"example": 12.5
},
"Vat": {
"format": "double",
"type": "number",
"example": 1.0
},
"RefundedFeesOnPosSales": {
"format": "double",
"type": "number",
"example": 12.5
},
"Total": {
"format": "double",
"type": "number",
"example": 12.5
},
"ThirdPartyIntegrationFeesAndTips": {
"format": "double",
"type": "number",
"example": 12.5
},
"WebAndAppCardOnXOrders": {
"format": "int32",
"type": "integer",
"example": 1
},
"WebAndAppCashOnXOrders": {
"format": "int32",
"type": "integer",
"example": 1
},
"KioskCardOnXOrders": {
"format": "int32",
"type": "integer",
"example": 1
},
"KioskCashOnXOrders": {
"format": "int32",
"type": "integer",
"example": 1
},
"QropCardOnXOrders": {
"format": "int32",
"type": "integer",
"example": 1
},
"QropCashOnXOrders": {
"format": "int32",
"type": "integer",
"example": 1
},
"PosCardOnXOrders": {
"format": "int32",
"type": "integer",
"example": 1
}
}
},
"PayoutReport3DetailsRevenue": {
"type": "object",
"properties": {
"GrossSales": {
"$ref": "#/components/schemas/PayoutReport3DetailsSalesLine"
},
"SalesTax": {
"$ref": "#/components/schemas/PayoutReport3DetailsSalesLine"
},
"DeliveryCharges": {
"$ref": "#/components/schemas/PayoutReport3DetailsSalesLine"
},
"OtherCharges": {
"$ref": "#/components/schemas/PayoutReport3DetailsSalesLine"
},
"Tips": {
"$ref": "#/components/schemas/PayoutReport3DetailsSalesLine"
},
"TotalRevenue": {
"$ref": "#/components/schemas/PayoutReport3DetailsSalesLine"
},
"RevenueForFeeCalculations": {
"$ref": "#/components/schemas/PayoutReport3DetailsSalesLine"
},
"DrsCharges": {
"$ref": "#/components/schemas/PayoutReport3DetailsSalesLine"
}
}
},
"PayoutReport3DetailsSalesLine": {
"type": "object",
"properties": {
"Online": {
"format": "double",
"type": "number",
"example": 1.0
},
"Pos": {
"format": "double",
"type": "number",
"example": 1.0
},
"Other": {
"format": "double",
"type": "number",
"example": 1.0
},
"Total": {
"format": "double",
"type": "number",
"readOnly": true,
"example": 12.5
}
}
},
"PayoutReport3DetailsSummary": {
"type": "object",
"properties": {
"Revenue": {
"format": "double",
"type": "number",
"example": 1.0
},
"RevenueOfWhichCash": {
"format": "double",
"type": "number",
"example": 1.0
},
"UnpaidRevenue": {
"format": "double",
"type": "number",
"example": 1.0
},
"RevenueForFeeCalculations": {
"format": "double",
"type": "number",
"example": 12.5
},
"FlipdishFees": {
"format": "double",
"type": "number",
"example": 12.5
},
"Adjustments": {
"format": "double",
"type": "number",
"example": 1.0
},
"ThirdPartyIntegrationFeesAndTips": {
"format": "double",
"type": "number",
"example": 12.5
},
"Total": {
"format": "double",
"type": "number",
"example": 12.5
}
}
},
"PayoutReport3Overview": {
"type": "object",
"properties": {
"PayoutReport3OverviewHeader": {
"$ref": "#/components/schemas/PayoutReport3OverviewHeader"
},
"PayoutStores": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PayoutReport3Store"
},
"example": []
}
}
},
"PayoutReport3OverviewHeader": {
"type": "object",
"properties": {
"PayoutId": {
"format": "int32",
"type": "integer",
"example": 500123
},
"BankAccountId": {
"format": "int32",
"type": "integer",
"example": 500123
},
"IsManualPayout": {
"type": "boolean",
"example": true
},
"AccountName": {
"type": "string",
"example": "Example Name"
},
"PayoutStatus": {
"type": "string",
"example": "Active"
},
"CreatedDate": {
"format": "date-time",
"type": "string",
"example": "2026-06-02T12:00:00Z"
},
"PeriodStartTime": {
"format": "date-time",
"type": "string",
"example": "2026-06-02T12:00:00Z"
},
"PeriodEndTime": {
"format": "date-time",
"type": "string",
"example": "2026-06-02T12:00:00Z"
},
"DestinationBank": {
"type": "string",
"example": "string"
},
"DestinationAccount": {
"type": "string",
"example": "string"
},
"Amount": {
"format": "double",
"type": "number",
"example": 12.5
},
"Currency": {
"type": "string",
"example": "EUR"
},
"BankAccountHasChanged": {
"type": "boolean",
"example": true
}
}
},
"PayoutReport3PropertyDetails": {
"type": "object",
"properties": {
"AvailableProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PayoutReport3PropertyFilterOption"
},
"example": []
},
"SelectedPropertyIds": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"string"
]
},
"MatchedStoreIds": {
"type": "array",
"items": {
"format": "int32",
"type": "integer"
},
"example": [
1
]
},
"Details": {
"$ref": "#/components/schemas/PayoutReport3Details"
}
}
},
"PayoutReport3PropertyFilterOption": {
"type": "object",
"properties": {
"PropertyId": {
"type": "string",
"example": "500123"
},
"PropertyName": {
"type": "string",
"example": "Example Name"
},
"StoreIds": {
"type": "array",
"items": {
"format": "int32",
"type": "integer"
},
"example": [
1
]
}
}
},
"PayoutReport3RefundedOrder": {
"type": "object",
"properties": {
"OrderId": {
"format": "int32",
"type": "integer",
"example": 500123
},
"PlacedAtTime": {
"format": "date-time",
"type": "string",
"example": "2026-06-02T12:00:00Z"
},
"ModifiedAtTime": {
"format": "date-time",
"type": "string",
"example": "2026-06-02T12:00:00Z"
},
"StoreName": {
"type": "string",
"example": "Example Name"
},
"Type": {
"enum": [
"Cash",
"Card"
],
"type": "string",
"example": "Cash"
},
"RefundedAmount": {
"format": "double",
"type": "number",
"example": 12.5
},
"RefundedFees": {
"format": "double",
"type": "number",
"example": 12.5
},
"RefundType": {
"type": "string",
"example": "string"
},
"CashFeeRefundedToCustomer": {
"format": "double",
"type": "number",
"example": 12.5
}
}
},
"PayoutReport3Store": {
"type": "object",
"properties": {
"StoreId": {
"format": "int32",
"type": "integer",
"example": 500123
},
"StoreName": {
"type": "string",
"example": "Example Name"
}
}
},
"PayoutReport3StorePayout": {
"type": "object",
"properties": {
"StoreId": {
"format": "int32",
"type": "integer",
"example": 500123
},
"StoreName": {
"type": "string",
"example": "Example Name"
},
"SummaryTotalPayout": {
"format": "double",
"type": "number",
"example": 12.5
},
"SummaryRevenue": {
"format": "double",
"type": "number",
"example": 1.0
},
"SummaryCashRevenue": {
"format": "double",
"type": "number",
"example": 1.0
},
"SummaryTotalFlipdishFees": {
"format": "double",
"type": "number",
"example": 12.5
},
"SummaryAdjustments": {
"format": "double",
"type": "number",
"example": 1.0
},
"Currency": {
"type": "string",
"example": "EUR"
}
}
},
"PayoutReport3StorePayouts": {
"type": "object",
"properties": {
"Stores": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PayoutReport3StorePayout"
},
"example": []
}
}
},
"PayoutStore": {
"description": "Payout details for a single store",
"type": "object",
"properties": {
"StoreId": {
"format": "int32",
"description": "The id of the Store.",
"type": "integer",
"example": 500123
},
"StoreName": {
"description": "Name of the store",
"type": "string",
"example": "Example Name"
},
"Amount": {
"format": "double",
"description": "Amount of the payout for this Store",
"type": "number",
"nullable": true,
"example": 12.5
},
"OnlineRevenue": {
"$ref": "#/components/schemas/RevenueDetail"
},
"Revenue": {
"$ref": "#/components/schemas/RevenueDetail"
},
"RevenueAdjustments": {
"$ref": "#/components/schemas/RevenueAdjustmentsDetails"
},
"FlipdishFees": {
"$ref": "#/components/schemas/FlipdishFeesDetails"
},
"Chargebacks": {
"$ref": "#/components/schemas/ChargebackDetails"
},
"OtherCharges": {
"$ref": "#/components/schemas/OtherChargesDetails"
},
"Balance": {
"$ref": "#/components/schemas/BalanceDetails"
},
"PosRevenue": {
"$ref": "#/components/schemas/PosRevenueDetails"
},
"ThirdPartyFees": {
"$ref": "#/components/schemas/ThirdPartyFeesDetails"
}
}
},
"PayoutSummary": {
"description": "Holds the information for a whitelabel payouts summary.",
"type": "object",
"properties": {
"PayoutStatus": {
"description": "Status of the payout",
"enum": [
"Pending",
"InTransit",
"Paid",
"Failed",
"Cancelled"
],
"type": "string",
"example": "Pending"
},
"TotalAmount": {
"format": "double",
"description": "Total payouts amount",
"type": "number",
"example": 12.5
},
"Currency": {
"description": "Payout currency",
"enum": [
"EUR",
"USD",
"GBP",
"CAD",
"AUD",
"DJF",
"ZAR",
"ETB",
"AED",
"BHD",
"DZD",
"EGP",
"IQD",
"JOD",
"KWD",
"LBP",
"LYD",
"MAD",
"OMR",
"QAR",
"SAR",
"SYP",
"TND",
"YER",
"CLP",
"INR",
"AZN",
"RUB",
"BYN",
"BGN",
"NGN",
"BDT",
"CNY",
"BAM",
"CZK",
"DKK",
"CHF",
"MVR",
"BTN",
"XCD",
"BZD",
"HKD",
"IDR",
"JMD",
"MYR",
"NZD",
"PHP",
"SGD",
"TTD",
"XDR",
"ARS",
"BOB",
"COP",
"CRC",
"CUP",
"DOP",
"GTQ",
"HNL",
"MXN",
"NIO",
"PAB",
"PEN",
"PYG",
"UYU",
"VEF",
"IRR",
"XOF",
"CDF",
"XAF",
"HTG",
"ILS",
"HRK",
"HUF",
"AMD",
"ISK",
"JPY",
"GEL",
"KZT",
"KHR",
"KRW",
"KGS",
"LAK",
"MKD",
"MNT",
"BND",
"MMK",
"NOK",
"NPR",
"PKR",
"PLN",
"AFN",
"BRL",
"MDL",
"RON",
"RWF",
"SEK",
"LKR",
"SOS",
"ALL",
"RSD",
"KES",
"TJS",
"THB",
"ERN",
"TMT",
"BWP",
"TRY",
"UAH",
"UZS",
"VND",
"MOP",
"TWD",
"BMD"
],
"type": "string",
"example": "EUR"
},
"TotalCount": {
"format": "int32",
"description": "Total payouts count",
"type": "integer",
"example": 12.5
}
}
},
"PosRevenueDetails": {
"description": "Breakdown of POS charges",
"type": "object",
"properties": {
"PosSalesAmount": {
"format": "double",
"description": "POS sale amount for the store",
"type": "number",
"example": 12.5
},
"PosSalesTax": {
"format": "double",
"description": "POS sale Tax for the store",
"type": "number",
"example": 1.0
},
"PosSalesTips": {
"format": "double",
"description": "POS sale tips for the store",
"type": "number",
"example": 1.0
},
"TotalPosRevenue": {
"format": "double",
"description": "POS Total Revenue for the store",
"type": "number",
"example": 12.5
}
}
},
"PreviousOrder": {
"type": "object",
"properties": {
"DeliveryType": {
"type": "string",
"example": "string"
},
"DeliveryLocationAddressString": {
"type": "string",
"example": "string"
},
"PaymentAccountType": {
"type": "string",
"example": "string"
},
"OrderId": {
"format": "int32",
"type": "integer",
"example": 500123
},
"ReceiptCode": {
"type": "string",
"example": "string"
},
"RestaurantName": {
"type": "string",
"example": "Example Name"
},
"LocalOrderId": {
"type": "string",
"example": "500123"
},
"TableServiceCategory": {
"type": "string",
"example": "string"
},
"PickupLocationOptionValue": {
"type": "string",
"example": "string"
},
"CustomerName": {
"type": "string",
"example": "Example Name"
},
"PhoneNumberInternationalFormatString": {
"type": "string",
"example": "+353000000000"
},
"DeliveryInstructions": {
"type": "string",
"example": "string"
},
"Currency": {
"enum": [
"EUR",
"USD",
"GBP",
"CAD",
"AUD",
"DJF",
"ZAR",
"ETB",
"AED",
"BHD",
"DZD",
"EGP",
"IQD",
"JOD",
"KWD",
"LBP",
"LYD",
"MAD",
"OMR",
"QAR",
"SAR",
"SYP",
"TND",
"YER",
"CLP",
"INR",
"AZN",
"RUB",
"BYN",
"BGN",
"NGN",
"BDT",
"CNY",
"BAM",
"CZK",
"DKK",
"CHF",
"MVR",
"BTN",
"XCD",
"BZD",
"HKD",
"IDR",
"JMD",
"MYR",
"NZD",
"PHP",
"SGD",
"TTD",
"XDR",
"ARS",
"BOB",
"COP",
"CRC",
"CUP",
"DOP",
"GTQ",
"HNL",
"MXN",
"NIO",
"PAB",
"PEN",
"PYG",
"UYU",
"VEF",
"IRR",
"XOF",
"CDF",
"XAF",
"HTG",
"ILS",
"HRK",
"HUF",
"AMD",
"ISK",
"JPY",
"GEL",
"KZT",
"KHR",
"KRW",
"KGS",
"LAK",
"MKD",
"MNT",
"BND",
"MMK",
"NOK",
"NPR",
"PKR",
"PLN",
"AFN",
"BRL",
"MDL",
"RON",
"RWF",
"SEK",
"LKR",
"SOS",
"ALL",
"RSD",
"KES",
"TJS",
"THB",
"ERN",
"TMT",
"BWP",
"TRY",
"UAH",
"UZS",
"VND",
"MOP",
"TWD",
"BMD"
],
"type": "string",
"example": "EUR"
},
"ProcessingFee": {
"format": "double",
"type": "number",
"example": 12.5
},
"ServiceChargePercentage": {
"format": "double",
"type": "number",
"example": 1.0
},
"ServiceChargeAmount": {
"format": "double",
"type": "number",
"example": 12.5
},
"TipAmount": {
"format": "double",
"type": "number",
"example": 12.5
},
"DeliveryAmount": {
"format": "double",
"type": "number",
"example": 12.5
},
"DepositReturnFeeAmount": {
"format": "double",
"type": "number",
"example": 12.5
},
"TotalTax": {
"format": "double",
"type": "number",
"example": 12.5
},
"TotalAmount": {
"format": "double",
"type": "number",
"example": 12.5
},
"Items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PreviousOrderItem"
},
"example": []
},
"TaxRates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxRate"
},
"example": []
},
"WhiteLabelId": {
"format": "int32",
"type": "integer",
"example": 500123
}
}
},
"PreviousOrderItem": {
"type": "object",
"properties": {
"MenuSectionDisplayOrder": {
"format": "int32",
"type": "integer",
"example": 1
},
"MenuSectionName": {
"type": "string",
"example": "Example Name"
},
"Name": {
"type": "string",
"example": "Example Name"
},
"PriceIncludingOptionSetItems": {
"format": "double",
"type": "number",
"example": 12.5
},
"DepositReturnFee": {
"format": "double",
"type": "number",
"example": 12.5
},
"TaxAmount": {
"format": "double",
"type": "number",
"example": 12.5
},
"PreviousOrderItemOptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PreviousOrderItemOption"
},
"example": []
}
}
},
"PreviousOrderItemOption": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"example": "Example Name"
},
"DepositReturnFee": {
"format": "double",
"type": "number",
"example": 12.5
}
}
},
"ProcessingFeeConfig": {
"description": "Processing fee config",
"type": "object",
"properties": {
"StoreId": {
"format": "int32",
"description": "Store Id",
"type": "integer",
"example": 500123
},
"PaymentAccountType": {
"description": "Payment account type",
"enum": [
"Card",
"Cash",
"Ideal",
"Bancontact",
"Giropay",
"Eps",
"Emv",
"PayPal",
"PayGreen",
"GoogleWalletToken"
],
"type": "string",
"example": "Card"
},
"PercentFee": {
"format": "double",
"description": "Percent fee to customer, including VAT",
"type": "number",
"example": 12.5
},
"FixedFee": {
"format": "double",
"description": "Fixed fee to customer, including VAT",
"type": "number",
"example": 12.5
}
}
},
"RestApiArrayResult_BankAccountSummary_": {
"description": "Rest api array result",
"required": [
"Data"
],
"type": "object",
"properties": {
"Data": {
"description": "Generic data object.",
"type": "array",
"items": {
"$ref": "#/components/schemas/BankAccountSummary"
},
"example": []
}
}
},
"RestApiArrayResult_CountryWithAccountFieldsDefinitions_": {
"description": "Rest api array result",
"required": [
"Data"
],
"type": "object",
"properties": {
"Data": {
"description": "Generic data object.",
"type": "array",
"items": {
"$ref": "#/components/schemas/CountryWithAccountFieldsDefinitions"
},
"example": []
}
}
},
"RestApiArrayResult_PayoutSummary_": {
"description": "Rest api array result",
"required": [
"Data"
],
"type": "object",
"properties": {
"Data": {
"description": "Generic data object.",
"type": "array",
"items": {
"$ref": "#/components/schemas/PayoutSummary"
},
"example": []
}
}
},
"RestApiArrayResult_ProcessingFeeConfig_": {
"description": "Rest api array result",
"required": [
"Data"
],
"type": "object",
"properties": {
"Data": {
"description": "Generic data object.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ProcessingFeeConfig"
},
"example": []
}
}
},
"RestApiArrayResult_StripeCustomConnectedAccount_": {
"description": "Rest api array result",
"required": [
"Data"
],
"type": "object",
"properties": {
"Data": {
"description": "Generic data object.",
"type": "array",
"items": {
"$ref": "#/components/schemas/StripeCustomConnectedAccount"
},
"example": []
}
}
},
"RestApiArrayResult_SubscriptionSummary_": {
"description": "Rest api array result",
"required": [
"Data"
],
"type": "object",
"properties": {
"Data": {
"description": "Generic data object.",
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionSummary"
},
"example": []
}
}
},
"RestApiErrorResult": {
"description": "Rest api error result",
"required": [
"Message"
],
"type": "object",
"properties": {
"Message": {
"description": "Error message",
"type": "string",
"example": "string"
},
"ErrorCode": {
"format": "int32",
"description": "Error code",
"type": "integer",
"example": 1
},
"StackTrace": {
"description": "Stack trace",
"type": "string",
"example": "string"
},
"Errors": {
"description": "List of errors grouped by field name",
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationErrorResult"
},
"example": []
}
}
},
"RestApiFinanceSearchPaginationResult_Invoice_": {
"description": "Rest api finance search pagination result",
"required": [
"NextPage",
"Limit",
"TotalRecordCount",
"Data"
],
"type": "object",
"properties": {
"NextPage": {
"description": "Next page",
"type": "string",
"example": "string"
},
"Limit": {
"format": "int32",
"description": "Current page size",
"type": "integer",
"example": 1
},
"TotalRecordCount": {
"format": "int32",
"description": "Total record count",
"type": "integer",
"example": 12.5
},
"Data": {
"description": "Generic data object.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Invoice"
},
"example": []
}
}
},
"RestApiFinanceSearchPaginationResult_SubscriptionInvoice_": {
"description": "Rest api finance search pagination result",
"required": [
"NextPage",
"Limit",
"TotalRecordCount",
"Data"
],
"type": "object",
"properties": {
"NextPage": {
"description": "Next page",
"type": "string",
"example": "string"
},
"Limit": {
"format": "int32",
"description": "Current page size",
"type": "integer",
"example": 1
},
"TotalRecordCount": {
"format": "int32",
"description": "Total record count",
"type": "integer",
"example": 12.5
},
"Data": {
"description": "Generic data object.",
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionInvoice"
},
"example": []
}
}
},
"RestApiPaginationResult_PayoutChargeback_": {
"description": "Rest api pagination result",
"required": [
"Page",
"Limit",
"TotalRecordCount",
"Data"
],
"type": "object",
"properties": {
"Page": {
"format": "int32",
"description": "Current page index",
"type": "integer",
"example": 1
},
"Limit": {
"format": "int32",
"description": "Current page size",
"type": "integer",
"example": 1
},
"TotalRecordCount": {
"format": "int32",
"description": "Total record count",
"type": "integer",
"example": 12.5
},
"Data": {
"description": "Generic data object.",
"type": "array",
"items": {
"$ref": "#/components/schemas/PayoutChargeback"
},
"example": []
}
}
},
"RestApiPaginationResult_PayoutOrder_": {
"description": "Rest api pagination result",
"required": [
"Page",
"Limit",
"TotalRecordCount",
"Data"
],
"type": "object",
"properties": {
"Page": {
"format": "int32",
"description": "Current page index",
"type": "integer",
"example": 1
},
"Limit": {
"format": "int32",
"description": "Current page size",
"type": "integer",
"example": 1
},
"TotalRecordCount": {
"format": "int32",
"description": "Total record count",
"type": "integer",
"example": 12.5
},
"Data": {
"description": "Generic data object.",
"type": "array",
"items": {
"$ref": "#/components/schemas/PayoutOrder"
},
"example": []
}
}
},
"RestApiPaginationResult_PayoutOtherCharge_": {
"description": "Rest api pagination result",
"required": [
"Page",
"Limit",
"TotalRecordCount",
"Data"
],
"type": "object",
"properties": {
"Page": {
"format": "int32",
"description": "Current page index",
"type": "integer",
"example": 1
},
"Limit": {
"format": "int32",
"description": "Current page size",
"type": "integer",
"example": 1
},
"TotalRecordCount": {
"format": "int32",
"description": "Total record count",
"type": "integer",
"example": 12.5
},
"Data": {
"description": "Generic data object.",
"type": "array",
"items": {
"$ref": "#/components/schemas/PayoutOtherCharge"
},
"example": []
}
}
},
"RestApiPaginationResult_PayoutRefund_": {
"description": "Rest api pagination result",
"required": [
"Page",
"Limit",
"TotalRecordCount",
"Data"
],
"type": "object",
"properties": {
"Page": {
"format": "int32",
"description": "Current page index",
"type": "integer",
"example": 1
},
"Limit": {
"format": "int32",
"description": "Current page size",
"type": "integer",
"example": 1
},
"TotalRecordCount": {
"format": "int32",
"description": "Total record count",
"type": "integer",
"example": 12.5
},
"Data": {
"description": "Generic data object.",
"type": "array",
"items": {
"$ref": "#/components/schemas/PayoutRefund"
},
"example": []
}
}
},
"RestApiPaginationResult_PayoutReport3RefundedOrder_": {
"description": "Rest api pagination result",
"required": [
"Page",
"Limit",
"TotalRecordCount",
"Data"
],
"type": "object",
"properties": {
"Page": {
"format": "int32",
"description": "Current page index",
"type": "integer",
"example": 1
},
"Limit": {
"format": "int32",
"description": "Current page size",
"type": "integer",
"example": 1
},
"TotalRecordCount": {
"format": "int32",
"description": "Total record count",
"type": "integer",
"example": 12.5
},
"Data": {
"description": "Generic data object.",
"type": "array",
"items": {
"$ref": "#/components/schemas/PayoutReport3RefundedOrder"
},
"example": []
}
}
},
"RestApiPaginationResult_Payout_": {
"description": "Rest api pagination result",
"required": [
"Page",
"Limit",
"TotalRecordCount",
"Data"
],
"type": "object",
"properties": {
"Page": {
"format": "int32",
"description": "Current page index",
"type": "integer",
"example": 1
},
"Limit": {
"format": "int32",
"description": "Current page size",
"type": "integer",
"example": 1
},
"TotalRecordCount": {
"format": "int32",
"description": "Total record count",
"type": "integer",
"example": 12.5
},
"Data": {
"description": "Generic data object.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Payout"
},
"example": []
}
}
},
"RestApiResult_AccountFieldsDefinitions_": {
"description": "Rest api result",
"required": [
"Data"
],
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/AccountFieldsDefinitions"
}
}
},
"RestApiResult_BankAccountDetail_": {
"description": "Rest api result",
"required": [
"Data"
],
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/BankAccountDetail"
}
}
},
"RestApiResult_FileCreationResult_": {
"description": "Rest api result",
"required": [
"Data"
],
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/FileCreationResult"
}
}
},
"RestApiResult_HasPaymentMethodResponse_": {
"description": "Rest api result",
"required": [
"Data"
],
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/HasPaymentMethodResponse"
}
}
},
"RestApiResult_ModelBase_": {
"description": "Rest api result",
"required": [
"Data"
],
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/ModelBase"
}
}
},
"RestApiResult_OrderPaymentInformation_": {
"description": "Rest api result",
"required": [
"Data"
],
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/OrderPaymentInformation"
}
}
},
"RestApiResult_PaymentIntent_": {
"description": "Rest api result",
"required": [
"Data"
],
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/PaymentIntent"
}
}
},
"RestApiResult_PayoutReport3Details_": {
"description": "Rest api result",
"required": [
"Data"
],
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/PayoutReport3Details"
}
}
},
"RestApiResult_PayoutReport3Overview_": {
"description": "Rest api result",
"required": [
"Data"
],
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/PayoutReport3Overview"
}
}
},
"RestApiResult_PayoutReport3PropertyDetails_": {
"description": "Rest api result",
"required": [
"Data"
],
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/PayoutReport3PropertyDetails"
}
}
},
"RestApiResult_PayoutReport3StorePayouts_": {
"description": "Rest api result",
"required": [
"Data"
],
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/PayoutReport3StorePayouts"
}
}
},
"RestApiResult_StripeConnectedAccount_": {
"description": "Rest api result",
"required": [
"Data"
],
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/StripeConnectedAccount"
}
}
},
"RestApiResult_Subscription_": {
"description": "Rest api result",
"required": [
"Data"
],
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/Subscription"
}
}
},
"RevenueAdjustmentsDetails": {
"description": "Revenue Adjustments breakdown",
"type": "object",
"properties": {
"OnlineSalesRefundedAmount": {
"format": "double",
"description": "Online sales refunds",
"type": "number",
"example": 12.5
},
"PosSalesRefundedAmount": {
"format": "double",
"description": "POS Online sales refunds",
"type": "number",
"example": 12.5
},
"CashSalesRefundedAmount": {
"format": "double",
"description": "Cash sales refunds",
"type": "number",
"example": 12.5
},
"CustomerCashFees": {
"format": "double",
"description": "Customer cash fees",
"type": "number",
"example": 12.5
},
"RefundsCount": {
"format": "int32",
"description": "Number of refunds",
"type": "integer",
"example": 3
},
"PayGreenSalesAmount": {
"format": "double",
"description": "PayGreen sales",
"type": "number",
"nullable": true,
"example": 12.5
},
"PayGreenProcessingFees": {
"format": "double",
"description": "PayGreen processing fees charged to end-user",
"type": "number",
"nullable": true,
"example": 12.5
},
"TotalOnlineRevenueAdjustments": {
"format": "double",
"description": "Total revenue adjustments",
"type": "number",
"example": 12.5
}
}
},
"RevenueDetail": {
"description": "Sales information",
"type": "object",
"properties": {
"OnlineSalesAmount": {
"format": "double",
"description": "Online sales amount",
"type": "number",
"example": 12.5
},
"OnlineSalesTax": {
"format": "double",
"description": "Online sales tax",
"type": "number",
"example": 1.0
},
"OnlineSalesIncludingTax": {
"format": "double",
"description": "Online sales amount plus online sales tax",
"type": "number",
"example": 1.0
},
"OnlineSalesFeesBaseAmount": {
"format": "double",
"description": "Online sales base amount to calculate fees",
"type": "number",
"example": 12.5
},
"CashSalesAmount": {
"format": "double",
"description": "Cash sales amount",
"type": "number",
"example": 12.5
},
"CashSalesTax": {
"format": "double",
"description": "Cash sales tax",
"type": "number",
"example": 1.0
},
"CashSalesIncludingTax": {
"format": "double",
"description": "Cash sales amount plus online sales tax",
"type": "number",
"example": 1.0
},
"CashSalesFeesBaseAmount": {
"format": "double",
"description": "Online sales base amount to calculate fees",
"type": "number",
"example": 12.5
},
"TotalSalesIncludingTax": {
"format": "double",
"description": "Total Sales (online and cash) including tax",
"type": "number",
"example": 12.5
},
"OnlineSalesDeliveryCharges": {
"format": "double",
"description": "Delivery charges on online sales",
"type": "number",
"example": 1.0
},
"OnlineSalesTips": {
"format": "double",
"description": "Tips for online sales",
"type": "number",
"example": 1.0
},
"TotalOnlineRevenue": {
"format": "double",
"description": "Online sales plus online delivery charges and tips",
"type": "number",
"example": 12.5
},
"OnlineSalesServiceCharges": {
"format": "double",
"description": "Service charge on online sales",
"type": "number",
"example": 1.0
}
}
},
"StripeAccountLinkRequest": {
"description": "Represents a request for Stripe account link creation",
"type": "object",
"properties": {
"StripeId": {
"description": "Stripe's own connected account identifier",
"type": "string",
"example": "500123"
},
"ReturnUrl": {
"description": "URL to be hit if link creation succeeds",
"type": "string",
"example": "https://api.flipdish.co/example"
},
"Collect": {
"description": "Which information to collect from users at this stage",
"enum": [
"CurrentlyDue",
"EventuallyDue"
],
"type": "string",
"example": "CurrentlyDue"
},
"Type": {
"description": "Either onboarding or edit user information",
"enum": [
"Onboarding",
"Update"
],
"type": "string",
"example": "Onboarding"
}
}
},
"StripeConnectedAccount": {
"description": "Represents a Stripe custom connected account",
"type": "object",
"properties": {
"FlipdishConnectedAccountId": {
"format": "int32",
"description": "Flipdish connected account identifier",
"type": "integer",
"example": 500123
},
"StripeId": {
"description": "Stripe's own connected account identifier",
"type": "string",
"example": "500123"
},
"WhitelabelConfigId": {
"format": "int32",
"description": "Id of the WhitelabelConfig the connected account is assigned to",
"type": "integer",
"example": 500123
},
"CardPaymentsStatus": {
"description": "Card payments capability status (Inactive, Pending, Active, Unrequested)",
"enum": [
"Inactive",
"Pending",
"Active",
"Unrequested"
],
"type": "string",
"example": "Inactive"
},
"TransfersStatus": {
"description": "Transfers capability status (Inactive, Pending, Active, Unrequested)",
"enum": [
"Inactive",
"Pending",
"Active",
"Unrequested"
],
"type": "string",
"example": "Inactive"
},
"AccountStatus": {
"description": "Current status of the account",
"enum": [
"Disabled",
"Enabled",
"AdditionalInformationRequired",
"PendingVerification",
"Unverified",
"Rejected",
"UpdateExternalAccount",
"PlatformPaused"
],
"type": "string",
"example": "Disabled"
},
"PayoutsEnabled": {
"description": "Payouts Enabled status",
"type": "boolean",
"nullable": true,
"example": true
},
"PaymentsEnabled": {
"description": "Payments Enabled status",
"type": "boolean",
"nullable": true,
"example": true
}
}
},
"StripeConnectedAccountInfo": {
"description": "Represents information about a Stripe connected account associated with a bank account",
"type": "object",
"properties": {
"AccountStatus": {
"description": "Stripe connected account status",
"enum": [
"Disabled",
"Enabled",
"AdditionalInformationRequired",
"PendingVerification",
"Unverified",
"Rejected",
"UpdateExternalAccount",
"PlatformPaused"
],
"type": "string",
"example": "Disabled"
},
"StripeId": {
"description": "Stripe connected account id",
"type": "string",
"example": "500123"
},
"CardPaymentStatus": {
"description": "Current status of the Card Payment capability of the account",
"enum": [
"Inactive",
"Pending",
"Active",
"Unrequested"
],
"type": "string",
"example": "Inactive"
},
"PayoutScheduleInterval": {
"description": "Payouts Schedule Interval",
"enum": [
"Manual",
"Daily",
"Weekly",
"Monthly"
],
"type": "string",
"example": "Manual"
},
"PayoutsEnabled": {
"description": "Payouts Enabled status",
"type": "boolean",
"nullable": true,
"example": true
},
"PayoutsPaused": {
"description": "Flag indicating if payouts are paused",
"type": "boolean",
"example": true
},
"PaymentsEnabled": {
"description": "Flag indicating if payments are enabled",
"type": "boolean",
"nullable": true,
"example": true
}
}
},
"StripeCustomConnectedAccount": {
"description": "Flipdish Stripe Custom Connected Account associated to the Store",
"type": "object",
"properties": {
"StoreId": {
"format": "int32",
"description": "Physical Restaurant Id",
"type": "integer",
"example": 500123
},
"StripeId": {
"description": "Stripe's own connected account identifier",
"type": "string",
"example": "500123"
},
"CardPaymentsStatus": {
"description": "Card payments capability status (Inactive, Pending, Active, Unrequested)",
"enum": [
"Inactive",
"Pending",
"Active",
"Unrequested"
],
"type": "string",
"example": "Inactive"
},
"TransfersStatus": {
"description": "Transfers capability status (Inactive, Pending, Active, Unrequested)",
"enum": [
"Inactive",
"Pending",
"Active",
"Unrequested"
],
"type": "string",
"example": "Inactive"
},
"AccountStatus": {
"description": "Current status of the account",
"enum": [
"Disabled",
"Enabled",
"AdditionalInformationRequired",
"PendingVerification",
"Unverified",
"Rejected",
"UpdateExternalAccount",
"PlatformPaused"
],
"type": "string",
"example": "Disabled"
}
}
},
"Subscription": {
"description": "Subscription",
"required": [
"Products",
"SubscriptionId",
"Name",
"Status",
"Currency",
"User"
],
"type": "object",
"properties": {
"Products": {
"description": "Products",
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionProduct"
},
"example": []
},
"NextInvoiceAmount": {
"format": "double",
"description": "Next invoice amount",
"type": "number",
"nullable": true,
"example": 12.5
},
"NextInvoiceBillingDate": {
"format": "date-time",
"description": "Next invoice billing date",
"type": "string",
"nullable": true,
"example": "2026-06-02T12:00:00Z"
},
"UpcomingInvoiceItems": {
"description": "Upcoming invoice items",
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceItem"
},
"example": []
},
"UpcomingInvoiceDiscounts": {
"description": "Upcoming invoice discounts",
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceDiscount"
},
"example": []
},
"UpcomingInvoice": {
"$ref": "#/components/schemas/UpcomingInvoice"
},
"SubscriptionId": {
"description": "The subscription identifier",
"type": "string",
"example": "500123"
},
"Name": {
"description": "Name",
"type": "string",
"example": "Example Name"
},
"Status": {
"description": "Status",
"enum": [
"Incomplete",
"IncompleteExpired",
"Trialing",
"Active",
"PastDue",
"Canceled",
"Unpaid"
],
"type": "string",
"example": "Incomplete"
},
"Currency": {
"description": "Currency",
"enum": [
"EUR",
"USD",
"GBP",
"CAD",
"AUD",
"DJF",
"ZAR",
"ETB",
"AED",
"BHD",
"DZD",
"EGP",
"IQD",
"JOD",
"KWD",
"LBP",
"LYD",
"MAD",
"OMR",
"QAR",
"SAR",
"SYP",
"TND",
"YER",
"CLP",
"INR",
"AZN",
"RUB",
"BYN",
"BGN",
"NGN",
"BDT",
"CNY",
"BAM",
"CZK",
"DKK",
"CHF",
"MVR",
"BTN",
"XCD",
"BZD",
"HKD",
"IDR",
"JMD",
"MYR",
"NZD",
"PHP",
"SGD",
"TTD",
"XDR",
"ARS",
"BOB",
"COP",
"CRC",
"CUP",
"DOP",
"GTQ",
"HNL",
"MXN",
"NIO",
"PAB",
"PEN",
"PYG",
"UYU",
"VEF",
"IRR",
"XOF",
"CDF",
"XAF",
"HTG",
"ILS",
"HRK",
"HUF",
"AMD",
"ISK",
"JPY",
"GEL",
"KZT",
"KHR",
"KRW",
"KGS",
"LAK",
"MKD",
"MNT",
"BND",
"MMK",
"NOK",
"NPR",
"PKR",
"PLN",
"AFN",
"BRL",
"MDL",
"RON",
"RWF",
"SEK",
"LKR",
"SOS",
"ALL",
"RSD",
"KES",
"TJS",
"THB",
"ERN",
"TMT",
"BWP",
"TRY",
"UAH",
"UZS",
"VND",
"MOP",
"TWD",
"BMD"
],
"type": "string",
"example": "EUR"
},
"User": {
"description": "User",
"type": "string",
"example": "string"
},
"DefaultPaymentDescription": {
"description": "Default payment description",
"type": "string",
"example": "string"
},
"CancellationRequestDate": {
"format": "date-time",
"description": "Cancellation Date",
"type": "string",
"nullable": true,
"example": "2026-06-02T12:00:00Z"
},
"CancellationDate": {
"format": "date-time",
"description": "Cancel Date",
"type": "string",
"nullable": true,
"example": "2026-06-02T12:00:00Z"
}
}
},
"SubscriptionInvoice": {
"description": "Invoice",
"required": [
"InvoiceId",
"Number",
"Currency",
"Status",
"PdfLink",
"HostedUrl",
"Overdue"
],
"type": "object",
"properties": {
"InvoiceId": {
"description": "The invoice identifier",
"type": "string",
"example": "500123"
},
"Number": {
"description": "Invoice number",
"type": "string",
"example": "string"
},
"Total": {
"format": "double",
"description": "Total",
"type": "number",
"example": 12.5
},
"Currency": {
"description": "Currency",
"enum": [
"EUR",
"USD",
"GBP",
"CAD",
"AUD",
"DJF",
"ZAR",
"ETB",
"AED",
"BHD",
"DZD",
"EGP",
"IQD",
"JOD",
"KWD",
"LBP",
"LYD",
"MAD",
"OMR",
"QAR",
"SAR",
"SYP",
"TND",
"YER",
"CLP",
"INR",
"AZN",
"RUB",
"BYN",
"BGN",
"NGN",
"BDT",
"CNY",
"BAM",
"CZK",
"DKK",
"CHF",
"MVR",
"BTN",
"XCD",
"BZD",
"HKD",
"IDR",
"JMD",
"MYR",
"NZD",
"PHP",
"SGD",
"TTD",
"XDR",
"ARS",
"BOB",
"COP",
"CRC",
"CUP",
"DOP",
"GTQ",
"HNL",
"MXN",
"NIO",
"PAB",
"PEN",
"PYG",
"UYU",
"VEF",
"IRR",
"XOF",
"CDF",
"XAF",
"HTG",
"ILS",
"HRK",
"HUF",
"AMD",
"ISK",
"JPY",
"GEL",
"KZT",
"KHR",
"KRW",
"KGS",
"LAK",
"MKD",
"MNT",
"BND",
"MMK",
"NOK",
"NPR",
"PKR",
"PLN",
"AFN",
"BRL",
"MDL",
"RON",
"RWF",
"SEK",
"LKR",
"SOS",
"ALL",
"RSD",
"KES",
"TJS",
"THB",
"ERN",
"TMT",
"BWP",
"TRY",
"UAH",
"UZS",
"VND",
"MOP",
"TWD",
"BMD"
],
"type": "string",
"example": "EUR"
},
"Status": {
"description": "Status",
"enum": [
"Draft",
"Open",
"Paid",
"UnCollectible",
"Void"
],
"type": "string",
"example": "Draft"
},
"SubscriptionId": {
"description": "The subscription identifier",
"type": "string",
"example": "500123"
},
"PaidAt": {
"format": "date-time",
"description": "Paid At",
"type": "string",
"nullable": true,
"example": "2026-06-02T12:00:00Z"
},
"FinalisedAt": {
"format": "date-time",
"description": "Finalised At",
"type": "string",
"nullable": true,
"example": "2026-06-02T12:00:00Z"
},
"PdfLink": {
"description": "Pdf Link",
"type": "string",
"example": "https://api.flipdish.co/example"
},
"HostedUrl": {
"description": "Hosted Url",
"type": "string",
"example": "https://api.flipdish.co/example"
},
"Overdue": {
"description": "Overdue",
"type": "boolean",
"example": true
}
}
},
"SubscriptionProduct": {
"description": "Product",
"required": [
"ProductId",
"Name",
"Quantity",
"PaymentFrequency"
],
"type": "object",
"properties": {
"ProductId": {
"description": "Product Identifier",
"type": "string",
"example": "500123"
},
"Name": {
"description": "Name",
"type": "string",
"example": "Example Name"
},
"Quantity": {
"format": "int64",
"description": "Quantity",
"type": "integer",
"example": 3
},
"PricePerUnit": {
"format": "double",
"description": "Price Per Unit",
"type": "number",
"nullable": true,
"example": 12.5
},
"PriceTotal": {
"format": "double",
"description": "Price Total",
"type": "number",
"nullable": true,
"example": 12.5
},
"PaymentFrequency": {
"description": "Payment Frequency",
"enum": [
"day",
"week",
"month",
"year"
],
"type": "string",
"example": "day"
},
"Stores": {
"description": "Stores",
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionStore"
},
"example": []
}
}
},
"SubscriptionStore": {
"description": "Subscription Store",
"required": [
"Id",
"Name"
],
"type": "object",
"properties": {
"Id": {
"format": "int32",
"description": "Store Id",
"type": "integer",
"example": 500123
},
"Name": {
"description": "Name",
"type": "string",
"example": "Example Name"
}
}
},
"SubscriptionSummary": {
"description": "Subscription Summary",
"required": [
"SubscriptionId",
"Name",
"Status",
"Currency",
"User"
],
"type": "object",
"properties": {
"NextInvoiceAmount": {
"format": "double",
"description": "Next invoice amount",
"type": "number",
"nullable": true,
"example": 12.5
},
"NextInvoiceBillingDate": {
"format": "date-time",
"description": "Next invoice billing date",
"type": "string",
"nullable": true,
"example": "2026-06-02T12:00:00Z"
},
"SubscriptionId": {
"description": "The subscription identifier",
"type": "string",
"example": "500123"
},
"Name": {
"description": "Name",
"type": "string",
"example": "Example Name"
},
"Status": {
"description": "Status",
"enum": [
"Incomplete",
"IncompleteExpired",
"Trialing",
"Active",
"PastDue",
"Canceled",
"Unpaid"
],
"type": "string",
"example": "Incomplete"
},
"Currency": {
"description": "Currency",
"enum": [
"EUR",
"USD",
"GBP",
"CAD",
"AUD",
"DJF",
"ZAR",
"ETB",
"AED",
"BHD",
"DZD",
"EGP",
"IQD",
"JOD",
"KWD",
"LBP",
"LYD",
"MAD",
"OMR",
"QAR",
"SAR",
"SYP",
"TND",
"YER",
"CLP",
"INR",
"AZN",
"RUB",
"BYN",
"BGN",
"NGN",
"BDT",
"CNY",
"BAM",
"CZK",
"DKK",
"CHF",
"MVR",
"BTN",
"XCD",
"BZD",
"HKD",
"IDR",
"JMD",
"MYR",
"NZD",
"PHP",
"SGD",
"TTD",
"XDR",
"ARS",
"BOB",
"COP",
"CRC",
"CUP",
"DOP",
"GTQ",
"HNL",
"MXN",
"NIO",
"PAB",
"PEN",
"PYG",
"UYU",
"VEF",
"IRR",
"XOF",
"CDF",
"XAF",
"HTG",
"ILS",
"HRK",
"HUF",
"AMD",
"ISK",
"JPY",
"GEL",
"KZT",
"KHR",
"KRW",
"KGS",
"LAK",
"MKD",
"MNT",
"BND",
"MMK",
"NOK",
"NPR",
"PKR",
"PLN",
"AFN",
"BRL",
"MDL",
"RON",
"RWF",
"SEK",
"LKR",
"SOS",
"ALL",
"RSD",
"KES",
"TJS",
"THB",
"ERN",
"TMT",
"BWP",
"TRY",
"UAH",
"UZS",
"VND",
"MOP",
"TWD",
"BMD"
],
"type": "string",
"example": "EUR"
},
"User": {
"description": "User",
"type": "string",
"example": "string"
},
"DefaultPaymentDescription": {
"description": "Default payment description",
"type": "string",
"example": "string"
},
"CancellationRequestDate": {
"format": "date-time",
"description": "Cancellation Date",
"type": "string",
"nullable": true,
"example": "2026-06-02T12:00:00Z"
},
"CancellationDate": {
"format": "date-time",
"description": "Cancel Date",
"type": "string",
"nullable": true,
"example": "2026-06-02T12:00:00Z"
}
}
},
"TaxRate": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"example": "Example Name"
},
"Percentage": {
"format": "double",
"type": "number",
"example": 1.0
},
"Total": {
"format": "double",
"type": "number",
"example": 12.5
}
}
},
"ThirdPartyFeesDetails": {
"description": "Breakdown of third party integration fees",
"type": "object",
"properties": {
"DeliveryIntegrationFee": {
"format": "double",
"description": "Third party integration delivery fee",
"type": "number",
"example": 12.5
},
"DeliveryTipFee": {
"format": "double",
"description": "Third party integration delivery tip fee",
"type": "number",
"example": 12.5
},
"TotalThirdPartyFees": {
"format": "double",
"description": "Total third party integration fees",
"type": "number",
"example": 12.5
}
}
},
"UpcomingInvoice": {
"description": "UpcomingInvoice.",
"required": [
"Subtotal",
"AmountDue",
"Tax"
],
"type": "object",
"properties": {
"Amount": {
"format": "double",
"description": "Amount",
"type": "number",
"example": 12.5
},
"NextBillingDate": {
"format": "date-time",
"description": "Next billing date",
"type": "string",
"example": "2026-06-02T12:00:00Z"
},
"Subtotal": {
"format": "double",
"description": "Subtotal",
"type": "number",
"example": 12.5
},
"TotalExcludingTax": {
"format": "double",
"description": "Total excluding tax",
"type": "number",
"nullable": true,
"example": 12.5
},
"AmountDue": {
"format": "double",
"description": "Amount due",
"type": "number",
"example": 12.5
},
"Tax": {
"format": "double",
"description": "Tax",
"type": "number",
"example": 1.0
},
"Items": {
"description": "Items",
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceItem"
},
"example": []
},
"Discounts": {
"description": "Discounts",
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceDiscount"
},
"example": []
}
}
},
"ValidationErrorResult": {
"description": "Validation error result",
"type": "object",
"properties": {
"FieldName": {
"description": "Field name",
"type": "string",
"example": "Example Name"
},
"Errors": {
"description": "List of errors relates to field",
"type": "array",
"items": {
"type": "string"
},
"example": [
"string"
]
}
}
}
},
"securitySchemes": {
"oauth2": {
"type": "oauth2",
"description": "OAuth 2.0. Implicit grant for first-party portal apps; client credentials grant for server-to-server App Store apps (exchange Client ID + Secret Key for a bearer access token).",
"flows": {
"implicit": {
"authorizationUrl": "https://api.flipdish.co/identity/connect/authorize",
"scopes": {
"api": "Access to the Flipdish API"
}
},
"clientCredentials": {
"tokenUrl": "https://api.flipdish.co/identity/connect/token",
"scopes": {
"api": "Access to the Flipdish API"
}
}
}
}
}
}
}