Skip to main content
GET
Afriex SDK
Use the optional fromSymbols and toSymbols query parameters to filter results to specific currency pairs.

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

fromSymbols
string

Comma-separated list of base currency symbols to filter rates by (e.g., USD,NGN,EUR). If omitted, defaults to USD only.

Example:

"USD,NGN,EUR"

toSymbols
string

Comma-separated list of target currency symbols to filter rates by (e.g., NGN,EUR,GBP). If omitted, all target currencies are returned.

Example:

"NGN,EUR,GBP"

channel
enum<string>

Optional uppercase payment channel (e.g. BANK_ACCOUNT, MOBILE_MONEY). When given, rate promotions that apply to that channel are applied to the returned rates.

Available options:
WIDGET,
BANK_ACCOUNT,
MOBILE_MONEY,
CARD,
CRYPTO,
INTERNAL,
ADMIN,
WALLET,
VIRTUAL_BANK_ACCOUNT,
POOL_ACCOUNT,
ACH_BANK_ACCOUNT,
INTERAC,
UPI,
GLOBAL,
VIRTUAL_CARD,
RFP,
SWIFT,
EFT,
WE_CHAT,
ALIPAY,
PAYBILL_TILL,
PAYMENT_LINQ

Response

Successful retrieval of rates

data
object