Premissas

      Antes de iniciar a configuração da Integração Bancária via API, é essencial estar com todos os dados e arquivos necessários disponíveis. Estes são fundamentais para que o processo funcione corretamente e sem interrupções.

• Certificado Digital (contendo chave pública e chave privada);

• Número do Convênio (fornecido pelo banco);

• ClientID (fornecido pelo banco);

• ClientSecret (fornecido pelo banco).

Configuração

      1. Acessar o Módulo Financeiro

      Acesse: Financeiro → Banco → Conta Bancária.

       2. Selecionar a conta

       Pesquise pela conta bancária que será integrada via API.

• • Observação: Atualmente, apenas contas do Santander são compatíveis com a integração.

    3. Informações Iniciais

     No campo Nº Convênio, insira o número fornecido pelo banco e marque a opção API Bancária.

   4. Configuração da API Bancária 

   Acesse a aba API Bancária e informe os dados fornecidos pelo banco:

• ClientID

• ClientSecret

   5. Importação do Certificado Digital

    Clique no botão Importar Certificado.

• Informe a chave pública e a chave privada.

• Utilize o ícone de lupa para localizar os arquivos, se necessário.

• Preencha a validade do certificado digital.

• Clique em Salvar.

     6. Criar Workspace

• Após salvar o certificado, clique no botão Criar Workspace.

• Se for exibido um ID, a configuração foi concluída com sucesso.

    7. Finalizar

• Clique em Salvar Registro para gravar todas as informações.

Com a configuração concluída, o sistema estará integrado com o banco, permitindo operações bancárias automatizadas e seguras diretamente pela plataforma. Isso resulta em maior controle, redução de erros manuais e conformidade com as exigências técnicas da instituição financeira.

Classificação de Status dos Títulos

Título PENDENTE: Título a receber com status ABERTO, que ainda não foi registrado na API bancária.
Título REGISTRADO: Título a receber com status ABERTO, que foi registrado na API bancária e está aguardando pagamento ou baixa manual.
Título BAIXADO: Título a receber com status ABERTO, que foi registrado na API bancária, mas foi baixado manualmente por um usuário do sistema, mesmo sem o pagamento efetivo (por exemplo, em casos de acordos, cancelamentos ou ajustes).
Título LIQUIDADO: Título a receber registrado na API bancária e que teve pagamento parcial ou total confirmado (conforme acordado com o cliente). Na consulta do título, este estará com status LIQUIDADO.
Título PROTESTADO: Título a receber registrado na API bancária que não foi pago dentro do prazo estipulado e foi encaminhado para protesto. Na consulta do título, este estará com status EM PROTESTO.
 

Consultar Títulos a Receber com status Pendente

• A Conta Bancária deve estar previamente configurada com a API Bancária ativa e funcional;

• Os Títulos a Receber devem estar vinculados a um Tipo de Cobrança que, por sua vez, esteja associado à mesma Conta Bancária.

           Passo a passo

Acesse Financeiro → Banco →  Integração Bancária.

1. Clique em Pesquisar Mnemônico (Lupa) e selecione a Conta Bancária;

2. No campo Cobrança informe o Tipo Cobrança que deseja pesquisar;

3. Marque a caixa status PENDENTE;

4. Informe o Período (neste filtro é possível selecionar por VENCIMENTO do Título ou EMISSÃO do Título);

5.  Clique em Pesquisar.

Registrando Título a Receber na API Bancária

1. Após a pesquisa dos títulos pendentes e/ou baixados (passos anteriores).       
2. Selecione o Título que deseja registrar e clique no botão Registrar. 

       Observação: Apenas os Títulos com status PENDENTE e BAIXADO podem ser registrados na API Bancária.

       3. Caso o cliente opte pode salvar o boleto gerado em PDF, basta marcar a caixa Gerar PDF ao registrar Boleto antes de realizar o registro dos títulos PENDENTES ou BAIXADOS.

       4. O sistema enviará as informações para a API e, ao receber a confirmação de que o boleto foi registrado com sucesso, exibirá uma mensagem de confirmação. A coluna Status será atualizada de Pendente para Registrado.

      5. Os arquivos em PDF gerados ao marcar a opção Gerar PDF ao registrar Boleto, serão salvos automaticamente na pasta C:\Rezende\IntegracaoBancaria do seu computador.

        Observação: Os boletos gerados serão nomeados seguindo a padronização de NOME DO SACADO, DATA do vencimento e HORA do registro deste boleto na API Bancária.

Envio de Alteração de Boleto Registrado

• Boletos com status REGISTRADO na tela Integração Bancária.

         Passo a passo

        Acesse Financeiro → Banco → Integração Bancária.

1. Clique em Pesquisar Mnemônico (Lupa) e selecione a Conta Bancária;

2. No campo Cobrança informe o Tipo Cobrança que deseja pesquisar;

3. Marque a caixa status REGISTRADO;

4. Informe o Período (neste filtro é possível selecionar por VENCIMENTO do Título ou EMISSÃO do Título);

5.  Clique em Pesquisar.

      6. Selecione o boleto que será realizado a baixa, e clique em Enviar Alteração.

      7. Será aberto a tela de Seleção de Instrução.

    8. Selecione qual alteração será enviada informe no campo abaixo qual valor será alterado e clique em OK.

     Observação: Só é permitido enviar as seguintes alterações: data, multa, juros e desconto — sendo que multa, juros e desconto devem ser informados apenas em valores percentuais (%).

Como Consultar se um Título Registrado Foi Liquidado

• Boletos com status REGISTRADO na tela Integração Bancária.

           Acesse Financeiro → Banco → Integração Bancária.

1. Clique em Pesquisar Mnemônico (Lupa) e selecione a Conta Bancária;

2. No campo Cobrança informe o Tipo Cobrança que deseja pesquisar;

3. Marque a caixa status REGISTRADO;

4. Informe o Período (neste filtro é possível selecionar por VENCIMENTO do Título ou EMISSÃO do Título);

5.  Clique em Pesquisar.

     6.  Selecione o boleto que deseja consultar e clique em Consultar. O sistema realizará a verificação do boleto e, ao final do processo, exibirá a mensagem: "Boletos consultados com sucesso!". Caso o boleto esteja liquidado, o status será automaticamente atualizado.

Visualizar Título Liquidado

• Boletos com status LIQUIDADO na tela Integração Bancária.
• Os títulos já consultados no tópico anterior, podem ser visualizados pelo filtro de status LIQUIDADO.

        Passo a passo

        Acesse Financeiro → Banco → Integração Bancária.

1. Clique em Pesquisar Mnemônico (Lupa) e selecione a Conta Bancária;

2. No campo Cobrança informe o Tipo Cobrança que deseja pesquisar;

3. Marque a caixa status LIQUIDADO;

4. Informe o Período (neste filtro é possível selecionar por data de VENCIMENTO do Título, data de LIQUIDAÇÃO do Título ou data EMISSÃO do Título);

5.  Clique em Pesquisar.

Realizar a baixa dos boletos via API Bancária

• Boletos com status REGISTRADO na tela Integração Bancária.

          Passo a passo

          Acesse Financeiro → Banco → Integração Bancária.

1. Clique em Pesquisar Mnemônico (Lupa) e selecione a Conta Bancária;

2. No campo Cobrança informe o Tipo Cobrança que deseja pesquisar;

3. Marque a caixa status REGISTRADO;

4. Informe o Período (neste filtro é possível selecionar por VENCIMENTO do Título ou EMISSÃO do Título);

5.  Clique em Pesquisar.

      6. Selecione o boleto que será realizado a baixa e clique em Baixar.

     7. O sistema exibirá uma mensagem solicitando a confirmação do usuário. Ao clicar em Não, a mensagem será fechada e nenhuma alteração será realizada. Ao clicar em Sim, o sistema prosseguirá com o processo de baixa do boleto.

      8. Clicando em Yes é exiba uma nova mensagem, onde é perguntado ao usuário se "Deseja consultar o boleto referente ao título XXX antes de realizar a baixa?".

      9. Clicando em Yes a API é consultada e caso o retorno seja LIQUIDADO o boleto não poderá ser baixado.

      10. Caso a consulta realizada na API retorne como REGISTRADO a realização da baixa segue normalmente. Clicando em No não é realizado a consulta deste boleto.

      11. Após o passo anterior e a baixa for realizada o sistema exibirá a mensagem de sucesso, o status do boleto será atualizado para BAIXADO.

Realizar Protesto de Título Registrado

• Boletos com status REGISTRADO na tela Integração Bancária.

          Passo a passo

          Acesse Financeiro → Banco → Integração Bancária.

1. Clique em Pesquisar Mnemônico (Lupa) e selecione a Conta Bancária;

2. No campo Cobrança informe o Tipo Cobrança que deseja pesquisar;

3. No menu lateral clique no “+” ao lado da palavra Cobrança, será aberto a aba PROTESTO;

4. Selecione o status REGISTRADO;
5. Informe o Período;
6. Clique em Pesquisar.

        7.Selecione o Título e clique em Protestar.

      8. Será exibida uma mensagem de confirmação do protesto clicando em No a mensagem é fechada e nenhuma alteração é realizada, clicando em Yes o sistema segue com o processo para realizar o protesto do boleto.

    9. Informe a data do protesto, Escritório de Cobrança e  clique em Salvar.

     10. Será exibida a mensagem “Boleto alterados com sucesso!” e o status será atualizado para PROTESTADO.

Consulta Título Protestado e Cancelamento de Protesto

• Boletos com status PROTESTADO na tela Integração Bancária;

           Passo a passo

           Acesse Financeiro → Banco → Integração Bancária.

1. Clique em Pesquisar Mnemônico (Lupa) e selecione a Conta Bancária;

2. No campo Cobrança informe o Tipo Cobrança que deseja pesquisar;

3. No menu lateral clique no “+” ao lado da palavra “Cobrança”, será aberto a aba PROTESTO;

4. Selecione o status PROTESTADO;

5. Informe o Período;

6. Clique em Pesquisar.

        7. Caso queira realizar o cancelamento do Protesto, selecione o boleto e em seguida clique em Cancelar Protesto.

        8. Será exibida uma mensagem de confirmação do protesto clicando em No a mensagem é fechada e nenhuma alteração é realizada, clicando em Yes o sistema segue com o processo para realizar o cancelamento do protesto do boleto.

         9. Informe a data e o motivo do cancelamento do protesto e em seguida clique em Salvar.

          10. Será exibida a mensagem “Boleto alterados com sucesso!” e o status será atualizado para CANCELAMENTO ENVIADO.