> 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/sicoob-api-cobranca.md).

# Sicoob (API Cobrança)

#### Visão geral

A integração Sicoob API Cobrança moderniza a gestão financeira no Consistem ERP, substituindo a troca de arquivos (CNAB 240/400) pela comunicação direta e em tempo real. Esta solução automatiza o envio de títulos para registro e a recepção de status, eliminando a manipulação manual de arquivos de remessa e retorno. O diferencial é a capacidade de validar dados cadastrais (CPF/CNPJ) instantaneamente e a flexibilidade híbrida, permitindo manter carteiras via API e via CNAB simultaneamente.

#### Requisitos

<table><thead><tr><th width="461">Consistem ERP</th><th>Sicoob (API Cobrança)</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 Receber) e Cobrança Escritural devidamente implantados.<br><strong>Licença:</strong> <a href="https://movidesk.consistem.com.br/form/5801/">Aquisição de licença</a> <strong>SICOOB</strong> ativa junto à Consistem.</p><p>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://developers.sicoob.com.br/">Saiba mais</a></td></tr><tr><td><strong>Certificado:</strong> O certificado gerado no banco deve estar instalado e configurado no servidor (Cache) para autenticação SSL/TLS.</td><td><strong>Contrato:</strong> Cobrança API ativo junto à cooperativa.</td></tr><tr><td><a href="/spaces/JAFv73zIUkocB6ArsYjv/pages/SfhnTXkjUOFBpQGkRuJV">Cadastro de Portador (CCAPL025)</a>: O portador correspondente à conta bancária deve estar cadastrado, com o número do banco e agência corretos.</td><td><strong>Portal:</strong> Cadastro no <a href="https://developers.sicoob.com.br/portal/">Portal Developers Sicoob</a>.</td></tr><tr><td></td><td><strong>Credenciais:</strong> Obtenção da chave <em>Client ID</em>.</td></tr><tr><td></td><td><strong>Escopos:</strong> Aplicação com escopos de <em>Leitura</em> e <em>Escrita</em> ativos e convite aceito no Internet Banking da conta beneficiária.</td></tr><tr><td></td><td><strong>Certificado:</strong> Geração do certificado no portal do banco para instalação no servidor da Consistem.</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 **SICOOB** e acione a coluna **Editar**.<br>

   <figure><img src="/files/MNWjBjAhVeeQ57oMtlI7" alt=""><figcaption></figcaption></figure>
2. No programa [Cadastro de Integração (CSINTEGRACAO010A)](/componentes/manuais-de-telas/cadastros-gerais-de-componentes/cadastro-de-integracao.md), informe o **Host** (`https://api.sicoob.com.br/`), o **Server Token** (`auth.sicoob.com.br`) e a credencial obtida no portal (*Client ID*). Altere a situação da integração para *Ativo* e salve os dados.<br>

   <figure><img src="/files/CGAHwD3s1wxZH1LBbhjZ" alt=""><figcaption></figcaption></figure>
3. Na [Aba Endpoints (CSINTEGRACAO010ATAB2)](/componentes/manuais-de-telas/cadastros-gerais-de-componentes/cadastro-de-integracao/aba-endpoints.md), ative os *endpoints* e configure a retenção de logs por 30 dias.<br>

   <figure><img src="/files/GenrMS83UFyE3fqIGL3F" alt=""><figcaption></figcaption></figure>
4. Na [Aba Integração Manual (CSINTEGRACAO010ATAB3)](/componentes/manuais-de-telas/cadastros-gerais-de-componentes/cadastro-de-integracao/aba-integracao-manual.md), utilize a opção *Obter Token* para testar a comunicação. O sistema deve atualizar o campo **Token** (*Bearer*) e a data de expiração.
5. Acesse o programa [Cadastro de Dados do Banco da Cobrança Escritural (CCCE030)](/financeiro/manuais-de-telas/financeiro-contas-a-receber/tabelas-da-cobranca-escritural/cadastro-de-dados-do-banco-da-cobranca-escritural.md) e, no campo **Leiaute CNAB**, selecione a opção *API*.​

   <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>Esta configuração ativa o uso da API para o banco selecionado.</p></div>

   <figure><img src="/files/VrRpH9UHw7YFWZ9TjaLa" alt=""><figcaption></figcaption></figure>
6. No programa [Configuração Geral da Cobrança Escritural (CCCE000)](/financeiro/manuais-de-telas/financeiro-contas-a-receber/configuracoes-da-cobranca-escritural/configuracao-geral-da-cobranca-escritural.md), altere o campo **Envio da Remessa Automática via API na Geração do Borderô** para *Sim*.

   <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>Esta é uma configuração independente que automatiza a transmissão após o borderô ser gerado.</p></div>

   <figure><img src="/files/s2YfeMV3QwaAbNEPeGfs" alt=""><figcaption></figcaption></figure>
7. 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 Títulos Liquidados Sicoob* (Financeiro - Contas a Receber) e defina a periodicidade para a leitura automática das baixas.<br>

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

#### Como a integração funciona

A comunicação utiliza o protocolo HTTPS com autenticação via OAuth2, utilizando o formato JSON para troca estruturada de dados.

A inteligência da integração é gerida pelo programa [Integração (CSINTEGRACAO010)](/componentes/manuais-de-telas/cadastros-gerais-de-componentes/integracao.md), que utiliza o *Client ID* e o certificado digital para obter um token de acesso temporário (*Bearer Token*). Para cada título gerado, o ERP realiza uma requisição direta ao *endpoint* do Sicoob. O banco processa a informação em tempo real e retorna imediatamente o **Nosso Número**, a **Linha Digitável** e o **Código de Barras**. Além disso, o sistema permite a convivência híbrida, possibilitando manter algumas carteiras via API e outras via CNAB tradicional. Se houver qualquer inconsistência nos dados do pagador, o sistema interrompe o processo e exibe o erro na hora, garantindo que apenas títulos válidos sejam registrados.

#### Fluxo do processo

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

1. **Origem dos Dados:** O processo inicia no programa de [Geração do Borderô de Remessa (CCCE065)](/financeiro/manuais-de-telas/financeiro-contas-a-receber/cobranca-escritural/geracao-do-bordero-de-remessa.md) ou na [Geração do Arquivo de Remessa de Borderô (CCCE100)](/financeiro/manuais-de-telas/financeiro-contas-a-receber/cobranca-escritural/geracao-do-arquivo-de-remessa-de-bordero.md).
2. **Envio (Remessa Digital):** Em vez de gerar um arquivo físico (.rem), o Consistem ERP traduz os dados para o leiaute JSON e os transmite instantaneamente (individualmente ou em lotes) para o *webservice* do Sicoob.
3. **Registro Imediato:** O Sicoob valida o título em tempo real. Sendo aceito, o título é marcado como *Registrado* no Contas a Receber e o boleto fica disponível para emissão com todos os dados bancários confirmados.
4. **Retorno Automático (Task):** Através do [Agendamento de Tarefas (CSTASK015)](/componentes/manuais-de-telas/agendamento-de-tarefas-e-processo-em-segundo-plano/agendamento-de-tarefas.md), o sistema consulta o banco periodicamente para identificar títulos liquidados ou baixados.
5. **Resultado Final (Liquidação):** O retorno é gravado automaticamente e a baixa definitiva ocorre no programa [Atualização do Movimento de Retorno (CCCE170)](/financeiro/manuais-de-telas/financeiro-contas-a-receber/cobranca-escritural/atualizacao-do-movimento-de-retorno.md), mantendo o status do Contas a Receber atualizado sem a necessidade de recepção ou importação manual de arquivos de retorno.

<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/sicoob-api-cobranca.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.