Column.AccountNumbers (Column v1.0.0)

Copy Markdown View Source

Virtual account number management.

Create multiple routing+account number pairs per bank account. Each unique account number can be issued to a different customer while routing to a single underlying bank account (FBO/sweep pattern).

Example

{:ok, acct_num} = Column.AccountNumbers.create("bacc_123", %{
  description: "Customer A virtual account"
})

Summary

Types

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

Functions

create(bank_account_id, params, opts \\ [])

Create an account number for a bank account.

get(bank_account_id, id, opts \\ [])

Get an account number.

list(bank_account_id, opts \\ [])

List all account numbers for a bank account.

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

Update an account number.

Types

bank_account_id()

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

id()

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

opts()

@type opts() :: keyword()

params()

@type params() :: map()

result()

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

Functions

create(bank_account_id, params, opts \\ [])

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

Create an account number for a bank account.

get(bank_account_id, id, opts \\ [])

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

Get an account number.

list(bank_account_id, opts \\ [])

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

List all account numbers for a bank account.

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

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

Update an account number.