Skip to main content
GET
Get a wallet's cashback balance
Cashback is kept in its own CASHBACK balance inside the wallet, apart from the money you can spend; this is that balance, read live from the bank. A wallet that holds no cashback — or one still being opened, which has no balance yet — answers 0. For everything the wallet has ever earned, read its earned cashback (GET .../wallets/{walletId}/cashback) instead. Because the balance is read from the bank, the call fails when the bank can’t answer: a rate limit or an outage returns the errors below, and any other refusal from the bank returns BANKING_PROVIDER_INTEGRATION_ERROR with the bank’s own status. All of them are temporary — retry later. Use default as walletId for the organization’s main wallet. A wallet of another environment answers 404, so send x-environment: LIVE for production wallets. Admins of the organization or of its realm — API clients included — 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)$

Response

Successful response

Cashback a wallet holds right now.

cashback
number
required

The wallet's current CASHBACK balance, in cents — read live from the bank. 0 when the wallet holds no cashback, or when it is still being opened and has no balance yet.

Example:

3200