Endpoint
GET /api/v1/business/balance
Headers
| Header | Required | Description |
|---|---|---|
X-Numero-Api-Key | Yes | Your API key |
X-Numero-Signature | Yes | Base64 HMAC-SHA256 over the exact raw request body (POST) or the canonicalised query string (GET), keyed with your Public Key. See Request signing. |
X-Numero-Signature-Version | Yes | Always v2. |
Query parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
currency | string | No | NGN | Currency code (e.g., NGN, USD) |
Request example
curl -X GET "https://api.usenumero.com/numeroaccount/api/v1/business/balance?currency=NGN" \
-H "X-Numero-Api-Key: your_api_key" \
-H "X-Numero-Signature: $SIGNATURE" \
-H "X-Numero-Signature-Version: v2"
Response
{
"data": {
"balance": 1500000.0,
"ledgerBalance": 1550000.0,
"totalHolds": 50000.0,
"availableBalance": 1450000.0,
"currency": "NGN"
},
"error": null,
"meta": {
"request_id": "req_365123ebc73323f1482508560ce6400e",
"pagination": null
}
}
| Field | Type | Description |
|---|---|---|
balance | number | Current book balance |
ledgerBalance | number | Total ledger balance including pending transactions |
totalHolds | number | Amount currently held (e.g., pending approvals) |
availableBalance | number | Balance available for transactions (balance - totalHolds) |
currency | string | Currency of the balance |