v1
latestOpenAPI 3.1.02026-07-266133267.6 KBsearch and retrieve bank entities from global bank directory [GET]
get/v3/payout/bank
Query parameters
countrystring required
Example:IN
ISO 3166-1 alpha-2 country code
search_textstring required
Example:HDFC
Search text (minimum 3 characters)
code_type'swift_code' | 'sort_code' | 'aba_code' | 'bsb_code' | 'ifsc_code' | 'iban' | 'bank_name' required
Example:ifsc_code
Type of bank code to search
limitinteger
Example:10
Maximum number of results (<= 50)
offsetinteger
Pagination offset
Response
Successful response
Example response
{
"status": "success",
"data": {
"results": [
{
"id": "bke_d7ag8hfhambilrokaoog",
"object": "bank"
}
]
}
}