Skip to main content

Guia de Integração | Widepay

sgptsmx-petroleo.png


1. Introdução

A integração com APIs Bancárias para a emissão de cobranças representa um avanço estratégico para empresas que buscam automatizar e otimizar sua gestão financeira. Ao conectar diretamente o SGP às instituições bancárias, elimina-se a necessidade de processos manuais, como geração de arquivos de remessa e importação de retornos, reduzindo significativamente erros operacionais e retrabalhos.

Entre os principais benefícios dessa integração destacam-se:

  • Automatização do processo de cobrança: o boleto é emitido e registrado automaticamente no banco a partir do SGP, garantindo maior agilidade e conformidade com as regras bancárias.

  • Redução de erros e inconsistências: a comunicação direta evita falhas comuns em processos manuais, como duplicidade de boletos ou divergências de valores.

  • Maior segurança e confiabilidade: os dados são transmitidos de forma padronizada e segura, minimizando riscos de fraudes ou informações incorretas.

  • Controle centralizado: todas as informações financeiras ficam concentradas no SGP, facilitando o acompanhamento de recebimentos e inadimplência.

  • Agilidade na tomada de decisão: relatórios atualizados permitem uma visão clara da saúde financeira da empresa.

Assim, a integração bancária não apenas simplifica o processo de cobrança, mas também proporciona maior eficiência operacional, segurança e controle estratégico sobre o fluxo de caixa da organização.

Antes de iniciar o processo, consulte nossa FAQ – Atenção à Segurança da sua Integração! para garantir uma implementação mais segura e eficiente.

2. Dados necessários para integrar ao SGP

Nessa etapa é preciso acessar a plataforma do Widepay para criar uma aplicação que vai fornecer as credenciais em produção para a integração com o SGP.

Você vai precisar dos seguintes dados:

  • ID da carteira
  • Token

Durante essa etapa, crie a aplicação no Widepay seguindo as instruções do suporte do banco.

3. Integração do Portador

Mesmo sendo uma integração via API, os dados da conta são necessários para a emissão dos boletos.

  • No Menu Principal, acesse Financeiro (), depois vá em Cadastros () e, em seguida, clique em Portadores ().

Modelo_de_imagem_horizontal_com_sombra.png

  • Você será direcionado para a página de cadastro de Portador, onde poderá inserir e configurar os dados necessários.

cadastro-portador-2.png


Na guia Dados Bancários configure:

  • Código do Banco: G05 - WidePay
  • Agência: 0
  • Conta Cedente: 0
  • Carteira: 0

wideport.png

Em seguida, na guia Relacionamentos da Empresa selecione:

  • Empresa beneficiária
  • Nome do beneficiário
  • CPF ou CNPJ do beneficiário

inter_empresa.png

Confirme essas informações com o cliente para evitar rejeição de boletos por dados incorretos.

Por fim, devemos configurar os Juros e Multa, acessando a guia Juros, Multas, Descontos e Taxas

O Widepay aceita apenas as opções:

  • Percentual Multa, Percentual Juros ao mês
  • Isento (valores zerados)

Para uma melhor compreensão, recomendamos a leitura da nossa documentação de Configuração de Juros e Multa

4. Ponto de Recebimento (Caixa)

O ponto de recebimento é o local onde os pagamentos de boletos serão registrados. 

  • No Menu Principal, acesse Financeiro (), depois vá em Cadastros () e, em seguida, clique em Pontos de Recebimento ().

caixa.png

  • Na guia Dados Básicos, defina o Nome do caixa e selecione o Portador padrão.

widecaixa.png


5. Cadastro do Gateway de Boletos

Agora vamos integrar o Gateway ao SGP para emissão de boletos.

  • No Menu Principal, acesse Financeiro (), depois vá em Cadastros () e, em seguida, clique em Gateway de Pagamento ().

Modelo_de_imagem_horizontal_com_sombra.png

Clique no botão Cadastrar e preencha da seguinte forma:

  1. Nome da Integração: Widepay
  2. Descrição
  3. Token: Token da carteira
  4. Usuário: ID da carteira
  5. Habilite Pagamentos via Boleto
  6. Selecione o Portador Widepay
  7. URL de Notificação: https://url_do_seu_sgp/ws/widepay/id_do_gateway/notificacao

A URL de Notificação também deve ser cadastrada na plataforma do Widepay para que os retornos ocorram

Antes de cadastrar a URL de notificação, verificar a URL verificar a seção de Informações Adicionais

Imagem de Referência (API Boleto)


wideboleto.png

6. Cadastro do Gateway de Boleto Hibrido

O caminho de acesso é o mesmo do cadastro de Gateway de Boleto, apenas devemos ajustas os dados preenchidos.

Caso já tenha um integração, basta habilitar os campos necessários para ativar o Boleto Híbrido no Gateway de boleto existente, sem a necessidade de criar um novo gateway.

Clique no botão Cadastrar e preencha da seguinte forma:

  1. Nome da Integração: Widepay
  2. Descrição
  3. Token: Token da carteira
  4. Usuário: ID da carteira
  5. Habilite Pagamentos via PIX
  6. Habilite Pagamentos via Boleto
  7. Selecione o Portador Widepay
  8. URL de Notificação: https://url_do_seu_sgp/ws/widepay/id_do_gateway/notificacao
  9. Habilite a opção "Gerar Boleto/Carnê + Pix ?" marcando a checkbox correspondente

A URL de Notificação também deve ser cadastrada na plataforma do Widepay para que os retornos ocorram

Antes de cadastrar a URL de notificação, verificar a URL verificar a seção de Informações Adicionais

Imagem de Referência (API Boleto Hibrido)

widehibrido.jpeg

7. Cadastro do Gateway PIX

O caminho de acesso é o mesmo do cadastro de Gateway de Boleto, apenas devemos ajustas os dados preenchidos.

Esse modelo de integração é apenas para emissão de QRCode PIX, caso queira uma integração de Boleto Hibrido, usar o processo da seção anterior!

Clique no botão Cadastrar e preencha da seguinte forma:

  1. Nome da Integração: Widepay
  2. Descrição
  3. Token: Token da carteira
  4. Usuário: ID da carteira
  5. Habilite Pagamentos via PIX
  6. Selecione o Portador Widepay
  7. URL de Notificação: https://url_do_seu_sgp/ws/widepay/id_do_gateway/notificacao
  8. Habilite a opção "Gerar Boleto/Carnê + Pix ?" marcando a checkbox correspondente

A URL de Notificação também deve ser cadastrada na plataforma do Widepay para que os retornos ocorram

Antes de cadastrar a URL de notificação, verificar a URL verificar a seção de Informações Adicionais

Imagem de Referência (API PIX)

widepix.png

8. Informações Adicionais

  • No cadastro da URL de notificação, o ID do Gateway é indispensável para o correto processamento dos retornos.
    • Para identificá-lo, siga os passos:
      • Crie um gateway deixando o campo “URL de notificação” em branco.
      • Anote o ID gerado.
      • Em seguida, cadastre a URL de notificação utilizando esse ID.
  • Para integrações que exijam uma rotina de processamento de retorno, é necessário acionar o suporte para que seja feita a configuração dessa rotina.
  • A seguir, listamos algumas funcionalidades disponíveis para a sua integração:

Funcionalidade Widepay
Boleto - Registro ✔️
Boleto - Retorno ✔️
Boleto - Cancelamento ✔️
Boleto - Tempo de Retorno Webhook
PIX - Emissão ✔️
PIX - Cancelamento ✔️
PIX - Tempo de Baixa Rotina/Webhook
PIX Híbrido ou Avulso? Ambos


tsmx-petroleo.png