Accounts & balances

GET /v1/accounts

Active vIBAN accounts only, paged. balance and availableBalance are major units. Linked accounts on the page are refreshed from the banking partner before the rows are built (skipped when balanceUpdatedAt is under a few seconds old; at most five partner fetches in parallel), so figures match GET /v1/balance when the partner answers. On a refresh failure the stored figures are returned with no error. An account the partner confirms missing is omitted from the page, as on /v1/balance.

Response: { "data": [Account], "meta": { "limit", "offset", "total" } }.

QueryDefaultDescription
limit10Page size (minimum 1, maximum 100)
offset0Rows to skip
currency—Accounts held in this currency

Unknown query names are 400. Use id as sourceAccountId on payouts, as accountId on transaction filters, and as accountId on a deposit declaration. Send that account's IBAN as receivingIban instead when you do not want to send the id. Exactly one of the two.

A scoped credential whose read Account rule withholds iban, accountNumber, routingNumber or swiftCode receives accounts without those keys (absent, not null).

The account's beneficiaryName is the name the banking partner holds for the account. It is not a customer.

GET /v1/balance

One row per active account, paged. When the account is linked at the banking partner, balances are fetched live (source: "fuse_live"). Otherwise stored values are returned (source: "local").

Response: { "data": [Balance], "meta": { "limit", "offset", "total" } }.

QueryDefaultDescription
limit10Page size (minimum 1, maximum 100)
offset0Rows to skip

Unknown query names are 400.

Payouts are checked against available funds (local balance first, then a live partner check). Prefer availableBalance when deciding whether you can pay.


Did this page help you?