BankAccount

Update a bank account

Updates a bank account by its ID.

patch/bank-accounts/{bank_account_id}

Request

  • Base URL: https://api.column.com
  • URL: https://api.column.com/bank-accounts/{bank_account_id}
  • Auth: HTTP basic

Path parameters

bank_account_idstring required

Request body

account_structure_idstring

The account structure ID

descriptionstring nullable

Updated description

display_namestring nullable

Updated display name

interest_config_idstring nullable

The interest config ID

is_ach_creditableboolean nullable

Whether ACH credits are enabled

is_ach_debitableboolean nullable

Whether ACH debits are enabled

is_interest_bearingboolean nullable

Whether interest bearing is enabled

is_overdraftableboolean nullable

Whether overdraft is enabled

overdraft_reserve_account_idstring

The overdraft reserve account ID

Response

Successful response

bicstring required

The SWIFT BIC code for this bank account for international wire payments.

created_atstring date-time required

The timestamp at which the bank account was created.

currency_codestring required

The three-letter ISO 4217 currency code for the account and its balances.

default_account_numberstring required

The externally facing default account number tied to this bank account.

default_account_number_idstring required

The default account number ID tied to this account.

descriptionstring required

A name for the bank account (minimum: 3 characters)

display_namestring

The display name for the bank account. Display name is an account nickname used on Column's Dashboard.

fdic_insurancestring required

The type of FDIC insurance offered on this account. The default value is standard.

idstring required

Unique ID for this account.

interest_config_idstring required

The ID of interest config for this account. If it is not set, the default interest config of your platform will be used for this account. Please contact our support team for more details.

is_interest_bearingboolean required

Whether your platform needs to accrue and pay interest to this account. Please contact our support team for more details.

is_overdraftableboolean required

Whether the account can be overdrafted, must include an overdraft_reserve_account_id

overdraft_reserve_account_idstring required

The overdraft reserve account that this account is linked to. If is_overdraftable: true then this field is required.

ownersstring[] required

List of entity_id's which are tied to this bank account

routing_numberstring required

The 9-digit ABA routing number for this bank account.

status'open' | 'closed' | 'frozen' required

The current status of the bank account. Can be open, closed, or frozen.

typestring required

Bank Account type. Can be CHECKING, OVERDRAFT_RESERVE, PROGRAM_RESERVE, or NETWORK_SETTLEMENT_ACCOUNT.

Changes

No recorded changes to this operation across all 1 revision of this API.