Skip to main content
GET
/
api
/
v1
/
org
/
balance
Fetch wallet balance
curl --request GET \
  --url https://sandbox.api.afriex.com/api/v1/org/balance \
  --header 'x-api-key: <api-key>'
{
  "data": {
    "USD": 990.00532,
    "NGN": 39623.02258,
    "GBP": 0
  }
}
Returns the wallet balances for your business in the specified currencies.

Authorizations

​
x-api-key
string
header
required

Static business API key issued from the dashboard. A business can provision multiple API keys, each scoped to a configurable set of permissions (e.g. read transactions, create deposits, etc). Permissions are chosen per key at creation time in the dashboard and may be revoked by deleting the key. Requests made with a key that does not include the permission required by the target endpoint will be rejected with a 403 Forbidden response; an unrecognised, malformed or revoked key returns 401 Unauthorized. Manage your keys and their permissions under Developer → API keys in the dashboard.

Headers

​
x-api-version
string

API version in ISO 8601 format (e.g. 2025-12-28). Defaults to latest stable.

Query Parameters

​
currencies
string

Comma-separated list of currencies to fetch balances for. If omitted, balances for all supported currencies are returned.

Response

Returns a map with currencies as keys and balances as values.

​
data
object