View supported banks for Pay by Bank

GET

/v2.01/:ClientId/payment-methods/openbanking/metadata/supported-banks

GET

/v2.01/:ClientId/payment-methods/openbanking/metadata/supported-banks

$ curl https://api.sandbox.mangopay.com/v2.01/{ClientId}/payment-methods/openbanking/metadata/supported-banks \
>      -H "Authorization: Bearer <token>"

1 {
2   "SupportedBanks": {
3     "Countries": [
4       {
5         "Banks": [
6           {
7             "BankName": "at-demobank-open-banking-embedded",
8             "Scheme": [],
9             "Name": "Tink Demo Bank"
10           },
11           {
12             "BankName": "at-demobank-open-banking-redirect",
13             "Scheme": [],
14             "Name": "Tink Demo Bank"
15           },
16           {
17             "BankName": "at-demobank-password",
18             "Scheme": [],
19             "Name": "Tink Demo Bank"
20           }
21         ],
22         "Country": "AT"
23       },
24       {
25         "Banks": [
26           {
27             "BankName": "de-demo-commerzbank-ob",
28             "Scheme": [
29               "SEPA_CREDIT_TRANSFER",
30               "SEPA_INSTANT_CREDIT_TRANSFER",
31               "PIS_FUTURE_DATE"
32             ],
33             "Name": "Commerzbank Sandbox"
34           },
35           {
36             "BankName": "de-demobank-open-banking-embedded-templates",
37             "Scheme": [
38               "PIS_BULK_PAYMENTS",
39               "SEPA_CREDIT_TRANSFER",
40               "SEPA_INSTANT_CREDIT_TRANSFER"
41             ],
42             "Name": "Tink Demo Bank"
43           },
44           {
45             "BankName": "de-demobank-open-banking-redirect",
46             "Scheme": [
47               "PIS_BULK_PAYMENTS",
48               "SEPA_CREDIT_TRANSFER",
49               "SEPA_INSTANT_CREDIT_TRANSFER"
50             ],
51             "Name": "Tink Demo Bank"
52           },
53           {
54             "BankName": "de-demobank-open-banking-redirect-pisonly",
55             "Scheme": [
56               "PIS_BULK_PAYMENTS",
57               "SEPA_CREDIT_TRANSFER",
58               "SEPA_INSTANT_CREDIT_TRANSFER"
59             ],
60             "Name": "Tink Demo Bank"
61           },
62           {
63             "BankName": "de-demobank-password",
64             "Scheme": [
65               "PIS_BULK_PAYMENTS",
66               "SEPA_CREDIT_TRANSFER",
67               "SEPA_INSTANT_CREDIT_TRANSFER"
68             ],
69             "Name": "Tink Demo Bank"
70           }
71         ],
72         "Country": "DE"
73       },
74       {
75         "Banks": [
76           {
77             "BankName": "dk-demobank-open-banking-embedded",
78             "Scheme": [
79               "INSTANT_DANISH_DOMESTIC_CREDIT_TRANSFER_INTRADAG",
80               "DANISH_DOMESTIC_CREDIT_TRANSFER",
81               "INSTANT_DANISH_DOMESTIC_CREDIT_TRANSFER_STRAKS"
82             ],
83             "Name": "Tink Demo Bank"
84           },
85           {
86             "BankName": "dk-demobank-open-banking-redirect",
87             "Scheme": [
88               "INSTANT_DANISH_DOMESTIC_CREDIT_TRANSFER_INTRADAG",
89               "DANISH_DOMESTIC_CREDIT_TRANSFER",
90               "INSTANT_DANISH_DOMESTIC_CREDIT_TRANSFER_STRAKS"
91             ],
92             "Name": "Tink Demo Bank"
93           }
94         ],
95         "Country": "DK"
96       }
97     ]
98   }
99 }

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 →

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](/api-reference/pay-by-bank/create-pay-by-bank-payin) endpoint. [Read the guide](/guides/payment-methods/banking/pay-by-bank) **→**

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired

Platform's API account identifier, associated with the API key.

Query parameters

CountryCodesstringOptional

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.

**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_pageintegerOptional

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.

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.

pageintegerOptional

Start value: 1

Default value: 1

Indicates the index of the page for the pagination.

Response

Success

SupportedBanksobject

The supported banks listed by country.

Errors

400

Bad Request Error