Column.BankAccounts (Column v1.0.0)

Copy Markdown View Source

FDIC-insured bank account management.

Account types: :fbo, :sweep, :clearing, :custom. Account state controls transfer eligibility. Supports multiple owners and balance history snapshots.

Example

{:ok, account} = Column.BankAccounts.create(%{
  description: "Customer wallet",
  entity_id: "ent_123",
  account_type: "checking"
})

{:ok, summary} = Column.BankAccounts.get_summary(account["id"])

Summary

Types

id()
opts()
params()
result()

Functions

add_owner(id, params, opts \\ [])

Add an owner to a bank account.

create(params, opts \\ [])

Create a new bank account.

delete(id, opts \\ [])

Delete a bank account.

get(id, opts \\ [])

Get a bank account by ID.

get_summary(id, opts \\ [])

Get balance summary history (snapshots) for a bank account.

list(opts \\ [])

List all bank accounts. Supports cursor pagination.

update(id, params, opts \\ [])

Update a bank account.

Types

id()

@type id() :: String.t()

opts()

@type opts() :: keyword()

params()

@type params() :: map()

result()

@type result() :: {:ok, map()} | {:error, Column.Error.t()}

Functions

add_owner(id, params, opts \\ [])

@spec add_owner(id(), params(), opts()) :: result()

Add an owner to a bank account.

create(params, opts \\ [])

@spec create(params(), opts()) :: result()

Create a new bank account.

delete(id, opts \\ [])

@spec delete(id(), opts()) :: result()

Delete a bank account.

get(id, opts \\ [])

@spec get(id(), opts()) :: result()

Get a bank account by ID.

get_summary(id, opts \\ [])

@spec get_summary(id(), opts()) :: result()

Get balance summary history (snapshots) for a bank account.

list(opts \\ [])

@spec list(opts()) :: result()

List all bank accounts. Supports cursor pagination.

update(id, params, opts \\ [])

@spec update(id(), params(), opts()) :: result()

Update a bank account.