XSxs2a
Bankcodes API

Check if a bank is supported by xs2a

Changed on

You will receive information about the selected bank. The field xs2a_supported can be used to determine whether or not you should offer XS2A products to your customer.

get/bankcodes

Request

Query parameters

bank_codestring

bank code of the customers bank, optionally a country_id, otherwise Germany will be assumed

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

The 2-letter country code

Example:DE

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

bicstring

BIC of the customers bank, no country id is necessary

per_pageinteger

Items per page

pageinteger

Which page to display

qstring

Uses the value to search for customers bank as either BIC or bank code

Response

Request successfully processed

bank_codestring

bank code of the bank

bicstring

BIC of the bank

namestring

Name of the bank

short_namestring

Abbreviated bank name

zipcodestring

National ZIP code of the bank

citystring

City

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

The 2-letter country code

testmodestring

'1', if this bank is a testbank

xs2a_productsProduct[]

array of xs2a products supported

xs2a_supportedboolean

true, if this bank is supported by XS2A

Example response

{
  "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