Central de Ajuda

Leitura de 8 min

Vindi - Cartão de Crédito

Introdução

A integração entre o Sistema e a plataforma de pagamentos Vindi tem como objetivo automatizar os processos financeiros e de vendas, proporcionando soluções de pagamento práticas e eficientes. Esta documentação fornece informações sobre o processo de integração, os benefícios e as configurações necessárias.

Solução Oferecida

Meio de pagamento por cartão de crédito, com opção de pagamento individual ou recorrente.

Acesso ao Formulário

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

Benefícios da Integração

BenefícioDescrição
AutomaçãoDiminui a necessidade de ações manuais e melhora a eficiência
RecorrênciaPermite pagamentos com cartão de crédito de forma recorrente
Receita PrevisívelCobranças recorrentes ajudam a garantir um fluxo de caixa regular
Comodidade para ClientesMinimiza atrasos e interrupções de serviço em função de 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.

Atenção!

Ao acessar as faturas na Central do Assinante, as cobranças Vindi também são listadas, e é possível optar por pagamento via Pix caso a cobrança Vindi ainda não esteja comunicada. Se a fatura for quitada por Pix, a cobrança Vindi será automaticamente cancelada, e vice-versa.

Etapas de configuração do módulo

  • Configuração da integração com cartão de crédito.
  • Juros, multas e desconto.
  • Agendamento da tarefa de cobrança recorrente.

Campos obrigatórios

  • Descrição: nome para a carteira de cobrança.
  • Conta: conta bancária vinculada à carteira.
  • Tipo de recebimento: define como a cobrança será gerada.
  • Validar filial na venda: se marcado como Sim, exige que o contrato do cliente pertença à mesma filial da carteira.
  • Ativo: define se a carteira estará disponível no Sistema.

Processo de Integração e Homologação

Para integrar a Integração de Cartão de Crédito Vindi ao Sistema, siga as instruções abaixo:

Homologação

Abra um atendimento junto ao setor Suporte Técnico e tenha os seguintes dados preparados:

Dados Necessários

Vindi (API Cartão de Crédito)

  • 1 - Número da agência com dígito?
  • 2 - Número da conta com dígito?
  • 3 - Chave (Merchant_Key)?
  • 4 - Plano na Vindi?

Dica!

Se tiver dúvidas sobre algum dos dados, consulte o(a) gerente de sua conta bancária.

Passo a passo para obter as credenciais da API

Informação!

Para utilizar a Carteira de Cartão de Crédito Vindi, será necessário gerar a “Chave” e o “Plano na Vindi”, que são as credenciais da API.

  1. Acesse o Internet Banking Vindi:
  2. Faça login em sua conta.
  3. Clique em Configurações no menu lateral e acesse Chaves de API.
  4. Clique em Nova Chave.
  5. Em seguida, clique em Criar Chave de acesso.
  6. Copie a chave gerada e guarde-a em local seguro.

Agora, para criar o plano de venda:

  1. Ainda na conta Vindi, acesse Configurações > Produtos.
  2. Clique em Novo Produto.
  3. Depois, clique em Criar Produto.
  4. Vá até Configurações > Planos > Novo Plano.
  5. Associe o produto criado e clique em Criar Plano.
  6. Copie o ID do plano gerado.

Credenciais API Finalizadas!

Com as credenciais e dados bancários disponíveis, o atendente do (Sistema) poderá avançar com a homologação da carteira com cartão de crédito.

Criando a Carteira

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

Aviso!

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

Essa definição garante que será gerada uma fatura detalhada, uma vez que a integração por cartão não gera documento impresso.

  1. Na aba Carteira de cobrança, preencha os campos conforme:
    • Descrição: Nome da carteira.
    • Conta: Crie uma nova conta com 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 exige e-mail válido e envia automaticamente a fatura, 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 defina outro conforme aplicável.

Criando a Conta

  • Conta: Nome da conta a ser criada.
  • Tipo da Conta: Selecione a opção Banco.
  • Data de abertura: Data atual de criação da conta.
  • Planejamento analítico: Para mais detalhes, acesse: Formulário Planejamento Analítico.
  • Filial: Informe o ID da filial à qual a conta e a carteira estarão vinculadas.

Na aba Banco:

  • Agência: Número da sua agência.
  • Dígito verificador da agência: Informe o dígito correspondente.
  • Número da conta: Número da sua conta bancária.
  • Dígito verificador da conta: Informe o dígito verificador da conta.

Configurações Cartão de Crédito

  • Gateway: Selecione Vindi.
  • Ambiente gateway: Marque como Produção.
  • Chave: Insira a Merchant_Key gerada.
  • Plano na Vindi: Informe o ID do plano obtido anteriormente.
  • Máximo de parcelas: Por padrão, insira 1. Configure um número maior se desejar permitir parcelamentos.
  • Juro (% ao mês): Configure o percentual de juros, se o campo de parcelas estiver acima de 1.
  • Repassar taxa para o cliente: Marque como “Sim” se quiser incluir a taxa da transação no valor final da fatura, ou “Não” para mantê-la fora do valor cobrado ao cliente.

Aviso!

Após salvar a carteira, o campo Webhook será preenchido automaticamente com a URL para notificações. Essa URL deverá ser configurada dentro da plataforma da Vindi, conforme instruções abaixo.

Configurando a URL de Notificações Webhook na Vindi

Siga os passos a seguir para configurar o Webhook:

  1. Acesse sua conta Vindi.
  2. Vá até o menu Configurações.
  3. Clique em Webhook.
  4. Clique em Novo Webhook.
  5. Cole a URL gerada na carteira dentro do Sistema.
  6. Marque a opção Fatura paga.
  7. Finalize em Criar Webhook.

Redirecionar Taxas (Nova Função)

Melhoria!

Agora é possível repassar ao cliente a taxa de transação, tanto em cobranças manuais quanto recorrentes. Tal prática está prevista em lei.

Se marcar Repassar taxa para o cliente como “Sim”, os seguintes campos aparecerão:

  • Será aplicada em pagamentos: Selecione entre Individuais, Recorrentes ou Ambos.
  • Porcentagem da taxa (%): Percentual cobrado sobre o valor da venda.
  • Valor fixo da taxa (R$): Valor fixo adicionado ao total da fatura.

Aviso!

Para a Vindi, recomenda-se utilizar Recorrentes, pois pagamentos únicos por cartão não são suportados nesta integração.

Juros/Multas/Desconto

  • Juros %: Configure 0.033% (valor permitido legalmente).
  • Multa %: Configure 2% (conforme permitido por lei).
  • Desconto até o vencimento R$: Valor em Reais a ser concedido por pagamento antecipado.
  • Desconto até o vencimento %: Percentual de desconto por pagamento antecipado.

Mais detalhes em: Juros, Multas e Desconto.

Dica!

Após concluir as configurações da carteira, clique em Salvar. Não se esqueça de ativar a nova carteira no Sistema para disponibilizá-la aos seus clientes, como mostrado abaixo.

Ativando a Carteira de Cobrança no Sistema

Com a carteira pronta, você pode ativá-la de duas formas:

  • Hotsite (Central do Assinante): Vinculando a carteira nos parâmetros gerais do Sistema, ela ficará disponível para todos os clientes no Hotsite.
  • Alternativa de Pagamento: Vinculando a carteira a uma Alternativa de Pagamento, você poderá restringir seu uso a certos clientes ou aplicar condições distintas conforme política de cobrança.

Configurando a Carteira no Hotsite - Central do Assinante

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

Tarefa de Baixa de Títulos em Recorrência

A próxima etapa é configurar a tarefa que será responsável por enviar ao Sistema as cobranças recorrentes no dia do vencimento.

  1. Vá ao menu Ferramentas.
  2. Clique em Ferramentas.
  3. Acesse Agenda de tarefas.
  4. Clique em Novo.
  5. Em Tarefa, selecione Baixar títulos cartão de crédito recorrente.
  6. Minuto (0-59): Defina o minuto em que será executada.
  7. Hora (0-23): Defina a hora de execução.

Dica!

Essa tarefa deve ser executada apenas uma vez por dia, em horário que não interfira em outras rotinas do sistema.

Fluxos e Processos

Fluxo de Integração

sequenceDiagram
    participant S as Sistema
    participant API as API Vindi
    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 Vindi e o Sistema oferece mais eficiência, automatização e controle para as operações financeiras.

Além de facilitar o gerenciamento das cobranças, ela ajuda a reduzir custos e melhora a experiência para seus clientes, permitindo pagamentos modernos e recorrentes.

Etiquetas

IntegracaoFinanceira Vindi PagamentosOnline CartaoDeCredito APIVindi Recorrencia

Leia Também

Visão de gráfico

Páginas relacionadas