> 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-pagamento-api.md).

# Sicoob (Pagamento API)

#### Visão geral

Esta integração automatiza o ciclo completo de pagamentos (Contas a Pagar) do Consistem ERP utilizando a API do Banco Sicoob. Substitui o modelo tradicional de troca de arquivos magnéticos (CNAB 240/400) por uma comunicação direta e em tempo real. Com isso, é possível realizar agendamentos e pagamentos de PIX, TED e Boletos de forma transparente, eliminando processos manuais de envio de remessas e leitura de retornos. Um diferencial importante é a possibilidade de realizar o cancelamento de agendamentos de TED diretamente pelo ERP e a obtenção de protocolos de agendamento instantâneos.

#### Requisitos

<table><thead><tr><th width="461">Consistem ERP</th><th>Sicoob (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 Pagamento Escritural devidamente implantados.</p><p><strong>Licença:</strong> <a href="https://movidesk.consistem.com.br/form/5801/">Aquisição de licença</a> <strong>SICOOBP</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> Pagamento via API ativo junto à cooperativa.</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>Portal:</strong> Cadastro no <a href="https://developers.sicoob.com.br/">Portal Developers</a>.</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>Credenciais:</strong> Obtenção da chave <em>Client ID</em>.</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><tr><td></td><td><strong>Escopos de Acesso:</strong> A aplicação deve possuir permissões específicas para Pagamentos e Consultas, com o vínculo aceito no Internet Banking da conta corrente.</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 **SICOOBP** e acione a coluna **Editar**.<br>

   <figure><img src="/files/SxSeBZrcbpJ8V41540Hc" 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** de produção (`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/2WFcSN1DiappK5bE5X1y" alt=""><figcaption></figcaption></figure>
3. Caso existam diferentes contas para diferentes CNPJs, utilize o botão **Empresa** para configurar credenciais distintas através do programa [Configurações Gerais por Empresa (CSINTEGRACAO010ATAB1A)](/componentes/manuais-de-telas/cadastros-gerais-de-componentes/cadastro-de-integracao/configuracoes-gerais-por-empresa.md).<br>

   <figure><img src="/files/HVVDKdzGeyNTO9yS8jVm" 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 confirmar a estabilidade da conexão.<br>

   <figure><img src="/files/20v6zQGzbMCFVkS3FYjJ" alt=""><figcaption></figcaption></figure>
5. 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 *Sicoob* e altere o campo **Integração pela API** para *Sim*.<br>

   <figure><img src="/files/AGPvJXqVLv03CB2IjTJH" alt=""><figcaption></figcaption></figure>
6. 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 Sicoob* (Financeiro - Contas a Pagar) e defina a periodicidade para a leitura automática dos retornos bancários.<br>

   <figure><img src="/files/aaiJNZyaWFSsXmqMLfTB" 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 a 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 o token de acesso (*Bearer Token*). Diferente do modelo de arquivos, o envio do pagamento gera uma resposta imediata do banco sobre a aceitação do lote ou erro de validação (como dados bancários incorretos ou falta de limite). O sistema também permite que agendamentos de TED sejam cancelados diretamente pelo ERP, disparando uma instrução de exclusão imediata na API do banco.

#### Fluxo do processo

O fluxo segue o leiaute padrão da Consistem para APIs de pagamento:

1. **Seleção e Borderô:** O usuário seleciona os títulos no Contas a Pagar e gera o borderô de pagamento normalmente através do 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. **Transmissão (Remessa Digital):** No programa [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 o arquivo físico (.rem), o ERP converte os dados para o leiaute JSON e os transmite instantaneamente para o Sicoob.
3. **Protocolo Instantâneo:** O banco valida a sintaxe em tempo real e devolve um protocolo de agendamento, que é registrado automaticamente no ERP como uma confirmação de envio.
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 executa consultas periódicas ao banco para verificar se os pagamentos agendados foram efetivados (liquidados) ou rejeitados pelo processamento bancário.
5. **Baixa e Conciliação:** Ao confirmar a liquidação, o retorno é processado automaticamente (via [Atualização do Movimento de Retorno (CCCE170)](/financeiro/manuais-de-telas/financeiro-contas-a-receber/cobranca-escritural/atualizacao-do-movimento-de-retorno.md)), efetuando a baixa do título e a conciliação financeira, eliminando a necessidade de baixar e importar arquivos de retorno manuais do Internet Banking.

<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-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.