Sign in

v1

latestOpenAPI 3.0.02026-07-14866188.2 KB
Info

Search for banks in a specific country (Support for international banks).

get/v0.2.4/info/bank-search

Query parameters

countrystring required

Two-letter country code (ISO 3166-1 alpha-2).

searchstring required

Search query for bank name (minimum 2 characters).

skipinteger

Number of records to skip for pagination.

takeinteger

Number of records to take (page size).

Response

Success.

statusstring

Status of the request.

messagestring

Success message.

Example response

{
  "status": "success",
  "message": "Banks retrieved successfully",
  "data": [
    {
      "primaryKey": "000000000371330",
      "institutionName": "DISTRICT 58 FEDERAL CREDIT UNION",
      "address1": "6217 HWY 15",
      "city": "CHASE",
      "region": "LOUISIANA",
      "country": "UNITED STATES",
      "countryISO": "US",
      "postalCode": "71324",
      "nationalBankCode": "311175158",
      "nationalBankCodeType": "USBC",
      "officeType": "Head Office"
    }
  ],
  "pagination": {
    "total": 1984,
    "take": 100
  }
}