Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Discovery

Test aggregator connection credentials

Runs a live connectivity check for an existing Open-Finance data-aggregator (Pluggy/Belvo) connection using its already-sealed credential, addressed by (vendor, configName). No credential is supplied or returned: the result is the secret-free boolean health of the connection.

post/v1/discovery/aggregator-connections/test

Request body

configNamestring required

Config name of the existing aggregator connection to test (tenant-scoped)

vendor'pluggy' | 'belvo' required

Aggregator vendor: pluggy or belvo

Example request

{
  "configName": "pluggy-main",
  "vendor": "pluggy"
}

Response

OK

configNamestring required

Connection config name that was tested

healthyboolean required

Whether the live connectivity check passed with the sealed credential

vendor'pluggy' | 'belvo' required

Aggregator vendor the tested connection is bound to

Example response

{
  "configName": "pluggy-main",
  "healthy": true,
  "vendor": "pluggy"
}