Routes

A route is a corridor your company is enabled for: a destination country, currency and payout method, along with its fees and remaining limits.

get_routes

Lists the corridors your company is enabled for, optionally filtered by source currency.

Signature

def get_routes(self, source_currency: Optional[str] = None) -> RoutesResponse:

Parameters

Name	Type	Required	Description
source_currency	Optional[str]	No	Filter by source currency. Omit (or pass None) to list every route your company is enabled for. Sent as the sourceCurrency query parameter.

Returns

RoutesResponse:

Field	Type	Description
routes	Optional[List[Route]]	The enabled corridors.

Route:

Field	Type	Description
name	Optional[str]	Route name, e.g. "BANK_TRANSFER-VE".
method	Optional[str]	Payout method for this corridor — see Payout type.
country	Optional[str]	Destination country.
currency	Optional[str]	Destination currency.
rate	Optional[str]	Indicative rate — a decimal string (e.g. "852.79"), same as every other amount on the wire. The rate that actually applies to a transfer is the one locked into its quotation.
fees	Optional[List[RouteFee]]	Pricing rules — pricing_rule, pricing_type, percentage_value, flat_value, pricing_label.
limits	Optional[RouteLimits]	per_transaction (PerTransactionLimit: min/max decimal strings), transaction (TransactionWindows of daily/weekly/monthly TransactionWindow: max/current/remaining counts), fund (FundWindows of daily/weekly/monthly FundWindow: max/current/remaining decimal strings).

Example

routes = client.get_routes("USDR")
for r in routes.routes or []:
    print(r.name, r.country, r.currency, r.rate)

Errors

• B2B_UNAUTHORIZED — bad token or bad request signature.
• ValueError — raised locally when source_currency is present but blank.

Notes

• Call it with no source_currency to list every route your company is enabled for.
• rate is indicative — do not use it to compute a payout amount. Use the exchange_rate from a quotation instead.

API reference

GET /me/routes