v2

latestOpenAPI 3.1.02026-07-262279731.3 MB
payByBank

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

get/v2.01/{ClientId}/payment-methods/openbanking/metadata/supported-banks

Path parameters

ClientIdstring required

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

Query parameters

CountryCodesstring

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_pageinteger

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.

pageinteger

Start value: 1

Default value: 1

Indicates the index of the page for the pagination.

Headers

Authorizationstring required

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.

Response

Success