CROSSFX API · CORRIDORS
Discover where CrossFX can transact.
Retrieve the current list of active source and destination currency pairs before you quote or build a transfer.
Use the API as the source of truth for corridor availability instead of hard-coding supported pairs into your application.
Active pairsDirectionalNo parametersDiscover dynamically
What is a corridor?#
A corridor is a source currency paired with a destination currency. Only a pair returned by the Corridors API can be quoted.SOURCE CURRENCY
USDC
Where the corridor starts
DESTINATION CURRENCY
KES
Where the corridor ends
DIRECTION MATTERS
USDC → KES does not imply KES → USDC.
Every corridor is directional. Treat each source and destination pairing as a separate capability.
Why use the Corridors API?#
Build valid selectors
Only show open pairsPopulate your currency selector with combinations that CrossFX currently supports.
Reject early
Stop unsupported requests in your UIValidate a pair before it reaches your quote or transfer workflow.
Discover changes
Adapt without a releaseDetect newly opened or closed corridors without changing hard-coded application configuration.
Before you start#
Authentication
Use a valid bearer tokenNo request parameters
One call returns the full listThe endpoint takes no query parameters or request body.
List supported corridors#
List Supported Corridors
Current active currency pairs`GET /api/v1/corridors`
Open the API Reference for the full response schema and an interactive console.
RESPONSE SHAPE
Returns data, an array of corridor objects. Each item contains source_currency_code and destination_currency_code.
Business rules#
Three rules matter when using corridor data in your application.RULE 01
Corridors are directional
A pair being open in one direction says nothing about availability in the reverse direction.
RULE 02
Destination must match country
On a quote, the destination currency must agree with the destination country. A mismatch produces a transfer that cannot be paid out.
RULE 03
Cache, but refresh
Corridors can open and close. Cache the list for efficiency, but re-read it periodically rather than pinning it at build time.
Use corridor data as configuration#
A practical integration pattern is:01
Fetch
Read open corridors
02
Cache
Store current pairs
03
Validate
Check before quoting
04
Refresh
Re-read on a schedule
The API response, rather than your application release, should determine which pairs you expose.
Errors#
Every error below returns the CrossFX platform error envelope, with error first and error_id last.SUPPORT IDENTIFIER
Keep the error_id
Quote the returned error_id when contacting CrossFX support so the request can be located in platform logs.
| HTTP | code | Trigger | What you do |
|---|
| 401 | — | The Authorization header is missing, malformed, or the token has expired | Request a new token and retry. The body is { "message": "Unauthorized" }. |
Generate Quote Guide
Quote an open corridorUse a supported source and destination pair to generate a quote.
Sandbox Data & Testing Guide
Test supported reference dataSee the countries and currencies available in the Sandbox environment.