Como instalar e configurar o Plugin Vtex

Escolha a seção

VTEX Cloud Commerce é uma plataforma de e-commerce disponibilizada ao mercado no modelo SaaS, sendo umas das mais robustas soluções.  

Objetivos

Os pedidos de compra geram faturas avulsas dentro da plataforma da Vindi, nos métodos de pagamento Cartão de Crédito, Pix e Bolepix. Esse último método significa que o comprador poderá escolher pagar a o pedido com código de barras do boleto ou através do QR Corde do Pix.  

Pré-requisitos

  • Ter um ambiente homologado pela VTEX;

  • Ter uma conta verificada na Vindi Pagamentos;

  • Criar conta de vendedor no plugin da Vindi;

  • Permissões necessárias: OMS FULL ACCESS e SELLER MANAGER;

  • Se utilizar split, então os afiliados devem ser cadastrados na VTEX com o mesmo e-mail de cadastro da Vindi pagamentos. 

Configuração

1. Gerar Chave de Aplicação na VTEX

  • Acesse o seu Painel Administrativo VTEX;

  • Vá no menu Configurações da Conta > Chaves de aplicação:image.png

  • Clique em Gerenciar Minhas Chaves:image.png

  • Em Gerenciar Minhas Chaves clique em Gerar Chave:image.png

  • No campo de busca, procure por Vindi Pagamentos.

Importante: As chaves devem ter as permissões mínimas: OMS FULL ACCESS e SELLER MANAGER.image.png

  • Salve a Chave de Aplicação e o Token de Aplicação gerados.

2. Ativar a Integração (Obrigatório)

Antes de prosseguir na VTEX, você deve enviar os dados para a Vindi realizar a ativação interna:

3. Configurar o Provedor na VTEX

  • No painel VTEX, acesse o menu Configurações da Loja > Pagamentos > Provedores:image.png

  • Clique em Novo Provedor (ou no botão "+" ) e busque por VindiPagamentos;

  • Nos campos Chave de Aplicação e Token de Aplicação, insira o Token da sua Conta Vindi Pagamentos (disponível no painel da Vindi em Configurações > Chaves de API):image.png

  • Em Detalhes, clique em Editar e certifique-se de que a opção "Ativar modo de teste" esteja Desativada:image.png

  • Clique em Salvar.

4. Configurar Métodos de Pagamento

  • Acesse o menu Configurações da Loja > Pagamentos > Configurações;

  • Clique em Adicionar nova condição de pagamento:image.png

  • Selecione o método desejado e selecione o provedor em Processar com o provedor e em seguida, defina as condições para o método;

  • Por fim, clique em Salvar:image.png

Dica para Split (se aplicável):

Se você utiliza Split de pagamentos, certifique-se de ativar a função "Ativar divisão e enviar recebedores" dentro das configurações do provedor e cadastrar os Sellers na VTEX com o mesmo e-mail utilizado na conta Vindi Pagamentos.

Importante

  • Identificação do Seller: Ao configurar um seller na VTEX, é obrigatório utilizar o mesmo e-mail cadastrado na conta da Vindi Pagamentos. Além disso, o seller deve possuir uma conta devidamente verificada na Vindi para receber os valores.

  • Limitação do Split de Pagamentos: O split só é processado se todos os métodos de pagamento da transação forem processados pelo provedor Vindi Pagamentos. Se o cliente utilizar um método de outro provedor em conjunto (pagamento misto), o split não será realizado para essa venda.

Exemplo Prático:

Se um cliente realizar um pagamento combinado:

  1. Método 1: Pix (via Vindi Pagamentos)

  2. Método 2: Vale Presente (via VTEX)

Neste cenário, embora o pagamento seja aprovado, o sistema não conseguirá realizar a divisão automática (split) de valores e taxas para os sellers. O valor total será transacionado, mas a liquidação para os parceiros deverá ser feita manualmente.

Funcionalidades disponíveis

  • Vendas Avulsas: Suporte completo para compra de produtos no modelo tradicional (não recorrente);

  • Diversidade de Pagamentos: Aceitação de Cartão de Crédito, Pix, Bolepix e Boleto Bancário;

  • Antifraude Integrado: Proteção nativa da Vindi inclusa na solução de pagamento;

  • Split de Pagamentos: Divisão automática de valores entre o marketplace e os sellers;

  • Multi-meios de Pagamento: Opção de compra utilizando até 02 cartões de crédito;

  • Gestão de Estornos: Suporte para cancelamento total ou parcial diretamente pela integração.

Importante

Devido à necessidade de uma configuração especial no Gateway e à validação dos dados de segurança, antes de iniciar a instalação, é obrigatório entrar em contato com a nossa equipe de Credenciamento através dos canais de suporte.

Lembre-se de que a integração só será totalmente liberada após o processamento do formulário de ativação mencionado nas etapas de configuração.