WalletD developers
Users and balances

List a user's balances per account purpose

One row per account purpose and commodity, each with balance, held and available, as the tenant's ledger of record reports them; held is money reserved by an authorization that has not been captured.

GET/v1/users/{userId}/balances

One row per account purpose and commodity, each with balance, held and available, as the tenant's ledger of record reports them; held is money reserved by an authorization that has not been captured. Requires balances:read. An API key may read any user, a user token only itself (forbidden, 403); an unknown id gives user_not_found (404).

Authorization

bearerAuth
AuthorizationBearer <token>

A tenant API key (sk_{env}_{id}_{secret}), a wallet user token, or an IdP access token. Which principal the credential resolves to decides the scopes it carries; see the authentication guide.

In: header

Path Parameters

userId*string
Formatuuid

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/balances"
[  {    "purpose": "string",    "commodity": "string",    "balance": 0,    "available": 0,    "held": 0  }]