Sign in

v1

latestOpenAPI 3.0.32026-08-0623677345.2 KB
Payments

Create bank account

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.

post/banks/

Query parameters

externalboolean
provider'bankops' | 'fintoc' | 'floid' | 'plaid'

Headers

x-simple-workspacestring required

Workspace (account) identifier. Required for every request.

x-piriod-test-modeboolean

Whether to operate against test-mode data. Defaults to false.

Request body

idstring
bankinteger required

Reference to the underlying bank entity (/generals/banks/).

namestring nullable
numberstring nullable
holder_idstring nullable
holder_namestring nullable
account_type'checking_account' | 'savings_account' | 'sight_account' | 'rut_account' | 'line_of_credit' nullable
auto_matchboolean
extra_dataobject
last_syncstring date-time nullable
status'active' | 'authentication_failed' | 'unknown_error' | 'archived'
archivedstring date-time nullable
createdstring date-time
updatedstring date-time

Response

Bank created.

idstring
bankinteger required

Reference to the underlying bank entity (/generals/banks/).

namestring nullable
numberstring nullable
holder_idstring nullable
holder_namestring nullable
account_type'checking_account' | 'savings_account' | 'sight_account' | 'rut_account' | 'line_of_credit' nullable
auto_matchboolean
extra_dataobject
last_syncstring date-time nullable
status'active' | 'authentication_failed' | 'unknown_error' | 'archived'
archivedstring date-time nullable
createdstring date-time
updatedstring date-time