Flipdish StripeCustomConnect API

openapi: 3.0.3
info:
  title: Flipdish API - Apps Accounts StripeCustomConnect API
  version: v1.0
  description: Flipdish Open API v1.0 — Apps operations. Flipdish is an online ordering and branded-app platform for restaurants and takeaways. This specification was derived from the official Flipdish Swagger document and grouped by resource domain.
  contact:
    name: Flipdish Support
    email: help@flipdish.com
    url: https://help.flipdish.com
  x-generated-from: https://api.flipdish.co/swagger/docs/v1.0
  x-last-validated: '2026-06-02'
servers:
- url: https://api.flipdish.co
  description: Flipdish production API
security:
- oauth2:
  - api
tags:
- name: StripeCustomConnect
  description: Operations for Stripe Custom Connect.
paths:
  /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: Cr

# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/openapi/flipdish-stripecustomconnect-api-openapi.yml