Skip to main content
Retrieve your merchant account balance. Supports multiple currencies.

Endpoint

GET /api/v1/business/balance
Signature required: No

Headers

HeaderRequiredDescription
x-api-keyYesYour API key

Query parameters

ParameterTypeRequiredDefaultDescription
currencystringNoNGNCurrency code (e.g., NGN, USD)

Request example

curl -X GET "https://api-dev.usenumero.com/numeroaccount/api/v1/business/balance?currency=NGN" \
  -H "x-api-key: your_api_key"

Response

{
  "status": true,
  "message": "Successful",
  "code": "200",
  "version": "v1",
  "reference": "abc123",
  "data": {
    "balance": 1500000.00,
    "ledgerBalance": 1550000.00,
    "totalHolds": 50000.00,
    "availableBalance": 1450000.00,
    "currency": "NGN"
  },
  "error": null
}
FieldTypeDescription
balancenumberCurrent book balance
ledgerBalancenumberTotal ledger balance including pending transactions
totalHoldsnumberAmount currently held (e.g., pending approvals)
availableBalancenumberBalance available for transactions (balance - totalHolds)
currencystringCurrency of the balance