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 Blade Platform API (GET /wallet/company/balance?locationId={locationId}, 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.

Request

Version stringrequired

API Version

Available optionsv3

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
}