v1

latestOpenAPI 3.1.02026-07-132363652.9 MB
Banks

Retrieve banks for a specific market. Without query params returns the default list for the market. With `q` performs a substring match on bank name; `provider` further scopes to a provider configuration; `limit` caps results (default 20, max 50).

Retrieve banks for a specific market. Without query params returns the default list for the market. With q performs a substring match on bank name; provider further scopes to a provider configuration; limit caps results (default 20, max 50).

get/api/v1/banks/{market}

Path parameters

marketstring required

The market code (e.g., GB, DE, US)

Example:GB

The market code (e.g., GB, DE, US)

Query parameters

qstring

Case-insensitive substring match on bank name

Example:chase

Case-insensitive substring match on bank name

'tink'
OR
'fumopay'
OR
'fumopay_sandbox'
OR
'sandbox'
OR
'straddle'
OR
'straddle_sandbox'

Restrict results to banks tied to this payment provider. Account-info providers (e.g. Flinks) are addressed via the payment provider that routes through them (e.g. straddle / straddle_sandbox).

limitinteger

Maximum number of results (default 20)

Example:20

Maximum number of results (default 20)

Response

Success

successboolean required

Indicates if the request was successful

Example response

[
  {
    "success": true,
    "data": {
      "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
    }
  }
]