Processo de emissão de boleto

A API de boletos permite a emissão de boletos de depósito (deposit) e cobrança (levy).

Características dos boletos

No boleto de depósito (deposit), o beneficiário final é o pagador do boleto, portanto, não há necessidade de preencher as informações a respeito do pagador.

Já no boleto de cobrança (levy), as informações do pagador são obrigatórias e, quando impressos, ficam no rodapé do documento.

Limite de emissão

O parceiro poderá entrar em contato com o time Bankly para definir um limite para a emissão de boletos.

Juros e multas

O boleto de cobrança (levy) possibilita a aplicação de juros e multas caso o pagamento seja realizado após a data de vencimento estipulada. A decisão de aplicar ou não essas penalidades fica a critério do parceiro no momento da emissão do boleto.

Descontos

O boleto de cobrança também possibilita oferecer descontos a pagadores que efetuem o pagamento do título em até um dia antes de sua data de vencimento (considerando apenas dias úteis).

🚧

Importante

O desconto não pode ser aplicado à data de vencimento do boleto.

Solicitação da emissão de boletos

Para solicitar a emissão de um boleto, deve-se utilizar o endpoint de emissão de boleto.

Verificações internas para a emissão de boletos

Durante o processo de emissão do boleto, o Bankly realiza algumas verificações em background:

• Verificação do status da conta do beneficiário final;
• Busca dos dados do Customer/Company (dados cadastrais da PF ou PJ);
• Validação de antifraude;
• Consulta dos limites, que verifica a quantidade de emissões de boletos permitida para o período e o valor mínimo e máximo dos boletos.

📘

Nota

Após a solicitação ter sido aceita, a requisição retornará o identificador único do boleto (authenticationCode), porém, é importante destacar que, neste ponto, o boleto ainda não foi registrado.

Assim que o boleto for registrado, informaremos por meio do evento de webhook (BOLETO_WAS_REGISTERED), e o status do boleto será alterado para "Registered".

Consulta de status do boleto

Para que um boleto possa ser gerado, ele deve apresentar o status "Registered".

Utilize o endpoint de consulta por authenticationCode para realizar a consulta de status do boleto.

Impressão de boleto

Após o registro do boleto, com o authenticationCode em mãos, o parceiro poderá:

• Solicitar o boleto do Bankly, em formato PDF, por meio do endpoint Impressão de boleto;
• Personalizar seu próprio boleto utilizando as informações retornadas na consulta de boleto por autheticationCode para a geração do código de barras.

Diagrama de sequência

Conheça o comportamento do sistema e os endpoints envolvidos no fluxo de emissão de boleto.

Para uma melhor experiência na visualização do diagrama:

1. Clique em "see the board";
2. Em seguida, clique no título "Diagrama de sequência - Boleto 2.0", para que a imagem abra em outra janela;
3. Utilize os símbolos de + e - para ampliar e reduzir o tamanho da imagem;
4. Dê um clique em uma parte da imagem e arraste-a, para navegar pelo diagrama.