Skip to main content
GET
Get a wallet's closing balance
Send the day as date (YYYY-MM-DD). The statement comes from the bank, in cents. Use default as walletId for the organization’s main wallet, and send x-environment: LIVE for production wallets. Organization admins can read every wallet; other users only the wallets shared with them, in any role.

Headers

x-environment
enum<string>

Environment of the wallet: 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 wallet belongs to.

Format: UUID

accountId
string
required

ID of the organization's account (24 hexadecimal characters).

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

ID of the wallet (24 hexadecimal characters), or default for the organization's main wallet.

Pattern: ^([0-9a-fA-F]{24}|default)$

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 a wallet had at the end of a day.

id
string
required

Identifier of this balance statement.

Example:

"b2c4f0a6-3d1e-4f5a-9b8c-7d6e5f4a3b2c"

balance
number
required

Balance of the wallet at the end of the day, in cents.

Example:

1250000

lastTransactionId
string | null
required

Identifier of the last transaction counted in the balance. null when the wallet had no transaction up to that day.

Example:

"c7d8e9f0-1a2b-4c3d-8e4f-5a6b7c8d9e0f"

referenceDate
string
required

The day of the balance, as YYYYMMDD.

Example:

"20261031"