Além dos módulos abordados no artigo anterior, como Catálogo, Preços, Promoções e Logística, a plataforma VTEX possui outros módulos necessários à operação da loja. Este artigo apresenta uma visão geral e as principais configurações dos seguintes módulos:
Pagamentos
O módulo de Pagamentos na VTEX é responsável por coordenar todas as operações financeiras realizadas em uma loja. Por meio dele, é possível determinar quais provedores, meios e condições de pagamento serão oferecidos aos clientes no checkout, bem como verificar informações a respeito das transações de pagamento efetuadas em cada pedido.
Antes de começar em Pagamentos
Para processar e receber os pagamentos das compras realizadas em uma loja VTEX, é preciso contratar os serviços de um ou mais provedores de pagamento. Este contrato é realizado diretamente entre o lojista e o respectivo provedor, não havendo mediação ou participação da VTEX. Para verificar quais provedores estão disponíveis na VTEX em cada país, basta acessar a Lista de provedores de pagamento.
É recomendável utilizar mais de um provedor de pagamento na loja para prover uma boa experiência ao cliente por meio diversos tipos de meios e condições de pagamento, e ao mesmo tempo, operar com diferentes taxas e custos, melhorando o desempenho do negócio.
As configurações de pagamento descritas nesta trilha podem ser realizadas a qualquer momento durante o processo de onboarding. Entretanto, para que a loja possa realizar qualquer tipo de transação de pagamento, é necessário que os módulos de Catálogo, Preços e Logística tenham sido previamente configurados.
Como funciona o módulo Pagamentos
A tabela a seguir apresenta os principais agentes e termos utilizados no contexto de Pagamentos:
Termo | Descrição |
---|---|
Gateway | Sistema responsável por processar informações de pagamento de uma compra no checkout. |
Adquirente | Empresa que realiza o processamento de pagamentos realizados por cartões de crédito e débito. |
Subadquirente | Empresa intermediadora de pagamentos entre os adquirentes, provedores de antifraude e lojistas. |
Bandeira de cartão | Empresa responsável por definir regras de negócios aplicadas a cartão de crédito e débito. |
Banco emissor | Instituição financeira responsável por realizar a autorização de um meio de pagamento, como boleto bancário, cartão de crédito ou débito. |
Provedor de pagamento | Empresa que oferece suporte para transações eletrônicas em diversos meios de pagamento. |
Provedor de antifraude | Empresa responsável por realizar análises de risco em transações de cartão de crédito e débito. |
Payment Provider Protocol | Protocolo de comunicação de um provedor de pagamento utilizado para transmissão de dados de pagamento. Saiba mais sobre como provedores de pagamento são integrados na VTEX em Payment Provider Protocol. |
Anti-fraud Provider Protocol | Protocolo de comunicação de um provedor de antifraude utilizado para transmissão de dados de análises de pagamento. Saiba mais sobre como provedores de antifraude são integrados na VTEX em Anti-fraud Provider Protocol. |
Meio de pagamento | Métodos disponibilizados pelo cliente para realizar o pagamento de uma compra, tais como, cartões de crédito, débito, carteiras digitais. |
Condição de pagamento | Regras estabelecidas para um determinado meio de pagamento, por exemplo, número máximo de parcelas permitidas e juros aplicados. |
Fluxos de pagamento e transação
Quando uma compra é finalizada na VTEX, uma nova transação é criada e o fluxo de pagamento é iniciado. No exemplo abaixo, é possível verificar um fluxo de pagamento para uma compra realizada por cartão de crédito:

Conforme as informações vão sendo transmitidas entre os agentes responsáveis pelo processamento dos dados, o status da transação de pagamento é atualizado para indicar em qual momento do fluxo os recursos se encontram. Para o fluxo de pagamento por cartão de crédito, temos o seguinte exemplo de status da transação:
Mais informações sobre cada etapa podem ser encontradas no artigo Fluxo da transação no Pagamentos. Para saber como acessar mais informações sobre as transações no Admin VTEX, bas conferir o artigo Ver detalhes da transação.
Configurando pagamentos na loja
Após estabelecer contrato com um provedor de pagamento, é necessário configurá-lo e definir quais meios e condições de pagamento serão disponibilizados no checkout da loja.
Habilitando o conector de pagamento
Os provedores de pagamento precisam ser habilitados em uma loja de modo que transmitam e recebam as informações necessárias para a conclusão de uma transação de pagamento. Os passos abaixo devem ser seguidos para cada provedores a ser habilitado:
- Acessar a Lista de provedores de pagamento.
- Selecionar o provedor desejado, clicando no respectivo link da tabela.
- Acessar o Admin VTEX para configurar o provedor conforme as instruções descritas no respectivo artigo de configuração.
Os artigos de configuração de provedores também podem ser acessados ao digitar o nome do provedor desejado na barra de busca do Help Center.
Definindo meios e condições de pagamento
Para configurar os meios e condições de pagamento, os passos abaixo devem ser seguidos:
- No Admin VTEX, acessar Configurações da loja > Pagamentos > Configurações, ou digitar Configurações na barra de busca no topo da página.
- Na aba Condições de pagamento, clicar no botão +.
- Clicar no nome do meio de pagamento desejado.
- Se desejar, o nome do meio de pagamento pode ser modificado na coluna Nome da condição.
- Ativar a opção Status.
- Em Processar com a afiliação: o nome do provedor de pagamento deve ser selecionado.
- Se desejar utilizar um sistema antifraude, a opção Usar solução antifraude deve ser selecionada. Saiba mais em Configurando provedor de antifraude (opcional).
- Caso o meio de pagamento escolhido permita a configuração de pagamentos parcelados, selecionar a opção Parcelado em A vista ou parcelado? e inserir as informações desejadas. Saiba mais em Configurar condições de pagamento.
- Se desejar, também é possível configurar condições especiais de pagamento. Saiba mais em Adicionando condições especiais de pagamento.
- Clicar em
Salvar
.
Configurações opcionais em Pagamentos
De acordo com o perfil de operação da loja, também é possível realizar as seguintes configurações opcionais de pagamentos:
- Adicionar condições especiais de pagamento
- Configurar meios de pagamento customizados
- Configurar provedor de antifraude
- Criar vales-presente
- Habilitar carteiras digitais
- Customer Credit
Adicionando condições especiais de pagamento
Condições especiais de pagamento permitem que sejam definidas regras específicas para um determinado meio de pagamento, tais como data de vencimento, banco emissor, política comercial, condição comercial e nome da conta.
Para conhecer mais detalhes sobre cada tipo de condição especial de pagamento, basta consultar o artigo Configurar condições especiais de pagamento.
Configurando meios de pagamento customizados
Na VTEX, é possível configurar os seguintes de meios de pagamento customizados:
-
Promissórias: compromisso de pagamento entre o lojista e o cliente referente ao valor de uma compra. É necessária a aprovação manual do lojista para aprovar a transação de compra. Mais informações em Configurar pagamentos com Promissória.
-
Cartões de loja (bandeira própria): cartão de crédito ou débito, emitido em parceria entre uma empresa e uma bandeira de cartões (Visa, Mastercard, entre outros). Pode ser utilizado somente para compras em estabelecimentos que operem com a marca da bandeira emissora do cartão. Mais informações em Configurar pagamentos com Cartões de Loja (bandeira própria).
-
Cartões de loja (co-branded): cartão de crédito ou débito de marca própria, emitido para uso exclusivo em compras realizadas na empresa emissora do cartão. Mais informações em Configurar pagamentos com Cartões de Loja (co-branded).
Configurando provedor de antifraude
Provedores de antifraude também podem ser configurados na loja para realizar análises de pagamentos de cartão de crédito e débito, desde que haja um contrato entre o lojista e o provedor. A sua utilização é recomendada, porém, opcional.
Para verificar os provedores de antifraude atualmente integrados na VTEX, é necessário digitar na barra de busca do Help Center o nome do provedor desejado ou acessar o Admin VTEX, conforme o artigo Configurar o antifraude.
Criando vales-presente
Os vales-presente, também conhecidos como, gift cards ou vouchers, podem ser utilizados em lojas VTEX como meio de pagamento ou programa de fidelidade.
A VTEX possui o seu próprio provedor de vales-presente, permitindo que vales sejam criados e gerenciados por meio do Admin VTEX ou da API do Gift Card. Saiba mais sobre as características de criação pelos dois métodos em GiftCard API.
Além disso, também é possível oferecer gift cards de provedores externos por meio da GiftCard Hub API. Para utilizar um provedor externo de gift card, é necessário possuir um contrato com o provedor e verificar se já está integrado na VTEX. Mais informações nos artigos Configurar Vale-presente e Gift Card system architecture.
Habilitando carteiras digitais
Carteiras digitais são ambientes seguros onde dados bancários e de cartão de crédito podem ser armazenados de forma criptografada e que podem ser acessadas pelo cliente no momento de realizar uma compra. A segurança deste meio de pagamento consiste em não ser necessário preencher todos os dados no checkout a cada compra, sendo somente solicitado ao realizar a autenticação dentro do próprio ambiente de carteira digital.
Na VTEX, é possível oferecer carteiras digitais nativas, como o Google Pay, ou carteiras digitais integradas, tais como Apple Pay, Samsung Pay e PayPal. Mais informações em Carteira digital (ewallet).
Customer Credit
Customer credit é a solução da VTEX para permitir que crédito seja oferecido a clientes específicos, possibilitando um prazo maior para o pagamento de suas compras. Por meio deste app, é possível ter acesso a gerenciamento de clientes, configuração de prazos e parcelamentos, definição de crédito e acompanhamento de status de títulos de cobrança emitidos, entre outras funcionalidades.
Para mais informações, acesse Customer Credit - Visão Geral e Customer Credit - Como Começar.
Pedidos
A partir do momento em que o cliente conclui a compra, é gerado um pedido na VTEX. O gerenciamento de pedidos pode ser feito pelo Admin VTEX, em Pedidos > Todos os pedidos, acessando-se uma página de detalhes da compra, ou via API. Uma visão geral de conteúdo para desenvolvedor sobre a Orders API pode ser encontrada no guia Orders.
Antes de começar em Pedidos
Para a loja ser capaz de gerenciar seus pedidos, a plataforma VTEX não exige configurações obrigatórias, e oferece diversas configurações opcionais que podem ser estratégicas para diferentes modelos de negócio.
No entanto, para o cliente ser capaz de realizar a compra e gerar um pedido, a loja precisa ter produtos cadastrados e precificados, oferecer meios de pagamento e garantir o envio do pedido. Para isso, é necessário realizar as configurações obrigatórias dos seguintes módulos:
Integração de pedidos
Com grande frequência, as lojas desejam integrar seus pedidos a sistemas como ERP (Enterprise Resource Planning) e WMS (Warehouse Management System). A implementação de backend permite à loja automatizar algumas ações no processamento do pedido, tais como:
- Receber notificações do andamento de pedidos e do seu status no fluxo do pedido.
- Obter informações de pedidos que precisam ser separados e embalados.
- Enviar a fatura para a plataforma VTEX, que vai encaminhá-la ao cliente.
- Realizar a alteração de itens do pedido.
Existem duas maneiras diferentes de acompanhar a mudança de status de pedido, o Feed ou Hook. Mais informações sobre integração de pedidos podem ser encontradas no artigo Integrações de backend.
Gerenciar pedidos
No Admin VTEX, em Pedidos > Todos os pedidos, é possível realizar as seguintes ações:
- Visualizar uma listagem com todos os pedidos da loja.
- Acessar informações da compra na página de detalhes, clicando sobre o pedido.
Na página de detalhes do pedido, também é possível acompanhar a evolução do fluxo do pedido. A imagem a seguir é um exemplo de fluxo quando a loja atua simultaneamente como marketplace e seller:

Para localizar o registro de uma compra no Admin VTEX, além de poder filtrar pedidos na página Todos os pedidos, existe a opção de pesquisar pela barra de busca global, que aparece em todas as páginas do Admin VTEX. Para realizar a pesquisa, basta selecionar a opção Pedidos
, no canto direito da barra de busca, e utilizar algum dos seguintes valores:
- ID do pedido
- Nome do cliente
- Email do cliente
- Documento do cliente
Só é possível acessar informações de pedidos criados nos últimos dois anos, sendo o mesmo período válido para os clientes acessarem seus pedidos pelo Minha Conta.
Emails transacionais
A VTEX oferece de forma nativa o envio de emails transacionais, para a loja ser capaz de disparar emails automáticos para o cliente informando sobre as atualizações do pedido. Ou seja, conforme o pedido avança no fluxo de processamento, o cliente pode receber um email de notificação para acompanhar, por exemplo, a aprovação do pagamento da compra e o envio do pedido.
A plataforma oferece uma série de templates de emails transacionais, mas também é possível personalizar a comunicação. A lista abaixo apresenta as principais informações sobre essas configurações opcionais, que são independentes entre si:
- Alias: email alternativo gerado automaticamente pela plataforma VTEX para mascarar o email do cliente nos emails transacionais da loja. Esse tipo de máscara de conversa representa mais proteção para os dados dos clientes, pois o email alternativo é criado de forma não legível para sistemas externos.
- Availability Notify ou Avise-me: configuração do botão Avise-me na página do produto que o cliente visualizou no site da loja. O botão se torna visível quando aquele produto está indisponível e o cliente pode escolher inserir o seu email no campo informado para ser notificado quando o produto estiver novamente disponível para compra.
Funcionalidade Minha conta
Minha Conta é a solução que garante aos clientes da loja terem autonomia no acompanhamento dos seus pedidos e na atualização de seus dados pessoais. Trata-se de ambiente único para cada cliente, que o acessa com senha e usuário.
Uma das vantagens da Minha Conta é que a funcionalidade torna mais direta a comunicação entre o cliente e a loja, além de permitir ao cliente ações como pedir novamente ou cancelar o pedido. A comunicação mais eficiente tende a diminuir a necessidade de serviços de atendimento ao cliente o que, por sua vez, representa uma redução de custos para a loja.
Configurações opcionais em Pedidos
A tabela a seguir apresenta algumas configurações opcionais do módulo Pedidos:
Funcionalidade | Descrição |
---|---|
Assinaturas | Assinaturas é um agendador automático de pedidos para facilitar aos clientes da loja fazerem compras recorrentes. O cliente indica quais itens deseja comprar e a frequência com que os pedidos automáticos devem ser feitos. Configurar Assinaturas é especialmente interessante para modelos de negócio como supermercados e vendas para pets, nos quais os clientes consomem os mesmo produtos com certa periodicidade. |
Televendas | A solução televendas permite mais autonomia para a equipe de serviço de atendimento da loja no apoio aos clientes. Ao configurar as funcionalidades de televendas, os operadores da loja se tornam habilitados a realizar tarefas como: - Comprar em nome de um cliente. - Ajustar manualmente o preço de itens de um carrinho de compras. - Alterar pedidos existentes. - Gerenciar informações de perfil de um cliente no Minha Conta. |
Divergência de valores | Nas estratégias de marketplace da loja no ecossistema VTEX, pode acontecer do preço definido pelo seller ser diferente do preço oferecido pelo marketplace. Cenários com promoções no marketplace, por exemplo, podem interferir no preço que o seller definiu para a venda do seu produto. Para evitar erros de processamento de pedidos, o seller VTEX pode configurar regras de Divergência de valores e estabelecer parâmetros para autorização automática de pedidos com essa diferença de preço entre seller e marketplace. Ao criar regras automáticas para aprovar ou recusar pedidos com diferença de preço, a loja evita ter que fazer o processamento manual de cada item e a operação ganha em eficiência. |
Mais informações em Configurações Gerais dos pedidos.
Checkout
O checkout é a etapa final no processo de compras online e contribui de maneira expressiva para uma boa taxa de conversão de vendas. No contexto da plataforma VTEX, o módulo Checkout desempenha algumas funções essenciais:
- Fornecimento de informações sobre o preço e a disponibilidade dos produtos na vitrine da loja.
- Adiciona itens e processa o carrinho de compras.
- Realiza o processo de conclusão da compra.
Antes de começar no Checkout
Para assegurar o correto funcionamento do checkout, é necessário que os seguintes módulos estejam devidamente configurados pela loja: Catálogo, Logística, Preços, Promoções, Pagamentos e Pedidos.

Este compartilhamento de informações permite que sejam processadas informações de disponibilidade, preços, promoções aplicáveis, métodos de envio e de pagamento.
Customizando o Checkout da loja
As customizações descritas abaixo são opcionais e tem o objetivo de produzir melhorias na performance da Checkout. Antes de configurá-las, é recomendável realizar uma análise para identificar quais são aplicáveis ao perfil operacional da loja.
- Otimização das opções de entregas do checkout
- Carrinho abandonado
- Modificar o preço de um item no carrinho de compras
- Valor mínimo de pedido e quantidade máxima de itens por SKU
- Geolocalização no Checkout
- Checkout UI Custom app
Otimização das opções de entregas no Checkout
Solução que permite acionar uma combinação de informações cadastradas para exibir ao cliente qual é a opção mais rápida e a mais barata para realizar a entrega dos produtos selecionados no carrinho. As outras opções (de maior custo ou maior prazo), não são exibidas no Checkout, melhorando a experiência do cliente.
Mais informações em Otimização das opções de entrega no Checkout.
Carrinho abandonado
Funcionalidade que permite envio de e-mails aos clientes para recordá-los sobre a conclusão da compra de um carrinho que tenha sido criado anteriormente, mas não finalizado.
Configurar o carrinho abandonado durante o Onboarding, permitirá que todos os carrinhos que ainda serão criados, possam ser encaminhados para avaliação do cliente ou finalizados.
Mais informações em Configurar carrinho abandonado.
Modificar o preço de um item no carrinho de compras
Na plataforma VTEX, as lojas têm a possibilidade de ajustar manualmente o preço de um item (SKU) presente no carrinho do Checkout. Esta funcionalidade pode ser usada para aplicar descontos especiais, corrigir erros de preço, criar ofertas personalizadas, resolver reclamações relacionadas a preços ou ajustar custos de envio.
Apenas usuários com perfis de acesso e permissões devidamente registrados no Admin VTEX podem realizar esta modificação.
Mais informações em Modificar o preço de um item no carrinho de compras.
Valor mínimo de pedido e quantidade máxima de itens por SKU
Nas operações de ecommerce, o custo logístico associado à entrega dos produtos desempenha um papel importante na manutenção da competitividade. Esse custo é impactado pelo valor total do carrinho de compras e quantidade de unidades do mesmo SKU contidas no carrinho.
A implementação de um valor mínimo de pedido pode melhorar a eficiência para sellers que realizam entregas em lotes, evitando pedidos com valor baixo ou poucos itens, que podem ser economicamente inviáveis.
Mais informações em Como configurar valor mínimo de pedido e quantidade máxima de itens por SKU.
Geolocalização no Checkout
A solução de geolocalização possibilita ao cliente utilizar o Google Maps na tela do checkout da loja para definir um local de entrega, ao invés de utilizar o CEP do endereço. Após indicar o ponto de entrega, o valor do frete do pedido será exibido de acordo com o valor cadastrado pelo lojista entregas na região selecionada do mapa (polígonos de coordenadas).
Além de calcular automaticamente o custo do frete, se a loja oferece a opção de retirada na loja física, a geolocalização pode ajudar os clientes a encontrar a loja mais próxima com base em sua localização atual.
Mais informações em Configurar geolocalização no checkout.
Checkout UI Custom app
Este aplicativo permite que diferentes customizações visuais possam ser aplicadas na tela do Checkout da loja.
Mais informações em Checkout UI Custom.