Boleto Rápido API

 Versão disponível: A partir da 4.12

A função do Boleto Rápido API é permitir que a emissão de boletos de cobrança seja efetuada por meio de uma API, isto é, uma interface de programação de aplicações, padronizada pelo Banco do Brasil, que permite a integração das operações das empresas com os serviços do banco na rotina de emissão de cobranças.

Com o Boleto Rápido API sua empresa poderá utilizar os recursos/serviços a seguir, sem a necessidade de troca de arquivos de remessa e/ou retorno:

• Registro de Boletos: serviço destinado à emissão de boletos de cobrança. A cobrança bancária é uma solução que permite receber valores referentes a bens adquiridos, serviços prestados, por meio da apresentação de boletos de pagamento, emitidos pelo beneficiário ao pagador/devedor.
• Baixa de Boletos: destinado ao cancelamento dos boletos registrados. Poderá ocorrer por meio de solicitação do pagador, cancelamento de nota ou renegociação. As rotinas que envolvem o cancelamento de boletos, serão detalhadas no tópico Cancelamento de um Boleto.  
• Alteração de Boletos: destinada ao registro de instruções para o boleto, tais como alteração de vencimento, descontos, multa, entre outras.
• Retorno dos Boletos: os boletos terão seu retorno obtido de forma automática, sem a necessidade de processar o arquivo retorno. Conforme retorno da API e configurações da conta bancária, a baixa e conciliação dos boletos recebidos poderão ser processados automaticamente.
• Gerar boletos híbridos: emitir boletos que também terão o QR Code para pagamento com Pix. {disponível na versão ≥ 4.13}

A seguir trataremos das configurações para emissão de boletos por meio de API do Banco e demais processos referentes a essa rotina. Clique nos links abaixo para facilitar sua navegação pelos tópicos:

Configurações para Emissão do Boleto Rápido API                      Ocorrências de Remessa

Alterações de Dados do Boleto                                                         Renegociação de Títulos 

Cancelamento de um Boleto 

Configurações para Emissão do Boleto Rápido API

Na tela Contas, aba Boleto(s)/Duplicatas, marque a opção "Boleto Rápido" e selecione o serviço "API do Banco". 

Em seguida, deve-se configurar as credenciais de acesso à API do Banco. Para isso, clique no botão "Configurar Credencias", localizado na seção "Geração da Credencial". Desse modo, será aberto um pop-up para você informar os dados de configuração da API do Banco do Brasil. 

Neste pop-up as informações da conta, como "Banco", "Agência Bancária" e "Conta", são preenchidos automaticamente e desabilitados para edição. Os demais dados deverão ser informados, sendo eles:

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.

Informe no campo "Convênio" o número do convênio estabelecido com o Banco. O tipo de convênio determina como os boletos serão numerados, emitidos e expedidos.

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:

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

No campo "Último boleto" é registrado o número sequencial que foi utilizado para compor o último "Nosso Número" impresso pelo sistema.

Observação: Com a marcação Boleto Rápido ativa e o serviço API do Banco selecionado, os dados referente a "Carteira", "Convênio", "Modalidade" e "Último boleto" não poderão ser editados na aba Intercâmbio Eletrônico de Dados (EDI). Estes poderão ser editados apenas através do botão "Configurar credenciais" da aba Boleto(s)/Duplicatas. 

Na seção "Seção Credenciais da API" deverão ser inseridos os dados de credenciais de acesso à API geradas pelo Banco. Caso você ainda não possua as credenciais, clique no botão "Ajuda" para ser direcionado para o vídeo orientativo: Como criar uma aplicação e conseguir suas credenciais.

Ao clicar em "Gerar Credenciais", você será direcionado para o Portal do Desenvolvedor, para que sejam criadas as credenciais. Se já possuir seus dados de acesso, basta informar o Client ID e o Client Secret nos campos:

• Client ID: É o identificador público e único no protocolo de autorização do Banco.
• Client Secret: É conhecido apenas para sua aplicação e o servidor de autorização.

Inserida todas as informações, clique em "Salvar" para concluir a configuração e validação dos dados informados. Caso seja concluída com sucesso será emitida a mensagem:

"As chaves inseridas já foram testadas e a integração com a API do Banco do Brasil foi concluída."

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, reveja as informações inseridas e realize uma nova tentativa.

Retornando a aba Boleto(s)/Duplicatas, na seção "Ações automáticas ao receber o retorno", poderão ser realizadas as seguintes configurações:

Ao ativar a marcação "Baixar o título quando o boleto for pago?", quando for identificada a liquidação do título, através do retorno obtido pela API do Banco, o título em questão terá sua baixa realizada.

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.

No campo "TOP Baixa boleto" informe uma TOP de lançamento ao título. Se esse campo estiver vazio na tela Conta, a TOP de baixa seguirá a configuração realizada no parâmetro "TOP de baixa para recebimentos - RCBTOPBAIXA".

Se a marcação "Conciliar a baixa do título ao receber o crédito?" estiver ligada, a movimentação bancária gerada a partir do recebimento do título, será gravada já com o campo "Conciliado" igual a "Sim", na tela Conciliação Bancária, impactando automaticamente tanto o saldo Real quanto o saldo Bancário da Conta envolvida. Caso esteja desligada, a conciliação bancária não será feita automaticamente, sendo necessário realizar o processo de conciliação já praticado hoje.

Nota: Você poderá verificar se o boleto foi baixado e conciliado automaticamente pela API do Banco do Brasil, por meio do campo "Histórico", localizado na aba Lançamento da tela Movimentação financeira. Assim, quando um boleto for baixado automaticamente, neste campo será incluída a seguinte descrição:

"Baixado automaticamente pela API do Banco do Brasil".

Caso esse boleto seja baixado e conciliado automaticamente, no mesmo campo será atribuída a seguinte mensagem:

"Baixado e conciliado automaticamente pela API do Banco do Brasil".

Com todas essas configurações, a conta estará configurada e apta para emitir boletos de cobrança por meio da API do Banco. Eliminando a necessidade de transferência de arquivos de remessa e retorno.

Importante: Caso você altere a conta configurada para emissão de boletos "API do Banco" para outro tipo de emissão, como "Boleto Avançado/Duplicatas", "Pix CNAB", "Pix Cobrança API", a credencial será inativada e o retorno dos boletos não serão realizados de forma automática.

Seção Configurações do boleto

Esta seção será apresentada na aba Boleto(s)/Duplicatas, quando a opção "API do Banco" estiver selecionada. Nela, pode-se realizar as seguintes configurações:

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.

Por meio do campo "Aceita título vencido?" indique se o boleto poderá ou não ser pago após o vencimento. Temos as seguintes alternativas:

• Sim: esta opção em conjunto com o campo "Dias limite de recebimento", definirá a quantidade de dias corridos após o vencimento que este boleto ficará disponível para pagamento. Ressaltamos que, se o campo Dias limite de recebimento for informado com o valor zero ou não for preenchido, será assumida a informação de limite de recebimento parametrizada no convênio.
• Não: ao selecionar esta opção, não será permitido o pagamento do boleto após a data de vencimento.

[voltar ao topo]

Ocorrências de Remessa

Quando uma nova conta bancária for configurada para emissão de boletos com API do Banco, será inserida automaticamente as ocorrências de remessa e a conta bancária configurada, além dos campos abaixo que serão monitorados:

• Abatimento
• Vlr Desconto
• Dt Vencimento
• Vlr Multa
• Vlr Juros

Caso seja necessário inserir novos campos para serem monitorados, você deverá seguir os passos de inserir novas ocorrências, conforme descrito no artigo Ocorrências de Remessa

[voltar ao topo]

Alterações de Dados do Boleto

Todas as alterações que são permitidas no boleto registrado, serão enviadas automaticamente para o Banco por meio da API. Não há necessidade de enviar arquivo de remessa para alterações.

Observação: Não é permitido a alteração do Vlr. do Desdobramento (tela Movimentação financeira, aba Lançamento) quando o boleto for emitido por uma conta bancária configurada com API do Banco (Banco do Brasil). Caso necessário, renegocie o título.

[voltar ao topo]

Renegociação de Títulos 

Ao realizar a Renegociação de Títulos que possuam boletos registrados com API do Banco e confirmar a renegociação, o(s) título(s) originais serão cancelados e novos serão emitidos. Dessa forma, será enviada uma instrução automaticamente para API do Banco cancelar os boletos e uma nova instrução para gerar o(s) novo(s) título(s) também será encaminhada para a API do Banco.

Observação: Na renegociação será utilizada a "Conta" informada no parâmetro "Conta Padrão para Financeiro - CONTAPADRAOFIN". Se não houver conta informada neste parâmetro, será usada a conta referente ao primeiro financeiro escolhido.

[voltar ao topo]

Cancelamento de um Boleto

Pode-se realizar o cancelamento de um boleto do Banco do Brasil que tenha sido emitido por uma conta configurada com API do Banco, de duas maneiras:

Por meio da tela Movimentação Financeira, acione no Painel de Filtros as marcações "Receita", "Real" e "Pendente", em seguida, selecione o registro desejado e acione o botão "Excluir". Desse modo, será apresentado o aviso:

"Você deseja realmente excluir o registro selecionado? Isso não pode ser desfeito."

Clicando em "Sim", será realizada a exclusão do registro e do boleto vinculado a ele.

Através do Portal de Vendas, você deve selecionar a nota já confirmada e acionar o botão "Cancelar Nota". Ao confirmar a exclusão será apresentado um pop-up para que seja informada a "Justificativa" do cancelamento. Feito isso, a nota será cancelada. 

Boletos que tenham sido emitidos com a conta configurada com API do Banco, terão seus cancelamentos enviados automaticamente. Ao excluir um título na Movimentação Financeira ou através de um cancelamento da Nota, será enviado automaticamente uma instrução de cancelamento do boleto para API.

[voltar ao topo]