Payin

Get the intermediary banks for funding a payin

Changed on

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 <i>bank acceptance</i> product, such as a temporary ACH/wire deposit account). <br> 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. <br> 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 instruction the provider publishes more than once is listed once. An empty intermediaries array means the bank is known but publishes no settlement instructions for that currency. <br> A pay-in that is not funded through a bank account (for instance a card authorization or a reverse wire drawdown), a malformed BIC, an invalid currency code or a BIC the settlement-instruction provider does not know returns a 400; for an unknown BIC the provider's remark is included in error.details. A 503 means the settlement-instruction provider could not be reached; retry later.

get/payin/{user_token}/{payin_token}/intermediaries

Request

Query parameters

bicstring required
Example:DEUTDEFFXXX

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

currency_codestring
Example:USD

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

Headers

Idempotency-Keystring

Unique key to prevent duplicate processing

Response

OK

payin_tokenstring

Token representing the pay-in the instructions were requested for.

originating_bicstring

SWIFT BIC of the originating bank, as given in the request (upper-cased).

currency_codestring

ISO 4217 code of the currency the instructions apply to: the currency_code given in the request, or else the pay-in's source_currency_code.

Example response

{
  "payin_token": "payin_ba4275f2-bae1-488d-9d6f-20af1cd83574",
  "originating_bic": "DEUTDEFFXXX",
  "currency_code": "USD",
  "intermediaries": [
    {
      "bank_name": "JPMORGAN CHASE BANK, N.A.",
      "bic": "CHASUS33XXX",
      "account_number": "001-1-234567",
      "national_id": "021000021",
      "routing_number": "021000021",
      "asset_category": "ANYY",
      "originating_branch": {
        "bank_name": "DEUTSCHE BANK AG",
        "street": "TAUNUSANLAGE 12",
        "city": "FRANKFURT AM MAIN",
        "post_zip": "60325",
        "region": "HESSEN",
        "country": "GERMANY"
      }
    }
  ]
}

Changes