Rates
Get exchange rates
Retrieves real-time exchange rates.
get/api/v1/org/rates
Request
- Base URLhttps://sandbox.api.afriex.com
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
fromSymbolsstring
Example:USD,NGN,EUR
Comma-separated list of base currency symbols to filter rates by (e.g., USD,NGN,EUR). If omitted, defaults to USD only.
toSymbolsstring
Example:NGN,EUR,GBP
Comma-separated list of target currency symbols to filter rates by (e.g., NGN,EUR,GBP). If omitted, all target currencies are returned.
channel'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'
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.
Response
Successful retrieval of rates
Example response
{
"data": {
"rates": {
"USD": {
"USD": "1",
"GBP": "0.69255",
"EUR": "0.80832",
"CAD": "1.30272",
"NGN": "1410.1041",
"KES": "125.0912"
}
},
"updatedAt": 1773245407620
}
}Changes
No recorded changes to this operation across all 1 revision of this API.