Retrieve supported beneficiary banks

Call Get supported financial institutions API to dynamically search and retrieve an array of Airwallex’s supported banks, branches or billers for beneficiaries of a given transfer method. The response includes routing values (bank codes, SWIFT codes, biller codes, etc.) and their corresponding institution names. This API can be used to render your own user-facing interface with a dropdown UI to collect bank information required for the Beneficiaries or Transfers endpoints.

This is a GET endpoint that requires all request parameters to be passed as query string parameters, and request bodies are not supported. The following query parameters are available:

• bank_country_code: The 2-letter ISO 3166-2 country code of the beneficiary’s bank.
• account_currency: The 3-letter ISO 4217 currency code for the beneficiary’s account.
• transfer_method: The transfer method for the payout (LOCAL or SWIFT). Note that for API versions prior to 2024-09-27, use payment_method instead of transfer_method.
• local_clearing_system: The local clearing system for LOCAL payouts where applicable (a default value will apply when this parameter is not specified and transfer_method is LOCAL). To learn more about supported local clearing systems, see Payout network.
• entity_type: The type of the beneficiary, COMPANY (business) or PERSONAL (individual).

• keyword: A search string used to retrieve financial institutions that match the input (by name or routing value; name search is not available for all regions). This parameter is mandatory for certain transfer methods where a full list is not returned by default, and a keyword is required to narrow down the response (e.g., the account_routing_value1 of a Local INR payout beneficiaries).

• bank_identifier: A valid bank code used to retrieve the list of branches for a specific bank. This is applicable only for transfer methods with a two-tier routing structure (e.g., the account_routing_value1 and account_routing_value2 for Local JPY payout beneficiaries).

  • To retrieve branches, first call the endpoint without bank_identifier to get the list of banks. Then repeat the call specifying bank_identifier with one of the values in the first response to retrieve its associated branches.

For the transfer method specified in the request, this API returns an array of matching financial institutions. The response is unpaginated and structured as follows:

• items: An array of objects representing the matched financial institutions. Each object includes a label and a value, as defined below:
  • label: The display name of the financial institution (e.g., bank or biller name). This is used for search and display purposes in your user interface.
  • value: The routing value associated with the financial institution. Use this value to identify a bank/branch/biller when creating a beneficiary or transfer.
• truncated: A boolean value indicating whether items is exhaustive for the parameters specified. When true, more results are available but only the first 50 are returned. Refine the keyword in your request to further narrow the match and refresh the results for your user.

See Transfer method specifications below for details.