Get Wallet Balance

GET /v2/telecom/balance/{account_id}

Returns the available balance and currency information for a specified telecom wallet. Use this endpoint before attempting recharges or bundle purchases to ensure sufficient funds.

Path Parameters

account_id

STRING · REQUIRED

The unique identifier for the telecom account. Must follow the pattern ACC_[a-zA-Z0-9]+.

Query Parameters

currency

STRING · OPTIONAL

Specify the currency code (e.g., USD, EUR) to convert the balance. Defaults to the account's primary currency.

include_history

BOOLEAN · OPTIONAL

Whether to include the last 5 transactions in the response.

Error Responses

401 Unauthorized: API key is invalid or missing.

404 Not Found: The specified account_id does not exist.

Request Sample

curl --request GET \
  --url https://api.zenvault.com/v2/telecom/balance/ACC_99218 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'

Response Sample

200 OK

{
  "id": "ACC_99218",
  "status": "active",
  "balance": 12450.75,
  "currency": "USD",
  "last_updated": "2023-10-24T12:00:00Z",
  "network": {
    "carrier": "Zenvault Global",
    "roaming": false
  }
}

info Optimization Tip

Using our Webhooks API? You can subscribe to balance.low events to get notified when a wallet drops below a threshold.