Skip to navigation

Get balances

View as Markdown

Every account of the company with its type, currency and balance. Pass currency to narrow the list to one currency.

Call it with your company API key. Partners calling with a partner key must also send X-Company-Id naming the company they are acting for.

Authentication

X-API-Keystring
API Key authentication via header

Headers

X-Company-IdstringOptional

Partner keys only: the company you are acting for (a company ULID). Omit it when calling with a company API key.

Query parameters

currencystringOptional
Only return accounts in this currency.

Response

Get balances successfully
balanceslist of objectsOptional

Errors

403
Forbidden Error