The settlement route the SWIFT gateway sends a currency through, chosen for the destination bank when destination_bic names one: the nostro account, the correspondent's same-day window and value date, outbound charges and liquidity

GET/ledger/correspondent/routes/{currency}

The SWIFT gateway service (svc_payments) reaches this route with one scope and nothing else of the ledger's: ledger:correspondent:route reads settlement routes, ledger:correspondent:post posts movements, ledger:correspondent:statement delivers cash management messages. destination_bic names the beneficiary bank: the account whose terms name the longest prefix of it settles the payment, and otherwise the currency's primary account does. A currency with no open nostro account at an active correspondent, or no approved terms in force, is ledger.correspondent_route_unavailable.

Path parameters

currencystringRequired

Query parameters

destination_bicstringOptional

atstringOptional

Returns

200 OK

accepts_nowbooleanRequired

account_identifierstringRequired

correspondent_bicstringRequired

correspondent_idstringRequired

correspondent_namestringRequired

currency_codestringRequired

cutoffobjectRequired

CutoffWindow is when the correspondent values a payment in the currency on the same day: from the opening to the cutoff, local to the correspondent's time zone, on its business days. The times and the market holidays come from the account agreement; SWIFT delivers at any hour.

4 child attributes

cutoffstringRequired

HH:MM

holidaysarray of stringsOptional

YYYY-MM-DD weekdays the correspondent's market is closed

opensstringRequired

HH:MM

time_zonestringRequired

destination_bicstringOptional

DestinationBIC is the beneficiary bank the route was chosen for, RoutedByPrefix the prefix in the account's terms that chose it (empty when the currency's primary route settled it), and Direct reports that the destination is the correspondent itself, so the payment reaches the beneficiary's bank without another institution in the chain.

directbooleanRequired

headroom_amountintegerRequired

Posted balance above the minimum; negative when below it

ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

maximum_balanceintegerRequired

minimum_balanceintegerRequired

nostro_account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

open_liquidity_alertsarray of stringsRequired

outbound_chargesarray of objectsRequired

4 child attributes

amountintegerRequired

billingstringRequired

Item_debit, invoice or deducted

charge_bearerstringRequired

directionstringRequired

Outbound or inbound

posted_balanceintegerRequired

routed_by_prefixstringOptional

target_balanceintegerRequired

terms_idintegerRequired

value_datestring · dateRequired

A business date, YYYY-MM-DD

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503