Skip to main content
POST
Afriex SDK
Pass walletType to choose the wallet to credit: Read a wallet back with Get Balance and the same walletType, so a top-up and a balance read always agree.

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.

Body

application/json
amount
number<double>
required

A positive number representing the amount to credit.

Example:

500

currency
string
required

Uppercase 3-letter ISO 4217 currency code (e.g. USD, NGN, GBP). Must be a supported Afriex currency.

Example:

"USD"

walletType
enum<string>

The wallet to credit. When omitted, the Payout (WITHDRAW) wallet is credited. Use FEE to top up the wallet that settles transaction fees, or DEPOSIT for the Collection wallet.

Available options:
DEPOSIT,
WITHDRAW,
FEE

Response

Balance successfully topped up. Returns the created transaction record.

data
object