Central de Ajuda

Leitura de 6 min

Integração Bancária API Santander Webhook

Este documento apresenta o processo de integração e uso da API do Santander, incluindo a configuração do Webhook para notificações em tempo real. A API possibilita a automação de operações bancárias, enquanto o Webhook assegura atualizações imediatas sobre transações e eventos.

Requisitos Importantes

  • Sistema Operacional Debian 10.
  • Para homologar uma carteira API, o recomendado é abrir um novo convênio de conta bancária. Caso opte por utilizar um convênio já em uso no IXC ou que já tenha emitido boletos, esteja ciente de possíveis divergências em relatórios, como:
    • Informações de “Título não encontrado” nos processamentos de retorno (referentes aos títulos da carteira API).
    • Liquidações atreladas a boletos divergentes.
  • Importante: Após a homologação da carteira API, evite a emissão de novos boletos pela antiga carteira de remessa/retorno que utiliza o mesmo convênio.

Funcionalidades Principais

  • Geração automática de boletos.
  • Consulta do status de transações.
  • Recebimento de notificações em tempo real via Webhook.
  • Gerenciamento completo da carteira de cobrança.

Funcionamento No Sistema

A integração com a API Santander funciona da seguinte forma:

  1. Autenticação:

    • O sistema utiliza as credenciais fornecidas pelo Santander (Client_ID e Client_Secret) para autenticação na API.

  2. Sincronização de Dados:

    • Informações de cobranças geradas no Sistema são enviadas ao Santander.
    • Atualizações sobre o status de boletos e pagamentos retornam ao Sistema.

  3. Processamento Automático:

    • Pagamentos são baixados automaticamente, reduzindo atrasos e erros manuais.

  4. Interface de Usuário:

    • Usuários podem gerenciar boletos e acessar informações diretamente no Sistema.

Processo De Integração e Homologação

O processo de integração e homologação inclui a obtenção de credenciais, a criação da carteira Gateway no Sistema e a configuração de parâmetros bancários.

Homologação

Dados Bancários Necessários Para Integração:

033 - Santander (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.
  • Chave Pix (caso use boleto híbrido — Boleto + Pix).
  • Client_ID.
  • Client_Secret.
  • O convênio bancário é novo ou já foi usado para emissão?

Dica!

Consulte o gerente da sua conta bancária caso tenha dúvidas sobre alguma informação.

Passo a Passo Para Obter Credenciais Da API

Informação!

Para homologar a carteira API, você precisa gerar o Client_ID e o Client_Secret no portal Developers Santander.

  1. Acesse o Developers Santander.
  2. Faça login com sua conta.
  3. Clique no menu da conta (ao lado do botão Sair).
  4. Escolha a opção Minhas Aplicações.
  5. Clique na aba Produção.
  6. Acesse o menu Aplicações e clique em Criar nova aplicação.
  7. Configure os parâmetros da aplicação API de Cobrança:
    • Marque a opção Utilizo um parceiro.
    • Nome da aplicação: Defina um nome de sua preferência.
    • Parceiro: Escolha IXC Soft.
    • Produto: Selecione o módulo Emissão de Boletos.
  8. Finalize clicando em Enviar.
  9. Fim.

Dica!

Aguarde alguns minutos após o envio e atualize a página para verificar se sua aplicação está disponível.

  1. Com sua aplicação criada, copie os dados das credenciais:
    • Client_ID.
    • Client_Secret.

Credenciais API Finalizadas!

Após obter essas informações, envie os dados bancários e as credenciais para o suporte da IXC Soft para prosseguir com a homologação.

Criando A Carteira

  1. No Sistema, acesse: Menu Sistema > Financeiro > Carteira de cobrança.
  2. Clique em Novo.
  3. Na aba Carteira de cobrança, configure:
    • Descrição: Nome da carteira.
    • Conta: Crie a conta que armazena os dados bancários.
    • Tipo de recebimento: Escolha Gateway.
    • Enviar e-mail para cliente ao gerar: Marque como Não, evitando envios automáticos de faturas e alterações desnecessárias no registro.
    • Validar filial na venda: Marque como Sim.
    • Planejamento analítico: Utilize o padrão 240 ou cadastre outro.
  4. Fim.

Configurações Gateway

  • Gateway: Selecione Santander.
  • Ambiente gateway: Produção.
  • Client_ID: Insira o código da aplicação API.
  • Client_Secret: Insira a chave da aplicação API.

Novo!

Agora estão disponíveis dois novos campos para o controle do float (como D+0, D+1) da data de crédito.

  • Se for preenchido com “0”, a data do crédito será igual à data do pagamento.
  • Se for preenchido com “1” ou valor maior, a data do crédito deve ser a data do pagamento + o número de dias úteis do campo.

Campos Adicionados:

  • Data de crédito Pix: data em que a movimentação financeira ficará registrada no ato de recebimento.
  • Data de crédito boleto: data em que a movimentação financeira ficará registrada no ato de recebimento.
  • Número Convênio: Informe o número do convênio (9 dígitos). Complete com zeros à esquerda, se necessário. Exemplo: 000884395.
  • Chave Pix: Informe a chave Pix cadastrada na conta do banco.
  • Tipo Chave Pix: Escolha entre CPF/CNPJ, Celular, E-mail ou Aleatória.

Aviso!

Certifique-se de preencher corretamente o número do convênio e a chave Pix para evitar falhas na comunicação.

Juros/Multas/Desconto

  • Juros %: Configure 0.033% (máximo permitido por lei).
  • Multa %: Configure 2% (máximo permitido por lei).
  • Desconto até o vencimento R$: Configure um valor fixo em Reais (opcional).
  • Desconto até o vencimento %: Informe o percentual de desconto (opcional).

Para mais informações, veja: Juros, Multas e Desconto.

Instruções

  • Santander API: Não possui restrições de linhas ou caracteres para instruções no boleto.
    Exemplo de instruções:

  • Instrução 1:

Após vencimento juros R$ #juro# ao dia.
  • Instrução 2:
Após vencimento multa R$ #multa#.

Para mais informações, veja: Instruções da Carteira de Cobrança.

Fluxo De Funcionamento

sequenceDiagram
    participant S as Sistema
    participant API as API Santander
    participant W as Webhook

    S->>API: Envia solicitação (ex: gerar boleto)
    API->>S: Responde com dados do boleto
    Note over API,W: Evento ocorre (ex: pagamento)
    W->>S: Envia notificação do evento
    S->>API: Confirma o recebimento

Aviso!

Ao salvar a carteira pela primeira vez, o sistema envia uma solicitação para a API Santander. O status de retorno deve ser 200 (Sucesso). Caso contrário, revise a comunicação entre o Sistema e a API.

Considerações Finais

A integração com a API Santander e a configuração do Webhook facilitam uma gestão financeira mais eficiente e automatizada. Certifique-se de manter as credenciais seguras e atualizadas, garantindo o funcionamento contínuo da integração.

Para suporte adicional, entre em contato com o time de suporte da IXC Soft.

Etiquetas

IntegracaoBancaria ApiBancaria Santander

Leia Também

Visão de gráfico

Páginas relacionadas