Skip to main content
GET
Get an account's closing balance
Send the day as date (YYYY-MM-DD). The statement comes from the bank: balance is the account’s closing balance and bagsBalance the total of its wallets’ closing balances, both in cents. Send x-environment: LIVE for the production account. Any member of the organization can read it.

Headers

x-environment
enum<string>

Environment of the account: LIVE (production) or TEST (sandbox). When you omit it, the request runs in TEST; any other value is rejected.

Available options:
LIVE,
TEST

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization the account belongs to.

Format: UUID

accountId
string
required

ID of the account (24 hexadecimal characters).

Pattern: ^[0-9a-fA-F]{24}$

Query Parameters

date
string
required

Day whose closing balance you read, as YYYY-MM-DD (YYYYMMDD is accepted too).

Pattern: ^(\d{4}-\d{2}-\d{2}|\d{8})$

Response

Successful response

The balance an account had at the end of a day.

id
string
required

Identifier of this balance statement.

Example:

"a1f3c5e7-9b2d-4f6a-8c0e-1d3f5a7b9c2e"

balance
number
required

Balance the account held at the end of the day, in cents.

Example:

4875000

bagsBalance
number
required

Sum of the account's wallets' balances at the end of the day, in cents.

Example:

4875000

referenceDate
string
required

The day of the balance, as YYYYMMDD.

Example:

"20261031"