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 configName. The vendor is read from the stored connection, not from the request. No credential is supplied or returned: the result is the secret-free boolean health of the connection. A config name that matches no connection returns 404; a connection whose vendor has no test path (Belvo) returns 422 (MTCH-0210), and no test runs.

POST /v1/discovery/aggregator-connections/test

Test aggregator connection credentials

cURL

curl --request POST \
  --url https://matcher.sandbox.lerian.net/v1/discovery/aggregator-connections/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "configName": "pluggy-main"
}
'

200

Example

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

Autorizaciones

Authorization · string · header · requerido

Bearer token authentication (format: "Bearer {token}")

Cuerpo

application/json

configName · string · requerido

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

Minimum string length: 1

Ejemplo:

"pluggy-main"

Respuesta

200

application/json

OK

configName · string · requerido

Connection config name that was tested

Ejemplo:

"pluggy-main"

healthy · boolean · requerido

Whether the live connectivity check passed with the sealed credential

Ejemplo:

true

vendor · enum<string> · requerido

Aggregator vendor the tested connection is bound to

Opciones disponibles: pluggy, belvo

Ejemplo:

"pluggy"