Skip to main content
SaaSVersion: v3

Get Location Wallet Balance

GET/saas/companies/{companyId}/locations/{locationId}/wallet-balance
deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Fetch the wallet balance for a specific location. Returns a resource object with balance details. Deprecated: this operation has moved to the Wallet API (GET /wallet/balance?locationId={locationId} with an Agency token, or GET /wallet/balance with a Sub-Account token) and will be removed from the SaaS API in the next version. Response shapes are unchanged, but no tenant id appears in the path: the agency comes from the token and the sub-account moves to a query parameter. Use the wallet.readonly scope.

Authorizations

Authorizationstringheaderrequired

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

Scope:saas/company.read
Auth methods:OAuthPrivate Integration
Token type:Agency Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Path Parameters

companyIdstringrequired

Company ID that owns the location

Example:5DP4iH6HLkQsiKESj6rh
locationIdstringrequired

Location ID to get wallet balance for

Example:AUKAtFVo0lWezBsBQ3FE

Response

Location wallet balance retrieved successfully

walletIdstringrequired

Wallet Id

Example:xyz789
balancenumberrequired

Current wallet balance

Example:1500.5
complimentaryCreditsnumberrequired

Complimentary credits amount

Example:100