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=de&transfer_method=sct_instant&offset=0&size=100
Content-Type: application/json
Authorization: Bearer <Token>
Host: <Host>
Request parameter |
Mandatory? |
Description |
country_code |
M |
Queries banks for the given country |
transfer_method |
O |
Filters banks by supported transfer method |
offset |
O |
Defines “where” to start in the current collection |
size |
O |
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 response object
Field |
Type |
Description |
banks[].bank_name |
string |
Name of the bank |
banks[].country_code |
string |
The country of the bank. ISO-3166 alpha-2 |
banks[].bank_codes |
string[] |
List of bank codes associated with that bank |
banks[].bics |
string[] |
List of BICs associated with that bank |
banks[].address |
Address |
Most common address of the bank if there are multiple |
banks[].popularity |
integer |
Number that describes the popularity of the bank for Open Banking consumers. A higher number indicates higher popularity |
banks[].authentication_methods |
string |
List of supported methods to authenticate (e.g. accessing the consumer's bank account) and authorize (e.g. a payment). 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 |
banks[].authorization_methods |
string |
See banks[].authentication_methods |
banks[].transfer_methods |
string |
List of supported transfer methods.
SCT - SEPA Credit Transfer SCT_INSTANT - SEPA Instant Credit Transfer |
banks[].tokenizable.ais |
boolean |
Describes if a token can be used for AIS (Account Information Service). |
banks[].tokenizable.pis |
boolean |
Describes if a token can be used for PIS (Payment Initiation Service). |
banks[].flows..supported |
string |
Object holding information about the different supported flows (namely accounts , account_details , balances , transactions , transfer ). |
pagination.count |
integer |
The amount of elements in the current result |
pagination.total |
integer |
The total amount of elements that are available |
pagination.next |
string |
The URI to the next list of results. Is only present if there are more results available |
pagination.prev |
string |
The URI to the previous list of results. Is null if the offset is 0 |
pagination.offset |
integer |
The current offset. Describes "where" to start in the current dataset |
Example
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
}
}