Get Current Wallet Balance

The Wallet API allows you to monitor your account balance, track transactions, and enable or disable automatic top-ups. These endpoints help you manage funds used for sending SMS messages.

Retrieve the current balance of your account.

GET /wallet

Required Permission

read:UserWallet

Your API key must have this permission enabled in order to use this endpoint.

Example Request

curl --location 'https://<hostname>/wallet' \
  --header 'Authorization: Bearer YOUR_API_KEY'

Replace YOUR_API_KEY with your API key.

All endpoints shown in this documentation use a sample base URL. The production API endpoint is provided by our team upon request.

Response (HTTP 200)

{
  "success": true,
  "balance": 42.50,
  "currency": "USD"
}