Create aggregator connection

Creates an Open-Finance data-aggregator (Pluggy/Belvo) connection and seals its credential. The connection’s config name is what the webhook token-mint endpoint binds a token to. The supplied credential is sealed before persistence and is never returned.

POST /v1/discovery/aggregator-connections

Create aggregator connection

cURL

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

201

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}")

Cuerpo

application/json

baseUrl · string<uri> · requerido

Vendor API base URL, stored as the connection host

Minimum string length: 1

Ejemplo:

"https://api.pluggy.ai"

clientId · string · requerido

Aggregator API client id (sealed; never emitted)

Minimum string length: 1

configName · string · requerido

Unique connection config name (tenant-scoped); the mint endpoint binds a token to this name

Minimum string length: 1

Ejemplo:

"pluggy-main"

secret · string · requerido

Aggregator API client secret (sealed; never emitted)

Minimum string length: 1

vendor · enum<string> · requerido

Aggregator vendor: pluggy (Pluggy Open Finance aggregator) or belvo (Belvo aggregator)

Opciones disponibles: pluggy, belvo

Ejemplo:

"pluggy"

accountRef · string

Opaque vendor account reference (Pluggy itemId, Belvo link id) the webhook pull threads onto its request. Omit to create a connection awaiting consent — the connect flow binds it after the end customer authorizes.

Ejemplo:

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

Respuesta

201

application/json

Created

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"