View supported banks for Pay by Bank

Retrieve supported banks to present to a user for Pay by Bank pay-ins

This endpoint allows you to retrieve a paginated list of banks that you can present to the user for selection during their Pay by Bank checkout experience. Once they have selected their bank, and optionally the scheme, submit the data of their selection to the POST Create a Pay by Bank PayIn endpoint. Read the guide →

Query parameters

CountryCodes · string

Allowed values: AT, DE, DK, EE, ES, FI, FR, GB, IE, IT, LV, LT, NL, NO, PL, PT.

The countries for which to return supported banks. You can combine query values in a comma-separated list.

per_page · integer

Min. value: 1; max. value: 100

Default value: 10

The number of Banks objects returned for each page of the pagination.

On this endpoint, the pagination refers to the number of Banks objects, regardless of whether they span multiple Countries objects.

page · integer

Start value: 1

Default value: 1

Indicates the index of the page for the pagination.

Responses

200 - Response parameters

SupportedBanks · object

The supported banks listed by country.

Hide properties

Countries · array (object)

Array of objects listing the paginated Banks per Country.

Hide properties

Banks · array (object)

List of paginated banks for the country. Display the list of banks for the user to choose before submitting their selection in the POST Create a Pay by Bank PayIn request.

Hide properties

BankName · string

The bank’s BankName to identify it in the pay-in request.

Scheme · array (string)

List of Scheme values supported by the bank, which can be presented to the user for selection before submission in the pay-in request.

Name · type

The bank’s display name to show to the user for selection.

Country · string

The Country value for the paginated list of Banks objects.

400 - Unsupported country code

{
    "Id": "c3f6137d-eb40-4d48-a320-4209577b0101",
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Date": 1749481944,
    "Type": "param_error",
    "Errors": {
        "countryCodes": "The value [AU] is not valid"
    }
}

REST

// GET has no body parameters

REST (10 banks by default)

{
    "SupportedBanks": {
        "Countries": [
            {
                "Banks": [
                    {
                        "BankName": "at-demobank-open-banking-embedded",
                        "Scheme": [],
                        "Name": "Tink Demo Bank"
                    },
                    {
                        "BankName": "at-demobank-open-banking-redirect",
                        "Scheme": [],
                        "Name": "Tink Demo Bank"
                    },
                    {
                        "BankName": "at-demobank-password",
                        "Scheme": [],
                        "Name": "Tink Demo Bank"
                    }
                ],
                "Country": "AT"
            },
            {
                "Banks": [
                    {
                        "BankName": "de-demo-commerzbank-ob",
                        "Scheme": [
                            "SEPA_CREDIT_TRANSFER",
                            "SEPA_INSTANT_CREDIT_TRANSFER",
                            "PIS_FUTURE_DATE"
                        ],
                        "Name": "Commerzbank Sandbox"
                    },
                    {
                        "BankName": "de-demobank-open-banking-embedded-templates",
                        "Scheme": [
                            "PIS_BULK_PAYMENTS",
                            "SEPA_CREDIT_TRANSFER",
                            "SEPA_INSTANT_CREDIT_TRANSFER"
                        ],
                        "Name": "Tink Demo Bank"
                    },
                    {
                        "BankName": "de-demobank-open-banking-redirect",
                        "Scheme": [
                            "PIS_BULK_PAYMENTS",
                            "SEPA_CREDIT_TRANSFER",
                            "SEPA_INSTANT_CREDIT_TRANSFER"
                        ],
                        "Name": "Tink Demo Bank"
                    },
                    {
                        "BankName": "de-demobank-open-banking-redirect-pisonly",
                        "Scheme": [
                            "PIS_BULK_PAYMENTS",
                            "SEPA_CREDIT_TRANSFER",
                            "SEPA_INSTANT_CREDIT_TRANSFER"
                        ],
                        "Name": "Tink Demo Bank"
                    },
                    {
                        "BankName": "de-demobank-password",
                        "Scheme": [
                            "PIS_BULK_PAYMENTS",
                            "SEPA_CREDIT_TRANSFER",
                            "SEPA_INSTANT_CREDIT_TRANSFER"
                        ],
                        "Name": "Tink Demo Bank"
                    }
                ],
                "Country": "DE"
            },
            {
                "Banks": [
                    {
                        "BankName": "dk-demobank-open-banking-embedded",
                        "Scheme": [
                            "INSTANT_DANISH_DOMESTIC_CREDIT_TRANSFER_INTRADAG",
                            "DANISH_DOMESTIC_CREDIT_TRANSFER",
                            "INSTANT_DANISH_DOMESTIC_CREDIT_TRANSFER_STRAKS"
                        ],
                        "Name": "Tink Demo Bank"
                    },
                    {
                        "BankName": "dk-demobank-open-banking-redirect",
                        "Scheme": [
                            "INSTANT_DANISH_DOMESTIC_CREDIT_TRANSFER_INTRADAG",
                            "DANISH_DOMESTIC_CREDIT_TRANSFER",
                            "INSTANT_DANISH_DOMESTIC_CREDIT_TRANSFER_STRAKS"
                        ],
                        "Name": "Tink Demo Bank"
                    }
                ],
                "Country": "DK"
            }
        ]
    }
}