Institutions

Institutions supported by Embedded Payment Run.

Get Institutions

Retrieves the Institutions supported by Embedded Payment Run. The response payload should list all the institutions.

Payment runs are funded from linked bank accounts provided by one of the supported institutions.

We recommend that you enable Buyers to check if their banks are supported before they start the registration and onboarding process.

SecurityapiKey

Request

query Parameters

country	string Filter by country
institutionIds	Array of strings Filter by institution ID
institutionName	string Filter by institution name
market	Array of strings Filter by market Items Enum: "EEA" "UK"
offset	integer >= 0
limit	integer >= 1

Responses

200

400

Bad Request Error - Your request is invalid.

401

Unauthorized - Your credentials or access token are invalid.

403

Forbidden - Access to the requested resource or action is forbidden.

429

Too many requests.

500

Internal Server Error - There is a problem with the server. Please try again later.

503

Service Unavailable - We're temporarily offline for maintenance. Please try again later.

default

Error

get/v1/institutions

Response samples

200
400
403
default

application/json

{"institutions": [{"id": "string",
"displayName": "string",
"markets": ["EEA"
],
"currencies": ["GBP"
],
"countries": ["GB"
],
"images": {"logo": "http://example.com",
"icon": "http://example.com"
}
}
],
"count": 10,
"responseCount": 100
}

➔ Next to Simulator