Sign in
Banks

Retrieve the curated top banks for a market. `country` selects the market; optional `currency` filters further; `limit` caps the result count. Public and cacheable at the market level.

Retrieve the curated top banks for a market. country selects the market; optional currency filters further; limit caps the result count. Public and cacheable at the market level.

get/api/v1/banks/top

Query parameters

countrystring required

The market / country code (ISO 3166-1 alpha-2)

Example:GB

The market / country code (ISO 3166-1 alpha-2)

currencystring

Optional currency filter (ISO 4217)

Example:GBP

Optional currency filter (ISO 4217)

limitinteger

Maximum number of banks to return

Example:3

Maximum number of banks to return

Response

Success

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": {
    "banks": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174001",
        "name": "Santander",
        "market": "GB",
        "currency": "GBP",
        "displayName": "Santander",
        "logoUrl": "https://example.com/logo.png",
        "websiteUrl": "https://www.santander.co.uk",
        "topInMarket": true
      }
    ]
  }
}

Changes

Changed in 2 of the 8 revisions of this API.11