> For the complete documentation index, see [llms.txt](https://ajuda.consistem.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ajuda.consistem.com.br/consistem-integracoes/areas-de-negocio/financeiro/banco-do-brasil-pagamento-api.md).

# Banco do Brasil (Pagamento API)

#### Visão geral

Esta integração moderniza e automatiza o fluxo de pagamentos entre o Consistem ERP e o Banco do Brasil. Ao substituir a tradicional troca de arquivos (CNAB) pela comunicação direta via API, a integração permite que o envio de remessas e o processamento de retornos ocorram de forma instantânea e segura, eliminando processos manuais de upload e download de arquivos bancários.

#### Requisitos

<table><thead><tr><th width="461">Consistem ERP</th><th>Banco do Brasil (Pagamento API)</th></tr></thead><tbody><tr><td><p><strong>Compatibilidade:</strong> 7.6 ou superiores do Consistem ERP.</p><p><strong>Módulos:</strong> Financeiro (Contas a Pagar) e o Pagamento Escritural devidamente implantados.</p><p>Licença: <a href="https://movidesk.consistem.com.br/form/5801/">Aquisição de licença</a> <strong>IBBP</strong> ativa junto à Consistem.<br><br>Orientamos o acompanhamento da nossa equipe de consultores.</p></td><td>Aquisição de licença e implantação deve ser verificada com a empresa fornecedora.<br><a href="https://apoio.developers.bb.com.br/">Saiba mais</a></td></tr><tr><td><a href="/spaces/JAFv73zIUkocB6ArsYjv/pages/SfhnTXkjUOFBpQGkRuJV">Cadastro de Portador (CCAPL025)</a>: Deve estar configurado com o código do banco, agência e o código ISPB da instituição financeira.</td><td><strong>Contrato:</strong> Liberação da conta para envio via API solicitada junto ao banco.</td></tr><tr><td>Dados da Conta (<a href="/spaces/XAGEHGEHsMtieeZPXhEm/pages/I00JQ78mkyhtbpybmlWc">Cadastro de Dados Bancários por Empresa (CCFFE016)</a> / <a href="/spaces/XAGEHGEHsMtieeZPXhEm/pages/f5cndcbBIdIb5DICDv5g">Cadastro de Banco do Pagamento Escritural (CCFFE050)</a>): Os dados da conta vinculada ao portador devem estar validados para o Pagamento Escritural.</td><td><strong>Portal:</strong> Cadastro no <a href="https://app.developers.bb.com.br/">Portal Developer BB</a>.</td></tr><tr><td></td><td><strong>Aplicação:</strong> Criação de uma aplicação no portal para obtenção das chaves de acesso.</td></tr><tr><td></td><td><strong>Credenciais:</strong> Obtenção das chaves <em>Developer Application Key</em>, <em>Client ID</em> e <em>Client Secret</em>.</td></tr><tr><td></td><td><strong>Escopos:</strong> Certifique-se de que a aplicação no portal possua escopos ativos para Pagamentos e Consultas.</td></tr><tr><td></td><td><strong>Liberação:</strong> Confirme com o gerente de conta a autorização formal para operar em ambiente de produção.</td></tr></tbody></table>

#### Configuração da integração

**No Consistem ERP**

1. Acesse o programa [Integração (CSINTEGRACAO010)](/componentes/manuais-de-telas/cadastros-gerais-de-componentes/integracao.md), selecione a integração **IBBP** e acione a coluna **Editar**.<br>

   <figure><img src="/files/A7onejirNBpmL3icWqZh" alt=""><figcaption></figcaption></figure>
2. No programa [Cadastro de Integração (CSINTEGRACAO010A)](/componentes/manuais-de-telas/cadastros-gerais-de-componentes/cadastro-de-integracao.md), configure a integração com as credenciais obtidas no portal (*Client ID*, *Client Secret* e *Developer Application Key*). Altere a situação da integração para *Ativo* e salve os dados.<br>

   <figure><img src="/files/0uuAOXxr55tQ3nsAg7ni" alt=""><figcaption></figcaption></figure>
3. Acesse o programa [Cadastro de Dados do Banco do Pagamento Escritural (CCFFE015)](/financeiro/manuais-de-telas/financeiro-contas-a-pagar/tabelas-do-pagamento-escritural/cadastro-de-dados-do-banco-do-pagamento-escritural.md), selecione o *Banco do Brasil* e altere o campo **Integração pela API** para *Sim*.<br>

   <figure><img src="/files/sAPjzXYT9YSFtJso9p6Y" alt=""><figcaption></figcaption></figure>
4. No [Cadastro de Agendamento de Tarefas (CSTASK010)](/componentes/manuais-de-telas/agendamento-de-tarefas-e-processo-em-segundo-plano/cadastro-de-agendamento-de-tarefas.md), [Aba Parâmetros Padrões](/componentes/manuais-de-telas/agendamento-de-tarefas-e-processo-em-segundo-plano/cadastro-de-agendamento-de-tarefas/aba-parametros-padroes.md), configure a tarefa *Buscar Documentos Liquidados Banco Brasil* (Financeiro - Contas a Pagar)*,* e defina a periodicidade para a leitura automática dos retornos.<br>

   <figure><img src="/files/Xbi5C1WYP9FxfsdpJL9r" alt=""><figcaption></figcaption></figure>

#### Como a integração funciona

A comunicação ocorre através do protocolo **HTTPS**, utilizando o padrão **REST** com dados em formato **JSON**. A autenticação é feita via **OAuth2**, garantindo que os dados sejam transmitidos de forma criptografada. A inteligência da integração é centralizada no programa [Integração (CSINTEGRACAO010)](/componentes/manuais-de-telas/cadastros-gerais-de-componentes/integracao.md), que valida a configuração em tempo real; se detectada a integração ativa, o sistema interrompe a geração de arquivos físicos e inicia a transmissão direta.

#### Fluxo do processo

O fluxo segue o leiaute padrão da Consistem para APIs bancárias:

1. **Origem dos Dados:** O usuário realiza a seleção dos títulos e a geração do borderô no programa [Geração do Borderô de Documento Normal (CCFFE065)](/financeiro/manuais-de-telas/financeiro-contas-a-pagar/pagamento-escritural/geracao-do-bordero-de-documento-normal.md).
2. **Envio (Remessa Digital):** No momento da [Gravação do Arquivo de Remessa (CCFFE100)](/financeiro/manuais-de-telas/financeiro-contas-a-pagar/pagamento-escritural/gravacao-do-arquivo-de-remessa.md), o sistema identifica a configuração de API. Em vez de gerar um arquivo de texto, os dados são enviados instantaneamente para os servidores do Banco do Brasil.
3. **Processamento:** O banco recebe os dados e retorna o status do agendamento ou pagamento em tempo real. O ERP já gera uma sequência de retorno automática com o protocolo do banco.
4. **Retorno Automático (Task):** Para consolidar a liquidação, o Consistem ERP utiliza o programa [Agendamento de Tarefas (CSTASK015)](/componentes/manuais-de-telas/agendamento-de-tarefas-e-processo-em-segundo-plano/agendamento-de-tarefas.md), executando a regra *Buscar Documentos Liquidados Banco Brasil*. Esta tarefa consulta o banco periodicamente para verificar se os pagamentos agendados foram efetivados.
5. **Resultado Final (Liquidação):** Ao confirmar a efetivação no banco, o retorno é processado e os documentos são liquidados automaticamente no ERP (via [Atualização do Arquivo de Retorno (CCFFE170)](/financeiro/manuais-de-telas/financeiro-contas-a-pagar/pagamento-escritural/atualizacao-do-arquivo-de-retorno.md)), atualizando o saldo e o status dos títulos de forma imediata, sem qualquer intervenção manual de importação de arquivos.

<p align="center">Esse conteúdo foi útil?</p>

<p align="center"><a href="https://movidesk.consistem.com.br/form/10395/" class="button primary" data-icon="thumbs-up">Sim</a> <a href="https://movidesk.consistem.com.br/form/10395/" class="button primary" data-icon="thumbs-down">Não</a></p>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://ajuda.consistem.com.br/consistem-integracoes/areas-de-negocio/financeiro/banco-do-brasil-pagamento-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.