Get Balance - Afriex Business API

Afriex SDK

TypeScript

const balances = await afriex.balance.getBalance({
  currencies: ["USD", "NGN", "GBP"],
});

// Returns: { USD: 10000, NGN: 5000000, GBP: 8000 }

curl --request GET \
  --url https://sandbox.api.afriex.com/api/v1/org/balance \
  --header 'x-api-key: <api-key>'

import requests

url = "https://sandbox.api.afriex.com/api/v1/org/balance"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://sandbox.api.afriex.com/api/v1/org/balance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.api.afriex.com/api/v1/org/balance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
?>

package main

import (
    "fmt"
    "net/http"
    "io"
)

func main() {

url := "https://sandbox.api.afriex.com/api/v1/org/balance"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-api-key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}

HttpResponse<String> response = Unirest.get("https://sandbox.api.afriex.com/api/v1/org/balance")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.api.afriex.com/api/v1/org/balance")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

Response

200

{
  "data": {
    "USD": 990.00532,
    "NGN": 39623.02258,
    "GBP": 0
  }
}

Authorizations

• x-api-key: Static business API key issued from the dashboard. A business can provision multiple API keys, each scoped to a configurable set of permissions. 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.

Headers

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

Query Parameters

• currencies: 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": {
    "currencies": ["USD", "NGN", "GBP"],
    "balances": [990.00532, 39623.02258, 0]
  }
}