Skip to main content

InstitutionsEndpoint

The InstitutionsEndpoint class provides support for the API operations of the institutions endpoint.

Methods​

GetInstitutions​

Gets a list of institutions supported by the Nordigen API. The list can be filtered by country and supported features. If multiple filters are applied, they are additive.

public async Task<NordigenApiResponse<List<Institution>, BasicResponse>>
  GetInstitutions(
        string? country = null, bool? accessScopesSupported = null,
        bool? accountSelectionSupported = null, bool? businessAccountsSupported = null,
        bool? cardAccountsSupported = null, bool? corporateAccountsSupported = null,
        bool? privateAccountsSupported = null, bool? readRefundAccountSupported = null,
        bool? paymentsEnabled = null, bool? paymentSubmissionSupported = null,
        bool? pendingTransactionsSupported = null, bool? ssnVerificationSupported = null,
        CancellationToken cancellationToken = default)

Overloaded country parameter using the SupportedCountry type:

public async Task<NordigenApiResponse<List<Institution>, BasicResponse>>
  GetInstitutions(
        SupportedCountry country, bool? accessScopesSupported = null,
        bool? accountSelectionSupported = null, bool? businessAccountsSupported = null,
        bool? cardAccountsSupported = null, bool? corporateAccountsSupported = null,
        bool? privateAccountsSupported = null, bool? readRefundAccountSupported = null,
        bool? paymentsEnabled = null, bool? paymentSubmissionSupported = null,
        bool? pendingTransactionsSupported = null, bool? ssnVerificationSupported = null,
        CancellationToken cancellationToken = default)

Parameters​

country - string? | SupportedCountry​

If set to true filters institutions by the country in which they operate. The country has to be specified by the two-letter country code following ISO 3166.

accessScopesSupported - bool​

If set to true filters institutions by whether or not access scopes are supported.

accountSelectionSupported - bool​

If set to true filters institutions by whether or not account selection is supported.

businessAccountsSupported - bool​

If set to true filters institutions by whether or not business accounts are supported.

cardAccountsSupported - bool​

If set to true filters institutions by whether or not card accounts are supported by this institution.

corporateAccountsSupported - bool​

If set to true filters institutions by whether or not corporate accounts are supported.

privateAccountsSupported - bool​

If set to true filters institutions by whether or not private accounts is supported.

readRefundAccountSupported - bool​

If set to true filters filters institutions by whether or not read refund account is supported.

readDebtorAccountSupported - bool​

If set to true filters institutions by whether or not the debtor account can be read before submitting payment.

paymentsEnabled - bool​

If set to true filters institutions by whether or not payments are supported.

paymentSubmissionSupported - bool​

If set to true filters institutions by whether or not payment submission is supported.

pendingTransactionsSupported - bool​

If set to true filters institutions by whether or not pending transactions are supported.

ssnVerificationSupported - bool​

If set to true filters institutions by whether or not SSN verification is supported.

cancellationToken - CancellationToken​

A token to signal cancellation of the operation.

Returns​

Task<NordigenApiResponse<List<Institution>, BasicResponse>>

A NordigenApiResponse containing a list of supported institutions if the request was successful.

GetInstitution​

Gets a specific institution by id.

public async Task<NordigenApiResponse<Institution, BasicResponse>>
  GetInstitution(string id, CancellationToken cancellationToken = default)

Parameters​

id - string​

The id of the institution to retrieve (can be retrieved via the GetInstitutions method).

cancellationToken - CancellationToken​

A token to signal cancellation of the operation.

Returns​

Task<NordigenApiResponse<Institution, BasicResponse>>

A NordigenApiResponse containing the Institution matching the id if the request was successful.