Integração API Banco do Brasil

APIs de Recebimento Banco do Brasil

Documentação para utilização das APIs de Cobrança do Banco do Brasil para permitir realizar envio e retorno de remessas bancárias sem utilizar a troca de arquivos, além da emissão de Bolecode e QRCode.

Bolecode

O bolecode é o meio de cobrança que utiliza as funcionalidades do recebimento por PIX e por Boleto no mesmo documento de pagamento.

O pagamento por QRCode é identificado de forma imediata pelo Banco do Brasil. Quando ocorre o pagamento por código de barras, o QRCode ficará indisponível.

Pix

O pagamento do QRCode é identificado de forma imediata pelo Banco do Brasil. A movimentação da conta ocorrerá no mesmo momento.

Credenciais

Será necessário solicitar ao gerente da conta no Banco do Brasil acompanhamento no processo de homologação nos ambientes de Produção/Homologação.

[Homologação] Sandbox

No portal do Banco do Brasil, deverá ser criado um cadastro para o cliente para ter acesso as informações das credenciais de homologação/produção.

 Acesse o Portal do Banco do Brasil: https://www.bb.com.br/site/developers/

Selecione a opção de CRIAR NOVA APLICAÇÃO;

• Informe um nome para aplicação. Ex: Tek-System-Homologação. Tek-System-Produção;
• Utilização do ícone da aplicação a logo da empresa;
• Selecione as APIs contratadas. Para funcionamento completo do sistema: Cobranças; Pix; Extratos;
• Finalize clicando em CRIAR.

Volte a tela principal do portal de desenvolvedor do Banco do brasil e entre na aplicação criada. Procure pela opção de Credenciais, será possível identificar os tokens utilizados para API.

Sandbox

• developer_application_key
• client_id
• client_secret
• Token: utilize a opção de COPIAR BASI

[Produção] API BB para Pix Recebimentos, Cobrança(Boletos) e Conta Corrente (Extrato)

Certifique-se de que todos os cenários foram testados em homologação. Somente clientes do BB podem gerar credenciais de produção.

 Acesse o Portal do Banco do Brasil: https://www.bb.com.br/site/developers/

Selecione a aplicação que deseja enviar para Produção;

• Procure pela opção ENVIAR PARA PRODUÇÃO;
• Insira o CNPJ da sua empresa e clique em Pesquisar CNPJ. O sistema irá exibir os detalhes da empresa selecionada. Verifique que todas as informações estejam corretas e, clique em Próximo;
• Revise os dados de sua aplicação, e clique no botão "Solicitar produção";
• A aplicação ficará em estado Aguardando aprovação e será gerada uma pendência de confirmação;
• Para resolver a pendencia no Banco do Brasil, verifique a documentação: https://apoio.developers.bb.com.br/referency/post/663534f889ca2300139cc2cc

Produção

• developer_application_key
• client_id
• client_secret
• Token: utilize a opção de COPIAR BASI

Certificado Digital

Além das credenciais, será necessário a utilização de certificado digital.

As APIs do Banco do Brasil cujo fluxo de autenticação é client credentials, utilizam certificados digitais garantindo mais proteção à comunicação, autenticação e integridade na utilização dos serviços. Quando um certificado é assinado 
por uma autoridade de certificação confiável, quem possuir o certificado pode contar com a chave pública que ele contém para estabelecer uma comunicação segura com a outra parte. O padrão internacional x.509 provê a especificação para 
certificados de chave pública e proporciona uma solução de segurança mais completa, assegurando a identidade de todas as partes envolvidas em uma integração.

Verifique os passos para geração e configuração do certificado digital no Portal do Banco do Brasil para ambiente de Produção: https://apoio.developers.bb.com.br/referency/post/670eaa39646e2900126b6bdc

Configurações do Sistema

Necessário solicitar liberação da funcionalidade licenciada ao setor responsável: INTEGRACAO_API_BRASIL

Cadastro da Conta Corrente

Incluir ou alterar cadastro da conta corrente que será utilizada para integração com o Banco do Brasil.

Preencher os dados:

Registro/Endereço: CNPJ/CEI, Inscrição Estadual e Endereço Completo;

Informações Bancárias: Banco, Agência, Conta e Digito Conta, Titular, Documento Titular, Sacador Avalista e Documento do Sacador Avalista(Pode ser mesmos dados do Titular da Conta);

Padrões da Remessa:

• Descrição

• Carteira

• Descrição da Carteira (SIMP = Simples; VINC = Vinculada)

• Variação

• Convênio

• Lay-Out Remessa

• Lay-Out Impressão de Boleto

• Próximo Slip

Chave Pix: Utilize uma chave do tipo aleatória;

Atenção aos campos:

Layout Config Remessa: Utilizar layout padrão BRASIL: INTEGRAÇÃO COM API – REMESSA;

Configuração de Tags de Títulos

Durante instalação ou processamento da remessa bancária serão incluídas as Tags de Títulos para utilização de atencipação de descontos. Por padrão, as tags serão configuradas para não atribuir descontos aos boletos e pix com vencimentos.

O sistema irá considerar o valor padrão das tags para envio das remessas de Boletos e Pix. Caso o cliente queira utilizar o valor diferente, poderá incluir a tag na duplicata, e ajustar o valor que desejar.

Os dias de descontos serão acrescidos a data de registro dos boletos/pix no banco. A data de desconto não poderá ser maior que a data de vencimento. Caso aconteça, o desconto não será considerado.

BRASIL: Modalidade de Desconto Boleto/Pix

Configurações para Pix

• 0 - Sem desconto;
• 1 - Valor Fixo até a[s] data[s] informada[s];
• 2 - Percentual até a data informada;
• 3 - Valor por antecipação dia corrido;
• 4 - Valor por antecipação dia útil;
• 5 - Percentual por antecipação dia corrido;
• 6 - Percentual por antecipação dia útil;

Configurações para Boleto

• 0 - Quando não houver condição de desconto;
• 1 - Valor Fixo até a data informada;
• 2 - Percentual até a data informada;
• 3 - Desconto por dia de antecipação;

BRASIL: Nº Dias de Antecipação p/ concessão de desconto (1) (2) (3)

Indicar o número de dias que será considerado para desconto de antecipação de recebimentos. Exemplo, se informado 15 dias na tag (1), será dado desconto ao cliente se pagar o título em até 15 dias. Possibilidade de indicar três opções de dias para desconto.

BRASIL: Taxa/Valor de Desconto por Antecipação (1) (2) (3)

Indicar o valor, percentual ou fixo, considerado para desconto de antecipação de recebimentos. Possibilidade de indicar três opções de valores para desconto.

Configuração do Certificado Digital

Após ter gerado os certificados no formato PEM, será necessário realizar a importação dos arquivos no cadastro da Conta. Acesse o módulo financeiro, cadastro da conta, entre na opção do botão Outros, selecione a opção Arquivos em Anexo.

Adote os nomes:

Descrição do arquivo: CERT_BOLETO
Nome do Arquivo: CertificadoCob.pem
Descrição do arquivo: CERT_PIX
Nome do Arquivo: CertificadoPix.pem
Descrição do arquivo: CERT_CONTACORRENTE
Nome do Arquivo: CertificadoContaCorrente.pem
Descrição do arquivo: CERT_GERAL
Nome do Arquivo: CertificadoGeral.pem

Poderá ser utilizado apenas um certificado digital, neste cenário utilize apenas CERT_GERAL.

Configurações da Unidade de Codificação

Incluir na TekStore da conta do Suporte a unidade de codificação correspondente as configurações que serão utilizadas para Api do Banco do Brasil. Seguir padrão JSON já conhecido para as demais integrações.

Nome da Unit deverá ser P10_INTEGRACAO_API_BRASIL_CONFIGURACAO. Onde 9999 corresponde ao código do cliente cadastrado na Tek-System.

Exemplo de configuração:

[
	{
		"contaBancaria": 0,
		"ambiente": "HOMOLOGACAO",
		"_comentario_": "Conta 0 - Usada em Requisições sem Autenticação - Não remover - É necessária!"
	},
	{
		"contaBancaria": 25,
		"_comentario_": "Testes",
		"ambiente": "HOMOLOGACAO",
		"clientIdSandbox": "",
		"clientSecretSandbox": "",
		"developerApplicationKeySandbox": "",
		"tokenSandbox": "",
		"clientIdProducao": "",
		"autoIncChavePix": 0,
		"autoIncPadraoRemessa": 0,
		"protestar": 0,
		"quantidadeDiasProtesto": 0,
		"negativar": 0,
		"quantidadeDiasNegativacao": 0,
		"indicadorAceiteTituloVencido": "S",
		"numeroDiasLimiteRecebimento": 30,
		"diasAposVencimentoParaBaixarPIXAgendado": 30,
		"codigoAceite": "N",
		"codigoTipoTitulo": 1,
		"mensagem1": "",
		"mensagem2": "",
		"mensagem3": "",
		"mensagemPix": "",
		"tipoCobrancaMulta": 2,
		"vlrTxMulta": 2.0,
		"indicadorPix": "S",
		"tokenWebhookTekSystem": "",
		"urlWebhook": "https://tekhook.teksystem.com.br:8080/hook/[token]"
	}
]

Descrição dos campos:

contaBancaria: Código da conta corrente do Banco do Brasil cadastrada no sistema Tek-System;

ambiente: Informar qual ambiente a conta está sendo utilizada. PRODUCAO/ HOMOLOGACAO;

clientIdSandbox: Client id que será utilizado em ambiente Sandbox;

clientSecretSandbox: Client Secret que será utilizado em ambiente Sandbox;

developerApplicationKeySandbox: Token de Desenvolvedor que será utilizado em ambiente Sandbox;

clientIdProducao: Client id que será utilizado em ambiente Produção;

tokenSandbox: Token que será utilizado em ambiente Sandbox;

autoIncChavePix: Corresponde a sequência de cadastro da chave Pix na conta correte. Campo de sequência por padrão fica oculto no cadastro, deverá utilizar opção para mostrar os campos para verificar a sequência correta a ser utilizada;

autoIncPadraoRemessa: Corresponde a sequência do cadastro de padrão da remessa da conta corrente.

codigoTipoTitulo: Indica o tipo de título que será enviado na remessa bancária. Utilizar 2-Duplicata Mercantil;

protestar: O protesto é a ação através da qual o portador de um título comercial cujo pagamento não foi efetuado dentro do prazo, garante seu pagamento por ações judiciais:

0 - Protestar

1 - Não Protestar

quantidadeDiasProtesto: Indica quantidade de dias após vencimento para protesto do título.

negativar: A negativação é o ato de inserir uma pessoa em cadastros de maus pagadores, tais como Serasa, porque não pagou uma conta, uma prestação ou outra obrigação financeira:

0 - Negativar

1 - Não Negativar

quantidadeDiasNegativacao: Indica quantidade de dias após vencimento para negativação do título.

indicadorAceiteTituloVencido: Indicador de que o boleto pode ou não ser recebido após o vencimento.

numeroDiasLimiteRecebimento: Quantidade de dias corridos que este boleto ficará disponível para pagamento após seu vencimento.

diasAposVencimentoParaBaixarPIXAgendado: Quantidade de dias corridos após o vencimento em que a cobrança poderá ser paga. Caso vencido este período e a cobrança não tenha sido paga, esta continuará ATIVA.

codigoAceite: Código para identificar se o boleto de cobrança foi aceito (reconhecimento da dívida pelo Pagador).

indicadorPix: Código para informar se o boleto terá um QRCode Pix atrelado. Se informado caracter inválido, assumirá 'N':

S - QRCode Dinâmico;

N - Sem PIX;

OUTRO - Sem Pix.

tipoCobrancaMulta: Indica o tipo de cobrança da multa. Podendo ser as opções:

0 - Sem multa;

1 - Valor fixo de multa após o vencimento;

2 - Percentual de multa após o vencimento.

taxaMulta: Informar percentual para valor de multa. Ex: 02.00;

mensagem1: Mensagem 1 individual a ser impressa no boleto (Limite 55 caracteres). Utilize <j> para trocar por taxa de juros e para <m> trocar taxa multa.

mensagem2: Mensagem 2 individual a ser impressa no boleto (Limite 55 caracteres). Utilize <j> para trocar por taxa de juros e para <m> trocar taxa multa.

mensagem3: Mensagem 3 individual a ser impressa no boleto (Limite 55 caracteres). Utilize <j> para trocar por taxa de juros e para <m> trocar taxa multa.

tokenWebhookTekSystem: token da configuração do cliente cadastrada na TekHook.

urlWebhook: Url de callback que foi utilizada para registro no Banco do Brasil. Gerado através da TekHook. Será utilizada para receber notificações de recebimento dos boletos e processamento de indicadores.

Funcionalidades

 Antes de prosseguir, verifique se os processamentos específicos, indicadores e relatórios específicos foram liberados para o usuário responsável pela utilização da API.

Remessa Bancária

Gerar Remessa Bancária

Incluir remessa bancária dos títulos para gerar boletos/pix

Os títulos não podem possuir informações de boletos/pix já gerados. Estes campos são preenchidos pelo sistema após processar a remessa.

Na aba de Totalização/Outras, em Geração, deverá ser informado o layout BRASIL: INTEGRAÇÃO COM API – REMESSA.

Campo de instrução deverá ser informado BOLETO(GERAR BOLETO HÍBRIDO) ou PIX(GERAR PIX AGENDADO). As demais opções ainda não estão disponíveis para utilização.

Clique no botão Processar: O Sistema realizará a transmissão dos títulos para API do Banco do Brasil.

Após finalizar o processo, será possível verificar a situação dos títulos no banco através dos Processamentos acessíveis na grade da guia Duplicatas do cadastro da Remessa ou na grade de duplicatas do cadastro de contas a receber (Menu Manutenção >> Contas a Receber).

Impressão dos Boletos

Para abrir a tela de impressão de boletos o usuário poderá selecionar o processamento específico "[TEK] BRASIL: Gerar impressão dos boletos do Borderô de Remessa" através da grade de Duplicatas no borderô de remessa bancária.

Ao executar o processamento, será aberto a tela de impressão de boletos padrão do sistema. Será preenchido alguns campos de acordo com as informações da remessa bancária.

• Conta Corrente e Padrão da Remessa: Conta e padrão utilizado na remessa bancária;
• Data de Emissão Inicial e Final: Menor data de emissão e maior data de emissão dos títulos selecionados na remessa bancária;
• Quanto ao Slip(Código de Barras): Como o processamento da remessa já preencheu os Slips, nesta etapa o usuário deve selecionar no campo 'Quanto ao Slip' a opção 'Apenas boletos com Slip'.

O processamento facilita a definição dos filtros da tela de emissão de boletos, porém o usuário é responsável por confirmar os títulos filtrados.

Exemplo do boleto impresso através do sistema.

Retorno Bancário

Para incluir o retorno bancário processado via API, acesse no Módulo Financeiro o menu Integração >> Banco >> Retorno Bancário. Preencha as informações de conta e layout do arquivo.

Ao clicar no botão 'Carregar', será informada a data do dia anterior para executar a consulta. A sugestão é que seja processada a consulta referente a movimentação do dia anterior para capturar todas as informações registradas na data informada. Por isto o sistema sugere como Data o dia anterior, mas o usuário pode modificar a informação.

Após executar o processamento, será salvo o arquivo.json com as informações das movimentações encontradas.

Clique no botão Interpretar para realizar a identificação dos títulos liquidados via QRCODE e/ou CHAVE PIX.
Clique no botão Gravar para aplicar as baixas identificadas.

As informações de pagamento do bolecode, seja por QRCode ou Código de Barras, podem ser visualizadas no arquivo de retorno de remessa disponibilizado diariamente pelo banco. Quando o bolecode é pago por QRCode, a instrução de liquidação será a 10 - BAIXA POR TER SIDO LIQUIDADO.

Os por QRCode já ficam disponíveis no momento para inclusão no retorno bancário.
Os títulos pagos por código de barras ficarão disponíveis seguindo as regras do boleto (Ex: D + 1).

Ao emitir os relatórios de movimentação da conta disponíveis na plataforma do Banco do Brasil, o usuário deverá ficar atento, pois as movimentações referentes ao boleto influenciam no Pix, e as movimentações do Pix influenciam no Boleto

Exemplo:
Ao pagar o boleto pela linha digitável, o pix correspondente ao boleto será cancelado;
Ao pagar o boleto pelo QRCODE (PIX), o boleto será cancelado.

Retorno de Boletos

Na movimentação do Bolecode, serão informados o Código da Barras, Linha Digitável e a URL QRCode PIX.

Retorno de Pix

Na movimentação do Pix, será informado apenas a URL QRCode Pix.

Borderô de Recebimento

Realizar o recebimento de um complemento de borderô através do QRCode do Pix.

Processamentos específicos disponíveis:
*[TEK] BRASIL: Recebimento por Pix: Processamento específico para gerar Pix para recebimento.
*[TEK] BRASIL: Cancelar/Estornar Pix: Processamento específico para cancelar o Pix gerado. Se o Pix já foi pago, será realizado o estorno do valor recebido.
*[TEK] BRASIL: Verificar Situação do Pix Imediato: Processamento específico para consultar a situação do Pix e atribuir Confirmação ou Cancelamento do Pagamento.

Recebimento através do Pix

Selecione no bordero de recebimento a duplicata que será paga. Gere um complemento no valor do Pix. Clique no complemento e acesse o processamento específico para recebimento do Pix.

O Pix somente será criado se o borderô estiver gravado, a data do acerto for igual a do dia atual e o horário for inferior às 23:40.

Ao clicar no processamento específico para Recebimento por Pix, será criado o Pix no Banco do Brasil e exibido o QRCode e o QRCode Data para pagamento no estilo cópia e cola, possibilitando ao usuário enviar via WhatsApp.

Além disso, serão preenchidos os dados do Pix no registro complementar.

Após pagamento ou cancelamento, será informado no registro de complemento a confirmação ou cancelamento da operação.

Após finalizar operação, não será possível alterar informação do complemento no borderô.

Quando o Pix for gerado e estiver aguardando confirmação ou com a confirmação de pagamento realizada, será gerado movimento de entrada no caixa. Pix com pagamento confirmado, o movimento no caixa é gerado como realizado. Quando o Pix estiver expirado ou cancelado, será gerado movimento de saída no caixa. Pix com pagamento confirmado e cancelado, o movimento no caixa é gerado como realizado.

Relatório Específico

Relatório para listagem do Extrato bancário através da API com Banco do Brasil

Ao executar o relatório serão exibidos os filtros:

Filtros:

• Conta: filtro importante para identificar qual conta será buscado as informações;
• Data Inicial e Final: período referente aos movimentos;
• Tipo de Movimento: Todos, Crédito e Débito.
• Compactação: analítico ou sintético.
• Quebras: filtro opcional para apresentação do relatório.
• Ordem: filtro opcional para apresentação do relatório.

Indicadores

BRASIL: Verificar Situação do Boleto

Indicador para ser utilizado em diversos locais do sistema para verificar informações dos boletos híbrido registrado no Banco do Brasil através da API.

• Contas a Receber;
• Ficha de Cliente;
• Borderôs de Acerto, Remessa e Retorno Bancário.

BRASIL: Verificar Situação do PIX

Indicador para ser utilizado em diversos locais do sistema para verificar informações dos PIX agendados registrado no Banco do Brasil através da API.

• Contas a Receber;
• Ficha de Cliente;
• Borderôs de Acerto, Remessa e Retorno Bancário.

BRASIL: Qtd de PIX recebidos hoje

Indicador para informar a quantidade de PIX recebidos durante o dia.

Para funcionar, é necessário configurar os parâmetros do indicador. Deve ser informado a conta que será utilizada. Será considerado as movimentações do dia atual.

Exemplo de configuração dos parâmetros:

{
  "conta":2
}

BRASIL: Qtd de Boletos recebidos hoje

Indicador para informar a quantidade de Boletos recebidos durante o dia.

Para funcionar, é necessário configurar os parâmetros do indicador. Deve ser informado a conta que será utilizada. Será considerado as movimentações do dia atual.

Exemplo de configuração dos parâmetros:

{
  "conta":2
}

BRASIL: Qtd de Pix recebidos hoje

Indicador para informar a quantidade de Pix Agendados recebidos durante o dia.

Para funcionar, é necessário configurar os parâmetros do indicador. Deve ser informado a conta que será utilizada. Será considerado as movimentações do dia atual.

Exemplo de configuração dos parâmetros:

{
  "conta":2
}

Outras Funcionalidades

BRASIL: Prorrogar Boleto

Efetuar a alteração da data de vencimento de um boleto. A data de vencimento consiste no último dia para pagamento do boleto sem acréscimo de multa, juros e outros.

Antes de executar o processamento para prorrogação, o usuário deverá efetuar a prorrogação do título no sistema. Após alteração realizada, executar o processamento para alteração no Banco do Brasil.

Não é possível realizar prorrogação do boleto no mesmo dia da emissão.

BRASIL: Protestar Boleto

Protestar um boleto no Banco do Brasil. O protesto é a ação através da qual o portador de um título comercial cujo pagamento não foi efetuado dentro do prazo, garante seu pagamento por ações judiciais.

Ao executar o título será protestado.

BRASIL: Solicitar Baixa de Boleto

Baixar um boleto no Banco do Brasil. O processo de baixa consiste na ação de invalidar o boleto.

Ao executar o título será baixado no Banco do Brasil.

BRASIL: Verificar Situação do Boleto

Irá exibir informações da situação do título selecionado referente ao boleto no Banco do Brasil.

BRASIL: Verificar Situação do PIX

Irá exibir informações da situação do título selecionado referente ao Pix no Banco do Brasil.

BRASIL: Cancelar Pix Agendado

Efetuar o cancelamento de um pix agendado no Banco do Brasi

BRASIL: Prorrogar Pix

Efetuar a alteração da data de vencimento de um Pix Agendado. A data de vencimento consiste no último dia para pagamento do pix sem acréscimo de multa, juros e outros.

Antes de executar o processamento para prorrogação, o usuário deverá efetuar a prorrogação do título no sistema. Após alteração realizada, executar o processamento para alteração no Banco do Brasil.