Manual de Integração com o Banco do Brasil – Accordous

Este guia explica, de forma simples e prática, como integrar sua conta do Banco do Brasil à plataforma Accordous.

A integração permite que você receba pagamentos automaticamente por boletos e PIX, além de facilitar o gerenciamento financeiro de seus contratos.

1. Requisitos para utilizar as APIs do Banco do Brasil

Antes de iniciar a integração, é importante verificar se você atende aos requisitos exigidos pelo Banco do Brasil para contratar as APIs disponíveis no Portal Developers BB.

---

Solicitação ao gerente

Solicite ao seu gerente a ativação da integração utilizando o script abaixo:

Olá, gostaria de ativar a minha integração e solicitar o ambiente de produção para a integração Accordous, na minha conta XXX / XXX. 

Quero acessar o App Developers em https://app.developers.bb.com.br/ e ativar as integrações de Cobrança e PIX (v2).

E-mails de suporte (caso necessário):
[email protected]
BB: [email protected]

Banco do Brasil S.A Equipe de Assessoria em Cash Management
E-mail: [email protected]
Telefone: 4003-4112

1.1. Requisitos para utilizar a API de Cobranças

A API de Cobranças é utilizada para receber valores provenientes de ofertas, vendas ou serviços prestados.

Para utilizá-la, você precisa:

• Ter um Convênio de Cobrança ativo no Banco do Brasil.
• Ser Pessoa Jurídica (API disponível apenas para CNPJ).
• Ter cadastro no Portal Developers BB.

---

1.2. Requisitos para utilizar a API PIX

A API PIX permite consultar, gerar, verificar liquidação e devolver QR Codes dinâmicos.

Para utilizá-la, você precisa:

• Ter uma Chave PIX cadastrada no Banco do Brasil.
• Ser Pessoa Jurídica.
• Ter cadastro no Portal Developers BB.

2. Criar ou acessar sua conta no Portal Developers BB

Para receber valores por boletos ou PIX na Accordous, você precisa integrar sua conta do Banco do Brasil.

1. Acesse o Portal Developers BB pelo link.
2. Caso ainda não tenha cadastro, crie uma conta no próprio site.
3. Após acessar sua conta, você poderá continuar com a criação da aplicação necessária para a integração.

---

3. Criar a aplicação no Portal Developers BB

Depois de acessar sua conta no Portal Developers:

1. Clique em "Aplicações".
2. Selecione "Nova Aplicação".
3. Preencha todas as informações solicitadas.
4. Escolha os escopos relacionados às operações que pretende usar na Accordous:
   • Cobranças
   • PIX

Recomenda-se selecionar ambos os escopos, mesmo que não pretenda utilizá-los agora.
Assim, você não precisará criar outra aplicação no futuro.

5. Clique em "Criar" para criar sua aplicação.

---

4. Enviar para produção e gerar credenciais

Com a aplicação criada:

1. Revise suas informações.

2. Envie a aplicação para produção.

3. Identifique seu CNPJ (o mesmo da sua conta bancária).

4. Aceite o termo de adesão.
   A integração ficará em análise para liberação em produção. Em geral, esse processo ocorre de forma rápida, podendo ser quase instantâneo, conforme ilustrado na captura de tela apresentada abaixo.

5. Clique em "Ir para credenciais" e em seguida "Gerar credenciais"

6. Suas credenciais de produção ficarão disponíveis na opção "Área de Credenciais".

Atenção: as credenciais possuem visualização única. Se você perder algum dado, será necessário gerar novas credenciais.

Guarde bem essas credenciais:

As credenciais necessárias para integração na plataforma Accordous são:

• Client ID
• Client Secret
• Application Key (Developer Application Key)

5. Configurar Webhook

A configuração de Webhook é um passo obrigatório para que possamos receber a liquidação de boletos e PIX na plataforma.

1. Ainda em "Detalhes da aplicação", clique em Webhook.

2. Na tela seguinte, clique em Cadastrar evento e coloque as seguintes informações:

   a. API selecionada:

   • Cobranças (v2)

   b. Tipo de evento:

   • Baixa operacional

3. Selecione o convênio/conta bancária vinculada.

4. Em dados de envio, coloque a seguinte URL: https://accordous.digital/webhook/banco-brasil

5. Se você também vai oferecer o PIX (o que é recomendado), faça o mesmo passo, porém selecione:

   a. API: Pix (v2)
   b. Em tipo de evento: PIX RECEBIDO
   c. Identificador: A chave PIX vinculada a esta conta bancária
   d. Dados de envio URL: https://accordous.digital/webhook/banco-brasil

---

6. Inserir as credenciais na Accordous

Com as credenciais em mãos:

1. Acesse sua conta na Accordous.
2. Vá ao menu: Configurações > Contas de Recebimento > Cadastrar Conta BB.
3. Preencha as informações da sua conta bancária:

Dados da conta

• Nome da conta
• CNPJ
• Agência, conta e dígito
• Chave PIX (opcional)

Dados da integração

• Client ID (obrigatório)
• Client Secret (obrigatório)
• Developer Application Key (obrigatório)
• Número do Convênio (obrigatório)
• Número da Carteira
• Variação da Carteira

Após preencher tudo, clique em Integrar conta.

---

7. Configurar juros e multa (opcional)

Após salvar os dados da integração, você poderá configurar:

• Juros
• Multa
• Descontos

Esses parâmetros serão aplicados às cobranças geradas pelo sistema, caso deseje.

---

8. O que você poderá fazer após integrar sua conta

• A integração com o Banco do Brasil permite:
• Receber pagamentos diretamente na sua conta BB PJ
• Emitir boletos e gerar cobranças via PIX
• Criar faturas manualmente ou automaticamente
• Visualizar e baixar boletos
• Cancelar boletos
• Editar faturas
• Incluir cobranças adicionais
• Enviar faturas por e-mail e WhatsApp

9. Informações internas importantes sobre o uso da integração

• Caso seja necessário atualizar um boleto já gerado, o Banco do Brasil pode levar até 30 minutos para refletir as novas informações (como valores, juros ou multa). É recomendado aguardar esse intervalo antes de realizar uma nova tentativa ou encaminhar o boleto ao pagador.

Para demais dúvidas e esclarecimentos, entre em contato com a nossa Central de Atendimento.