latestSwagger 2.02026-08-20196638916.1 KB

23d8982b533d

Connectivity v1.Provider

List providers

Lists all providers available for a authenticated user.

get/api/v1/providers

Query parameters

capability'CHECKING_ACCOUNTS' | 'CREATE_BENEFICIARIES' | 'CREATE_BENEFICIARIES_IN_PAYMENT' | 'CREDIT_CARDS' | 'IDENTITY_DATA' | 'INVESTMENTS' | 'LIST_BENEFICIARIES' | 'LOANS' | 'MORTGAGE_AGGREGATION' | 'MORTGAGE_LOAN' | 'PAYMENTS' | 'SAVINGS_ACCOUNTS' | 'TRANSFERS'

Use the capability to only list providers with a specific capability. If no capability the provider response will not be filtered on capability.

includeTestProvidersboolean

Defaults to false. If set to true, Providers of TEST type will be added in the response list.

excludeNonTestProvidersboolean

Defaults to false. If set to true, Providers of type different than TEST will be removed from the response list.

namestring

Gets a specific provider from the name. If this query parameter is used, only one or no providers will be returned.

pisCapability'AUTO_PAYMENT' | 'BACS' | 'CHAPS' | 'CZECH_EXPRESS_INTERNAL_TRANSFER' | 'CZECH_INTERNAL_TRANSFER' | 'DANISH_DOMESTIC_CREDIT_TRANSFER' | 'FASTER_PAYMENTS' | 'INSTANT_DANISH_DOMESTIC_CREDIT_TRANSFER_INTRADAG' | 'INSTANT_DANISH_DOMESTIC_CREDIT_TRANSFER_STRAKS' | 'INSTANT_NORWEGIAN_DOMESTIC_CREDIT_TRANSFER_STRAKS' | 'INSTANT_POLISH_DOMESTIC_CREDIT_TRANSFER' | 'MULTIBANCO' | 'NORWEGIAN_DOMESTIC_CREDIT_TRANSFER' | 'PAYMENT_CANCELLATION' | 'PAYPAL' | 'PIS_BULK_PAYMENTS' | 'PIS_FUTURE_DATE' | 'PIS_MOBILE_AUTO_SIGN' | 'PIS_SE_BANK_TRANSFERS' | 'PIS_SE_BG' | 'PIS_SE_PG' | 'PIS_SEPA_ICT_RECURRING_PAYMENTS' | 'PIS_SEPA_RECURRING_PAYMENTS' | 'POLISH_DOMESTIC_CREDIT_TRANSFER' | 'SEPA_CREDIT_TRANSFER' | 'SEPA_INSTANT_CREDIT_TRANSFER' | 'SINGLE_PAYMENT_STATUS_CHECK' | 'SWISS_DOMESTIC_CREDIT_TRANSFER' | 'VRP_SWEEPING'

Use the capability to only list providers with a specific payment capability. If no payment capability the provider response will not be filtered on capability.

Response

OK

providersConnectivity20v1Provider[] required— unresolved $ref

List of providers that match the query.