Get wallet balance

Fetch the current wallet balance and complimentary credits for the sub-account resolved from the access token.

An Agency token reads the agency wallet, or a named sub-account via locationId. A Sub-Account token always reads its own wallet. Complimentary credits apply to sub-account wallets only and are omitted for an agency read.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:wallet.readonly

Auth methods:OAuthPrivate Integration

Token types:Agency TokenSub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Example:v3

Query Parameters

locationIdstring

Narrows an Agency token to one of its sub-accounts. Omit it and an Agency token reads the agency wallet. A Sub-Account token may only name its own sub-account: a different one is refused with 403, not ignored.

Example:AUKAtFVo0lWezBsBQ3FE

Response

200

application/json

Wallet balance retrieved successfully

walletIdstringrequired

Wallet the balance belongs to: the sub-account id for a Sub-Account token, the agency id for an Agency token reading its own wallet.

Example:xyz789

balancenumberrequired

Current wallet balance

Example:1500.5

complimentaryCreditsnumber

Complimentary credits on the wallet. Sub-account wallets only -- agency wallets have no complimentary credits, and the field is omitted rather than reported as zero.

Example:100