Fluxo ideal para a emissão de boletos

Olá! Para facilitar a integração de nossos clientes e parceiros, elaboramos este post para mostrar de uma forma intuitiva e modelada o fluxo ideal de emissão de boletos, utilizando a nossa solução para integração de boletos bancários.

O objetivo principal é que aqui você consiga ter uma visão geral de nosso sistema, das principais funcionalidades do componente/API, métodos e rotas, e entender o funcionamento, para que o início de suas implementações ocorram da forma mais produtiva possível!

Então, vamos lá!

Logo abaixo, você irá verá uma imagem com o fluxo completo modelado, mas antes disso, é interessante também revisarmos as principais partes da integração com algumas observações sobre elas.

Tudo começa com a geração do tx2 ou do JSON em seu sistema

Em nossa integração, as informações do boleto podem ser passadas via "arquivo tx2" ou JSON , com campos padronizados. Ou seja, independente do banco, os campos do boleto terão o mesmo nome. É claro, existem particularidades entre bancos, como o Banco X exigir determinado campo, enquanto que o mesmo campo não é aceito pelo Banco Y. Mas estes são detalhes que vamos acertando no momento de homologar o boleto junto ao banco. O que importa é que com esta padronização, o esforço no desenvolvimento para homologar diferentes bancos fica muito reduzido!

*Neste link você tem acesso à listagem completa de campos disponíveis para montar seu boleto.

Vale lembrar que quando você integra pela ocx (componente instalado na máquina), a forma de gerar as informações do boleto é via "arquivo tx2" ; e se você optar por integrar via API, pode gerar as informações do boleto tanto em formato tx2 quanto em formato JSON!

E a partir daqui, esta é a sequencia do fluxo:

✔ 1º - "Inclusão do Boleto": Ou seja, é o momento que você pega o tx2 ou o JSON que seu sistema montou e envia para nossa API (via componente (ocx) ou diretamente via https). Nós recebemos este arquivo e te devolvemos um IdIntegracao, que é um ID único que vai identificar seu boleto em nosso sistema. Esse ID é importante porque para todo o restante do fluxo nós iremos utilizá-lo.

✔ 2º - Consultar o IdIntegracao: É o momento que consultamos o boleto em nosso banco de dados, para sabermos se se ele está com uma das seguintes situações:

✔ 3º - Solicitar a impressão: Nosso processo de impressão em lote (vários IdIntegracao juntos) é assíncrono. Então, aqui você repassa para o componente a lista de idIntegracao (separados por vírgula), e nós te devolvemos o protocolo de impressão, que será consultado logo em seguida;

✔ 3.1 e 3.2 - Imprimir ou Gerar o PDF: Então, usando o protocolo de impressão que acabamos de obter, chamamos os métodos de impressão ou geração do PDF do boleto;

✔ 4º - Gerar a remessa: Ainda usando o IdIntegracao, este método ao ser chamado devolve o conteúdo da remessa (no caso da transmissão manual); ou solicita para nossa API gerar o arquivo de remessa direto para o banco (no caso da transmissão automática);

✔ 5º e 5.1 (Apenas para a transmissão manual): O 5º passo recebe o arquivo de retorno que veio do banco e retorna um protocolo; e o passo 5.1 recebe este protocolo e retorna a lista dos IdIntegracao que foram atualizados com o arquivo de retorno. Também é uma operação assíncrona

E por último: basta consultar os IdIntegracao que voltaram no passo 5.1 ou os IdIntegracao que foram gerados na remessa (passo 4), para saber se os boletos mudaram de situação, de "Emitido" para "Registrado" , ou de "Registrado" para "Liquidado" por exemplo.

Depois que o boleto volta do banco, tanto na forma automática quanto da forma manual, é preciso repetir a consulta (a mesma apresentada no 2º passo desta documentação), para que você consiga identificar qual foi o resultado do processamento bancário de seus boletos.

Como retorno desta consulta, os boletos poderão apresentar também as  seguintes situações:

Para facilitar a compreensão, segue também o modelo com a sequência de fluxos:

Vale lembrar que além destes métodos modelados acima, temos também diversos outros métodos, incluindo:

• Personalização de impressão;
• Notificações via Webhook
• Envio de email único ou em lote;
• Descarte de boletos;
• Notificações automáticas por email e SMS;
• Remessas de Alteração e Baixa;

Restando qualquer dúvida, estamos sempre à disposição!