Flipdish · Schema
BankAccountSummary
BankAccountSummary schema from Flipdish API - Payments.
RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks
Properties
| Name | Type | Description |
|---|---|---|
| Id | integer | Id of this account |
| StoreNames | array | Store Names that are attached to this account |
| StoreIds | array | Store Ids that are attached to this account |
| AccountState | string | Status of Account |
| CurrencyCode | string | Currency of Account |
| VatNumber | string | Account Holders Vat Number |
| AccountHolderAddress | string | Account Holders Address |
| AccountHolderCountryCode | string | Account Holders Country Code |
| StripeConnectedAccountInfo | object | |
| AccountName | string | Name of this account |
| Iban | string | IBAN of this account |
| Swift | string | SWIFT of this bank account |
| NationalClearingCode | string | National Clearing Code (BSB in Australia, Routing Number in USA/Canada, NCC in NZ) |
| PopulatedAccountFields | array | A list of one or more populated account fields (field key-value pairs). If this list contains at least one item, the Iban, Swift and NationalClearingCode fields will be ignored. |
| RejectionReason | string | Reason for Rejection |
| BusinessType | string | Business Type |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-schema/payments-bank-account-summary-schema.json",
"title": "BankAccountSummary",
"description": "BankAccountSummary schema from Flipdish API - Payments.",
"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"
}
}
}