Central de Ajuda

Leitura de 8 min

Iugu - Cartão de Crédito

Introdução

A integração entre o Sistema e a plataforma de pagamentos Iugu tem como objetivo automatizar operações financeiras e de vendas, oferecendo soluções de pagamento seguras e eficientes. Esta documentação explica como funciona a integração, os benefícios oferecidos e as configurações necessárias.

Solução Oferecida

Meio de pagamento por cartão de crédito, com possibilidade de uso em cobranças individuais ou recorrentes.

Acesso ao Formulário

Caminho: Sistema > Cadastros > Financeiro > Carteira de cobrança.

Benefícios da Integração

BenefícioDescrição
AutomaçãoDiminuição da necessidade de ações manuais e melhoria da eficiência
Flexibilidade de PagamentoPermite pagamento via cartão de crédito individual ou recorrente
Receita PrevisívelCobranças recorrentes ajudam na manutenção de um fluxo de caixa estável
Comodidade para ClientesRedução de atrasos e interrupções de serviço por inadimplência

Estrutura

Como funciona a integração

  1. Configuração.
  2. Acesso à Central do Assinante.
  3. Escolha da Opção de Pagamento.
  4. Preenchimento dos dados do Cartão de Crédito.
  5. Habilitação da Recorrência.

Etapas de configuração do módulo

  • Configuração da integração com cartão de crédito.
  • Juros, multas e desconto.
  • Tarefa responsável pelo envio das cobranças recorrentes.

Campos obrigatórios

  • Descrição: nome definido para a carteira de cobrança.
  • Conta: conta bancária vinculada à carteira.
  • Tipo de recebimento: define a forma da cobrança.
  • Validar filial na venda: quando marcado como Sim, exige que a filial do contrato do cliente seja igual à da carteira.
  • Ativo: define se a carteira está habilitada para uso no Sistema.

Processo de Integração e Homologação

Para realizar a integração e homologação da Integração de Cartão de Crédito Iugu no Sistema, siga os procedimentos abaixo:

Homologação

É necessário abrir um atendimento com o setor Suporte Técnico e fornecer os seguintes dados:

Dados Necessários

401 - Iugu S.A. (API Cartão de Crédito)

  • 1 - Número da agência com dígito?
  • 2 - Número da conta com dígito?
  • 3 - ID da Conta?
  • 4 - Token da API?

Dica!

Em caso de dúvidas, entre em contato com o(a) gerente de sua conta bancária.

Passo a passo para obter as credenciais da API

Informação!

Para homologar a Carteira de Cartão de Crédito Iugu, você precisa gerar o “Token da Conta”, que é a credencial da integração criada no ambiente da Iugu.

  1. Acesse o Internet Banking Iugu:
  2. Faça login com sua conta.
  3. No menu à esquerda, clique no ícone de Engrenagem.
  4. Em Informações da Conta, copie o código exibido ao lado como ID da Conta.
  5. No menu lateral, vá até a seção Desenvolvedor e clique em Integração via API.
  6. Na tela de Tokens da API, em Tipo, selecione Produção.
  7. No campo Descrição, escreva Cartão de crédito e clique em Salvar.
  8. Copie o Token da API gerado.

Credenciais API Finalizadas!

Com o Token gerado e os dados bancários em mãos, o atendente do (Sistema) dará seguimento à homologação da sua carteira de cobrança com cartão de crédito.

Criando a Carteira

  1. Acesse o menu Sistema.
  2. Vá à pasta Financeiro.
  3. Clique em Carteira de cobrança.
  4. Clique em Novo.

Aviso!

Antes de começar a configuração, vá até a aba Impressão e defina o campo Layout de Impressão como Boleto + fatura detalhada.

Como a integração por cartão não gera documentos, com essa configuração será emitida uma fatura detalhada ao solicitar a impressão.

  1. Na aba Carteira de cobrança, configure os seguintes campos:
    • Descrição: Nome da carteira.
    • Conta: Crie a conta que armazenará os dados bancários.
    • Tipo de recebimento: Selecione Cartão de crédito.
    • Enviar e-mail para cliente ao gerar: Marque como Não, pois envia automaticamente a fatura e exige que o cliente tenha um e-mail registrado, o que pode não ser desejado.
    • Validar filial na venda: Marque como Não.
    • Ativo: Marque como Sim.
    • Filial: Clique em X para remover o valor.
    • Planejamento analítico: Utilize o código 240 ou crie outro conforme a necessidade.

Criando a Conta

  • Conta: Nome da conta a ser criada.
  • Tipo da Conta: Selecione a opção Banco.
  • Data de abertura: Informe a data de criação da conta.
  • Planejamento analítico: Veja mais em: Formulário Planejamento Analítico.
  • Filial: Selecione o ID da filial para esta Conta e Carteira.

Na aba Banco:

  • Agência: Número da agência.
  • Dígito verificador da agência: Dígito relativo à agência.
  • Número da conta: Número da conta bancária.
  • Dígito verificador da conta: Dígito relativo à conta bancária.

Configurações Cartão de Crédito

  • Gateway: Escolha Iugu.
  • Ambiente gateway: Marque como Produção.
  • ID da conta: Insira o código de identificação da conta Iugu.
  • Token: Insira o Token da API gerado anteriormente.
  • Máximo de parcelas: Defina como 1 se não desejar parcelamento. Caso queira permitir parcelas, aumente conforme necessário.
  • Juro (% ao mês): Percentual de juros para parcelamentos, válido apenas se for permitido mais de uma parcela.
  • Repassar taxa para o cliente: Indique “Sim” para repassar o valor da taxa ao cliente no valor total da fatura, ou “Não” para absorver esse valor.

Redirecionar Taxas (Nova Função)

Melhoria!

Agora é possível repassar ao cliente as taxas de transação. Isso é permitido por lei e pode ser aplicado tanto em pagamentos únicos quanto em recorrentes.

Ao marcar Repassar taxa para o cliente como “Sim”, os seguintes campos serão exibidos:

  • Será aplicada em pagamentos: Escolha entre Individuais, Recorrentes ou Ambos.
  • Porcentagem da taxa (%): Percentual cobrado sobre o valor da venda.
  • Valor fixo da taxa (R$): Valor em Reais acrescentado ao valor da cobrança.

Aviso!

Em Individuais, será aplicada apenas a pagamentos únicos feitos pela Central do Assinante. Em Recorrentes, a taxa será aplicada nas cobranças automáticas. Selecionando Ambos, será aplicada nas duas formas.

Juros/Multas/Desconto

  • Juros %: Configure 0.033% (respeitando o limite legal).
  • Multa %: Configure 2% (também dentro do permitido legalmente).
  • Desconto até o vencimento R$: Valor em Reais concedido para pagamentos antecipados.
  • Desconto até o vencimento %: Percentual de desconto para pagamento antecipado.

Mais informações em: Juros, Multas e Desconto.

Dica!

Após finalizar todas as configurações, clique em Salvar. Na sequência, é essencial ativar sua carteira no sistema para que seus clientes possam utilizá-la, conforme descrito abaixo.

Ativando a Carteira de Cobrança no Sistema

Agora que a carteira está configurada, é necessário vinculá-la de uma das seguintes formas:

  • Hotsite (Central do Assinante): Vinculando a carteira nos parâmetros do Hotsite, todos os clientes poderão usar esta carteira para pagamentos pela Central do Assinante.
  • Alternativa de Pagamento: Vinculando a carteira como alternativa de pagamento, é possível restringir seu uso a determinados grupos de clientes ou criar diferentes opções de desconto por carteira.

Configurando a Carteira no Hotsite - Central do Assinante

  1. Acesse o menu Sistema.
  2. Acesse o submenu Hotsite.
  3. Vá até a pasta Configurações.
  4. Clique em Configurações Geral.
  5. Abra a aba Financeiro.
  6. Configure os campos de Cartão de Crédito e Recorrência com Cartão de Crédito.
  7. Clique em Salvar para finalizar.

Dica!

Veja o processo completo de configuração em: Configurar Recorrência com Cartão de Crédito.

Configurando a Carteira como Alternativa de Pagamento

  1. Crie um cadastro de Alternativa de Pagamento conforme explicado em Configurações Alternativas de Pagamento.
  2. Vá ao menu Sistema > Cadastros > Financeiro > Carteira de cobrança e localize a carteira que deseja ajustar.
  3. Clique em Editar.
  4. No campo Configuração de alternativa de pagamento, insira o ID ou utilize a Lupa para localizar a alternativa criada.
  5. Finalize a configuração clicando em Salvar.

Concluído!

Apenas os contratos vinculados à carteira com a alternativa de pagamento configurada poderão pagar por cartão de crédito.

Tarefa de Baixa de Títulos em Recorrência

Com a carteira criada e ativa, é necessário configurar uma tarefa que será responsável por gerar automaticamente as cobranças no dia do vencimento.

  1. Vá ao menu Ferramentas.
  2. Clique em Ferramentas.
  3. Acesse Agenda de tarefas.
  4. Clique em Novo.
  5. No campo Tarefa, selecione Baixar títulos cartão de crédito recorrente.
  6. Minuto (0–59): Escolha o minuto da execução.
  7. Hora (0–23): Informe a hora da execução.

Dica!

Programe essa tarefa para ser executada apenas uma vez por dia, em horário que não conflite com outras tarefas.

Fluxos e Processos

Fluxo de Integração

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

    S->>API: Envia requisição (ex: gerar fatura)
    API->>S: Responde com dados da fatura
    Note over API,W: Evento ocorre (ex: pagamento)
    W->>S: Notifica sobre o evento
    S->>API: Confirma recebimento da notificação

Considerações finais

A integração entre a Iugu e o Sistema representa um avanço importante na otimização dos processos financeiros.

Com mais automação, redução de custos operacionais e suporte às necessidades dos clientes, essa solução facilita a gestão de cobranças e contribui para um ambiente financeiro mais seguro e eficiente.

Etiquetas

IntegracaoFinanceira Iugu PagamentosOnline CartaoDeCredito APIIugu Recorrencia

Leia Também

Visão de gráfico

Páginas relacionadas