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.