GET
Get wallet balance

Authorizations

Authorization
string
header
required

The end user's JWT access token, sent as Authorization: Bearer <token>.

Obtain one from POST /partner/customers or POST /partner/customers/login — both return it as token. It identifies which of your users a call is made for, and is sent alongside your X-API-Key on every authenticated endpoint.

Event discovery, categories, subcategories and scores are public and need no token.

X-API-Key
string
header
required

ISV / partner credential — public half. Required on every request.

Identifies the integration partner (ISV) making the call. Issued by Dime Trades when the ISV is onboarded and sent on every /partner/* endpoint:

  • On the two partner endpoints that create accounts or issue tokens (POST /partner/customers, POST /partner/customers/login), it is accompanied by X-API-Secret and is the only authentication — there is no user token yet.
  • On every other partner endpoint it is sent alongside the user's Authorization: Bearer <token>: the API key says which platform is calling, the bearer token says which user it is calling for.

Credentials are scoped to one or more brands; using a key with a brandId outside that scope returns 403. Staging and production keys are separate. The key identifies your platform — treat it as a backend credential.

Response

Balance returned.

data
WalletBalance · object

Units: every balance on this object is in dollars, as a decimal with 2 places — not cents. Contract prices elsewhere in the API are cents; see Conventions → Money and units.

Response of GET /wallet/balance (GetWalletBalanceService). totalBalance is computed (availableBalance + lockedBalance), and totalDeposits/ totalWithdrawals are derived from the ledger (the wallet's own total_deposits/total_withdrawals columns hold stale seed data and are never used). Public feature-flag settings and per-user preferences are spread onto the same object (not modeled here — see getPublicSettingsMap and the user's userSettings JSON column) and always include userSettings.isOneTapClickEnabled. lastUpdatedAt is only present when a wallet row exists for the user.

errors
array