Get the intermediary banks for funding a payin

This GET endpoint lists the intermediary (correspondent) banks through which the payer's bank can send the funds for a pay-in funded through a bank account (a bank acceptance product, such as a temporary ACH/wire deposit account).
Provide the SWIFT BIC of the originating bank, the bank the payer sends the funds from, in bic, and optionally the currency the funds will be sent in as currency_code; when it is omitted, the pay-in's source_currency_code is used.
The response lists the standard settlement instructions published for that bank in that currency. Each entry names the correspondent bank that holds the originating bank's account in that currency (bank_name, bic, account_number, national_id, and routing_number when the correspondent is a US Fedwire/FedACH participant), any further intermediaries the correspondent routes through (intermediary_bic_1/intermediary_account_1, intermediary_bic_2/intermediary_account_2) and the originating bank's branch the instruction belongs to (originating_branch). Share these with the payer so their bank routes the transfer correctly. An empty intermediaries array means no settlement instructions are published for that BIC in that currency.
A pay-in that is not funded through a bank account (for instance a card authorization or a reverse wire drawdown), a malformed BIC or an invalid currency code returns a 400. A 503 means the settlement-instruction provider could not be reached; retry later.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^(usr_)?[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Token representing the user the pay-in belongs to

string
required
^(payin_)?[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Token representing the pay-in transaction. Returned in the response when a pay-in is created via /payin/USER_TOKEN

Query Params
string
required
^[A-Za-z]{6}[A-Za-z0-9]{2}([A-Za-z0-9]{3})?$

SWIFT BIC (8 or 11 characters) of the originating bank, the bank the payer sends the funds from. Case-insensitive.

string
^[A-Za-z]{3}$

ISO 4217 code of the currency the funds will be sent in. Defaults to the pay-in's source_currency_code.

Headers
string

Unique key to prevent duplicate processing

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json