Banks Autocomplete

The Payiano Banks Autocomplete endpoint helps you efficiently search for registered banks when creating or updating payout accounts. It provides a fast, user-friendly search mechanism that returns matching banks based on partial input.

This endpoint improves user experience by minimizing typing effort and avoiding selection errors. Especially useful when your system supports a large list of banks per country or payout method. Results are paginated and suitable for use in dropdowns or select fields with dynamic searching.

GET/payout/autocomplete/banks
Sandbox: https://api.payiano.dev/v1/payout/autocomplete/banks
Live: https://api.payiano.com/v1/payout/autocomplete/banks
Security
  • Authorization header with access token is required to access this endpoint: Bearer ACCESS-TOKEN
  • Your access token should be associated to one of these permissions payout.accounts.view , payout.accounts.create or payout.accounts.update
Request
Request body schema:
application/json
Query parameters:
page
Type: integer|null
Default: 1

The page number to be retrieved, for the list of banks. So, a combination of page=1 and per_page=25 returns the first 25 banks items. A combination of page=2 and per_page=25 returns the next 25 banks items.

per_page
Type: integer|null
Default: 25
Possible values: [1 ... 200]

The maximum number of banks items to return in the response.

q
Type: array_of_strings|null
Min: 3

This parameter enables free-text search across key banks fields (including but not limited to name, code and bic), requiring a minimum of 3 characters per search term. It performs case-insensitive partial matching, and returns relevance-ranked results while automatically handling special characters. This provides a simple yet powerful way to quickly find relevant banks items.

sort
Type: array_of_objects|null

Control the ordering of results with sophisticated multi-column sorting. Specify an array of objects, each containing a field and direction. Maximum 5 sort fields per request to maintain optimal performance.

field
Type: enum
Possible values:
[ "bic", "code", "name" ]

This attribute specifies the field used for sorting. It can be a direct attribute of the resource or a related field referenced using dot notation.

direction
Type: enum
Possible values:
[ "asc", "desc" ]

This attribute specifies the sorting direction. It can be either asc for ascending order or desc for descending order. Please note that the value is case-sensitive.

Response
200
Response schema:
application/json
Response body:
total_pages
Type: integer

The total number of pages that are available for the payout banks search criteria.

current_page
Type: integer

The current pagination page.

per_page
Type: integer

The amount of payout banks items return per page.

total_items
Type: integer

The total number of payout banks that match the search criteria.

items
Type: array_of_objects

The list of payout banks that match the search criteria.

name
Type: string

A descriptive name for the bank. This helps identify the bank when managing multiple payout recipients such as vendors, employees, or partners. Examples: 'Banque Misr', 'National Bank of Egypt'.

alt_name
Type: string

An alternative or secondary name for the bank, typically used in a different language or script. For example, if name is provided in English ('Banque Misr'), then alt_name may be provided in Arabic ('بنك مصر'), or vice versa. This helps ensure proper identification of banks across multilingual systems and user interfaces.

code
Type: string

The standardized short code of the bank (e.g., NBE, Banque Misr, CIB ). This code should be unique per country and is commonly used internally or for mapping to ACH directories.

country_code
Type: string

Specify the unique two-letter country code ( e.g EG, SA or AE ) corresponding to the country where the bank is located. This code is part of the standard international country codes set by the ISO .

bic
Type: string
Max: 11

The SWIFT BIC (Bank Identifier Code) of the bank used in international wire transfers. Must be 8 or 11 uppercase alphanumeric characters. Example: 'BMISEGCXXXX' for Banque Misr main branch.

Response sample:
1
{ 2 "per_page": 25, 3 "total_pages": 1, 4 "total_items": 1, 5 "current_page": 1, 6
 "items": [ 7
 { 8 "name": "Banque Misr", 9 "alt_name": "بنك مصر", 10 "code": "MISR", 11 "country_code": "EG", 12 "bic": "BMISEGCXXXX" 13 } 14 ] 15}