---
title: "POST /api/v1.0/{appId}/bankaccounts"
method: POST
path: "/api/v1.0/{appId}/bankaccounts"
tags: ["BankAccount"]
---

# POST /api/v1.0/{appId}/bankaccounts

`POST /api/v1.0/{appId}/bankaccounts`

## Request

- Base URL: `https://api.flipdish.co`
- URL: `https://api.flipdish.co/api/v1.0/{appId}/bankaccounts`
- Auth: OAuth 2 (implicit, authorization URL `https://api.flipdish.co/identity/connect/authorize`, scopes: `api`)

## Path parameters

- `appId` string, required

## Request body

- BankAccountCreate
  - `BankAddress` string: Address lf the bank
  - `BankCountryCode` string: CountryCode of the Bank Account
  - `AccountHolderAddress` string: Account Holders Address
  - `AccountHolderCountryCode` string: Account Holders Country Code
  - `VatNumber` string: Account Holders Vat Number
  - `CurrencyCode` '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': Currency of Account
  - `StoreIds` integer[]: List of stores to attach to Account
  - `BankName` string: Name of Bank
  - `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` AccountFieldKeyValuePair[]: 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.
    - `Key` 'Iban' | 'AccountNumber' | 'RoutingNumber' | 'BSB' | 'BranchCode' | 'BankCode' | 'InstitutionNumber' | 'TransitNumber' | 'ClearingCode' | 'IfscCode' | 'Clabe' | 'SortCode' | 'Swift': Depending on the Key, the field's value will be stored in a different field in PayeeBankAccountData
    - `Value` string: The value of the field
  - `RejectionReason` string: Reason for Rejection
  - `BusinessType` 'Individual' | 'Company' | 'NonProfit' | 'GovernmentEntity', nullable: Business Type

## Response `200`

OK

- RestApiResultBankAccountDetail: Rest api result
  - `Data` BankAccountDetail, required
    - `Id` integer: Id of this account
    - `StoreNames` string[]: Store Names that are attached to this account
    - `AccountState` 'Unverified' | 'AwatingVerification' | 'Verified' | 'Grandfathered': Status of Account
    - `StripeConnectedAccountInfo` StripeConnectedAccountInfo: Represents information about a Stripe connected account associated with a bank account
      - `AccountStatus` 'Disabled' | 'Enabled' | 'AdditionalInformationRequired' | 'PendingVerification' | 'Unverified' | 'Rejected' | 'UpdateExternalAccount' | 'PlatformPaused': Stripe connected account status
      - `StripeId` string: Stripe connected account id
      - `CardPaymentStatus` 'Inactive' | 'Pending' | 'Active' | 'Unrequested': Current status of the Card Payment capability of the account
      - `PayoutScheduleInterval` 'Manual' | 'Daily' | 'Weekly' | 'Monthly': Payouts Schedule Interval
      - `PayoutsEnabled` boolean, nullable: Payouts Enabled status
      - `PayoutsPaused` boolean: Flag indicating if payouts are paused
      - `PaymentsEnabled` boolean, nullable: Flag indicating if payments are enabled
      - `DisabledReason` string: If the Stripe connected account is disabled, this is Stripe's raw requirements.disabled_reason describing why, as last recorded from a Stripe connected-account webhook. Known values are requirements.fields_needed, requirements.past_due, requirements.pending_verification, rejected.fraud, rejected.terms_of_service, rejected.listed, rejected.other and platform_paused, but Stripe can introduce new ones, so the value is passed through unmapped (the same way CapabilityRequirementsInfo.DisabledReason is). null when the account is not disabled. Note that {Flipdish.PublicModels.V1.BankAccount.StripeConnectedAccountInfo.AccountStatus} is a deliberately lossy mapping of this value and the two can legitimately disagree - do not derive one from the other.
    - `BankAddress` string: Address lf the bank
    - `BankCountryCode` string: CountryCode of the Bank Account
    - `AccountHolderAddress` string: Account Holders Address
    - `AccountHolderCountryCode` string: Account Holders Country Code
    - `VatNumber` string: Account Holders Vat Number
    - `CurrencyCode` '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': Currency of Account
    - `StoreIds` integer[]: List of stores to attach to Account
    - `BankName` string: Name of Bank
    - `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` AccountFieldKeyValuePair[]: 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.
      - `Key` 'Iban' | 'AccountNumber' | 'RoutingNumber' | 'BSB' | 'BranchCode' | 'BankCode' | 'InstitutionNumber' | 'TransitNumber' | 'ClearingCode' | 'IfscCode' | 'Clabe' | 'SortCode' | 'Swift': Depending on the Key, the field's value will be stored in a different field in PayeeBankAccountData
      - `Value` string: The value of the field
    - `RejectionReason` string: Reason for Rejection
    - `BusinessType` 'Individual' | 'Company' | 'NonProfit' | 'GovernmentEntity', nullable: Business Type

## Other responses

- `400`: BadRequest
- `401`: Authentication has been denied for this request.
- `403`: Successful authentication, but authorization has been denied for this request.

---

[API](https://skmtc.dev/flipdish/apis/flipdish-open-api-v1-0.md) · [All operations](https://skmtc.dev/flipdish/apis/flipdish-open-api-v1-0/llms.txt) · [OpenAPI document](https://skmtc.dev/flipdish/apis/flipdish-open-api-v1-0/revisions/4d8c2b9e1c13?raw)