Skip to main content
POST
Create Bank Account

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Body

entity
integer
required
currency
string
Maximum string length: 3
external_account_id
string | null
Maximum string length: 200
name
string | null
Maximum string length: 250
nickname
string | null
Maximum string length: 250
status
string | null
Maximum string length: 250
type
  • CHECKING - Checking
  • SAVING - Savings
  • CREDIT_CARD - Credit Card
  • DEBIT_CARD - Debit Card
  • INVESTMENT - Investment
  • LOAN - Loan
Available options:
CHECKING,
SAVING,
CREDIT_CARD,
DEBIT_CARD,
INVESTMENT,
LOAN
available_balance
number<double> | null
Required range: -1000000000000000000 < x < 1000000000000000000
current_balance
number<double> | null
Required range: -1000000000000000000 < x < 1000000000000000000
institution_id
string | null
Maximum string length: 250
source
string | null
Maximum string length: 250
aba_routing_number
string | null

ABA routing number (9 digits) for US bank accounts

Maximum string length: 9
swift_bic
string | null

SWIFT BIC code (8 or 11 characters) for international accounts

Maximum string length: 11
tag_ids
integer<int64>[]
Required range: -9223372036854776000 <= x <= 9223372036854776000
tag_group_ids
integer<int64>[]
Required range: -9223372036854776000 <= x <= 9223372036854776000
chart_of_accounts_account
integer | null
department
integer | null

Response

201 - application/json
id
integer
required
read-only
is_deleted
boolean
default:false
required
read-only
deleted_at
string<date-time> | null
required
read-only
entity_name
string
required
read-only
department_name
string
required
read-only
chart_of_accounts_account_name
string
required
read-only
account_type
string
required
read-only
account_subtype
string
required
read-only
account_cashflow_classification
string
required
read-only
type_name
string
required
read-only
subtype_name
string
required
read-only
cashflow_classification_name
string
required
read-only
account_id
string<uuid>
required
read-only
created_at
string<date-time>
required
read-only
last_modified_at
string<date-time>
required
read-only
customer
integer
required
read-only
entity
integer
required
tags
integer[]
required
read-only
currency
string
Maximum string length: 3
external_account_id
string | null
Maximum string length: 200
name
string | null
Maximum string length: 250
nickname
string | null
Maximum string length: 250
status
string | null
Maximum string length: 250
type
  • CHECKING - Checking
  • SAVING - Savings
  • CREDIT_CARD - Credit Card
  • DEBIT_CARD - Debit Card
  • INVESTMENT - Investment
  • LOAN - Loan
Available options:
CHECKING,
SAVING,
CREDIT_CARD,
DEBIT_CARD,
INVESTMENT,
LOAN
available_balance
number<double> | null
Required range: -1000000000000000000 < x < 1000000000000000000
current_balance
number<double> | null
Required range: -1000000000000000000 < x < 1000000000000000000
institution_id
string | null
Maximum string length: 250
source
string | null
Maximum string length: 250
aba_routing_number
string | null

ABA routing number (9 digits) for US bank accounts

Maximum string length: 9
swift_bic
string | null

SWIFT BIC code (8 or 11 characters) for international accounts

Maximum string length: 11
tag_ids
integer<int64>[]
Required range: -9223372036854776000 <= x <= 9223372036854776000
tag_group_ids
integer<int64>[]
Required range: -9223372036854776000 <= x <= 9223372036854776000
chart_of_accounts_account
integer | null
department
integer | null