Get sub-account wallet balance

GET 
/wallet/company/balance

Fetch the current wallet balance and complimentary credits for one of the agency's sub-accounts. The agency is resolved from the access token; the sub-account is named by the required locationId query parameter.

Request

Version stringrequired

API Version

Available optionsv3

locationId stringrequired

Sub-account whose wallet balance to read. Required: this operation addresses a single wallet, so there is no company-wide reading of it.

application/json

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
}