---
title: "Create bank account"
method: POST
path: "/banks/"
tags: ["Payments"]
---

# Create bank account

`POST /banks/`

Creates a bank account. When `?external=true&provider=fintoc` is passed
the request is treated as a Fintoc callback and uses the third-party
serializer instead.

## Query parameters

- `external` boolean
- `provider` 'bankops' | 'fintoc' | 'floid' | 'plaid'

## Headers

- `x-simple-workspace` string, required
- `x-piriod-test-mode` boolean

## Request body

- Bank — Workspace-level bank account configured for receiving payments.
  - `id` string
  - `bank` integer, required — Reference to the underlying bank entity (`/generals/banks/`).
  - `name` string, nullable
  - `number` string, nullable
  - `holder_id` string, nullable
  - `holder_name` string, nullable
  - `account_type` 'checking_account' | 'savings_account' | 'sight_account' | 'rut_account' | 'line_of_credit', nullable
  - `auto_match` boolean
  - `extra_data` object
  - `last_sync` string, date-time, nullable
  - `status` 'active' | 'authentication_failed' | 'unknown_error' | 'archived'
  - `archived` string, date-time, nullable
  - `created` string, date-time
  - `updated` string, date-time

## Response `201`

Bank created.

- Bank — Workspace-level bank account configured for receiving payments.
  - `id` string
  - `bank` integer, required — Reference to the underlying bank entity (`/generals/banks/`).
  - `name` string, nullable
  - `number` string, nullable
  - `holder_id` string, nullable
  - `holder_name` string, nullable
  - `account_type` 'checking_account' | 'savings_account' | 'sight_account' | 'rut_account' | 'line_of_credit', nullable
  - `auto_match` boolean
  - `extra_data` object
  - `last_sync` string, date-time, nullable
  - `status` 'active' | 'authentication_failed' | 'unknown_error' | 'archived'
  - `archived` string, date-time, nullable
  - `created` string, date-time
  - `updated` string, date-time

## Other responses

- `400` — Request body or query parameters failed validation.

---

[API](https://skmtc.net/piriod/apis/piriod-api.md) · [All operations](https://skmtc.net/piriod/apis/piriod-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/piriod/piriod-api/revisions/70cbc827dc7b/schema)