External Accounts: saved counterparty bank accounts (routing and account number) that ACH, RTP and FedNow transfers can send to by external_account_id. Increase has no delete; archive one with update-external-account(id, {status: "archived"}).

The create body holds a full account and routing number: never log it.

Functions

archive-external-account

fn (external-account-id: Str): Map
fn (external-account-id: Str, opts: Map): Map

Archive an External Account (PATCH {status: "archived"}), the closest thing Increase has to a delete.

Example

account ::increase::external-accounts/archive-external-account("external_account_ukk55lr923a3ac0pp7iv")
account.status

create-external-account

fn (params: Map): Map
fn (params: Map, opts: Map): Map

POST /external_accounts: save a counterparty account. params needs account_number, routing_number and description; optional account_holder ("business", "individual", "unknown") and funding ("checking", "savings", "general_ledger", "other").

Example

::increase::external-accounts/create-external-account({
  routing_number: "101050001",
  account_number: "987654321",
  description: "Landlord",
  account_holder: "business"
}, {idempotency-key: "vendor-17-bank"})

get-external-account

fn (external-account-id: Str): Map
fn (external-account-id: Str, opts: Map): Map

GET /external_accounts/{external_account_id}: retrieve an External Account.

Example

account ::increase::external-accounts/get-external-account("external_account_ukk55lr923a3ac0pp7iv")
account.description
account.status

list-external-accounts

fn (): Map
fn (params: Map): Map
fn (params: Map, opts: Map): Map

GET /external_accounts: one page of External Accounts. Filters: "status.in" (active, archived), routing_number, idempotency_key, limit, cursor.

Example

page ::increase::external-accounts/list-external-accounts({"status.in": ["active"], limit: 25})
map(page.data, %.id)

update-external-account

fn (external-account-id: Str, params: Map): Map
fn (external-account-id: Str, params: Map, opts: Map): Map

PATCH /external_accounts/{external_account_id}: change description, account_holder, funding, or status ("archived" retires it; Increase has no delete).

Example

::increase::external-accounts/update-external-account("external_account_ukk55lr923a3ac0pp7iv", {description: "Landlord (new)"})