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.

Request

Version stringrequired

API Version

Available options2021-07-28

companyId stringrequired

Company ID that owns the location

locationId stringrequired

Location ID to get wallet balance for

application/json

Location wallet balance retrieved successfully

application/json

Schema

Schema

walletIdstringrequired

Wallet Id

balancenumberrequired

Current wallet balance

complimentaryCreditsnumberrequired

Complimentary credits amount

Example (auto)

{
  "walletId": "xyz789",
  "balance": 1500.5,
  "complimentaryCredits": 100
}