Boleto Rápido por API Banco do Brasil

Este é o passo a passo de como credenciar uma conta do Banco do Brasil no Boleto rápido. 

Caso não tenha gerado suas credenciais, acesse o link Como obter credenciais - API Banco do Brasil? para instruções detalhadas sobre como criar suas credenciais de acesso.

Configurações iniciais

Na tela Contas, escolha a conta que deverá se tornar API, em seguida, na aba Boleto(s)/Duplicatas habilite a marcação "Boleto Rápido" e selecione o serviço "API do Banco". Clique no botão "Configurar Credencias" e será aberto um pop-up com uma jornada de credenciamento. 

O credenciamento do Boleto Rápido é composto por três etapas:

Modalidade do serviço

Para escolher a Modalidade do serviço, selecione o "Boleto simples" ou o "Boleto híbrido", que é o boleto tradicional, acrescido de um QRCode para pagamento por PIX.

Importante: para aderir ao Boleto híbrido é preciso abrir uma chave pix junto à instituição bancária e preparar o seu atual modelo de boleto para receber o QR Code.

Em seguida, clique em "Avançar" para dá o aceite aos termos e condições de uso do Boleto rápido.

É muito importante ler os termos e condições de uso, disponíveis no link do pop-up, para ciência dos custos e obrigações legais ao habilitar a funcionalidade. Após a leitura, é obrigatório confirmar que está de acordo com as informações apresentadas. Esta é a assinatura oficial da contratação do serviço Boleto Rápido:

Configuração de cobrança

Defina as regras de permanência do boleto após o vencimento, negativação ou protesto e insira as configurações de juros e multa. 

Configurar ações após o vencimento do título:

• Na sub-aba "Geral", o campo "Aceita título vencido?" indica se o boleto permanecerá ativo no banco após o vencimento. Se a opção "Não aceitar pagamento de títulos vencidos" for selecionada, os boletos serão automaticamente baixados após o vencimento, e as funcionalidades de protesto e negativação não poderão ser configuradas.
• Na seção "Negativação", especifique se o boleto será negativado após o vencimento. Caso opte pela negativação, informe o número de dias corridos após o vencimento no campo "Dias para negativação" para que a negativação ocorra automaticamente. No campo "Órgão Negativador", escolha entre as opções "Serasa" ou "Quod".
• No campo "Dias para protesto", defina se o boleto será protestado após o vencimento. Em caso afirmativo, especifique o número de dias para protesto: de 3 a 5 dias para dias úteis, ou 6 a 29, 35, 40 ou 45 dias para considerar dias corridos.

Nota: para as contas do Banco do Brasil não é possível negativar e protestar o título ao mesmo tempo.

Configurar juros:

• Dispensar a cobrança de juros: ao selecionar essa opção não será atribuído juros no boleto.
• Isentar a cobrança de juros: com essa opção, será isento a cobrança de juros. 
• Definir uma taxa mensal (em porcentagem): ao informar essa opção, no registro do boleto será considerado um percentual para cobrança de juros.
• Definir um valor (R$) fixo por dia: com essa opção indicada, será enviado no registro do boleto um valor fixo (em reais) por dia de atraso para cobrança de juros.

Com a opção Definir uma taxa mensal (em porcentagem) ativada, o campo "Valor percentual" será habilitado. Nele, informe o valor ou o percentual de juros. Por exemplo, caso seja informado 1%, será cobrado uma taxa de juros de 1% (em relação ao valor do título) ao mês.

Ao selecionar a opção Definir um valor (R$) fixo por dia, o campo "Valor em reais" será habilitado. Nele, informe o valor em reais que será cobrado por dia. Por exemplo, caso seja informado R$1,00, será cobrado uma taxa de juros de um real por dia, independente do valor do título.

Configurar multa:

Configure também os "Tipos de Multa", conforme as alternativas a seguir:

• Dispensar a cobrança de multa: ao selecionar essa opção não será atribuído multa no boleto.
• Definir um percentual em relação ao valor do título: nessa opção, ao registrar o boleto será definido uma porcentagem de multa sobre o valor do título.
• Definir um valor (R$) fixo: indicando essa opção, será definido um valor fixo para cobrança de multa.

Com a opção Definir uma taxa mensal (em porcentagem) selecionada, o campo Valor percentual será habilitado. Nele, informe o valor ou o percentual de juros. Por exemplo, caso seja informado 10%, será cobrado um valor relativo a 10% do valor do título como taxa de multa.

Com a opção Definir um valor (R$) fixo por dia definida, o campo Valor em reais será habilitado. Nele, informe o valor em reais que será cobrado por dia. Por exemplo, caso seja informado R$10,00, será cobrado uma taxa de multa de dez reais, independente do valor do título.

Defina no campo "Data da Multa" a partir de qual data será cobrada a multa, dentre as seguintes alternativas:

• Usar data de vencimento: ao selecionar essa opção, será considerada a data de vencimento para cobrança de multa.
• Configurar quantidade de dias: com essa opção, será possível configurar uma quantidade de dias considerando a data de vencimento como base para cobrança de multa. Por exemplo, caso seja informado 5 dias no campo, será usada a data de Vencimento + 5, ou seja, a multa será cobrada 5 dias a partir da data do vencimento.

Se for selecionada a opção Configurar quantidade de dias, o campo "Dias para multa", deverá ser preenchido com um valor maior que zero e que não seja negativo.

Observação: é obrigatório preenchimento de todos os campos que forem habilitados. 

Ao concluir o credenciamento, os tópicos configurados corretamente serão marcados como finalizados, permitindo o avanço para a próxima etapa.

Credenciamento de Conta 

Forneça os dados da conta, como convênio, carteira e modalidade, além das credenciais geradas no portal Developers da instituição bancária correspondente.

No campo "Carteira" informe o número da carteira do convênio de cobrança.

Preencha o campo "Variação" com o número da variação da carteira do convênio de cobrança. Pode-se informar um valor com até 3 dígitos.

Informe no campo "Convênio" o número do convênio estabelecido com o Banco.

É importante configurar um número de Convênio distinto para cada conta bancária. Caso seja informado um número de Convênio já utilizado em outra conta configurada com a API do Banco, será apresentada a mensagem:

"O Convênio informado [xxxx] já está sendo usado para outra conta bancária."

Por meio do campo "Modalidade", será identificada a característica dos boletos dentro das modalidades de cobrança existentes no Banco. Este campo poderá ser definido com uma das seguintes alternativas:

• Simples: para a cobrança de duplicatas, notas promissórias, recibos e outros documentos;
• Vinculada: para a cobrança de duplicatas entregues ao Banco em garantia de operação de crédito ou como mecanismo de auto liquidez.

Nota: segundo as regras de negócio do Banco do Brasil, para a conta do tipo Vinculada, os boletos são dados como garantia ao banco e, por isso, não será permitido realizar alterações e cancelamento via API após sua emissão. Para estes processos, o banco direciona que sejam feitos diretamente pelo Internet Banking.

Com as credenciais geradas em mãos, informe o "Client ID" e "Client Secret".  

Clique em "Credenciar" para concluir a configuração e validação dos dados informados. Caso seja concluída com sucesso, o sistema exibirá uma mensagem confirmando a conclusão.

 Caso seja encontrado algum dado incorreto, será apresentada a mensagem:

"As credenciais inseridas apresentaram erro no teste de integração. Por favor, tente novamente."

Nesse caso, corrija as informações inseridas e realize uma nova tentativa. 

Configurações de ações automáticas

Na aba Boleto(s)/Duplicatas, na seção "Ações automáticas ao receber o retorno", com o serviço API do Banco selecionado, poderão ser realizadas as seguintes configurações abaixo:

Baixa Automática

Defina a "Baixa automática" conforme as alternativas: 

• Não realizar;
• Realizar na data de pagamento;
• Realizar na data do crédito em conta.

Caso a opção seja diferente de Não realizar, a baixa automática será feita via API.

Pode-se verificar se o boleto foi baixado e conciliado automaticamente por meio dos campos:

• Histórico: localizado na aba Lançamento da tela Movimentação financeira para versões menores que 4.23;
• Baixa por API: deverá ser ativado por meio da opção de configurações de formulário para versões 4.24 ou maiores.

Quando um boleto for baixado automaticamente, o campo receberá a seguinte descrição:

"Baixado automaticamente pela API do Banco."

Caso falte alguma configuração que impeça a API de realizar a baixa automática, aparecerá no Histórico do título na Movimentação Financeira:

"Não foi possível realizar a baixa automática. Verifique triggers e processos de baixa."

Já o campo Baixa por API trará o tipo de erro que impediu a realização da baixa.

Lançamento Baixa Boleto

O campo "Lançamento baixa boleto" refere-se ao tipo de lançamento bancário. Se esse campo estiver vazio na tela Conta, o código de lançamento bancário a ser utilizado será aquele especificado no campo "Lançamento bancário receitas", na aba Propriedades, das Preferências da Empresa.

TOP Baixa Boleto

No campo "TOP Baixa boleto" informe uma TOP de lançamento ao título. Lembre-se que, esse campo deve ser preenchido para que a baixa automática seja efetuada.

Conciliação Automática

O campo "Conciliação automática" pode ser configurado apenas quando o campo Baixa Automática não estiver com a opção "Não realizar" selecionada. Nele, defina a forma da Conciliação Automática, conforme as opções: 

• Não realizar;
• Realizar na data de pagamento;
• Realizar na data do crédito em conta.

Aba Impressão

Por meio do campo "Modelo Cobrança" busque e selecione o modelo de boleto cadastrado na tela Modelos de Nota Fiscal/Duplicatas/Boletos.

Informe a "Impressora" que será utilizada para impressão do boleto.

Determine o "Tipo Impressora" para emissão do documento.

[voltar ao topo]