Central de Ajuda

Leitura de 7 min

Yapay - Cartão de Crédito

Introdução

A integração entre o Sistema e a plataforma de pagamentos Yapay tem como objetivo automatizar os processos financeiros e de vendas, oferecendo soluções de pagamento eficazes e seguras. Esta documentação apresenta o processo de integração, seus benefícios e as configurações necessárias.

Dica!

As empresas Vindi e Yapay realizaram uma fusão. Caso ainda não possua uma conta na Yapay, cadastre-se pelo link:

Solução Oferecida

Meio de pagamento por cartão de crédito, tanto individual quanto recorrente.

Acesso ao Formulário

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

Benefícios da Integração

BenefícioDescrição
AutomaçãoMenor necessidade de ações manuais e aumento da eficiência
Flexibilidade de PagamentoPermite pagamentos via cartão de crédito, tanto únicos quanto recorrentes
Receita PrevisívelA recorrência contribui para um fluxo de caixa mais estável
Comodidade para ClientesRedução de atrasos e falhas no 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.
  • Agendamento da tarefa para cobranças recorrentes.

Campos obrigatórios

  • Descrição: nome informado no cadastro da carteira.
  • Conta: conta bancária vinculada à carteira.
  • Tipo de recebimento: define a forma de geração das cobranças.
  • Validar filial na venda: se marcado como Sim, exige que a filial do contrato seja igual à da carteira.
  • Ativo: define se a carteira estará habilitada 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 Yapay no Sistema, siga os procedimentos abaixo:

Homologação

Entre em contato com o setor Suporte Técnico e tenha em mãos os seguintes dados:

Dados Necessários

Yapay (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 (Token Merchant_Key)?

Dica!

Em caso de dúvidas sobre os dados bancários, procure o(a) gerente da sua conta bancária.

Passo a passo para obter as credenciais da API

Informação!

A chave de integração (Token ou Merchant Key) é necessária para configurar a Carteira de Cartão de Crédito Yapay, sendo inserida diretamente na carteira.

  1. Acesse o Internet Banking Yapay:
  2. Faça login com sua conta.
  3. No menu lateral, clique em Minha Conta.
  4. Na seção Dados pessoais, localize o campo Token.

Copie o Token, que será utilizado na configuração da carteira de cobrança como a chave de integração.

Credenciais API Finalizadas!

Com os dados bancários e o Token em mãos, o atendente do (Sistema) poderá seguir 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 prosseguir com a configuração, vá até a aba Impressão e no campo Layout de Impressão, selecione o modelo: Boleto + fatura detalhada.

Como a integração de cartão não gera arquivo ou documento, essa configuração garante a geração de uma fatura detalhada, quando a impressão for solicitada.

  1. Na aba Carteira de cobrança, preencha os seguintes campos:
    • Descrição: Nome da carteira.
    • Conta: Crie ou selecione a conta com os dados bancários.
    • Tipo de recebimento: Escolha Cartão de crédito.
    • Enviar e-mail para cliente ao gerar: Marque como Não, pois pode enviar a fatura automaticamente, o que pode causar inconsistências.
    • Validar filial na venda: Marque como Não.
    • Ativo: Marque como Sim.
    • Filial: Remova clicando no botão X.
    • Planejamento analítico: Utilize o código padrão 240 ou crie um novo conforme necessário.

Criando a Conta

  • Conta: Informe o nome da nova conta.
  • Tipo da Conta: Selecione Banco.
  • Data de abertura: Data atual ou de criação da conta.
  • Planejamento analítico: Para mais informações, acesse: Formulário Planejamento Analítico.
  • Filial: Escolha o ID da filial à qual a conta será vinculada.

Na aba Banco:

  • Agência: Número da agência.
  • Dígito verificador da agência: Informe o dígito verificador.
  • Número da conta: Digite o número da conta.
  • Dígito verificador da conta: Informe o dígito correspondente.

Configurações Cartão de Crédito

  • Gateway: Escolha Yapay.
  • Ambiente gateway: Escolha Produção.
  • Chave: Insira o Token da conta Yapay.
  • Máximo de parcelas: Informe 1 para pagamento à vista ou ajuste conforme seu modelo de parcelamento.
  • Juro (% ao mês): Defina esse valor apenas se for permitir mais de uma parcela.
  • Repassar taxa para o cliente: Marque “Sim” se quiser incluir a taxa da transação no valor total da fatura, ou “Não” para o cliente pagar apenas o valor original.

Redirecionar Taxas (Nova Função)

Melhoria!

Agora é possível aplicar o repasse de taxas de transação diretamente ao cliente nas cobranças manuais e recorrentes. Esta prática é autorizada por lei.

Ao ativar a opção Repassar taxa para o cliente, os seguintes campos serão exibidos:

  • Será aplicada em pagamentos: Escolha entre Individuais, Recorrentes ou Ambos.
  • Porcentagem da taxa (%): Defina a porcentagem a ser aplicada ao valor da cobrança.
  • Valor fixo da taxa (R$): Informe o valor em Reais a ser somado ao pagamento com cartão.

Aviso!

Se selecionar Individuais, a taxa será aplicada apenas nos pagamentos únicos realizados na Central do Assinante. Se selecionar Recorrentes, será aplicada apenas nas cobranças com recorrência. Ao selecionar Ambos, a taxa será aplicada em ambas as situações.

Juros/Multas/Desconto

  • Juros %: Configure 0.033% (valor sugerido dentro do permitido por lei).
  • Multa %: Configure 2% (máximo permitido por lei).
  • Desconto até o vencimento R$: Valor fixo em Reais para desconto no pagamento até o vencimento.
  • Desconto até o vencimento %: Percentual de desconto para pagamento até o vencimento.

Mais detalhes podem ser consultados em: Juros, Multas e Desconto.

Dica!

Clique em Salvar para finalizar a configuração. Agora é necessário ativar a carteira no Sistema, conforme instruções a seguir.

Ativando a Carteira de Cobrança no Sistema

Após a configuração, a carteira poderá ser ativada por meio de duas formas:

  • Hotsite (Central do Assinante): Ao configurar a carteira nos parâmetros do Hotsite, todos os clientes poderão realizar pagamentos com essa carteira através da Central do Assinante.
  • Alternativa de Pagamento: Permite associar a carteira a outra carteira mais abrangente, limitada a grupos específicos de clientes. Ideal para criar diferentes opções e condições de pagamento.

Configurando a Carteira no Hotsite - Central do Assinante

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

Dica!

Acesse o guia completo em: Configurar Recorrência com Cartão de Crédito.

Configurando a Carteira como Alternativa de Pagamento

  1. Crie a Alternativa de Pagamento, conforme descrito em Configurações Alternativas de Pagamento.
  2. No menu Sistema > Cadastros > Financeiro > Carteira de Cobrança, encontre a carteira desejada.
  3. Clique em Editar.
  4. No campo Configuração de alternativa de pagamento, preencha com o ID ou use a Lupa para localizar.
  5. Clique em Salvar para finalizar o vínculo.

Concluído!

Apenas contratos com a carteira vinculada à Alternativa de Pagamento com opção de cartão de crédito poderão utilizar essa forma de pagamento.

Tarefa de Baixa de Títulos em Recorrência

É necessário configurar uma tarefa no Sistema para enviar, automaticamente, as cobranças com vencimento no dia.

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

Dica!

Essa tarefa deve ser executada uma única vez ao dia, preferencialmente em horário que não conflite com outros agendamentos do sistema.

Fluxos e Processos

Fluxo de Integração

sequenceDiagram
    participant S as Sistema
    participant API as API Yapay
    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 Yapay e o Sistema representa um avanço importante para a gestão financeira automatizada.

Com mais praticidade para os clientes, menor risco de inadimplência e redução de ações manuais, essa integração contribui para uma operação mais eficiente e organizada.

Etiquetas

IntegracaoFinanceira Yapay PagamentosOnline CartaoDeCredito APIYapay Recorrencia

Leia Também

Visão de gráfico

Páginas relacionadas