A integração entre Dito Cashback e VTEX permite que o resgate de cashback ocorra diretamente na VTEX, utilizando as informações de pedidos e pagamentos da loja. O processo de autenticação entre as plataformas é realizado por meio de credenciais geradas na VTEX, e a ativação da integração é conduzida pelo time da Dito a partir dessas informações.

• Nível de Acesso: Administrador, Administrador de Dados, Analista de tecnologia.
  

• Persona: Desenvolvedores, analistas de e-commerce e profissionais responsáveis por integrações técnicas entre plataformas.
  

ÍNDICE

Veja os Assuntos abordados nesse artigo:

• Atenção à conciliação com o ERP
• Pré-requisitos
• Passo a passo completo para configurar a integração
  • 1.2. Crie uma service account
  • 2. Habilitando a integração Dito Cashback + Vtex
  • 2.1. Solicite a integração
  • 2.2. Aguarde a atuação do time Dito
  • 3. Teste a Integração
• FAQ – Perguntas Frequentes sobre a Integração Dito Cashback + VTEX

Atenção à conciliação com o ERP

Na integração do Dito Cashback com a VTEX, é essencial que o cashback seja registrado corretamente no ERP como desconto. Caso contrário, a empresa pode pagar impostos sobre o valor total da venda e gerar divergências contábeis.

O cashback funciona como método de pagamento na VTEX, mas deve ser tratado como desconto no ERP para garantir conformidade fiscal.

Recomendações da Dito: alinhar com o time contábil/fiscal, verificar repasse das vendas, confirmar com parceiros de integração e manter configurações corretas.

Pré-requisitos

Antes de iniciar o processo de integração, a marca deve garantir que:

• Utiliza a plataforma VTEX;

• Possui acesso administrativo à conta VTEX;

• Consegue criar uma Chave de API na VTEX;

• Possui um perfil específico (usuário ou app) dedicado à integração com a Dito Cashback.

Passo a passo completo para configurar a integração

1. Criar um perfil específico e gerar a Chave de API na VTEX

Para o resgate de cashback pela VTEX, é necessário que a marca gere uma Chave de API na própria VTEX, com as permissões adequadas para a integração com o Dito Cashback.

Esse processo deve ser feito a partir de um perfil específico (usuário ou app) dedicado à Dito. O usuário precisa possuir a role/permissão “206163 User Administrator - RESTRICTED" ou superior.

Recomendações:

• Não utilizar usuários pessoais;
• Criar um perfil exclusivo para a Dito Cashback;
• Garantir que a Chave de API possua apenas as permissões necessárias para o processo de integração e resgate.

1.1.  Criando um Perfil do Cashback

Crie um novo perfil custom que dê acesso às APIs de giftcard da VTEX.

• Acesse Configurações da Conta > Perfis de Acesso e clique em “Novo Perfil”.

• Configure o Novo perfil/New role:
  
  

1. Escolha o “Choose role” (perfil de acesso) como “Custom”

2. Defina um nome para a role/perfil

3. Selecione o produto “GiftCard” 

   1. Habilite o recurso “View Gift Card providers” (Ver provedores de Gift Card)

   2. Habilite o recurso “Edit Gift Card providers” (Editar provedores de Gift Card)

4. Selecione o produto “PCI Gateway”

   1. No recurso “Payment-ManageStore” habilite “Manage Store” (Gerenciar Loja)

1.2. Crie uma service account

Crie uma service account que será usada para configurar o provedor de giftcard.

• Acesse Configurações da Conta > Chaves de API e clique em “Gerar Chave”
  
  

• Forneça um nome e adicione a role/perfil criada no passo anterior. Em seguida, clique em “Generate” (Gerar) para gerar uma nova chave/service account.

  
  

  
  
  
• Copie e guarde os dados da service account gerada (“chave da aplicação” e “token da aplicação”), pois essas informações serão necessárias no próximo passo.

2. Habilitando a integração Dito Cashback + Vtex

Agora, com esses passos realizados, você pode contar com a Dito para que a integração seja finalizada. Será necessário enviar para o time Dito as informações geradas nos passos anteriores:

2.1. Solicite a integração

Abra um chamado com nosso time de Atendimento solicitando a integração do cashback com a VTEX. Enviando junto ao ticket as seguintes informações:

• Chave e token de API da VTEX gerados na etapa 1.2

• Nome da conta da VTEX
  

Pode ser visualizado no “Nome da conta principal” em Configurações da conta > Conta.

2.2. Aguarde a atuação do time Dito

Agora é só aguardar que o time da Dito irá prosseguir com a habilitação da integração.

3. Teste a Integração

• Acesse a loja VTEX com o login de um cliente que possua um cashback disponível.

• No checkout, deve-se exibir o valor de cashback disponível para uso do cliente.

• Selecione o cashback e o valor deve ser deduzido do montante a pagar.

• Informe o segundo meio de pagamento e conclua a compra.

• Não se esqueça de aprovar o pedido e faturar; Assim que faturado o cashback terá o uso consolidado.

Com essas etapas, você conecta com sucesso o sistema de cashback da Dito à plataforma VTEX, permitindo que o cashback seja utilizado como método de pagamento no checkout, com segurança e visibilidade. Além disso, o uso correto das credenciais e da conciliação com o ERP garante conformidade financeira e operacional.

Ficou com alguma dúvida ou identificou algum problema? Acione nosso time pelo chat disponível no app dito. (Horário de Atendimento de Segunda a Sexta das 9hrs as 18hrs)

Gostou, mas acha que algo pode melhorar? Sua opinião é muito importante para nós! Se você tem alguma sugestão ou sentiu falta de algo neste módulo, queremos ouvir você.

Compartilhe suas ideias diretamente com nosso time de Produto através do link abaixo. ➡️ Acesse aqui o Portal de Ideias

FAQ – Perguntas Frequentes sobre a Integração Dito Cashback + VTEX

1. Por que é recomendado criar um perfil "Custom" em vez de usar um perfil de administrador já existente?
   
   Resposta: Por segurança. Ao criar um perfil específico com permissões restritas apenas a GiftCard e PCI Gateway, você garante que a integração tenha acesso somente ao necessário para operar o cashback, protegendo o restante das configurações da sua loja.
   
   

2. Qual o impacto de não configurar o cashback como desconto no ERP?
   
   Resposta: Se o ERP não reconhecer o cashback como desconto, a empresa poderá pagar impostos sobre o valor total da venda (incluindo a parte paga com cashback), o que gera custos fiscais indevidos e divergências na conciliação contábil.
   
   

3. Onde encontro o "Nome da conta da VTEX" para enviar ao suporte da Dito?
   
   Resposta: Esta informação pode ser visualizada no campo “Nome da conta principal” dentro do painel da VTEX, seguindo o caminho: Configurações da conta > Conta.
   
   

4. A chave de API gerada pode ser visualizada novamente caso eu perca o Token?
   
   Resposta: Não. Por questões de segurança, o token da aplicação é exibido apenas uma vez no momento da geração. Caso o perca, será necessário gerar uma nova chave de API seguindo o mesmo procedimento.
   
   

5. O cashback é descontado do saldo do cliente assim que ele finaliza a compra?
   
   Resposta: O uso do cashback é reservado no checkout, mas a sua consolidação (baixa definitiva) ocorre apenas após o pedido ser faturado na plataforma VTEX.