Pular para o conteúdo principal
POST
Create aggregator connection

Autorizações

Authorization
string
header
obrigatório

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

Corpo

application/json
baseUrl
string<uri>
obrigatório

Vendor API base URL, stored as the connection host

Minimum string length: 1
Exemplo:

"https://api.pluggy.ai"

clientId
string
obrigatório

Aggregator API client id (sealed; never emitted)

Minimum string length: 1
configName
string
obrigatório

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

Minimum string length: 1
Exemplo:

"pluggy-main"

secret
string
obrigatório

Aggregator API client secret (sealed; never emitted)

Minimum string length: 1
vendor
enum<string>
obrigatório

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

Opções disponíveis:
pluggy,
belvo
Exemplo:

"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.

Exemplo:

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

Resposta

Created

accountRef
string
obrigatório

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

Exemplo:

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

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

Exemplo:

false

baseUrl
string<uri>
obrigatório

Stored vendor API base URL

Exemplo:

"https://api.pluggy.ai"

configName
string
obrigatório

Connection config name the operator mints a token against

Exemplo:

"pluggy-main"

vendor
enum<string>
obrigatório

Aggregator vendor the connection is bound to

Opções disponíveis:
pluggy,
belvo
Exemplo:

"pluggy"