Retrieving the Banks of a Country

The list of banks for a country can be retrieved through a GET call towards the URL provided in the country.banks property of the call to retrieve all supported countries.

Request

GET /v1/banks?country_code={country_code} HTTP/1.1
Content-Type: application/json
Authorization: Bearer <Token>
Host: <Host>
curl -X "GET" "/v1/banks?country_code={country_code}" \
         -H "Content-Type: application/json" \
         -H "Authorization: Bearer <token>"  \
         -H "Host: <Host>"

country_code String, required

Queries banks for the given country. It must comply with the ISO 3166-1 alpha-2 representation of the country. Valid options are in the country.country_code property of the call to retrieve all supported countries.

transfer_method String, optional

Filters banks by supported transfer method Supported transfer methods that are:

  • SCT - SEPA Credit Transfer
  • SCT_INSTANT - SEPA Instant Credit Transfer

offset String, optional

Defines "where" to start in the current collection. If no value for offset is provided, a default of 0 will be used

size String, optional

Defines how many elements to include in the result. If no value for size is provided, a default of 100 will be used. There is a maximum of 1.000 elements per request

Response

{
    "banks": [{
        "bank_name": string,
        "country_code": string,
        "bank_codes": Array<string>,
        "bics": Array<string>,
        "address": {
            "street_address": string,
            "street_address2": string,
            "postal_code": string,
            "city": string,
            "region": string,
            "country": string
        },
        "popularity": int,
        "authentication_methods": Array<enum<PASSWORD|MOBILE|SMS_TAN|...>>,
        "authorization_methods": Array<enum<...>>,
        "transfer_methods": Array<enum<SCT, SCT_INSTANT>>,
        "tokenizable": {
            "ais": bool,
            "pis": bool
        },
        "flows": {
            "<flow.type>": ?{
                "supported": ?bool
            },
            ...
        }
    },
    ...],
    "pagination": {
        "count": int,
        "total": int,
        "next": ?string,
        "prev": ?string,
        "offset": int
    }
}

banks Object[], always present

banks holds an array of objects with information on the requested banks.

banks[].bank_name String, always present

Name of the bank

banks[].country_code String, always present

The country of the bank as a ISO 3166-1 alpha-2 string

banks[].bank_codes String[], always present

List of bank codes associated with that bank

banks[].bics String[], always present

List of BICs associated with that bank

banks[].address AddressData, always present

Most common address of the bank if there are multiple

banks[].popularity Integer, always present

Number that describes the popularity of the bank for Open Banking consumers. A higher number indicates higher popularity.

banks[].authentication_methods Enum, always present

List of supported methods to authenticate (e.g. accessing the consumer's bank account) and authorize (e.g. a payment).

Possible values are:

CLASSIC_TAN, ITAN, MTAN, CHIPTAN_MANUAL, CHIPTAN_FLICKER, SMARTTAN, SMARTTAN_PLUS, PHONE_TAN, PASSWORD, PHOTO_TAN, USB_DONGLE, EMAIL_TAN, PUSH_TAN, FINTS_SMARTCARD, FINTS_KEYFILE, APP_TAN, NONE, UNKNOWN

Detailed information on these values can be found here under "data.result.authentication_method".

banks[].authorization_methods Enum, always present

See banks[].authentication_methods

banks[].transfer_methods Enum, always present

The list of supported transfer methods that are:

  • SCT - SEPA Credit Transfer
  • SCT_INSTANT - SEPA Instant Credit Transfer

banks[].tokenizable Object, always present

The tokenizable object provides information on whether or not consent tokens can be used.

banks[].tokenizable.ais Boolean, always present

Describes if a token can be used for AIS (Account Information Service).

banks[].tokenizable.pis Boolean, always present

Describes if a token can be used for PIS (Payment Initiation Service).

banks[].flows Object, optional

The flows object provides information on the flows for the bank.

banks[].flows.<flow_type> Object, optional

The key of this property is the type of the flow (for example accounts) and the value is an object holding information about the flow.

banks[].flows.<flow_type>.supported Boolean, optional

A boolean indicator for whether or not the flow is supported for the bank.

pagination Object, always present

The pagination objects holds several properties to enable paging through the results.

pagination.count Integer, always present

The amount of elements in the current result.

pagination.total Integer, always present

The total amount of elements that are available.

pagination.next String, optional

The URI to the next list of results. It is only present if more results are available.

pagination.prev String, optional

The URI to the previous list of results. It is null if the offset is 0.

pagination.offset Integer, always present

The current offset that indicates "where" to start in the current dataset.

Example

GET https://universe.openbanking.klarna.com/v1/banks?country_code=de HTTP/1.1
curl -X "GET" "https://universe.openbanking.klarna.com/v1/banks?country_code=de"
{
    "banks": [{
        "bank_name": "Postbank",
        "country_code": "DE",
        "bank_codes": ["10010010", "37010050", "59010031", ...],
        "bics": ["PBNKDEFF370", "PBNKDEFF250", ...],
        "address": {
            "street_address": "THEODOR-HEUSS-ALLEE 72",
            "street_address2": "",
            "postal_code": "60320",
            "city": "FRANKFURT AM MAIN",
            "region": "",
            "country": "DE"
        },
        "popularity": 10000,
        "authentication_methods": ["PASSWORD"],
        "authorization_methods": ["MTAN", "CHIPTAN_FLICKER", "CHIPTAN_MANUAL", "USB_DONGLE"],
        "transfer_methods": ["SCT"],
        "tokenizable": {
            "ais": false,
            "pis": false
        },
        "flows": {
            "accounts": {
                "supported": true
            },
            "account_details": {
                "supported": false
            },
            "balances": {
                "supported": true
            },
            "transactions": {
                "supported": true
            },
            "transfer": {
                "supported": true
            }
        }
    },
    {
        "bank_name": "Deutsche Bank",
        "country_code": "DE",
        "bank_codes": ["10070000", "10070024", "10070100", ...],
        "bics": ["DEUTDEBBXXX", "DEUTDEDBBER", ...],
        "address": {
            "street_address": "Taunusanlage 12",
            "street_address2": "",
            "postal_code": "60325",
            "city": "Frankfurt am Main",
            "region": "",
            "country": "DE"
        },
        "popularity": 4979,
        "authentication_methods": ["PASSWORD"],
        "authorization_methods": ["MTAN", "ITAN", "PHOTO_TAN"],
        "transfer_methods": ["SCT", "SCT_INSTANT"],
        "tokenizable": {
            "ais": false,
            "pis": false
        },
        "flows": {
            "accounts": {
                "supported": true
            },
            "account_details": {
                "supported": false
            },
            "balances": {
                "supported": true
            },
            "transactions": {
                "supported": true
            },
            "transfer": {
                "supported": true
            }
        }
    }],
    "pagination": {
        "count": 100,
        "total": 1732,
        "next": "https://universe.openbanking.klarna.com/v1/banks?country_code=de&offset=100&size=100",
        "prev": null,
        "offset": 0
    }
}

results matching ""

    No results matching ""