ZonmPay
Sign in

Read your wallet

Balance API

Read your wallet balance in real time. Balances are kept in exact minor units and returned per currency and per environment.

GEThttps://zonmpay.com/api/public/v1/balance

Step by step

  1. 1

    Authenticate the request

    Send your secret key in the x-api-key header (or as Authorization: Bearer KEY). Keys are created in the developer area and shown only once — store yours server-side and never in browser code.

  2. 2

    Call the endpoint

    A simple GET with your live key returns the current balance of your business wallet.

  3. 3

    Use the right figure

    balance is what you can pay out now. pending is money still moving and is not yet spendable.

Example request

cURL
curl -X GET https://zonmpay.com/api/public/v1/balance \
  -H "x-api-key: YOUR_API_KEY"

Responses

Success
{
  "type": "success",
  "message": "Balance retrieved successfully",
  "data": {
    "currencies_count": 1,
    "environment": "live",
    "balances": {
      "TZS": { "currency": "TZS", "balance": "26.00", "pending": "0.00" }
    },
    "timestamp": "2026-09-19T09:46:58.000Z"
  }
}
Error
{
  "type": "error",
  "message": "Invalid API key",
  "data": { "error_code": "unauthorized" }
}

Things that can go wrong

  • unauthorizedThe key is missing, unknown or revoked.
All documentationNumber Lookup API