Skip to main content
GET
/
business
/
balance
Get wallet balance
curl --request GET \
  --url https://api-staging.usenumero.com/numeroaccount/api/v1/business/balance \
  --header 'X-Numero-Api-Key: <api-key>'
{
  "data": {
    "accountNumber": "<string>",
    "bankName": "<string>",
    "currency": "NGN",
    "available": 123,
    "pending": 123,
    "total": 123
  },
  "error": {
    "message": "<string>",
    "param": "<string>"
  },
  "meta": {
    "request_id": "<string>",
    "pagination": {
      "page": 123,
      "page_size": 123,
      "total": 123,
      "has_more": true
    }
  }
}

Authorizations

X-Numero-Api-Key
string
header
required

Your business API key (live_key_...). Issued on approval; managed in Dashboard → Settings → Developer.

Query Parameters

currency
string
default:NGN

Response

Balance

Canonical response envelope for the public surface. data on success, error on failure.

data
object
required

Endpoint payload on success (object or array); null on failure.

error
object
required
meta
object
required