Skip to content

Módulo iugu Boleto para WHMCS

versão downloads abrir issue

Boleto registrado no checkout do WHMCS, com baixa automática.

O WHMCS cuida dos seus clientes, faturas e serviços. A iugu processa a cobrança. Este módulo une os dois: o cliente gera o boleto na própria fatura, paga, e a fatura é baixada sozinha, sem conferência de extrato nem baixa manual.

Comprar o módulo

Sumário

Por que usar

  • Boleto na própria fatura. O cliente gera o boleto direto na fatura do WHMCS, sem sair do seu site
  • Baixa automática. Quando o boleto é pago, a fatura correspondente é quitada sozinha pela verificação periódica de status, sem conferência manual
  • Copiar em um clique. A linha digitável e o Pix copia e cola do boleto ficam com botão de copiar na fatura, facilitando o pagamento pelo celular
  • No seu tempo. Dias até o vencimento, valor mínimo e mensagem na fatura configuráveis
  • Testes sem risco. O ambiente sandbox da iugu valida todo o fluxo antes de ir para produção

Funcionalidades

  • Boleto registrado gerado via API iugu, integrado ao checkout nativo do WHMCS
  • Copia e cola da linha digitável e do Pix do boleto na fatura, com um clique
  • Verificação periódica de status configurável: horário de execução e quantidade de faturas verificadas por requisição
  • Baixa automática das faturas quando o boleto é pago
  • Valor mínimo da fatura para permitir pagamento via boleto
  • Dias até o vencimento configuráveis
  • Mensagem personalizada exibida na fatura
  • Redirecionamento para o boleto ao acessar a fatura (opcional)
  • Suporte a produção e a testes (sandbox)
  • Logs de diagnóstico configuráveis
  • Aviso de atualização e verificação de versão na própria tela de configuração do módulo

O boleto na fatura do cliente

Boleto iugu exibido na fatura do WHMCS

Requisitos

  • WHMCS 8.x ou superior
  • PHP 8.2 a 8.4, com cURL e ionCube Loader 15 ou superior
  • Cron do WHMCS ativo, para a verificação de status e a revalidação da licença
  • Conta iugu com API habilitada (token de produção e de testes)

Instalação

  1. Baixe o arquivo em https://gofas.net/gibd/ e descompacte. Será criada a pasta gofasiuguboleto.
  2. Copie a pasta modules de dentro de gofasiuguboleto para a raiz da instalação do WHMCS, mesclando com as pastas existentes.
  3. Ative o módulo em Configurações > Portais para Pagamentos, na aba Todos os Portais de Pagamento, clicando em "Gofas iugu Boleto".
  4. Informe a chave de licença e os tokens da API.

Configuração

Opções do módulo

Tela de configurações do módulo iugu Boleto, versão 2.0.1

  • Chave de licença: obtida ao adquirir o módulo. Sem licença ativa o módulo não gera novos boletos
  • API token produção: token de produção da sua conta iugu
  • API token teste: token de testes da sua conta iugu
  • Sandbox: alterna entre o ambiente de testes e produção
  • Salvar Logs: grava informações de diagnóstico em Utilitários > Logs > Registros do Módulo
  • Valor mínimo: valor mínimo da fatura para permitir pagamento via boleto
  • Dias até o vencimento: prazo do boleto a partir da emissão
  • Mensagem na fatura: texto exibido ao cliente na fatura
  • Verificação de status: horário de execução e quantidade de faturas verificadas por requisição
  • Enviar estatísticas de uso: telemetria identificada opcional

Informações importantes

  • A tarifa do boleto é paga separadamente à iugu, conforme o plano da sua conta
  • O cron do WHMCS precisa estar ativo. É ele que verifica o status dos boletos, dá baixa nas faturas pagas e revalida a licença
  • Sem licença ativa, os boletos já gerados continuam válidos e as baixas em andamento seguem funcionando. O módulo apenas deixa de gerar novos boletos até a licença ser regularizada
  • Sempre faça backup antes de alterar qualquer coisa no seu sistema
  • Personalizações podem ser feitas sem editar o código original, via hooks, mantendo o módulo atualizável

Perguntas frequentes

A baixa da fatura é automática?

Sim. A cada rodada do cron o módulo consulta na iugu o status dos boletos em aberto, na quantidade que você configurar, e quita no WHMCS as faturas cujos boletos foram pagos.

Posso testar antes de cobrar de verdade?

Sim. Com o Sandbox ligado e o token de testes, todo o fluxo roda no ambiente de testes da iugu, sem gerar cobrança real.

O que acontece se a licença ficar inativa?

Os boletos já gerados continuam válidos e as baixas em andamento seguem funcionando. O módulo apenas deixa de gerar novos boletos até a licença ser regularizada.

Changelog

Veja changelog.md.

Suporte

Dúvidas, sugestões e problemas: https://gofas.net/contato/

Licença

Contrato de licença de uso

Changelog

Melhorias:

  • número e logradouro do pagador extraídos errado de address1 - #31
  • bank_slip_extra_days calculado como subtração de datas em YYYYMMDD - #30
  • Publicar download PHP 8.1 (ionCube 14) para o gib no WHMCS live - #29
  • link: falha silenciosa quando a iugu retorna HTTP 200 com success:false - #28

Comparar versões

Melhorias:

  • v2.0.1: chave de licença lida cifrada, phone_home sem admin_url/admin_path e module_version desatualizada - #27

Comparar versões

Melhorias:

  • Converter para módulo pago (verificação de licença + ionCube + produto WHMCS) - #25
  • readme: link de suporte para o forum do proprio modulo - #24
  • readme: contador do site, captura sem aviso de hook e secao de licenca - #23
  • readme: captura versionada, badges e sumario - #22
  • readme: conteudo da pagina do site transferido e captura de configuracao - #21

Comparar versões

Melhorias:

  • Remover variante de codigo para PHP 7.4 (indexd.php / includesd) - #20
  • Telemetria com consentimento (v1.3.0) - #19

Correções:

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

Comparar versões

Comparar versões

Melhorias:

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

Comparar versões

Correções:

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

Comparar versões

Melhorias:

  • Exibe nas configurações do módulo data e hora da última verificação de versão - #14 enhancement
  • 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 enhancement
  • Carrega configurações e variáveis personalizadas incluídas nos arquivos /custom/config.php e /custom/params.php - #11 enhancement
  • Checa a instalação do hook e alerta no topo das configurações quando o arquivo não é localizado - #10 enhancement
  • Botão "Verificar atualizações" nas configurações reseta a informação local e verifica a versão mais recente disponível - #9 enhancement

Comparar versões

Melhorias:

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

Comparar versões

Melhorias:

Comparar versões

Scroll To Top