Flipdish · Schema

PayoutDetail

Holds the information for a whitelabel payout with details broken down by Store

RestaurantOnline OrderingMobile AppsPoint-of-SaleOrderMenusPaymentsWebhook

Properties

Name Type Description
PayoutId integer The id of the payout.
BankAccountId integer Bank account identifier
AccountName string Account name of the payout destination
PayoutStatus string Status of the payout
CreatedDate string Date payout was created
PeriodStartTime string This payout includes operations after at this date (inclusive)
PeriodEndTime string This payout includes operations before at this date (exclusive)
DestinationBank string Destination bank name
DestinationAccount string Last 4 digits of the destination bank IBAN
PayoutType string Type of payout source
Currency string Payout currency
PayoutStores array Payout information broken down by Store
Amount number Payout amount
CutoffDate string Payouts before this date do not have a details breakdown
View JSON Schema on GitHub

JSON Schema

payments-payout-detail-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-schema/payments-payout-detail-schema.json",
  "title": "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"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/payments-payout-detail"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.