> 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/modulos/financeiro/manuais-de-processos/financeiro-contas-a-pagar/pagamento-escritural/configurar-integracao-via-api-sicoob-para-pagamento-escritural.md).

# Configurar Integração via API Sicoob para Pagamento Escritural

{% hint style="success" %}
Este processo é válido a partir da versão 7.6 do Consistem ERP.
{% endhint %}

### Objetivo

***

Automatizar a rotina financeira do Contas a Pagar mediante a comunicação direta entre o Consistem ERP e o Banco Sicoob via API.

{% embed url="<https://modeler.camunda.io/share/cf36fe1f-d2b6-4f18-aaf5-56c5e6ca3513>" %}

### Pré-Requisitos

***

#### Requisito de negócio

Possuir contrato ativo de API de Pagamentos com o Sicoob.\
Cadastrar e obter as credenciais (Client ID e certificado digital) no portal Developers Sicoob.

#### Requisitos de sistema

[Integração (CSINTEGRACAO010)](/modulos/componentes/manuais-de-telas/cadastros-gerais-de-componentes/integracao.md)\
[Consulta Logs de Integração (CSINTEGRACAO100)](/modulos/componentes/manuais-de-telas/consulta-de-componentes/consulta-logs-de-integracao.md)\
[Agendamento de Tarefas (CSTASK015)](/modulos/componentes/manuais-de-telas/agendamento-de-tarefas-e-processo-em-segundo-plano/agendamento-de-tarefas.md)\
[Cadastro da Ocorrência de Retorno (CCFFE030)](/modulos/financeiro/manuais-de-telas/financeiro-contas-a-pagar/tabelas-do-pagamento-escritural/cadastro-da-ocorrencia-de-retorno.md)\
[Cadastro de Dados do Banco do Pagamento Escritural (CCFFE015)](/modulos/financeiro/manuais-de-telas/financeiro-contas-a-pagar/tabelas-do-pagamento-escritural/cadastro-de-dados-do-banco-do-pagamento-escritural.md)

### Etapas do Processo

***

{% stepper %}
{% step %}

### Demanda de Integração

Inicia-se com a necessidade de estabelecer a comunicação entre o Consistem ERP e a instituição financeira.
{% endstep %}

{% step %}

### Configurar Integrador

Acesse a rotina [Integração (CSINTEGRACAO010)](/modulos/componentes/manuais-de-telas/cadastros-gerais-de-componentes/integracao.md), selecione o registro **SICOOBP** e clique na coluna **Editar**. No programa [Cadastro de Integração (CSINTEGRACAO010A)](/modulos/componentes/manuais-de-telas/cadastros-gerais-de-componentes/cadastro-de-integracao.md), defina o usuário responsável pelo setor financeiro.\
Clique no botão **Empresa** e, na [Aba Dados Gerais (CSINTEGRACAO010ATAB1)](/modulos/componentes/manuais-de-telas/cadastros-gerais-de-componentes/cadastro-de-integracao/aba-dados-gerais.md), informe o **Host**, **Client ID**, **número da cooperativa**, **servidor de autenticação**, **tamanho de documento padrão** (20) e vincule o **certificado digital** do portal do banco.\
Na [Aba Endpoints (CSINTEGRACAO010ATAB2)](/modulos/componentes/manuais-de-telas/cadastros-gerais-de-componentes/cadastro-de-integracao/aba-endpoints.md), ative os serviços da API e configure a retenção do log de comunicação para, no mínimo, um mês.
{% endstep %}

{% step %}

### Obter Token e Autenticação

Acesse a [Aba Integração Manual (CSINTEGRACAO010ATAB3)](/modulos/componentes/manuais-de-telas/cadastros-gerais-de-componentes/cadastro-de-integracao/aba-integracao-manual.md), execute a ação de obtenção de token para a empresa desejada e confirme a operação. Em seguida, acesse a rotina [Consulta Logs de Integração (CSINTEGRACAO100)](/modulos/componentes/manuais-de-telas/consulta-de-componentes/consulta-logs-de-integracao.md), filtre pela data com a integração correspondente e valide o registro da mensagem de sucesso na autenticação.
{% endstep %}

{% step %}

### Agendar Consulta Diária

Acesse o programa [Agendamento de Tarefas (CSTASK015)](/modulos/componentes/manuais-de-telas/agendamento-de-tarefas-e-processo-em-segundo-plano/agendamento-de-tarefas.md) e configure o agendamento da tarefa de verificação diária. O processo consultará periodicamente os pagamentos no banco para atualizar movimentações canceladas ou liquidadas.
{% endstep %}

{% step %}

### Configurar Ocorrência de Retorno

Acesse a rotina [Cadastro da Ocorrência de Retorno (CCFFE030)](/modulos/financeiro/manuais-de-telas/financeiro-contas-a-pagar/tabelas-do-pagamento-escritural/cadastro-da-ocorrencia-de-retorno.md) e efetue o cadastro das ocorrências bancárias de retorno e de retorno para consulta, padronizando a interpretação dos comandos pelo sistema.
{% endstep %}

{% step %}

### Ativar API de Pagamentos

Acesse o programa [Cadastro de Dados do Banco do Pagamento Escritural (CCFFE015)](/modulos/financeiro/manuais-de-telas/financeiro-contas-a-pagar/tabelas-do-pagamento-escritural/cadastro-de-dados-do-banco-do-pagamento-escritural.md), informe o código do banco Sicoob, altere o campo de integração via API para a opção *Sim* e salve a alteração para habilitar a geração das informações.
{% endstep %}

{% step %}

### Consistem Integrado Sicoob

Integração concluída com sucesso, habilitando o tráfego automatizado de dados entre o Consistem ERP e a instituição financeira.
{% endstep %}
{% endstepper %}

<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/modulos/financeiro/manuais-de-processos/financeiro-contas-a-pagar/pagamento-escritural/configurar-integracao-via-api-sicoob-para-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.
