Campos do convênio que valem para todos os bancos
Carteira, padrão CNAB, nosso número, local de pagamento, juros, multa, desconto, protesto e os marcadores das mensagens de instrução: os campos do convênio de cobrança que existem em qualquer banco, o que cada um faz e onde eles aparecem no boleto. Também explica como as credenciais são protegidas e qual e-mail do cliente vai para o banco.
Quando usar
Use ao criar um convênio de cobrança, ao configurar juros e multa por atraso, ou quando tiver dúvida sobre o que um campo do convênio muda no boleto impresso.
Antes de começar
- Conta bancária cadastrada em Financeiro > Contas Bancárias.
- Dados de cobrança combinados com o banco: carteira, código do beneficiário e padrão de arquivo.
Dados de cobrança
São os campos que identificam o acordo de cobrança com o banco. Eles valem para todos os bancos, mesmo quando o convênio não usa integração por API.
| Campo | O que faz |
|---|---|
| Descrição | Nome interno do convênio, para você reconhecê-lo nas listagens. Não sai no boleto. |
| Padrão CNAB | Layout do arquivo de remessa: 240 ou 400, conforme o que o banco aceita. |
| Número da remessa | Sequencial do próximo arquivo de remessa, quando você usa arquivo em vez de API. |
| Próximo nosso número | Sequencial usado quando é o Hap que controla a numeração dos títulos. |
| Variação da carteira | Obrigatório apenas no Banco do Brasil. |
| Local de pagamento | Texto impresso no boleto. O padrão é "Pagável em qualquer banco até o vencimento". |
| Nosso número controlado pelo banco | Marque quando o banco gera a numeração. Recomendado no Sicredi e no Sicoob. |
| Registro WebService? | Liga o roteamento pela API do banco. Desmarcado, o boleto segue pelo caminho antigo. |
| Boleto híbrido | Faz o boleto sair também com QR Code Pix, nos bancos que suportam. |
Juros, multa, desconto e protesto
Esses campos definem o que o banco deve cobrar quando o cliente paga depois do vencimento, e o que fazer com o título vencido. Eles são enviados ao banco junto com o registro e também aparecem impressos no boleto.
| Campo | O que faz |
|---|---|
| Tipo de protesto | Protestar em dias corridos, em dias úteis, não protestar, ou negativar sem protesto. |
| Dias para protesto | Quantos dias depois do vencimento o título vai a protesto. |
| Tipo de juros | Diário, em reais por dia, ou mensal, em percentual. Escolher o tipo errado muda o valor cobrado. |
| Juros | O valor ou o percentual, conforme o tipo escolhido. |
| Tipo de multa | Sem multa, valor fixo em reais, ou percentual sobre o título. |
| Multa | O valor ou o percentual da multa por atraso. |
| Tipo de desconto | Sem desconto, percentual, ou desconto por antecipação. |
| Dias antes do vencimento para desconto | Até quando o desconto vale. Aparece quando o tipo de desconto exige prazo. |
| Mensagens de instrução | Até quatro linhas de texto livre impressas no boleto. Aceitam marcadores, que viram valores do título (veja a seção Marcadores das mensagens de instrução). |
Ao salvar a conta bancária, o Hap confere o protesto de cada convênio ativo (os que vão ao banco na emissão do boleto):
| Configuração | O que acontece ao salvar |
|---|---|
| "Não Protestar" ou tipo em branco | Os dias de protesto são gravados como 0 |
| "Não Protestar" com [dias_protesto] nas instruções | Os dias são mantidos e aparece um aviso: a instrução impressa promete um protesto que o banco não vai fazer |
| Protesto ou negativação sem dias, ou fora da faixa do banco | O cadastro não é salvo. A mensagem diz qual convênio, a faixa aceita e que, para registrar sem protesto, basta escolher "Não Protestar" |
| Caixa, Inter, C6 ou Cora com registro automático | Aviso: esses bancos não recebem o protesto nem a negativação no registro pela API, a instrução só sai impressa |
| Negativação no Itaú, Safra ou Santander com registro automático | Aviso: esses bancos recebem o protesto, mas não a negativação no registro pela API. Para negativar, comande no internet banking |
| Tipo de protesto fora das opções da tela | Nada é alterado. O banco não recebe protesto nem negativação, e a tela avisa |
| Banco | Faixa |
|---|---|
| Sicredi | de 3 a 99 dias |
| Bradesco | de 5 a 99 dias |
| Demais bancos | de 1 a 99 dias |
Marcadores das mensagens de instrução
Nas mensagens de instrução, um marcador entre colchetes é trocado pelo valor do título quando o boleto é registrado no banco e quando ele é impresso. Escreva o marcador exatamente como na tabela, com os colchetes.
| Marcador | O que sai no boleto |
|---|---|
| [valor_juros] | O valor dos juros por dia de atraso |
| [valor_multa] | O valor da multa |
| [valor_desconto] | O valor do desconto |
| [dias_protesto] | Os dias para protesto |
| [notas_fiscais] | As notas da cobrança de várias OS faturadas juntas, por exemplo "NF-e 1810 e NFS-e 538". Fica vazio quando o título não é dessa cobrança |
E-mail do pagador
O Hap envia ao banco o e-mail do cadastro do cliente junto com o registro do boleto. Cada banco aceita um tamanho máximo para esse campo, e o Hap nunca corta o e-mail: um e-mail cortado não chega a ninguém e faz o banco recusar o boleto.
- 1
Vai o primeiro e-mail do cadastro que tenha formato válido e caiba no limite do banco. Com vários e-mails no cadastro (separados por ponto e vírgula ou vírgula), os que não cabem são pulados.
- 2
Se nenhum couber, o boleto é registrado sem e-mail e fica um aviso no log da integração do boleto, sem o endereço.
| Banco | Limite |
|---|---|
| Sicredi | 40 caracteres |
| Inter | 50 caracteres |
| Bradesco | 70 caracteres |
| Safra | 80 caracteres |
| Sicoob, C6 Bank e Cora | 100 caracteres |
Como as credenciais ficam protegidas
Depois de salvos, os segredos não voltam mais para a tela: Client Secret, senha da API, chave de API (x-api-key), Client Secret da API Pix, a chave privada e a senha do certificado. O mesmo vale para o Client Secret e o certificado da aba Extrato da conta. O campo aparece vazio com o aviso "Definido - digite para trocar".
- 1
Para manter o que já está gravado, deixe o campo em branco e salve normalmente. Nada é apagado.
- 2
Para trocar, digite o novo valor no campo e salve.
- 3
Para trocar o certificado, carregue os arquivos novos (.crt e .key) e, se houver, a senha nova.
A senha do certificado é gravada criptografada. Nos registros de integração, tokens, senhas e segredos aparecem mascarados, e o conteúdo completo das chamadas ao banco só aparece para administradores.
Problemas comuns
- O banco recusa o boleto por causa da carteira: a carteira é fornecida pelo banco e alguns exigem um formato exato - o Itaú, por exemplo, exige três dígitos.
- Nosso número repetido: se o Hap controla a numeração e o mesmo convênio é usado em dois lugares, os números podem colidir. Nos bancos que geram o nosso número, prefira deixar o controle com o banco.
- Juros ou multa não saem no boleto: confira o tipo escolhido. Juros diário é um valor em reais por dia; juros mensal é um percentual. Escolher o tipo errado muda completamente o valor cobrado.
- As instruções não aparecem impressas: são até quatro linhas de texto livre e elas só saem se o layout do boleto tiver espaço para elas. Confira em um boleto de teste.
- O Client Secret ou a senha aparecem vazios depois de salvar: é o esperado. O segredo continua gravado e o aviso "Definido - digite para trocar" confirma isso. Só digite se quiser trocar.
- O marcador [notas_fiscais] saiu vazio no boleto: ele só tem conteúdo no boleto da cobrança de várias OS faturadas juntas. Nos outros títulos ele fica em branco - por isso, escreva a frase de um jeito que continue fazendo sentido sem as notas.
- Um marcador saiu escrito no boleto, com os colchetes: confira se ele foi digitado exatamente como na tabela de marcadores, com os colchetes e o sublinhado.
- O boleto foi registrado sem o e-mail do cliente: nenhum e-mail do cadastro do cliente cabe no tamanho que o banco aceita (no Sicredi, 40 caracteres) ou o e-mail está com formato inválido. O Hap não corta o e-mail, porque um e-mail cortado é recusado pelo banco. Cadastre um e-mail que caiba como primeiro e-mail do cliente; o aviso fica registrado no log da integração do boleto.