# Integração bancária API Sicredi

Este documento detalha as funcionalidades da integração bancária via API Sicredi no sistema, seu funcionamento e o processo de integração e homologação.

> [!NOTE] Requisitos importantes  
> - **Sistema operacional Debian 10**.  
> - Para a homologação de uma carteira com API, o **recomendado** é abrir um novo convênio de conta bancária. Caso opte por usar um já existente no IXC e/ou com boletos emitidos anteriormente, esteja ciente de que podem ocorrer divergências nos relatórios gerados por arquivos de retorno.  
Essas divergências incluem: mensagens de título não encontrado nos processamentos de retorno (relacionados a títulos da carteira API), liquidações associadas a boletos incorretos, entre outros.  
> - **Após a homologação da nova carteira, evite gerar novos boletos pela antiga carteira de remessa/retorno vinculada ao mesmo convênio.**

## Funcionalidades principais

A integração da API bancária do Sicredi na versão 2 permite a geração de boletos híbridos, possibilitando ao cliente realizar o pagamento tanto pelo código de barras (linha digitável) quanto pelo QR Code Pix.

> [!TIP] Atenção, Beta!  
> Este conteúdo está disponível na **versão Beta**.  
> Ele estará presente na **versão Master** a partir de abril de 2025.  
>
> ##### Webhook disponível!  
> Uma nova melhoria foi implementada, permitindo a comunicação via webhook entre o sistema e o banco.  
> Com o webhook, sempre que o banco disponibilizar uma instrução de cobrança (liquidação, cancelamento, etc.), o log de comunicação é enviado automaticamente para o sistema.  
> - Pagamentos via Pix: recebimento imediato no sistema.  
> - Pagamentos via boleto: processamento no próximo dia útil, após confirmação da liquidação pelo banco.  
>
> Mesmo com o webhook ativado, mantenha um horário configurado para a [[tarefa - consulta de pagamento sicredi api|Tarefa - Consulta Pagamento Sicredi API]] como garantia de processamento de liquidações que porventura fiquem pendentes.  
>
> Para mais detalhes, acesse: [[integracao webhook da api sicredi - master abril 2025|Integração Webhook da API Sicredi]].

## Funcionamento no sistema

A integração da API Sicredi no sistema ocorre da seguinte forma:

1. **Autenticação**  
   - As credenciais fornecidas pelo Sicredi são utilizadas para se conectar à API.  
2. **Sincronização de dados**  
   - As informações de cobrança são enviadas para o Sicredi.  
   - O sistema recebe retornos com os status de boletos e pagamentos.  
3. **Processamento automático**  
   - Os pagamentos são baixados automaticamente.  
4. **Interface de usuário**  
   - Os usuários podem acompanhar e gerenciar os boletos diretamente no sistema.

## Processo de integração e homologação

Para iniciar a integração e homologação da API Sicredi no sistema, siga os passos a seguir:

### Preparação

- Entre em contato com o Suporte Financeiro para contratar o módulo de API e prosseguir com a criação da carteira.

### Homologação

Abra um chamado com o setor **Suporte Financeiro** do IXC Provedor e envie os dados abaixo:

> [!EXAMPLE] Dados bancários necessários para a integração:
>
>**748 - Banco Sicredi (API)**  
>
> - Número da agência com dígito  
> - Número da conta com dígito  
> - Número do convênio / beneficiário ou cedente  
> - Número do posto  
> - Token / código de acesso (chave master)  
> - Credencial X-API-KEY  
> - Indicar se o convênio é novo ou já utilizado anteriormente para emissão  

> [!TIP] Dica!  
> Consulte o(a) gerente da sua conta bancária em caso de dúvidas com algum dos dados solicitados.

### Como gerar o token / código de acesso no Sicredi

> [!INFO] Informação!  
> Esse código é chamado de Token (Chave Master) e é necessário para a integração.

1. Acesse o [Internet Banking Sicredi](https://sicredi.com.br/) e realize o login.  
2. Vá até o menu **Cobrança**.  
3. No menu lateral, role até o final e clique em **Código de acesso > Gerar**.  
4. Marque o termo de adesão e clique em **Avançar**.  
5. No aplicativo do Sicredi, na aba de segurança, leia o QR Code com o celular.  
6. Após gerar o código, copie o **Token Chave Master** e envie ao atendente da IXC Soft.

> [!TIP] Dica!  
> - Nem todas as contas permitem gerar o Token no Internet Banking.  
> - Se a opção não aparecer, solicite ao gerente da conta a ativação do produto **"Cobrança Online Ecom"** pelo sistema **SIAT**.  
> - Essa liberação permitirá a geração do Token diretamente pelo beneficiário.

### Passo a passo para obter o Client_ID

> [!INFO] Informação!  
> Também será necessário gerar o X-API-KEY no portal Developers do Sicredi.

1. Acesse o [Developers Sicredi](https://developer.sicredi.com.br/).  
2. Faça login com seus dados.  
3. No menu **Minha Conta**, clique em **Minhas Apps**.  
4. Clique em **Criar nova aplicação**.  
5. Informe o nome e a descrição. Você pode usar o mesmo nome para ambos no formato:  
   * **Api Cobranca (nº agência) (nº cedente)**  
6. Escolha os escopos:
   - **OPEN API - OUATH - PARCEIROS 1.0.0**  
   - **OPEN API - COBRANÇA - PARCEIROS 1.0.0**  
7. Clique em **Registrar**.  
8. Em **Minhas Apps**, copie o valor de **Client_ID** (parte antes da barra).  
9. Vá até **Suporte > Abra um chamado**.  
10. Preencha o formulário com as seguintes informações:
    - **Assunto:** API Cobrança Boletos  
    - **Motivo do contato:** Solicitar Access Token  
    - **Assunto do chamado:** Solicitar Access Token Produção  
    - **Ambiente:** Produção  
    - **Client ID ou nome da App:** insira o código copiado  
11. Clique em **Enviar**.

> [!WARNING] Aviso!  
> Aguarde a liberação da credencial pelo banco. Esse processo pode levar de 5 a 60 minutos após o envio do chamado.

12. Quando o chamado for marcado como **Resolvido**, volte ao menu **Minhas Apps**.  
13. Verifique se o status da aplicação está **Aprovada**.  
14. Clique em **Ver Detalhes** da aplicação.  
15. Copie o código **X-API-KEY** exibido.

> [!WARNING] Aviso!  
> Se você tiver criado a aplicação no ambiente **Sandbox**, será necessário criar uma nova aplicação no ambiente correto **(Produção)** para utilizar a credencial.

> [!SUCCESS] Credenciais API Finalizadas!  
> Com o Token Chave Master e o X-API-KEY gerados e seus dados bancários em mãos, o Suporte da IXC Soft poderá seguir com a homologação da carteira.

### Criando a carteira

1. Acesse o menu **Sistema**.  
2. Vá para a pasta **Financeiro**.  
3. Clique em **Carteira de cobrança**.  
4. Clique em **Novo**.  
5. Na aba **Carteira de cobrança**, preencha os campos:  
	- **Descrição:** Nome da carteira.  
	- **Conta:** Vincule a conta bancária.  
	- **Tipo de recebimento:** Selecione **Gateway**.  
	- **Enviar e-mail para cliente ao gerar:** Marque como **Não**.  
	- **Validar filial na venda:** Marque como **Sim**.  
	- **Planejamento analítico:** Utilize o padrão **240** ou cadastre um novo.

### Criando a conta

- **Conta:** Nome da conta.  
- **Tipo da Conta:** Escolha **Banco**.  
- **Data de abertura:** Data atual da criação.  
- **Planejamento analítico:** Veja mais em: [[formulario planejamento analitico|Formulário Planejamento Analítico]].  
- **Filial:** Vincule a filial correspondente.

Em **Banco**:

- **Banco:** Selecione:  
   - **748 - Banco Cooperativo Sicredi S.A. - BANSICR**  
- **Agência:** Número da agência.  
- **Dígito verificador da agência:** Informe o dígito correspondente.  
- **Número da conta:** Informe o número da conta.  
- **Dígito verificador da conta:** Informe o dígito correspondente.

### Configurações gateway

- **Gateway:** Selecione **Sicredi API**.  
- **Versão da API:** Escolha **V2**.  
- **Ambiente gateway:** Selecione **Produção**.  
- **Código do beneficiário + código da cooperativa:** Insira os dois dados juntos.  
- **Código de acesso:** Cole o Token Chave Master.  
- **X-api-key:** Cole o valor copiado no portal Developers.  
- **Envia e-mail Gateways:** Marque como **Não**.  
- **Gera pix:** Marque como **Sim**.  
- **Tarifas Gateway:** Configure conforme a orientação em: [[tarifas bancarias - gateway, api e pix|Tarifas Bancárias - Gateway, API e Pix]].

### Configurações bancárias

- **Contador do nosso número:** Veja como configurar em [[contador do nosso numero|Contador do Nosso Número]].  
- **Número do convênio:** Informe o código do convênio.  
- **Posto:** Informe o número do posto bancário.  
- **Títulos com recebimento via pix:** Marque **Sim**.

> [!WARNING] Aviso!  
> - Se o convênio for novo, inicie o contador de nosso número a partir de **200001**.  
> - Se reutilizar um convênio, consulte o último número com o banco antes de configurar.

### Juros/Multas/Desconto

> [!WARNING] Aviso!  
> A API Sicredi não permite juros em **Reais (R$)**.

- **Juros %:** Defina o valor padrão de 0.033%.  
- **Multa %:** Utilize 2%.  
- **Desconto até o vencimento R$:** Informe um valor fixo.  
- **Desconto até o vencimento %:** Configure o percentual.  
- **Desconto parcela proporcional:** Marque se desejar aplicar a regra proporcional.

Para mais informações, acesse: [[juros, multas e desconto|Juros, Multas e Desconto]].

### Instruções

> [!INFO] Informação:  
> - Máximo de **5 linhas de instrução**.  
> - Cada linha pode ter até **80 caracteres**.

Remova as aspas das hashtags:

- **Instrução 1:**
```
Após vencimento juros R$ #juro# ao dia.
```

- **Instrução 2:**
```
Após vencimento multa R$ #multa#.
```

> [!WARNING] Aviso!  
> Se adicionar mais linhas, defina também as condições no campo **Imprimir instruções quando...**.

Para mais detalhes, acesse: [[instrucoes da carteira de cobranca|Instruções da Carteira de Cobrança]].

### Impressão

- **Layout de impressão:** Utilize o modelo padrão **3 por página**.

Para mais informações, acesse: [[layouts de impressao|Layouts de Impressão]].

### Agenda de tarefas

> [!INFO] Informação!  
> Após configurar a carteira, é necessário agendar as tarefas de baixa de faturas automáticas.

São recomendadas até 4 tarefas diárias.  
Exemplo: 06h50, 12h50, 18h50, 23h50.

Para configurar:

1. Vá até o menu **Ferramentas**.  
2. Clique em **Ferramentas**.  
3. Acesse **Agenda de tarefas**.  
4. Clique em **Novo**.  
5. Em **Tarefa**, escolha **Consulta pagamento Sicredi API**.  
6. **Minuto (0-59):** Defina os minutos desejados.  
7. **Hora (0-23):** Insira os horários separados por vírgulas.  
   - Exemplo: **6,12,18,23**

> [!WARNING] Aviso!  
> Se utilizar o Webhook, configure apenas 1 horário por dia para a tarefa de conferência.

Mais informações: [[tarefa - consulta de pagamento sicoob api|Tarefa - Consulta de Pagamento Sicoob API]]

## Ativação

> [!SUCCESS] Finalizado!  
> Após concluir todas as etapas, a carteira estará pronta para uso. Gere um boleto de teste, realize o pagamento e confirme a baixa automática. A homologação estará concluída com o sucesso do processo.

## Considerações finais

A integração da API Sicredi proporciona uma solução moderna e eficiente para o controle de cobranças bancárias. Siga todas as etapas com atenção e mantenha suas credenciais protegidas para garantir o funcionamento contínuo.

## Etiquetas
#IntegracaoBancaria #ApiBancaria #Sicredi 

## Leia Também
* [[carteira de cobranca|Carteira de Cobrança]]
* [[integracoes bancarias - carteira de cobranca|Integrações Bancárias - Carteira de Cobrança]]
* [[integracoes bancarias - api|Integrações Bancárias - API]]
* [[api banco sicredi|API Banco Sicredi]]
* [[como solicitar o pix na central do assinante|Como Solicitar o Pix na Central do Assinante]]
* **Manual Sicredi API**: https://drive.google.com/file/d/1HbrUFtwu2XM7n5yxeKAXKCYIA_RB5pnX/view?usp=drive_link