Skip to main content
GET
Get a wallet's earned cashback
The total adds up every cashback credit the wallet has received, in cents, and only grows: spending or moving the cashback does not lower it. A wallet that never received any answers 0. For the cashback still available in the wallet, read its cashback balance (GET .../wallets/{walletId}/cashback-balance) instead. 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

Total cashback a wallet has earned.

totalCashbackEarned
number
required

Sum of every cashback credit the wallet has received, in cents. It only grows: spending or moving the cashback does not lower it. 0 when the wallet has never received any.

Example:

12450