Download OpenAPI specification:Download
API to fetch details for
Payload to fetch a bank-group
country required | string <ISO 3166-1 alpha-2> ISO 3166-1 alpha-2 representation of the country |
bank_group_krn required | string <KRN> The unique klarna resource name of the bank-group |
{- "country": "DE",
- "bank_group_krn": "krn:openbanking:global:bank-group:b49b66ac-868b-47f0-9587-fd9ae02a9627"
}
{- "bank_group_krn": "krn:openbanking:global:bank-group:b49b66ac-868b-47f0-9587-fd9ae02a9627",
- "name": "Sparkasse",
- "country": "DE",
- "group_selection_recommended": true,
- "logos": [
- {
- "filetype": "PNG",
- "optimized_for": {
- "property1": true,
- "property2": true
}, - "width": 50,
- "height": 50
}
], - "bank_colors": {
- "background": "#FF00FF",
- "label": "#222222"
}
}
Payload to fetch a list of bank-groups
country required | string <ISO 3166-1 alpha-2> ISO 3166-1 alpha-2 representation of the country |
object (PaginationRequestV2) Describes a paginated request |
{- "country": "DE",
- "pagination": {
- "size": 10,
- "offset": 10
}
}
{- "bank_groups": [
- {
- "bank_group_krn": "krn:openbanking:global:bank-group:b49b66ac-868b-47f0-9587-fd9ae02a9627",
- "name": "Sparkasse",
- "country": "DE",
- "group_selection_recommended": true,
- "logos": [
- {
- "filetype": "PNG",
- "optimized_for": {
- "property1": true,
- "property2": true
}, - "width": 50,
- "height": 50
}
], - "bank_colors": {
- "background": "#FF00FF",
- "label": "#222222"
}
}
], - "pagination": {
- "count": 10,
- "total": 200,
- "offset": 10,
- "next": {
- "size": 10,
- "offset": 20
}, - "prev": {
- "size": 10,
- "offset": 0
}
}
}
Payload to fetch a bank with all integrations details
country required | string <ISO 3166-1 alpha-2> ISO 3166-1 alpha-2 representation of the country |
bank_krn required | string <KRN> A unique klarna resource name for the bank |
{- "country": "DE",
- "bank_krn": "krn:openbanking:global:bank:f15ca33f-cd76-46b8-88f3-403e11bdc710"
}
{- "country": "DE",
- "bank_krn": "krn:openbanking:global:bank:f15ca33f-cd76-46b8-88f3-403e11bdc710",
- "name": "Sparkasse Gießen",
- "group": {
- "bank_group_krn": "krn:openbanking:global:bank-group:b49b66ac-868b-47f0-9587-fd9ae02a9627",
- "name": "Sparkasse",
- "country": "DE",
- "group_selection_recommended": true,
- "logos": [
- {
- "filetype": "PNG",
- "optimized_for": {
- "property1": true,
- "property2": true
}, - "width": 50,
- "height": 50
}
], - "bank_colors": {
- "background": "#FF00FF",
- "label": "#222222"
}
}, - "bics": [
- "SKGIDE5FXXX",
- "SKGIDE5F513",
- "SKGIDE5FKTO",
- "SKGIDE5F500"
], - "bic_bank_codes": [
- "ABNA"
], - "bank_codes": [
- "2100"
], - "local_routing_numbers": [
- "5000"
], - "synthetic_bank_codes": [ ],
- "address": {
- "street_address": "Johannesstraße 3",
- "street_address2": "3. Floor",
- "postal_code": "35390",
- "city": "Gießen",
- "country": "DE"
}, - "popularity": 1000,
- "integrations": [
- {
- "country": "DE",
- "integration_krn": "krn:openbanking:global:integration:2092b601-ac9c-46de-a975-bd8e203f1479",
- "onboarding_required": true,
- "access_method": "PSD2",
- "sub_integrations": [
- {
- "sub_integration_krn": "krn:openbanking:global:sub-integration:128aca15-30ae-4c9c-aaf6-656687805ad4",
- "version": "V2",
- "priority": 1,
- "activation_required": true,
- "exact_bank_code_required": false,
- "capabilities": {
- "consumer_types": [
- "PERSONAL"
], - "source_types": [
- "BANK"
], - "auth": {
- "processes": [
- "EMBEDDED"
]
}, - "consents": {
- "supported": true,
- "lifetime": {
- "min_in_days": 1,
- "max_in_days": 90
}
}, - "accounts": {
- "supported": true,
- "consent_supported": true
}, - "account_details": {
- "supported": true,
- "consent_supported": true
}, - "balances": {
- "supported": true,
- "consent_supported": true
}, - "transactions": {
- "supported": true,
- "max_history": {
- "recurring": {
- "days": 180
}, - "with_psu_present": {
- "days": 90
}
}, - "transaction_id_consistency": "CONSISTENT",
- "states": "BOOKED",
- "consent_supported": true
}, - "transfer": {
- "supported": true,
- "domestic": {
- "supported": true,
- "instant_payments": {
- "sending": true,
- "receiving": true
}, - "debtor_needed": true,
- "funds_check": "NOT_RELIABLE",
- "mandatory_data": {
- "debtor": {
- "account_id": null,
- "iban": null
}, - "creditor": {
- "holder_name": null,
- "iban": null,
- "bank_code": null,
- "account_number": null,
- "bic": null,
- "address": null
}
}
}, - "sepa": {
- "supported": true,
- "instant_payments": {
- "sending": true,
- "receiving": true
}, - "debtor_needed": true,
- "funds_check": "NOT_RELIABLE",
- "mandatory_data": {
- "debtor": {
- "account_id": null,
- "iban": null
}, - "creditor": {
- "holder_name": null,
- "iban": null,
- "bank_code": null,
- "account_number": null,
- "bic": null,
- "address": null
}
}
}
}
}
}
]
}
], - "logos": [
- {
- "filetype": "PNG",
- "optimized_for": {
- "property1": true,
- "property2": true
}, - "width": 50,
- "height": 50
}
], - "bank_colors": {
- "background": "#FF00FF",
- "label": "#222222"
}, - "statistics": {
- "accounts": {
- "holder_percentage": 0,
- "iban_percentage": 0,
- "bic_percentage": 0,
- "account-number_percentage": 0
}, - "account_details": {
- "holder_percentage": 0,
- "iban_percentage": 0,
- "bic_percentage": 0,
- "account-number_percentage": 0
}, - "balance": {
- "balance_percentage": 0,
- "available_percentage": 0,
- "limit_percentage": 0,
- "reserved_percentage": 0
}, - "transaction": {
- "bank-references_percentage": {
- "property1": 0,
- "property2": 0
}
}
}
}
Payload to fetch a list of banks
country required | string <ISO 3166-1 alpha-2> ISO 3166-1 alpha-2 representation of the country |
object (FilterRequestV2) Object which contains a filter which should be applied. | |
object (PaginationRequestV2) Describes a paginated request |
{- "country": "DE",
- "filter": {
- "access_methods": [
- "PSD2"
]
}, - "pagination": {
- "size": 10,
- "offset": 10
}
}
{- "banks": [
- {
- "country": "DE",
- "bank_krn": "krn:openbanking:global:bank:f15ca33f-cd76-46b8-88f3-403e11bdc710",
- "name": "Sparkasse Gießen",
- "bank_group_krn": "krn:openbanking:global:bank-group:b49b66ac-868b-47f0-9587-fd9ae02a9627",
- "bics": [
- "SKGIDE5FXXX",
- "SKGIDE5F513",
- "SKGIDE5FKTO",
- "SKGIDE5F500"
], - "bic_bank_codes": [
- "ABNA"
], - "bank_codes": [
- "2100"
], - "local_routing_numbers": [
- "5000"
], - "synthetic_bank_codes": [ ],
- "address": {
- "street_address": "Johannesstraße 3",
- "street_address2": "3. Floor",
- "postal_code": "35390",
- "city": "Gießen",
- "country": "DE"
}, - "popularity": 1000,
- "logos": [
- {
- "filetype": "PNG",
- "optimized_for": {
- "property1": true,
- "property2": true
}, - "width": 50,
- "height": 50
}
], - "bank_colors": {
- "background": "#FF00FF",
- "label": "#222222"
}, - "statistics": {
- "accounts": {
- "holder_percentage": 0,
- "iban_percentage": 0,
- "bic_percentage": 0,
- "account-number_percentage": 0
}, - "account_details": {
- "holder_percentage": 0,
- "iban_percentage": 0,
- "bic_percentage": 0,
- "account-number_percentage": 0
}, - "balance": {
- "balance_percentage": 0,
- "available_percentage": 0,
- "limit_percentage": 0,
- "reserved_percentage": 0
}, - "transaction": {
- "bank-references_percentage": {
- "property1": 0,
- "property2": 0
}
}
}
}
], - "pagination": {
- "count": 10,
- "total": 200,
- "offset": 10,
- "next": {
- "size": 10,
- "offset": 20
}, - "prev": {
- "size": 10,
- "offset": 0
}
}
}
iban | string Search a bank for the given IBAN |
bic | string Search a bank for the given BIC |
bank_code | string Search a bank for the given bank code. This includes also synthetic_bank_code, bic_bank_code and local_routing_number |
country required | string <ISO 3166-1 alpha-2> ISO 3166-1 alpha-2 representation of the country |
{- "iban": "DE06000000000023456789",
- "bic": "DEUTDEBB174",
- "bank_code": "10070000",
- "country": "DE"
}
{- "banks": [
- {
- "country": "DE",
- "bank_krn": "krn:openbanking:global:bank:f15ca33f-cd76-46b8-88f3-403e11bdc710",
- "name": "Sparkasse Gießen",
- "group": {
- "bank_group_krn": "krn:openbanking:global:bank-group:b49b66ac-868b-47f0-9587-fd9ae02a9627",
- "name": "Sparkasse",
- "country": "DE",
- "group_selection_recommended": true,
- "logos": [
- {
- "filetype": "PNG",
- "optimized_for": {
- "property1": true,
- "property2": true
}, - "width": 50,
- "height": 50
}
], - "bank_colors": {
- "background": "#FF00FF",
- "label": "#222222"
}
}, - "bics": [
- "SKGIDE5FXXX",
- "SKGIDE5F513",
- "SKGIDE5FKTO",
- "SKGIDE5F500"
], - "bic_bank_codes": [
- "ABNA"
], - "bank_codes": [
- "2100"
], - "local_routing_numbers": [
- "5000"
], - "synthetic_bank_codes": [ ],
- "address": {
- "street_address": "Johannesstraße 3",
- "street_address2": "3. Floor",
- "postal_code": "35390",
- "city": "Gießen",
- "country": "DE"
}, - "popularity": 1000,
- "integrations": [
- {
- "country": "DE",
- "integration_krn": "krn:openbanking:global:integration:2092b601-ac9c-46de-a975-bd8e203f1479",
- "onboarding_required": true,
- "access_method": "PSD2",
- "sub_integrations": [
- {
- "sub_integration_krn": "krn:openbanking:global:sub-integration:128aca15-30ae-4c9c-aaf6-656687805ad4",
- "version": "V2",
- "priority": 1,
- "activation_required": true,
- "exact_bank_code_required": false,
- "capabilities": {
- "consumer_types": [
- "PERSONAL"
], - "source_types": [
- "BANK"
], - "auth": {
- "processes": [
- null
]
}, - "consents": {
- "supported": true,
- "lifetime": {
- "min_in_days": null,
- "max_in_days": null
}
}, - "accounts": {
- "supported": true,
- "consent_supported": true
}, - "account_details": {
- "supported": true,
- "consent_supported": true
}, - "balances": {
- "supported": true,
- "consent_supported": true
}, - "transactions": {
- "supported": true,
- "max_history": {
- "recurring": null,
- "with_psu_present": null
}, - "transaction_id_consistency": "CONSISTENT",
- "states": "BOOKED",
- "consent_supported": true
}, - "transfer": {
- "supported": true,
- "domestic": {
- "supported": null,
- "instant_payments": null,
- "debtor_needed": null,
- "funds_check": null,
- "mandatory_data": null
}, - "sepa": {
- "supported": null,
- "instant_payments": null,
- "debtor_needed": null,
- "funds_check": null,
- "mandatory_data": null
}
}
}
}
]
}
], - "logos": [
- {
- "filetype": "PNG",
- "optimized_for": {
- "property1": true,
- "property2": true
}, - "width": 50,
- "height": 50
}
], - "bank_colors": {
- "background": "#FF00FF",
- "label": "#222222"
}, - "statistics": {
- "accounts": {
- "holder_percentage": 0,
- "iban_percentage": 0,
- "bic_percentage": 0,
- "account-number_percentage": 0
}, - "account_details": {
- "holder_percentage": 0,
- "iban_percentage": 0,
- "bic_percentage": 0,
- "account-number_percentage": 0
}, - "balance": {
- "balance_percentage": 0,
- "available_percentage": 0,
- "limit_percentage": 0,
- "reserved_percentage": 0
}, - "transaction": {
- "bank-references_percentage": {
- "property1": 0,
- "property2": 0
}
}
}
}
]
}
Payload to a bank with all integrations details
country required | string <ISO 3166-1 alpha-2> ISO 3166-1 alpha-2 representation of the country |
object (FilterRequestV2) Object which contains a filter which should be applied. | |
object (PaginationRequestV2) Describes a paginated request |
{- "country": "DE",
- "filter": {
- "access_methods": [
- "PSD2"
]
}, - "pagination": {
- "size": 10,
- "offset": 10
}
}
{- "integrations": [
- {
- "country": "DE",
- "integration_krn": "krn:openbanking:global:integration:2092b601-ac9c-46de-a975-bd8e203f1479",
- "onboarding_required": true,
- "access_method": "PSD2",
- "sub_integrations": [
- {
- "sub_integration_krn": "krn:openbanking:global:sub-integration:128aca15-30ae-4c9c-aaf6-656687805ad4",
- "version": "V2",
- "priority": 1,
- "activation_required": true,
- "exact_bank_code_required": false,
- "capabilities": {
- "consumer_types": [
- "PERSONAL"
], - "source_types": [
- "BANK"
], - "auth": {
- "processes": [
- "EMBEDDED"
]
}, - "consents": {
- "supported": true,
- "lifetime": {
- "min_in_days": 1,
- "max_in_days": 90
}
}, - "accounts": {
- "supported": true,
- "consent_supported": true
}, - "account_details": {
- "supported": true,
- "consent_supported": true
}, - "balances": {
- "supported": true,
- "consent_supported": true
}, - "transactions": {
- "supported": true,
- "max_history": {
- "recurring": {
- "days": 180
}, - "with_psu_present": {
- "days": 90
}
}, - "transaction_id_consistency": "CONSISTENT",
- "states": "BOOKED",
- "consent_supported": true
}, - "transfer": {
- "supported": true,
- "domestic": {
- "supported": true,
- "instant_payments": {
- "sending": true,
- "receiving": true
}, - "debtor_needed": true,
- "funds_check": "NOT_RELIABLE",
- "mandatory_data": {
- "debtor": {
- "account_id": null,
- "iban": null
}, - "creditor": {
- "holder_name": null,
- "iban": null,
- "bank_code": null,
- "account_number": null,
- "bic": null,
- "address": null
}
}
}, - "sepa": {
- "supported": true,
- "instant_payments": {
- "sending": true,
- "receiving": true
}, - "debtor_needed": true,
- "funds_check": "NOT_RELIABLE",
- "mandatory_data": {
- "debtor": {
- "account_id": null,
- "iban": null
}, - "creditor": {
- "holder_name": null,
- "iban": null,
- "bank_code": null,
- "account_number": null,
- "bic": null,
- "address": null
}
}
}
}
}, - "bank_krns": [
- "krn:openbanking:global:bank:f15ca33f-cd76-46b8-88f3-403e11bdc710"
]
}
]
}
], - "pagination": {
- "count": 10,
- "total": 200,
- "offset": 10,
- "next": {
- "size": 10,
- "offset": 20
}, - "prev": {
- "size": 10,
- "offset": 0
}
}
}