Get Institutions

Request

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.

Security

apiKey

Query

countrystring

Filter by country

institutionIdsArray of strings

Filter by institution ID

institutionNamestring

Filter by institution name

marketArray of strings

Filter by market

Items Enum:"EEA""UK"

offsetinteger, >= 0

limitinteger, >= 1

curl -i -X GET \
  'https://sandbox.weavr.io/payment-run/v1/institutions?country=string&institutionIds=string&institutionName=string&market=EEA&offset=0&limit=1' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json

institutionsArray of objects(Institution)required

countintegerrequired

The total number of records (excluding the paging limit)

Example:10

responseCountintegerrequired

The total number of records returned in this response (always capped at 100).

Example:100

Response

{
  "institutions": [
    { … }
  ],
  "count": 10,
  "responseCount": 100
}