Retrieve Wallet Balance

Retrieve wallet balances for your business. You can optionally filter by currency.

Query Parameters

Parameter	Type	Required	Description
`currency`	`string`	No	Filters the wallet balance by currency. Example: `GHS`, `KES`, `NGN`.

Authentication

This endpoint requires your API key.

x-api-key: YOUR_API_KEY

Endpoint

GET /v1/wallets/balance?currency=GHS

{
  "data": {
    "currency": "GHS",
    "totalBalance": 24.82,
    "availableBalance": 24.82,
    "pendingSettlementBalance": 0,
    "reservedBalance": 0,
    "paidOutBalance": 0,
    "transferableBalance": 24.82
  },
  "status": true,
  "message": "Success",
  "code": 200
}

Response Fields

Field	Type	Description
`currency`	`string`	Currency for the returned balance.
`totalBalance`	`number`	Total wallet balance for the currency.
`availableBalance`	`number`	Balance currently available.
`pendingSettlementBalance`	`number`	Balance pending settlement.
`reservedBalance`	`number`	Balance reserved for pending operations.
`paidOutBalance`	`number`	Balance already paid out.
`transferableBalance`	`number`	Balance available for transfer or payout.

Notes

If currency is provided, the response returns a single currency balance object.
If currency is omitted, the response returns balances for all available currencies.
The API key determines whether the request is processed in test or live mode.