Skip to main content
GET
Afriex SDK

Choosing a wallet

Your business can hold more than one wallet. Pass walletType to choose which one to read: Leave walletType out to read the Payout wallet, which is what this endpoint has always returned. The response shape is the same for every wallet.

Fee wallet and payouts

If your business settles fees from the Fee wallet and that wallet falls too far below zero, a payout is refused with the error code BUSINESS_FEE_WALLET_OVERDRAFT_LIMIT_EXCEEDED. Read the wallet with walletType=FEE to see where you stand. In sandbox, fund it with Top Up Sandbox Balance.

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. Manage your keys and their permissions under Developer → API keys in the dashboard.

A request whose key does not carry the permission the target endpoint requires is rejected with 401 Unauthorized, the same response an unrecognised, malformed, revoked or disabled key returns. The API does not distinguish the two cases on the wire.

See the Permissions reference for the permission each endpoint requires.

Headers

x-api-version
string

API version in ISO 8601 format. The only supported version is 2026-05-18, which is also the default when the header is omitted. Any other value is rejected with a 400 Bad Request.

Query Parameters

currencies
string

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

walletType
enum<string>
default:WITHDRAW

The wallet to read. Defaults to WITHDRAW, the Payout wallet. FEE reads the wallet that settles transaction fees, which is zero for a business that does not use one. DEPOSIT reads the Collection wallet, and returns an empty data object while the Collection wallet is not enabled.

Available options:
DEPOSIT,
WITHDRAW,
FEE

Response

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

data
object