Update aggregator connection

Edits an existing Open-Finance data-aggregator (Pluggy/Belvo) connection by id so a mistyped baseUrl is not permanent. The vendor is immutable. clientId/secret are optional: supply both to rotate the sealed credential, or omit both to leave the stored secret intact. The supplied credential is sealed before persistence and is never returned. A non-aggregator connection id returns 404.

PUT /v1/discovery/aggregator-connections/{id}

Update aggregator connection

cURL

curl --request PUT \
  --url https://matcher.sandbox.lerian.net/v1/discovery/aggregator-connections/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountRef": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "baseUrl": "https://api.pluggy.ai",
  "clientId": "<string>",
  "configName": "pluggy-main",
  "secret": "<string>"
}
'

200

Example

{
  "accountRef": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "awaitingConsent": false,
  "baseUrl": "https://api.pluggy.ai",
  "configName": "pluggy-main",
  "vendor": "pluggy"
}

Autorizaciones

Authorization · string · header · requerido

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

Parámetros de ruta

id · string · requerido

Opaque aggregator connection id

Cuerpo

application/json

accountRef · string

Opaque vendor account reference (Pluggy itemId, Belvo link id). Supply it to bind (or re-bind) the connection after the vendor's consent widget returns one; omit it to leave the stored value untouched.

Ejemplo:

"a1b2c3d4-5678-90ab-cdef-1234567890ab"

baseUrl · string<uri>

Vendor API base URL, stored as the connection host. Omit it to leave the stored URL untouched.

Ejemplo:

"https://api.pluggy.ai"

clientId · string

Aggregator API client id (optional; supply with secret to rotate, omit both to keep the stored credential; sealed; never emitted)

configName · string

Unique connection config name (tenant-scoped); the mint endpoint binds a token to this name. Omit it to leave the stored name untouched.

Ejemplo:

"pluggy-main"

secret · string

Aggregator API client secret (optional; supply with clientId to rotate, omit both to keep the stored credential; sealed; never emitted)

Respuesta

200

application/json

OK

accountRef · string · requerido

Stored opaque vendor account reference (Pluggy itemId, Belvo link id); empty while the connection is awaiting consent

Ejemplo:

"a1b2c3d4-5678-90ab-cdef-1234567890ab"

awaitingConsent · boolean · requerido

Whether the connection is still awaiting the end customer's vendor consent (no vendor item/link bound yet)

Ejemplo:

false

baseUrl · string<uri> · requerido

Stored vendor API base URL

Ejemplo:

"https://api.pluggy.ai"

configName · string · requerido

Connection config name the operator mints a token against

Ejemplo:

"pluggy-main"

vendor · enum<string> · requerido

Aggregator vendor the connection is bound to

Opciones disponibles: pluggy, belvo

Ejemplo:

"pluggy"