Skip to main content
Get Institution
curl --request GET \
  --url https://api.yapily.com/institutions/{institutionId} \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "modelo-sandbox",
  "name": "Modelo Sandbox",
  "fullName": "Modelo Sandbox",
  "countries": [
    {
      "displayName": "Italy",
      "countryCode2": "IT",
      "bic": "MODEIT21XXX"
    },
    {
      "displayName": "United Kingdom",
      "countryCode2": "GB",
      "bic": "MODEGB21XXX"
    }
  ],
  "environmentType": "SANDBOX",
  "credentialsType": "OPEN_BANKING_UK_AUTO",
  "media": [
    {
      "source": "https://images.yapily.com/image/ce2bfdbf-1ae2-4919-ab7b-e8b3d5e93b36?size=0",
      "type": "icon"
    },
    {
      "source": "https://images.yapily.com/image/ca502f24-d6df-4785-b4b8-1034b100af77?size=0",
      "type": "logo"
    }
  ],
  "features": [
    "ACCOUNT_BALANCES",
    "INITIATE_BULK_PAYMENT",
    "ACCOUNT_BENEFICIARIES",
    "ACCOUNT_SCHEDULED_PAYMENTS",
    "EXISTING_PAYMENTS_DETAILS",
    "ACCOUNT_TRANSACTIONS",
    "ACCOUNT_STATEMENTS",
    "INITIATE_DOMESTIC_PERIODIC_PAYMENT",
    "INITIATE_ACCOUNT_REQUEST",
    "IDENTITY",
    "ACCOUNT_PERIODIC_PAYMENTS",
    "ACCOUNT_REQUEST_DETAILS",
    "ACCOUNT_TRANSACTIONS_WITH_MERCHANT",
    "INITIATE_SINGLE_PAYMENT_SORTCODE",
    "INITIATE_DOMESTIC_SINGLE_PAYMENT",
    "INITIATE_DOMESTIC_SCHEDULED_PAYMENT",
    "ACCOUNT_STATEMENT",
    "CREATE_DOMESTIC_SINGLE_PAYMENT",
    "ACCOUNT_STATEMENT_FILE",
    "CREATE_DOMESTIC_PERIODIC_PAYMENT",
    "CREATE_DOMESTIC_SCHEDULED_PAYMENT",
    "EXISTING_PAYMENT_INITIATION_DETAILS",
    "INITIATE_INTERNATIONAL_SINGLE_PAYMENT",
    "CREATE_SINGLE_PAYMENT_SORTCODE",
    "CREATE_BULK_PAYMENT",
    "CREATE_INTERNATIONAL_SINGLE_PAYMENT",
    "ACCOUNT",
    "PERIODIC_PAYMENT_FREQUENCY_EXTENDED",
    "ACCOUNT_DIRECT_DEBITS",
    "ACCOUNTS"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.yapily.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Use HTTP Basic Authentication with your Application ID as username and Application Secret as password. Manage credentials in the Yapily Console. See Authentication for details.

Path Parameters

​
institutionId
string
required

Mandatory. The Yapily institution Id for the Institution.

Response

Ok

Typically, a bank or business unit within a bank e.g. (AIB Business, AIB Ireland, AIB UK).

​
id
string

Unique identifier for the Institution.

​
name
string

The friendly name of the Institution.

​
fullName
string

The full name of the Institution.

​
countries
object[]

An array of Country denoting which regions the Institution provides coverage for

​
environmentType
enum<string>

The environment type.

See Institution Configuration for more information

Available options:
SANDBOX,
MOCK,
LIVE
​
credentialsType
enum<string>

The type of credentials required to register the Institution

Available options:
OAUTH1,
OAUTH2,
OAUTH2_NOSECRET,
OAUTH2_SIGNATURE,
OPEN_BANKING_UK_MANUAL,
OPEN_BANKING_UK_AUTO,
OPEN_BANKING_IBM,
OPEN_BANKING_AUTO,
OPEN_BANKING_AUTO_EMAIL,
OPEN_BANKING_MANUAL,
OPEN_BANKING_WITH_TPP_ID_AND_SECRET,
API_KEY,
OPEN_BANKING_NO_KEY,
OPEN_BANKING_NO_TRANSPORT,
TOKEN_IO
​
media
object[]

Contains links to the logo and the icons for the Institution

​
features
enum<string>[]

Used to describe what functions are supported by the associated Institution.

For more information on each feature, see the following links:

Available options:
INITIATE_PRE_AUTHORISATION,
INITIATE_PRE_AUTHORISATION_ACCOUNTS,
INITIATE_PRE_AUTHORISATION_PAYMENTS,
INITIATE_ACCOUNT_REQUEST,
INITIATE_EMBEDDED_ACCOUNT_REQUEST,
ACCOUNT_REQUEST_DETAILS,
ACCOUNTS,
ACCOUNT,
ACCOUNT_TRANSACTIONS,
ACCOUNT_STATEMENTS,
ACCOUNT_STATEMENT,
ACCOUNT_STATEMENT_FILE,
ACCOUNT_SCHEDULED_PAYMENTS,
ACCOUNT_DIRECT_DEBITS,
ACCOUNT_PERIODIC_PAYMENTS,
ACCOUNT_TRANSACTIONS_WITH_MERCHANT,
IDENTITY,
ACCOUNTS_WITHOUT_BALANCE,
ACCOUNT_WITHOUT_BALANCE,
ACCOUNT_BALANCES,
INITIATE_SINGLE_PAYMENT_SORTCODE,
EXISTING_PAYMENT_INITIATION_DETAILS,
CREATE_SINGLE_PAYMENT_SORTCODE,
EXISTING_PAYMENTS_DETAILS,
INITIATE_DOMESTIC_SINGLE_PAYMENT,
INITIATE_EMBEDDED_DOMESTIC_SINGLE_PAYMENT,
CREATE_DOMESTIC_SINGLE_PAYMENT,
INITIATE_EMBEDDED_BULK_PAYMENT,
INITIATE_DOMESTIC_SINGLE_INSTANT_PAYMENT,
CREATE_DOMESTIC_SINGLE_INSTANT_PAYMENT,
INITIATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT,
CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT,
INITIATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING,
CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING,
INITIATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_COMMERCIAL,
CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_COMMERCIAL,
INITIATE_DOMESTIC_SCHEDULED_PAYMENT,
CREATE_DOMESTIC_SCHEDULED_PAYMENT,
INITIATE_DOMESTIC_PERIODIC_PAYMENT,
CREATE_DOMESTIC_PERIODIC_PAYMENT,
PERIODIC_PAYMENT_FREQUENCY_EXTENDED,
INITIATE_INTERNATIONAL_SCHEDULED_PAYMENT,
CREATE_INTERNATIONAL_SCHEDULED_PAYMENT,
INITIATE_INTERNATIONAL_PERIODIC_PAYMENT,
CREATE_INTERNATIONAL_PERIODIC_PAYMENT,
INITIATE_INTERNATIONAL_SINGLE_PAYMENT,
CREATE_INTERNATIONAL_SINGLE_PAYMENT,
INITIATE_BULK_PAYMENT,
CREATE_BULK_PAYMENT,
EXISTING_BULK_PAYMENT_DETAILS,
TRANSFER,
OPEN_DATA_PERSONAL_CURRENT_ACCOUNTS,
OPEN_DATA_ATMS,
READ_DOMESTIC_SINGLE_REFUND,
READ_DOMESTIC_SCHEDULED_REFUND,
READ_DOMESTIC_PERIODIC_PAYMENT_REFUND,
READ_INTERNATIONAL_SINGLE_REFUND,
READ_INTERNATIONAL_SCHEDULED_REFUND,
ACCOUNT_BENEFICIARIES,
INITIATE_ONETIME_PRE_AUTHORISATION_PAYMENTS,
INITIATE_ONETIME_PRE_AUTHORISATION_ACCOUNTS,
INITIATE_ONETIME_PRE_AUTHORISATION,
VARIABLE_RECURRING_PAYMENT_FUNDS_CONFIRMATION