Processo de emissão de boleto

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 Hiperbanco 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.

⚠️

Importante

Não é possível emitir boletos das 5h25min às 6h05min, pois este é o período de sincronização de nosso sistema com o fornecedor.

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

Durante o processo de emissão do boleto, o Hiperbanco 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 "Pending".

Consulta de status do boleto

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

📘

Nota

Ao consultar o endpoint de Consulta por authenticationCode, os status do boleto retornados serão diferentes, podendo ser:

Processed, Registered, Conciliated, Settled, Cancelled.

Impressão de boleto

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

• Solicitar o boleto do Hiperbanco em formato PDF, por meio do endpoint Impressão de boleto;
• Personalizar seu proprio boleto utilizando as informações retornadas na consulta de boleto por autheticationCode.

⚠️

Importante

Recordamos que, enquanto o boleto não apresentar o status "Registered" / "Pending" (registrado), não será possível efetuar seu pagamento, emitir o PDF ou realizar seu cancelamento. Recomendamos consultar o status do boleto ou aguardar o envio do evento de webhook de registro (BOLETO_WAS_REGISTERED) para dar continuidade ao processo de emissão.