Sign in
Banks
Admin

Get all banks with their activation status (admin only)

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"
    }
  ]
}

Changes

Changed in 3 of the 8 revisions of this API.314

  • b372e7d5563d213See the full diff
    • ▲

      for the query request parameter market, the minLength was increased from 0 to 2

      request-parameter-min-length-increased

    • ▲

      added the pattern ^[A-Za-z]{2}$ to the query request parameter market

      request-parameter-pattern-added

    • ●

      for the query request parameter market, the maxLength was set to 2

      request-parameter-max-length-set

    • ○

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

      response-property-pattern-added

    • ○

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

      response-property-pattern-added

    • ○

      added the required property data/items/providers to the response with the 200 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6637b341d86d1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 919eb7a392aa1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 367 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog