BAbanqzinc
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).

Changed on

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}

Request

Path parameters

marketstring required

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

Example:GB

Query parameters

qstring

Case-insensitive substring match on bank name

Example:chase
'tink'
OR
'fumopay'
OR
'fumopay_sandbox'
OR
'sandbox'
OR
'straddle'
OR
'straddle_sandbox'
limitinteger

Maximum number of results (default 20)

Example: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
    }
  }
]

Changes

  • b372e7d5563dRevision changes
    • breaking

      the / response's property type changed from string to no type for status

    • breaking

      the // response's property format changed from uri to no format for status

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter provider

    • info

      added the new optional query request parameter q

    • info

      added the optional property / to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added subschema #1 subschema #2 to the / response property allOf list for the response status

    • info

      the // response's property pattern ^[A-Za-z]{3}$ was added for the status

    • info

      the // response's property pattern ^[A-Za-z]{2}$ was added for the status

  • 6637b341d86dRevision changes
    • info

      endpoint added