Institution Links#

Institution Links provide information about supported banks and financial institutions for open banking payments.

The Institution object#

Attribute	Type	Description
`id`	string	Institution identifier
`object`	string	Always `"institution"`
`name`	string	Display name
`full_name`	string	Full legal name
`logo_url`	string	Logo URL
`icon_url`	string	Icon URL
`country`	string	ISO 3166-1 alpha-2 country code
`supported_features`	array	`single_payment`, `recurring_payment`, `account_info`
`status`	enum	`available`, `degraded`, `unavailable`

{
  "id": "revolut",
  "object": "institution",
  "name": "Revolut",
  "full_name": "Revolut Ltd",
  "logo_url": "https://assets.casapay.com/institutions/revolut.svg",
  "icon_url": "https://assets.casapay.com/institutions/revolut-icon.svg",
  "country": "GB",
  "supported_features": ["single_payment", "recurring_payment", "account_info"],
  "status": "available"
}

Retrieve an Institution#

GET /v1/institutions/:id

curl https://api.casapay.com/v1/institutions/revolut \
  -H "Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc"

List Institutions#

GET /v1/institutions

Parameter	Type	Description
`country`	string	Filter by country code
`feature`	string	Filter by supported feature
`search`	string	Search by institution name

curl "https://api.casapay.com/v1/institutions?country=GB&feature=single_payment" \
  -H "Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc"

{
  "object": "list",
  "data": [
    { "id": "revolut", "name": "Revolut", "country": "GB", "status": "available" },
    { "id": "hsbc", "name": "HSBC", "country": "GB", "status": "available" },
    { "id": "barclays", "name": "Barclays", "country": "GB", "status": "available" },
    { "id": "lloyds", "name": "Lloyds", "country": "GB", "status": "available" }
  ],
  "has_more": true
}