List of banks

You can get the list of supported banks by calling dedicated endpoint. This is needed for embedded flow, where the user has to select his bank for the payment. It can be used also in redirect flow if you want to have the list of banks and show it in the UI.

Request

GET {{everifin_url}}/api/{{version}}/banks?countryCode=SVK

Filter

Field	Type	Optional	Description
countryCode	ALPHA-3	yes	Country code

Response

The response consists of the items having the following fields.

Field	Type	Optional	Description
id	text	no	Bank id, for the most of banks it is the bank BIC code
name	text	no	Bank name
countryCode	APLHA-3 code	no	Bank country code
itemType	enum	no	As some banks can be logically grouped (e.g. multiple bank products under one bank house or multiple banks in one bigger bank group) and thus the response can be multi-layer structure (max 3 levels), this field indicates the type of the item in the structure (if it is the bank or some kind of group having sub-items). Possible values: BANK MAIN_GROUP PRODUCT_GROUP

Item types

Item Type

Description

BANK

Item represents the actual bank (has no sub-items).

MAIN_GROUP

Item can appear only on first level of the response data and will always have sub-items. The sub-items can be of item types:

BANK
PRODUCT_GROUP

PRODUCT_GROUP

Item can appear on first or second level of the response structure and will always have sub-items. The sub-items can be only the items of the type BANK.

The motivation to introduce this grouping item type is possibility to present the list of one bank’s products differently comparing to main group of banks in GUI (This way the integrator of the API can follow the way how the bank presents the banking products to their clients - e.g. Bank Austria displays them in one modal window).

Response example

200:
{
    "meta": {
        "status": "SUCCESS"
    },
    "data": [{
        "id": "subaskbx"
        "name": "VÚB Banka",
        "countryCode" : "SVK",
        "itemType": "BANK"
    }, 
    {
        "id": "gibaskbx"
        "name": "Slovenská sporiteľňa",
        "countryCode" : "SVK",
        "itemType": "BANK"
    },
    {
            "id": "sparkasse-de-main-group",
            "name": "Sparkassen-Finanzgruppe",
            "countryCode": "DEU",
            "itemType": "MAIN_GROUP",
            "items": [
                {
                    "id": "solades1mei",
                    "name": "Sparkasse Meißen",
                    "countryCode": "DEU",
                    "itemType": "BANK"
                },
                {
                    "id": "sparkasse-de-products",
                    "name": "Sparkasse Produkten",
                    "countryCode": "DEU",
                    "itemType": "PRODUCT_GROUP",
                    "items": [
                        {
                            "id": "sparkasse-product1-id",
                            "name": "Sparkasse Product 1",
                            "countryCode": "DEU",
                            "itemType": "BANK"
                        },
                        {
                            "id": "sparkasse-product2-id",
                            "name": "Sparkasse Product 2",
                            "countryCode": "DEU",
                            "itemType": "BANK"
                        }
                    ]
                }
            ]
        },]
}