Pular para o conteúdo principal
PUT
Update aggregator connection

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

id
string
obrigatório

Opaque aggregator connection id

Corpo

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.

Exemplo:

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

Exemplo:

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

Exemplo:

"pluggy-main"

secret
string

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

Resposta

OK

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"