v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-03-02559.7 KB
Routes

Look up payment routes

Find available payment routes for a currency corridor. Returns matching entries sorted by priority (lower = preferred). Optionally filter by payee reference or rail type.

get/api/directory/routes

Query parameters

sourceCurrencystring required
Example:ZAR

Source currency code (ISO 4217)

targetCurrencystring required
Example:USD

Target currency code (ISO 4217)

payeeRefstring

Payee identifier for exact match

railstring
Example:mobile_money,bank_transfer

Comma-separated rail types to filter

Headers

x-tenant-idstring required

Response

Matching routes

totalinteger