Objetivo do Guia:
Integrar suas contas externas (como Corretoras, Mesas OTC e Custodiantes) à plataforma Parfin. Isso permite que a plataforma puxe os seus saldos automaticamente e consolide tudo na sua tela de Portfolio.


ℹ️A conexão de contraparte permite integrar contas externas à plataforma, como corretoras, mesas OTC, custodiantes ou outros provedores disponíveis. Essa funcionalidade pode ser utilizada para consultar informações, consolidar dados operacionais e, dependendo da configuração da empresa, viabilizar fluxos específicos dentro da plataforma.

Importante: nem todos os clientes utilizam esse tipo de conexão. O uso dessa funcionalidade depende da estrutura operacional contratada e das permissões habilitadas para cada empresa.


Pré-requisitos

ℹ️Observação: cada tipo de contraparte pode solicitar credenciais diferentes para realizar a conexão.

Algumas conexões utilizam API Key e API Secret, enquanto outras podem solicitar tokens, certificados, identificadores de conta, credenciais geradas pelo banco ou outros dados específicos.

No exemplo abaixo, estamos utilizando o modelo de autenticação por API Key e API Secret. Porém, antes de preencher as informações, confira sempre quais campos são solicitados na tela para a contraparte selecionada.

  • [ ]  Acesso nível: Administrador (ou usuário com permissão de acesso ao menu Settings).
  • [ ]  Credenciais da API: Você precisará da API-Key e da API-Secret geradas previamente na plataforma que você deseja conectar (ex: Binance, Mercado Bitcoin, sua mesa OTC, etc.).
  • [ ]  Permissões da API: Garanta que a API gerada na outra plataforma tenha permissão de Leitura (para mostrar saldos) e/se necessário, Trade/Saque (se for operar por dentro da Parfin).

? Para usuários técnicos: Quer entender os detalhes técnicos de como a nossa plataforma se comunica com as contrapartes? Consulte a nossa documentação:  https://docs.parfin.io/

Passo a Passo

1. Acessando a área de Conexões

O primeiro passo é navegar até a área de configurações de contrapartes:

  1. No menu lateral esquerdo, clique em Settings.
  2. Na parte superior da tela, certifique-se de estar na aba Counterparties (ela tem um sublinhado verde quando está ativa).
  3. Clique no botão verde [+ Connect Counterparty] localizado no canto direito da tela.

2. Preenchendo as Credenciais de Integração

Agora, você vai informar à Parfin qual instituição deseja conectar e inserir as chaves de segurança:

  1. Counterparty Type: Clique na lista e selecione o tipo de instituição (Ex: Bank,Custodian, Exchange,, OTC Desk).
  2. Counterparty: Selecione o nome específico da instituição que você está conectando (Ex: Internal OTC).

  1. API-Key: Cole a chave pública fornecida pela sua contraparte.
  2. API-Secret: Cole a chave secreta fornecida pela sua contraparte.
  3. Account Description: Dê um nome de fácil identificação para essa conta (Ex: "Conta Principal Binance" ou "OTC - Fundo X").


ℹ️Observação: nem todos os tipos de contraparte solicitam as mesmas credenciais de segurança.

Algumas conexões podem exigir outros dados de autenticação.

Por isso, antes de preencher as informações, verifique na tela da plataforma quais campos são solicitados para o tipo de conexão selecionado.

⚠️ Atenção: As chaves de API são sensíveis a espaços em branco. Ao copiar e colar, certifique-se de não deixar nenhum espaço sobrando no início ou no final do texto.

3. Finalizando a Conexão

  1. Após preencher todos os campos corretamente, o botão Submit no canto superior direito (que estava cinza) ficará verde e clicável.
  2. Clique em Submit.
  3. Aguarde a mensagem de sucesso. A nova contraparte aparecerá listada na sua tela de "Counterparty Connections".

Resolução de Problemas (Troubleshooting)


Caso o botão não fique clicável, isso significa que o sistema identificou que falta alguma informação obrigatória.


Como resolver: Verifique se você preencheu todos os 5 campos da tela. Preste atenção especial ao campo "Account Description", que costuma ser esquecido, mas é obrigatório para ativar o botão.


Isso ocorre quando a Parfin tenta se comunicar com a outra instituição, mas a chave é rejeitada.


Como resolver:

  1. Verifique se não há espaços em branco ocultos no final da sua API-Key ou API-Secret.
  2. Confirme se as chaves que você colou correspondem exatamente à plataforma escolhida no campo "Counterparty".
  3. Verifique na plataforma de origem (sua corretora/banco) se o IP da Parfin precisa ser liberado (Whitelisted) nas configurações da API.

Ainda precisa de ajuda?

Se você inseriu as chaves corretamente, mas a integração continua falhando, nossa equipe técnica pode te auxiliar,  abra um ticket com um print da tela de erro e te ajudaremos a entrar!