wallet returns the spendable balance
alongside lifetime received and spent totals, denominated in your org’s points
currency.
The credential differs per route here.
GET /v1/wallet is member-token only -
it reads “my” wallet, so there is no member to name. GET /v1/wallet/transactions
also accepts your Org-API-Key with externalUserID. To read a specific member’s
balance server-side, use GET /v1/members/{externalUserID}.See Authentication. Whether you read sandbox or live balances is
selected by the key - see Environments.Get the wallet
wallet() calls GET /v1/wallet and returns a Wallet for the member the token
was minted for. The snippet below reads the balance, totals, and currency (it
also shows the wallet embedded in eligibility):
curl
The Wallet schema
Every points figure comes with a
...Display sibling in your own currency and
a ...USD sibling in dollars, so you never have to render a points number or do
the conversion yourself. See
Currency configuration for setting what your
currency is worth.balance is the spendable amount and the figure a redemption is checked
against - a redemption fails with INSUFFICIENT_POINTS when balance is below
the offer’s pointsPrice. amountReceived and amountSpent are running
lifetime totals and do not decrease when points are spent.Minting and the ledger
Reading the wallet is member-mode, but minting points is server-side. Credit points and inspect the per-transaction ledger (walletTransactions) from your
backend - see Points and wallet.
Next steps
Points and wallet
Server-side minting and the credit/debit transaction ledger.
Eligibility
Read tier and wallet together in one call.
Redemptions
Spend the balance by redeeming offers.