Skip to navigation

List Banks

View as Markdown

Lists beneficiary banks or financial institutions by country code.

Authentication:

  • REQUIRED: Provide client_id and client_secret via:
  • Basic Auth: Authorization: Basic base64(client_id:client_secret)

Query Parameters:

  • country_code (required): Country code (ID, PH, VN, BO, NG, GH, or ZM)

Response:

  • banks: Array of bank/financial institution objects with unified code field
  • country_code: The country code requested
  • total: Total number of banks returned

Bank Code Standardization: All banks in the response use a unified code field. Institution identifiers are normalized to the code field for consistency.

Supported Countries:

  • ID (Indonesia, IDR) — published bank coverage for accounts with IDR enabled. Each row has code (3-digit national bank code), name, short_name, and swift_code when the source row has one. Pass code or swift_code as payment_destination_code on lookupPaymentCode with payment_method bank_transfer and a 6–30 digit account number as payment_destination. The list is informational: lookup accepts any 3-digit bank code or SWIFT, including codes not returned here. Codes 013, 022, and 200 each appear twice (a bank and its syariah window share code and differ by swift_code). Code 688 has no swift_code. E-wallet payouts (DANA, OVO, GOPAY, SHOPEEPAY) are not in this list.
  • PH (Philippines)
  • VN (Vietnam)
  • BO (Bolivia) — use returned code values as payment_destination_code with lookupPaymentCode
  • NG (Nigeria), GH (Ghana), ZM (Zambia) — banks and mobile-money operators in one list; code carries channel_category to tell them apart

Note: listBanks applies to ID, PH, VN, BO, NG, GH and ZM. ID requires IDR in the account’s supported_currencies; otherwise the call returns 403 COUNTRY_NOT_SUPPORTED_BY_ACCOUNT. Other corridors resolve routing from the QR or country_code at decode/lookup time.

Authentication

AuthorizationBasic

Basic Auth: base64(client_id:client_secret)

Query parameters

country_codeenumRequired

ISO 3166-1 alpha-2 country code. ID returns Indonesia banks and requires IDR on the account.

Response

OK
bankslist of objects
country_codestring
totalinteger

Errors

400
Bad Request Error
401
Unauthorized Error