XSxs2a
Bankcodes API

Get a paginated list of all bankcodes for a query string

Changed on

For a paginated result of bankcodes based on a query string, send a get request to this endpoint.

get/bankcodes/autocomplete

Request

Query parameters

qstring required

Use a query string to search for a bank by name

country_id'DE' | 'AT' | 'CH'

The 2-letter country code

Example:DE

Two letter country code id, e.g. AT, CH, DE

per_pageinteger

Items per page

pageinteger

Which page to display

product'xs2a_verify' | 'xs2a_risk' | 'xs2a_pay' | 'xs2a_api'

The name of the xs2a product.

Example:xs2a_risk

Limit your search to a specific product

Response

Request successfully processed

totalinteger

Total number of results.

per_pageinteger

Number of objects per page

current_pageinteger

Current page.

last_pageinteger

Last page, usually the total of available pages.

frominteger

Showing results from index element.

tointeger

Showing results to index element.

Example response

{
  "total": 26,
  "per_page": 15,
  "current_page": 1,
  "last_page": 15,
  "from": 1,
  "to": 15,
  "data": [
    {
      "bank_code": "88888888",
      "bic": "TESTDE88XXX",
      "name": "Testbank",
      "short_name": "Testbank",
      "zipcode": "12345",
      "city": "Teststadt",
      "country_id": "DE",
      "testmode": "1",
      "xs2a_products": [
        "xs2a_risk"
      ],
      "xs2a_supported": true
    }
  ]
}

Changes

  • ae5fbc5feee3Revision changes
    • breaking

      removed the enum value ES from the query request parameter country_id

    • breaking

      removed the enum value FR from the query request parameter country_id

    • breaking

      removed the enum value GB from the query request parameter country_id

    • breaking

      removed the enum value IT from the query request parameter country_id

    • info

      removed the ES enum value from the // response property for the response status

    • info

      removed the FR enum value from the // response property for the response status

    • info

      removed the GB enum value from the // response property for the response status

    • info

      removed the IT enum value from the // response property for the response status