Integração Bancária API CrediSIS
Este documento apresenta as funcionalidades da integração bancária por meio da API CrediSIS no sistema, explicando como ela funciona e o processo necessário para realizar a integração e homologação.
Aviso!
Esta integração não emite o Boleto Híbrido (Boleto + QR code Pix). Ela permite apenas a emissão do boleto simples.
Requisitos Importantes
- Sistema operacional Debian 10.
- Para a homologação de uma carteira API o indicado é abrir um novo convênio de conta bancária. Caso deseje utilizar um que já esteja em uso no IXC e/ou que já tenha boletos emitidos por ele, deve estar ciente de que podem ocorrer divergências nos relatórios provenientes de arquivos de retorno.
Entre as divergências estão: Informação de Título não encontrado nos processamentos de retorno (quem se referem a títulos da carteira de API), liquidações atreladas a boletos divergentes, etc.- Além disso, após a homologação de sua carteira de API, é crucial evitar a geração de novos boletos pela antiga carteira de remessa/retorno, que utiliza o mesmo convênio.
Funcionalidades principais
A integração com a API bancária do banco CrediSIS permite gerar e registrar boletos de cobrança diretamente no sistema, sem a necessidade de enviar manualmente arquivos de remessa e retorno ao banco.
Funcionamento no sistema
A integração com a API CrediSIS no sistema opera da seguinte maneira:
- Autenticação:
- O sistema utiliza as credenciais fornecidas pelo CrediSIS para acessar a API de forma segura.
- Sincronização de dados:
- O sistema envia as informações de cobrança para o CrediSIS.
- Recebe atualizações sobre o status dos boletos e dos pagamentos.
- Processamento automático:
- Os pagamentos são baixados automaticamente no sistema.
- Interface de usuário:
- Os usuários podem acompanhar os boletos e acessar todas as informações diretamente pelo sistema.
Processo de integração e homologação
Para integrar e homologar a API CrediSIS no sistema, siga os passos a seguir:
Preparação
- Com o auxílio do Suporte Financeiro, contrate o módulo de API no seu sistema. Essa etapa é necessária para que a criação da sua carteira possa ser iniciada.
Homologação
Dados bancários necessários para a integração:
097 - Banco CrediSIS (API)
- 1 - Número da agência com dígito?
- 2 - Número da conta com dígito?
- 3 - Número do Convênio / Beneficiário ou Cedente?
- 4 - Token da API?
- Este convênio bancário é totalmente novo ou já foi usado para emissão?
Dica!
Caso tenha dúvida sobre algum dos dados bancários, consulte o(a) Gerente de sua Conta Bancária.
Como gerar o Token da API CrediSIS
Dica!
Para a homologação da carteira de API do CrediSIS é necessária a criação de uma aplicação de API. Para a criação desta API, entre em contato com seu Gerente de Contas do Banco, após criação, será disponibilizado o Token da API para ser utilizado no sistema.
Criando a carteira
- Acesse o menu Sistema.
- Vá até a pasta Financeiro.
- Clique em Carteira de cobrança.
- Clique em Novo.
- Na primeira aba, chamada Carteira de cobrança, realize as seguintes configurações:
- Descrição: Defina o nome da carteira.
- Conta: Crie a conta que armazenará os dados bancários.
- Tipo de recebimento: Selecione a opção Gateway.
- Enviar e-mail para cliente ao gerar: Marque a opção Não, pois exige que o cadastro do cliente tenha e-mail e ainda envia a fatura automaticamente, fazendo o registro dela no banco (por isso, não é recomendado utilizar).
- Validar filial na venda: Marque como Sim.
- Planejamento analítico: Utilize o código padrão 240, ou cadastre um novo.
Criando a conta
- Conta: Defina o nome para a conta.
- Tipo da Conta: Selecione a opção Banco.
- Data de abertura: Informe a data atual de configuração da conta para esta carteira.
- Planejamento analítico: Para mais informações, acesse: Contas Contábeis Analíticas.
- Filial: Escolha o ID da filial para a qual serão criadas a Conta e a Carteira.
Na aba seguinte, Banco:
- Banco: Selecione o ID da instituição bancária conforme o cadastro nacional. Para o CrediSIS, o código é
097 - Central Cred. - Agência: Informe o número da sua agência.
- Dígito verificador da agência: Preencha com o dígito que aparece após o número da agência.
- Número da conta: Digite o número da sua conta bancária.
- Dígito verificador da conta: Informe o dígito verificador da conta.
Configurações gateway
- Gateway: Escolha o CrediSIS.
- Importado gateway: Marque como Não.
- Token: Insira o Token da API fornecido pelo banco.
- Envia e-mail Gateways: Marque como Não.
- Número convênio: Informe o número de convênio bancário fornecido pelo banco.
- Tarifas Gateway: Defina o lançamento das tarifas manualmente, pois o banco não lança automaticamente. Para instruções, acesse: Tarifas Bancárias - Gateway, API e Pix.
Atenção!
A criptografia do campo de Credencial/Token da API está presente na versão Beta do sistema. Sua disponibilidade na versão Estável será a partir de Outubro de 2025.
Aviso!
O campo usado para a Credencial/Token da API será criptografado assim que inserido na carteira de cobrança. Além disso, seu conteúdo será exibido como campo de senha, tanto na carteira de cobrança quanto na auditoria. Essa medida foi implementada para aumentar a segurança e evitar acessos não autorizados às suas credenciais.
Se houver alterações na aplicação de API ou nesse campo na carteira de cobrança, a Credencial/Token deverá ser copiada novamente na aplicação da API correspondente e reinserida na carteira de cobrança para que a autenticação funcione corretamente.
Juros/Multas/Desconto
Aviso!
A API do CrediSIS não aceita valores de juros em Reais (R$).
- Juros %: Configure o valor padrão de 0.033% (acima deste, pode ser considerado como juros abusivo).
- Multa %: Configure o valor padrão de 2% (valores maiores podem ser considerados multa abusiva).
- Desconto até o vencimento R$: Informe um valor fixo em Reais para redução no valor da fatura, se pago até o vencimento.
- Desconto até o vencimento %: Informe o percentual de desconto para pagamento até o vencimento.
- Desconto parcela proporcional: Marque esta opção para que o sistema considere o desconto proporcional nas faturas.
Para mais informações, acesse: Juros, Multas e Desconto.
Instruções
- Instrução 1:
Após vencimento juros R$ #juro# ao dia.
- Instrução 2:
Após vencimento multa R$ #multa#.
Aviso!
Se forem adicionadas mais instruções, será necessário incluir a variável de leitura correspondente nas configurações do campo Imprimir instruções quando…
Para mais informações, acesse: 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 Impressão.
Agenda de tarefas
Informação!
Após a criação da carteira de cobrança, é necessário configurar as tarefas que farão as baixas automáticas das faturas no sistema.
Recomenda-se cadastrar duas tarefas de consulta distribuídas ao longo do dia, sendo a última o mais próximo possível da meia-noite.
- Exemplo de horários: 06h50 e 23h50.
Para configurar, siga os passos:
- Acesse o menu Ferramentas.
- Clique em Ferramentas.
- Vá até Agenda de tarefas.
- Clique no botão Novo.
- Em Tarefa, escolha Consulta de pagamentos e cobranças CrediSIS API.
- Em Minuto (0-59): Ajuste com um valor entre 0 e 59 minutos.
- Em Hora (0-23): Defina com um valor entre 0 e 23 horas. Para configurar mais de um horário, separe os valores com vírgulas.
- Exemplo em Horas (0-23): 6,23.
Ativação
Finalizado!
Após concluir todas as etapas, a carteira e a agenda de tarefas estarão prontas. A partir disso, você já pode gerar um boleto de teste, efetuar o pagamento e verificar se a fatura é baixada automaticamente pelo sistema.
Com a baixa automática confirmada, o processo de homologação estará finalizado.
Considerações finais
A integração da API CrediSIS com o sistema é uma solução eficaz para o controle de cobranças bancárias. Para garantir o bom funcionamento, é importante seguir com atenção todas as etapas de configuração e manter as credenciais em segurança.
Etiquetas
IntegracaoBancaria ApiBancaria CrediSIS
