Skip to main content
POST
Criar conexão de agregador

Autorizações

Authorization
string
header
obrigatório

Autenticação por Bearer token (formato: "Bearer {token}")

Corpo

application/json
accountRef
string
obrigatório

Referência opaca de conta do fornecedor (Pluggy itemId, ID de link Belvo) que o pull do webhook encadeia em sua requisição

Minimum string length: 1
Exemplo:

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

baseUrl
string<uri>
obrigatório

URL base da API do fornecedor, armazenada como host da conexão

Minimum string length: 1
Exemplo:

"https://api.pluggy.ai"

clientId
string
obrigatório

ID do cliente da API do agregador (selado; nunca emitido)

Minimum string length: 1
configName
string
obrigatório

Nome único da configuração da conexão (com escopo de tenant); o endpoint de emissão vincula um token a este nome

Minimum string length: 1
Exemplo:

"pluggy-main"

secret
string
obrigatório

Segredo do cliente da API do agregador (selado; nunca emitido)

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

Fornecedor de agregador: pluggy (agregador Pluggy Open Finance) ou belvo (agregador Belvo)

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

"pluggy"

Resposta

Criado

accountRef
string
obrigatório

Referência opaca de conta do fornecedor armazenada (Pluggy itemId, ID de link Belvo)

Exemplo:

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

baseUrl
string<uri>
obrigatório

URL base da API do fornecedor armazenada

Exemplo:

"https://api.pluggy.ai"

configName
string
obrigatório

Nome da configuração da conexão contra a qual o operador emite um token

Exemplo:

"pluggy-main"

vendor
enum<string>
obrigatório

Fornecedor de agregador ao qual a conexão está vinculada

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

"pluggy"