Methods

Methods

Accounts

Create account

Creates a KYC entity and bank account. PII is passed through to the banking provider — never stored in the gateway. An account creation fee (account_creation_cents) is charged if configured.

label
string
external_id
stringYour internal user/org ID
type
string
entity
any

List accounts

Returns all accounts for the authenticated owner. Each account includes a live balance (cents) and currency.

external_id
string

Get account

Returns account details with live balance, interest ticker, and daily transfer/funding limits with usage.

id
string · required

Update account (label, external_id, freeze/unfreeze)

Update account metadata or change status between OPEN and FROZEN. Freezing an account disables all active cards on Increase. Unfreezing re-enables them. Closed accounts cannot be modified.

id
string · required
label
string
externalId
string
status
stringSet to FROZEN to freeze the account and disable all cards, or OPEN to unfreeze.

Close account

id
string · required

Create sub-account

Creates a sub-account under the treasury entity with an account number. No KYC required, no card issued, no funding.

label
string
externalId
stringYour internal user/org ID

Provision sub-account + card

Creates a sub-account under the treasury entity, issues a virtual card, and returns both. No KYC required.

label
string
externalId
stringYour internal user/org ID
cardDescription
stringOptional card label

Get routing and account number

Returns the routing number and account number for inbound ACH/wire deposits.

id
string · required

Get account analytics

Returns account-scoped metrics: live balance, card count, transfer count, transaction volume, funded total, interest accrual data (for a real-time ticker), and daily time-series. Use ?days= to control history window (default 30, max 365) and ?metric= to select the series (balance, volume, funded).

id
string · required
days
integer · default: 30
metric
string · default: balanceWhich metric to plot in the graph time-series