v1

latestOpenAPI 3.1.02026-07-132363652.9 MB

Banks

Admin

Get all banks with their activation status (admin only)

get/api/v1/admin/banks

Query parameters

marketstring

Filter by market (optional)

Example:GB

Filter by market (optional)

isActivestring

Filter by activation status (optional)

Example:true

Filter by activation status (optional)

Response

Success

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Santander",
      "market": "GB",
      "currency": "GBP",
      "displayName": "Santander",
      "logoUrl": "https://example.com/logo.png",
      "topInMarket": true,
      "isActive": true,
      "tinkProvider": {
        "id": "tink-provider-123",
        "popular": true
      },
      "providers": [
        {
          "name": "tink",
          "popular": true
        }
      ],
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ]
}