SaasVersion: 2021-04-15
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. readAuth methods:
OAuthPrivate IntegrationToken type:
Agency TokenRequest
Headers
Versionstringrequired
API Version
Available options
2021-04-15Path Parameters
companyIdstringrequired
Company ID that owns the location
Example:
5DP4iH6HLkQsiKESj6rhlocationIdstringrequired
Location ID to get wallet balance for
Example:
AUKAtFVo0lWezBsBQ3FEResponse
Location wallet balance retrieved successfully
walletIdstringrequired
Wallet Id
Example:
xyz789balancenumberrequired
Current wallet balance
Example:
1500.5complimentaryCreditsnumberrequired
Complimentary credits amount
Example:
100