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

# Sicoob (API Pagamento Escritural)

### Visão Geral

\
A integração de Pagamento Escritural via API do SICOOB substitui o modelo tradicional de troca de arquivos manuais (CNAB) por uma comunicação direta e em tempo real entre o ERP e o banco. O objetivo principal é automatizar o envio de ordens de pagamento e a recepção de status de liquidação, garantindo maior agilidade, segurança e redução de erros operacionais.

### Requisitos

| **Consistem ERP**                                                                                                                                                                                                                                                             | **Banco SICOOB**                                                                                                                                                                                                                                                                                         |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <p><strong>Compatibilidade:</strong> 7.6 ou superiores do Consistem ERP.</p><p>Módulo Financeiro - Contas a Pagar</p><p><a href="https://movidesk.consistem.com.br/form/5801/">Aquisição de licença</a></p><p>Orientamos o acompanhamento da nossa equipe de consultores.</p> | Aquisição de licença e implantação deve ser verificada com a empresa fornecedora. [Saiba mais](https://www.sicoob.com.br/).                                                                                                                                                                              |
| <p><br></p>                                                                                                                                                                                                                                                                   | Criação de uma conta no[ ](https://belluno.tawk.help/article/como-abrir-sua-conta-digital-belluno)[banco Sicoob](https://www.sicoob.com.br/web/sicoob/contas-empresa). A conta é aberta por CNPJ.                                                                                                        |
| <p><br></p>                                                                                                                                                                                                                                                                   | <p><strong>Credenciais Bancárias:</strong> O cliente deve solicitar ao Sicoob a liberação da conta para envio via API e obter as seguintes chaves no portal do desenvolvedor do banco:</p><ul><li><em>Developer Application Key</em></li><li><em>Client ID</em></li><li><em>Client Secret</em></li></ul> |

### Parametrizações

**No Consistem ERP**

1. No programa [Cadastro de Portador (CCAPL025)](/cadastros-gerais/manuais-de-telas/cadastros-gerais/cadastro-de-portador.md), cadastre o portador com o **código BACEN** *756* e informe o **ISPB** *20382324* (obrigatório para TED);

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

2. Cadastre a **agência** e o **CNPJ** **da conta corrente** no programa [Cadastro de Dados Bancários por Empresa (CCFFE016)](/financeiro/manuais-de-telas/financeiro-contas-a-pagar/tabelas-do-pagamento-escritural/cadastro-de-dados-bancarios-por-empresa.md). Como o Sicoob não tem dígito, adicione 0 ao final;

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

3. Acesse o programa [Cadastro da Modalidade de Pagamento (CCFFE025)](/financeiro/manuais-de-telas/financeiro-contas-a-pagar/tabelas-do-pagamento-escritural/cadastro-da-modalidade-de-pagamento.md) e vincule as formas de pagamento: *1 (TED), 30 (Boletos)* ou *45 (Pix)*;

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

4. Configure os **códigos** de **retorno** e de **procedimento** para *00 (Pagamento Efetuado)* e *2 (Documento Liquidado)* no programa [Cadastro da Ocorrência de Retorno (CCFFE030)](/financeiro/manuais-de-telas/financeiro-contas-a-pagar/tabelas-do-pagamento-escritural/cadastro-da-ocorrencia-de-retorno.md);

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

5. No [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), marque o campo **Integração pela API** como *Sim*;

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

6. Ative a tarefa **Buscar Documentos Liquidados Sicoob** para rodar periodicamente, no [Agendamento de Tarefas (CSTASK015)](/componentes/manuais-de-telas/agendamento-de-tarefas-e-processo-em-segundo-plano/agendamento-de-tarefas.md). A periodicidade de execução deve ser definida conforme a necessidade da empresa, podendo variar de uma vez ao dia até intervalos de hora em hora.

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

**Na Integração Sicoob**

1. Configure o Host <https://api.sicoob.com.br/> para criar o cadastro **SICOOBP**;
2. Acesse o programa [Integração (CSINTEGRACAO010)](/componentes/manuais-de-telas/cadastros-gerais-de-componentes/integracao.md) e clique no link da coluna **Editar**, na linha do código **SICOOBP**;

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

3. No programa [Cadastro de Integração (CSINTEGRACAO010A)](/componentes/manuais-de-telas/cadastros-gerais-de-componentes/cadastro-de-integracao.md), aba [Dados Gerais (CSINTEGRACAO010ATAB1)](/componentes/manuais-de-telas/cadastros-gerais-de-componentes/cadastro-de-integracao/aba-dados-gerais.md), insira **Host**, **Host Homologação** ([https://sandbox.sicoob.com.br)](https://sandbox.sicoob.com.br/), **Certificado**, **Client ID**, **Secret**, **Número da Cooperativa**, **Servidor do Token** ([auth.sicoob.com.br](http://auth.sicoob.com.br)) e o **Tamanho Número Documento** (20) para realizar a autenticação;

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

* Caso a organização possua múltiplas empresas com contas correntes distintas, deve-se preencher o campo **Empresa Integração** e acessar o botão **Empresa**, habilitando a parametrização individualizada para cada unidade;

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

4. Ative todos os serviços na aba [Endpoints (CSINTEGRACAO010ATAB2)](/componentes/manuais-de-telas/cadastros-gerais-de-componentes/cadastro-de-integracao/aba-endpoints.md) e configure o log para, no mínimo, 30 dias;
5. Na aba [Integração Manual (CSINTEGRACAO010ATAB3)](/componentes/manuais-de-telas/cadastros-gerais-de-componentes/cadastro-de-integracao/aba-integracao-manual.md), selecione a opção *Obter Token* no campo **Dados** e preencha os dados da empresa para validar a configuração e requisitar o Token;

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

6. Para o monitoramento e rastreio das comunicações, utilize o programa [Consulta Logs de Integração (CSINTEGRACAO100)](/componentes/manuais-de-telas/consulta-de-componentes/consulta-logs-de-integracao.md), selecionando a opção **Integração API Sicoob - Pagamentos**. Marque todos os *endpoints* configurados para facilitar diagnósticos e o suporte em eventuais falhas.

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

### Como a integração funciona

A troca de mensagens ocorre via JSON através do protocolo REST, garantindo modernidade e segurança. Esse fluxo elimina o envio manual de arquivos, estabelecendo uma conexão instantânea para a gestão do ciclo financeiro.

Com suporte nativo para pagamentos de Pix, boletos e TED, o sistema possibilita a gestão completa de status e agendamentos diretamente na interface do Consistem ERP, preservando os processos já estabelecidos no módulo financeiro.

### Fluxo do Processo<br>

1. **Geração:** O usuário gera o borderô de pagamento 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. **Transmissão:** Caso não esteja configurado para envio automático, é necessário acessar o programa [Gravação do Arquivo de Remessa (CCFFE100)](/financeiro/manuais-de-telas/financeiro-contas-a-pagar/pagamento-escritural/gravacao-do-arquivo-de-remessa.md) para transmitir os dados do borderô via API ao Sicoob. Caso ocorra qualquer divergência ou pendência de informação que impeça o processamento automático, o sistema tratará o registro como uma exceção. Nestes cenários, o usuário deve acessar o programa [Atualização do Arquivo de Retorno (CCFFE170)](/financeiro/manuais-de-telas/financeiro-contas-a-pagar/pagamento-escritural/atualizacao-do-arquivo-de-retorno.md) para localizar o retorno pendente e realizar o processamento manual dos documentos.
3. **Monitoramento:** O status pode ser acompanhado pelo programa [Atualização do Arquivo de Retorno (CCFFE170)](/financeiro/manuais-de-telas/financeiro-contas-a-pagar/pagamento-escritural/atualizacao-do-arquivo-de-retorno.md);
4. **Conciliação:** A *task* (tarefa automática) consulta o banco periodicamente. Ao identificar um pagamento liquidado, ela gera o registro de retorno no sistema.
5. **Baixa:** O sistema realiza a liquidação automática do título no Contas a Pagar, finalizando o ciclo financeiro.

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