Integração Boletos BTG

1- Criação de aplicações no BTG

Link: https://developers.empresas.btgpactual.com/docs/registrando-um-app


A criação de aplicativos é feita apenas e somente pelo desenvolvedor cadastrado pelo titular da conta. É importante ressaltar que, para a utilização do ambiente de produção, é preciso ter um aplicativo verificado, com um SLA de até 07 dias pelo BTG.

 

Como eu verifico um aplicativo?

Para ter seu aplicativo verificado você precisa, primeiro, se certificar que possui o plano avançado contratado. O processo entre a solicitação de verificação e a devolutiva pode levar até 7 dias úteis.

Depois disso, você criará um aplicativo assim como ensinaremos logo abaixo, porém, deixando o botão no topo da tela configurado para o modo "produção":
 


 

Entre na Área do Desenvolvedor


 

Clique em "Criar Aplicativos" para começar o fluxo de criação de aplicativo

Você será guiado pelo processo de criação de aplicativo, onde você poderá definir as informações que refletirão nos nossos sistemas quanto ao seu aplicativo. O fluxo consiste em 3 etapas:
 

  1. Dados do aplicativo;
  2. Escopos utilizados;
  3. Resumo.

Ambiente

Certifique-se que esteja criando seu aplicativo no ambiente desejado. O controle do ambiente no qual o aplicativo está sendo criado pode ser feito a partir do toggle no canto superior direito da página, conforme:

 

Dados do aplicativo

 

Esta é a primeira etapa na criação de aplicativo e exigirá que você informe:

  1. Nome: É o nome que identifica o aplicativo da sua empresa no nosso sistema e aparecerá para seus clientes.
  2. Tipo: É o tipo de aplicação que seu aplicativo alimentará. Veja as características para saber mais.
  3. Descrição do aplicativo: É uma breve descrição sobre as finalidades do seu aplicativo e não é obrigatório.
  4. Modelo de integração: É referente ao modelo de integração que seu aplicativo poderá realizar. Veja Modelos de Aplicativo para saber mais.
  5. URL de redirecionamento: É a URL que será utilizada para o callback durante nosso fluxo de autenticação. Veja Authorization Code para saber mais.


IMPORTANTE: A URL de redirecionamento você só irá obter quando criar a integração na Vindi; Porém você pode adicionar qualquer informação para continuar e depois alterar essa informação.

 

Escopos utilizados

Aqui você encontrará uma lista dos Escopos separados por serviço para que você escolha quais deseja consumir no seu sistema.

 

Você pode selecionar tudo relacionado a Boletos;

As principais necessárias são:

  1. empresas.btgpactual.com/accounts.readonly
  2. empresas.btgpactual.com/bank-slips
  3. openid

 

Resumo

 

Basta clicar no item que deseja para que veja as informações presentes!

Após confirmar as informações e enviá-las, seu aplicativo ficará pendente de homologação se for o ambiente de produção.

 

 

2 - Cadastrando chaves na aplicação Vindi

Com a solicitação de chaves do BTG, após o período de aprovação, agora podemos cadastrar as chaves para ativação da operação de boletos BTG com a Vindi.

 

Instalar a integração BTG Pactual na plataforma

Entre em "Configurações / Extensões & Integrações". Encontrar a integração do BTG Pactual e clicar em instalar.


 

 

Preencher os campos "Client ID" e "Secret" com os dados gerados na plataforma do BTG. (Passo 01)
 


Depois de instalar a integração, precisamos autorizá-la no BTG Pactual. Clicando em "Autorizar" o usuário é redirecionado para a plataforma do BTG para autenticação e depois é redirecionado de volta para a Vindi.

Importante: Nesse passo obrigatoriamente precisa de um usuário no BTG com Permissão Financeira para poder autenticar com sucesso.



Importante: Nesse momento você consegue a URL de redirecionamento, você deve alterar sua aplicação BTG (Passo 01) com esse link gerado pela Vindi.


 

Cadastro de Gateway

Solicite para a Vindi a criação de um "Boleto Bancário Online" com o BTG;

Email: credenciamento@vindi.com.br 

 

Cadastro de método de pagamento

Solicite a Vindi criar um método de pagamento do tipo "Boleto Bancário Online" e conectar com o gateway BTG criado.

Email: credenciamento@vindi.com.br 

Passe as informações necessárias para cadastro:

  1. Carteira;
  2. Agência;
  3. Conta;
  4. Convênio;
  5. Dias para vencimento;
  6. Empresa;

 Pronto, sua empresa está cadastrada para emissão de boletos BTG.



Dúvidas frequentes:

 

1. O que é a integração de boleto no BTG?

A integração de boleto no BTG permite que empresas emitam boletos bancários diretamente por meio da plataforma do BTG, facilitando a cobrança e o pagamento de faturas, com a opção de personalizar o boleto conforme as necessidades do negócio.

2. Como posso começar a integrar boletos no sistema do BTG?

Para integrar boletos no sistema do BTG, você precisará solicitar acesso à API de cobrança de boletos do banco, configurar as credenciais de API fornecidas e seguir a documentação técnica para a implementação. O processo envolve configurar sua conta bancária e integrar a API ao seu sistema de gestão de pagamentos.

3. Quais são os requisitos técnicos para realizar a integração?

A integração requer o uso de uma linguagem de programação que suporte requisições HTTP, como Python, Java, PHP ou Node.js. Você também precisará de um ambiente seguro para armazenar as credenciais da API, além de uma estrutura para validar e gerar boletos no formato exigido pelo BTG.

4. Qual o formato de arquivo necessário para o boleto gerado?

Os boletos gerados pela plataforma BTG são geralmente emitidos no padrão CNAB, que é um formato amplamente utilizado no Brasil. Os arquivos de boleto podem ser gerados em formato PDF ou por meio de integrações via API para enviar os dados para a plataforma do banco.

5. Quais informações precisam ser fornecidas para gerar um boleto?

Para gerar um boleto, é necessário fornecer os seguintes dados:

  • Valor do boleto
  • Data de vencimento
  • Dados do beneficiário (sua empresa)
  • Dados do pagador (cliente)
  • Instruções de pagamento (caso necessário)
  • Taxa de juros/multa por atraso, se aplicável.

6. A integração suporta boletos com diferentes carteiras bancárias?

Sim, a integração de boleto do BTG permite configurar diferentes carteiras bancárias, caso sua empresa precise emitir boletos com condições específicas de cada carteira (como a carteira 11, 13, 17, entre outras). A configuração precisa ser feita de acordo com o tipo de cobrança que sua empresa utilizar.

7. Como posso personalizar o boleto gerado pelo BTG?

A personalização do boleto pode ser realizada via API, ajustando detalhes como logotipo, mensagens de instruções, e layout do boleto. A personalização está sujeita às regras do banco e às opções disponíveis na plataforma.

8. Quais são as formas de pagamento aceitas pelo sistema de boletos do BTG?

O sistema de boletos do BTG permite apenas o pagamento via boletos bancários, que podem ser pagos em bancos, lotéricas ou aplicativos de pagamento que aceitem boletos. O sistema pode ser configurado para aceitar pagamentos de forma automatizada, com confirmação de pagamento.

9. Quais erros podem ocorrer durante a integração e como resolvê-los?

Erros comuns podem incluir:

  • Erro de autenticação: Verifique se suas credenciais da API estão corretas.
  • Erro de dados do boleto: Certifique-se de que todos os dados necessários, como valores e vencimentos, foram preenchidos corretamente.
  • Erro na conexão com a API: Verifique sua conexão de rede e a configuração de segurança. Para resolver problemas específicos, consulte a documentação da API do BTG ou entre em contato com o suporte técnico.

10. Qual é o prazo para compensação do pagamento do boleto?

O prazo de compensação varia de acordo com o banco emissor do boleto, mas geralmente é entre 1 e 3 dias úteis após o pagamento. O status do pagamento pode ser consultado diretamente via API ou pelo portal do BTG.

11. Como posso verificar o status de um boleto emitido?

A consulta de status pode ser feita diretamente pela API do BTG, que oferece endpoints para verificar se o boleto foi pago ou se está em aberto. Também é possível verificar o status no portal do BTG.

12. O sistema permite realizar a devolução de boletos pagos?

Sim, caso seja necessário devolver um boleto pago, o sistema do BTG permite que a devolução seja solicitada, conforme as regras do banco. A devolução pode ser processada através da API ou diretamente no portal do banco.

13. O que fazer caso o boleto não seja pago até o vencimento?

Se o boleto não for pago até o vencimento, você pode emitir um novo boleto com juros e multa, caso tenha configurado essas opções durante a emissão. Também é possível reemitir o boleto através da API.