API Reference
Balance API
Get wallet balances and manage sandbox funds.
Get Balance
const balances = await afriex.balance.getBalance({
currencies: "USD,NGN,GBP",
});
// Returns: { USD: 10000, NGN: 5000000, GBP: 8000 }Or pass an array:
const balances = await afriex.balance.getBalance({
currencies: ["USD", "NGN", "GBP"],
});Get Single Currency Balance
const usdBalance = await afriex.balance.getBalanceForCurrency("USD");
console.log("USD Balance:", usdBalance); // 10000Response Format
{
"USD": 10000.50,
"NGN": 5000000.00,
"GBP": 8000.25
}Top Up Sandbox Balance
Sandbox-only. Returns 403 Forbidden in production.
const transaction = await afriex.balance.topUpSandbox({
amount: 500,
currency: "USD",
});
console.log(transaction.transactionId); // '69d6005dab82306f11b03360'
console.log(transaction.status); // 'SUCCESS'Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
amount | number | Yes | Positive number to credit |
currency | string | Yes | ISO 4217 code (e.g., USD, NGN) |
Response:
{
transactionId: '69d6005dab82306f11b03360',
status: 'SUCCESS',
type: 'DEPOSIT',
sourceAmount: '500',
sourceCurrency: 'USD',
destinationAmount: '500',
destinationCurrency: 'USD',
destinationId: '',
customerId: '',
meta: {},
createdAt: '2026-04-08T07:14:37.568Z',
updatedAt: '2026-04-08T07:14:37.568Z',
}