Ir para o conteúdo

Módulo iugu boleto para WHMCS

Automatiza a emissão e confirmação de pagamentos de boletos do seu WHMCS .

Download gratuito e tarifa de R$2,50/boleto pago, são benefícios exclusivos da parceria Gofas e iugu para usuários desse módulo.

Ainda não tem conta iugu? Cadastre-se aqui e garanta tarifa especial também para receber via Pix e Cartão de crédito.

Compatível com PHP 7.4+ e PHP 8.1+;

Link para o boleto e linha digitável diretamente na fatura

Captura-de-Tela-2023-03-14-as-19.04.12-e1678832310669.png

Tudo o quê um módulo de boletos precisa

✓ Confirmação de pagamento automática;

✓ Segunda via automática ao acessar a fatura;

✓ Linha digitável nos emails das faturas;

✓ Link direto para o boleto no email;

✓ Redireciona (ou não) para o boleto ao acessar a fatura;

✓ Dispensa configurações complicadas de campos personalizados etc;

✓ Botão na fatura para copiar linha digitável com apenas um clique;

Requisitos do sistema

  1. WHMCS versão 8.6 ou superior;
  2. PHP 7.4 ou superior

Instalação

Ao descompactar o arquivo do download, observe que os diretórios foram distribuídos seguindo a mesma hierarquia dos diretórios padrão do WHMCS, o arquivo + pasta do gateway estão localizados no diretório /modules/gateways/, enquanto o hook se encontra na pasta /includes/hooks/. Siga os passos a seguir se precisar de mais detalhes:

  1. Faça download do módulo;
  2. Descompacte o arquivo .zip;
  3. Copie o arquivo gofasiuguboleto.php + o diretório /gofasiuguboleto/, localizados na pasta /modules/gateways/ do arquivo recém descompactado, para a pasta /modules/gateways/ da instalação do WHMCS;
  4. Copie o arquivo gofasiuguboleto.php localizado na pasta /includes/hooks/ do arquivo recém descompactado, para a pasta /includes/hooks/ da instalação do WHMCS.

Primeiros passos

  1. Crie um campo personalizado de cliente para CPF e/ou CNPJ, ou se preferir, crie dois campos distintos, um campo apenas para CPF e outro campo para CNPJ. O módulo identifica os campos do perfil do cliente automaticamente;

  2. Ative o Gateway em Opções > Pagamentos > Portais de Pagamento > Aba "All Payment Gateways" > Clique em "Gofas iugu - Boleto";

  3. Defina o nome de exibição do método de pagamento, exemplo: "Boleto Bancário". Após esses passos básicos, sigas as instruções a seguir atentamente para entender como funciona cada configuração do módulo.

 

Configurações do módulo

  1. API token produção: (Obrigatório)  é a senha de acesso à iugu API no modo produção. Veja aqui como criar o API token;

  2. Sandbox Token: (Obrigatório) é a senha de acesso à iugu API no modo teste. Veja aqui como criar o API token;

  3. Sandbox: Ative essa opção para gerar cobranças em modo de teste;

  4. Salvar Logs:Salva informações de diagnóstico em Utilitários > Logs > Log de Módulo. Para funcionar, antes é necessário ativar o debug de módulo clicando em "Ativar Log de Debug";

  5. Valor mínimo: insira o valor total mínimo da fatura para permitir pagamento via Boleto. Formato: Decimal, separado por ponto. Não deve ser menor que o valor da tarifa aplicada à sua conta iugu;

  6. Dias até o vencimento: Dias entre a data de emissão e a data do vencimento do boleto quando gerado no dia do vencimento ou após o vencimento da fatura. Boleto gerado antes do vencimento da fatura é emitido com a mesma data de vencimento da fatura. Mínimo 1 máximo 30;

  7. Mensagem na fatura: Texto exibido na fatura acima do botão "Vizualizar Boleto". Aceita HTML;

  8. Redirecionar para o Boleto: Redireciona o cliente diretamente para o URL do boleto ao acessar a fatura;

  9. Horário da verificação: A hora do dia em que o módulo deve verificar o status de pagamento dos boletos associados às faturas não pagas. Apenas números, entre 00 e 23. Exemplo: se você deseja que as verificações aconteçam todos os dias as 06h da manhã, o valor desse campo deve ser 06;

  10. Verificações por requisição: Número máximo de transações consultadas por vez. As consultas à API iugu são realizadas em fila com espaço de tempo de 5 a 10 minutos e todas as faturas a verificar são divididas em lotes, cuja quantidade é o valor definido nesse campo. Saiba mais sobre a verificação de pagamentos.

Tags de mesclagem

Utilize as mergetags geradas pelo módulo para exibir informações do Boleto nos emails de Faturas do WHMCS.

Para adicionar as tags edite os templates de email referentes à faturas em WHMCS admin > Opções > Modelos de Email.

Tags disponíveis

{$gib_pdf}: Exibe o URL do boleto em PDF;

{$gib_bankLine}: Exibe a linha digitável do Boleto ;

Informações importantes

 

Como funciona a confirmação automática de pagamentos

A confirmação automática de pagamentos é realizada uma vez por dia através de tarefas cron do WHMCS, isso reduz drasticamente a chance de erros e elimina diversas dependências de software.

Para a confirmação automática de pagamentos funcionar você deve instalar o hook que acompanha o módulo no pacote de download.

Para evitar erros, interrupções e sobrecargas, entenda como funciona e tenha bom senso ao definir as opções "Início da verificação" e "Máximo de verificações por requisição".

Exemplo: Existem no seu WHMCS 500 faturas aguardando confirmação de pagamento, você definiu que a verificação inicia às 06h e são verificadas 100 transações de cada vez. Nesse cenário o módulo será acionado 5 vezes por dia e consultará o status de 100 boletos cada vez que for invocado, repetindo o processo com espaço de tempo de 5 a 10 minutos entre cada execução até verificar todos os boletos aplicáveis, sendo executado a primeira vez as 06h e a última vez às 06h e 25min.

Lembre-se de que apenas faturas faturas com status "Não Pago" e que emitiram boleto através desse módulo serão verificadas. Outro detalhe a estar atento é que ao alterar método de pagamento ou status de uma fatura, a mesma será eliminada da fila de verificação.

Histórico de atualizações

Changelog

v1.2.3 (13/06/2023)

Full Changelog

Fixed bugs:

  • Evita erro getGatewayVariables not defined na área do cliente #17

v1.2.2 (20/05/2023)

Full Changelog

Closed issues:

  • Resolvido o erro "gateway functions not found" no cadastro #16

v1.2.1 (10/04/2023)

Full Changelog

Fixed bugs:

  • Descontos aplicados à fatura considerados como números positivos #15

v1.2.0 (04/04/2023)

Full Changelog

Implemented enhancements:

  • Exibe nas configurações do módulo data e hora da última verificação de versão #14
  • Diretório raíz do WHMCS agora é obtido via banco de dados a consultando o diretório do template ativo (para casos onde localizações relativas podem falhar) #13
  • Carrega configurações e variáveis personalizadas incluídas nos arquivos /custom/config.php e /custom/params.php #11
  • Checa a instalação do hook e alerta no topo das configurações quando o arquivo não é localizado #10
  • Botão "Verificar atualizações" nas configurações reseta a informação local e verifica a versão mais recente disponível #9

v1.1.0 (02/04/2023)

Full Changelog

Implemented enhancements:

  • Redução no número de pastas e arquivos do módulo #8
  • Nova opção: Máximo de boletos verificados a cada consulta de status de pagamento realizada na API iugu #6
  • Nova opção: Horário da verificação #5
  • Adicionada compatibilidade com PHP 7 e 8 #4
  • Atualização dos links para a documentação #3
  • Atualiza o registro de versão ao registrar confirmação de pagamento #2

v1.0.0 (23/03/2023)

Full Changelog

Implemented enhancements:

  • Lançamento #1

* This Changelog was automatically generated by github_changelog_generator

Ao baixar esse módulo você concorda com nosso contrato de licenciamento de software.

Deixe um Comentário

Você precisa fazer login para publicar um comentário.

Role para cima