FAQ

Aqui você encontrará as perguntas mais frequentes.

Conceitos básicos #

O que é um item?#

Um item representa a conexão entre um usuário e uma instituição financeira, bem como todos os dados retornados nessa conexão.

O que é uma aplicação e quais os tipos disponíveis?#

Uma aplicação diz respeito as chaves de clientId e clientSecret utilizadas para acessar a API. Essas chaves devem ser manuseadas com atenção, pois é somente com elas que os dados da API podem ser retornados. É possível criar aplicações nos ambientes de Desenvolvimento e Produção.

Qual a diferença entre apiKey e connectToken?#

apiKey é a chave que dá acesso à nossa API. É obtida através das credenciais do cliente na Pluggy (clientId & clientSecret) e tem validade de 2 horas.

connectToken é a chave utilizada para acessar o Pluggy Connect Widget, ou seja, a interface gráfica de nossa API. Para obter o connectToken é necessário a obtenção da apiKey em primeiro lugar. O connectToken tem duração de 30 minutos.

Conectores e instituições financeiras #

Qual a diferença entre conectores Pluggy e conectores Open Finance?#

	Conectores Pluggy (não regulado)	Conectores Open Finance (regulado)
Tecnologia	Proprietária da Pluggy	Estrutura regulada pelo Banco Central
Acesso	Direto às instituições financeiras	Via consentimento do usuário
Dados	Conforme exibidos no Internet Banking	Padronizados e enriquecidos

Para mais informações, acesse nossa documentação.

Como consultar as instituições financeiras disponíveis para conexão?#

Existem algumas maneiras de consultar as instituições financeiras (conectores) disponíveis:

Documentação: conectores Open Finance (regulado) aqui, conectores Pluggy (não regulado) aqui.
API: consultar aqui.
Dashboard: consultar aqui.

Quais instituições precisam de token para conectar?#

As instituições que requerem token para realizar a conexão podem ser analisadas nesta página de nossa documentação.

Como habilitar os conectores em minha aplicação?#

Para habilitar conectores na nossa widget, basta acessar a aba de Customização no nosso dashboard.

Sim, nós disponibilizamos um atributo selectedConnectorId que permite exibir apenas o conector pré-definido. Mais detalhes em nossa documentação.

Gerenciamento de items e conexões #

Se um usuário conectar duas vezes a mesma conta, serão geradas duas conexões diferentes?#

Sim. Cada vez que o usuário dá seu consentimento (inserção de credenciais nos conectores Pluggy ou seleção dos dados a serem compartilhados nos conectores Open Finance), é gerada nova conexão (novo itemId). Para evitar que isso ocorra, devemos realizar uma conexão e atualizar essa mesma conexão (itemId) para que os dados mais recentes possam ser retornados pela nossa API.

Para mitigar esse cenário, oferecemos uma configuração que verifica se a conta já foi conectada anteriormente. Para mais informações, acesse nossa documentação.

Como posso identificar que uma conexão (itemId) pertence a um cliente específico?#

Nós disponibilizamos um campo para ser preenchido com as informações do usuário que está realizando a conexão. Esse campo é o clientUserId e deve ser enviado no momento da criação do item (conexão da conta) ou, para usuários da Pluggy Connect Widget, pode ser enviado no momento de sua abertura.

O campo clientUserId recebe qualquer dado (string) que você quiser enviar, mas recomendamos o seguinte padrão: "nome | email | cpf_ou_cnpj".

Mais detalhes em nossa documentação.

Como realizar a revogação de um consentimento (conexão)?#

Para revogar um consentimento, basta deletar o item correspondente via API. Isso encerra a conexão e remove os dados associados.

Por que o itemId parou de atualizar?#

Uma das causas mais comuns é o atingimento do limite de requisições. Isso ocorre quando a mesma conta é conectada diversas vezes, fazendo com que o usuário atinja o limite junto à instituição financeira.

Limite por CPF/CNPJ: esse limite é compartilhado entre todos os itemIds do mesmo CPF ou CNPJ. Quando atingido, as transações só voltarão a ser atualizadas no próximo mês.

O item atingiu o limite — o que fazer?#

Infelizmente não é possível reverter o limite no mês corrente. Para evitar que isso volte a acontecer, evite criar múltiplas conexões para a mesma conta — reutilize sempre o mesmo itemId e atualize-o quando precisar de dados mais recentes.

É possível listar todos os items que eu já criei na Pluggy?#

Não é possível consultar os itens por motivos de segurança, para evitar qualquer vazamento de dados.

As novas transações de uma conta são atualizadas em tempo real?#

Não. As novas transações de uma conta somente estarão disponíveis para a consulta após uma atualização na conexão. Para mais informações sobre a atualização das contas, consultar nossa documentação.

Novas transações nos conectores Open Finance (regulado) podem levar até 24h para estarem disponíveis para consulta.

Como funciona a atualização automática?#

A Pluggy sistematiza uma atualização automática para os itemIds. Basta manifestar interesse nos nossos canais de comunicação. É possível escolher um horário de início das atualizações. Os itemIds vão para uma fila e são atualizados de acordo com a capacidade de processamento, para evitar sobrecargas.

Ambientes e produção #

Como ir para produção?#

Para ir para produção, basta criar uma nova aplicação de produção na nossa dashboard, aba de Aplicações, clicando em "Ir para a produção".

É importante criar essa aplicação de produção pois, nessa aplicação:

É disponibilizada atualização automática;
Não há limite de itemIds;
Não há acesso a página demo, para que dados sensíveis de clientes não fiquem expostos.