Skip to main content
SaasVersion: 2023-02-21

Get Location Wallet Balance

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

Fetch the wallet balance for a specific location. Returns a resource object with balance details.

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 options2023-02-21

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