Integração com a Varejo Online

Criada por Isabelly Souza, Modificado em Qui, 16 Jul na (o) 11:02 AM por Isabelly Souza

Configuração

Configuração BonifiQ

Com a integração deve ser feita do lado do PDV, precisamos primeiro gerar as chaves de API para que a configuração de integração possa ser feita do lado da Varejo Online.

Para isso, no admin dentro do tenant que deseja, clique em Empresa e em seguida na opção <>API:

Clique em “+ Credencial de API e escolha a opção “Privada”

Insira um nome válido, clique em “PDV” e em seguida em “Gerar credencial”:

Observação: essa etapa é importante para sabermos a finalidade da integração que será realizada.

Após o aviso de que apresentado em tela (a chave e senha gerada, serão visualizadas apenas uma vez. Documente e compartilhe a informação com o cliente de forma consciente e segura), clique em “Entendido”.

Visualize as informações apresentadas em tela, documente as informações e compartilhe de forma segura com a agência responsável para que possam seguir com as configurações de integração:

Configuração Varejo Online

A ativação é self-service e realizada diretamente no cadastro da empresa no Varejo Online, utilizando as credenciais da BonifiQ.
Essa configuração é de responsabilidade do cliente, no entanto podemos apoiá-los nessas etapas. Por isso é importante entender o passo a passo a seguir dentro da Varejo Online:

Acesse Cadastro de Empresa > Gerenciadores de Pagamentos e Cashback
Localize BonifiQ na lista de integrações disponíveis
Ative a integração e insira o Usuário e a Senha de API da BonifiQ
Salve as configurações — a integração já estará disponível para uso

? As credenciais são vinculadas à empresa. Um mesmo cliente pode configurar a integração em outras empresas da mesma base ou de bases diferentes, sem bloqueios adicionais.

Funcionalidades e configurações disponíveis

1. Verificação de resgate com PIN

É possível configurar a integração para solicitar um PIN no momento do resgate de cashback. Quando ativado:

O cliente informa o PIN para confirmar o resgate
Se o PIN for inválido, a tela é bloqueada — a operação não pode continuar até que um PIN correto seja informado ou a venda seja cancelada

Obs: Nessa etapa é necessário solicitar essa ativação ao CS responsável por sua conta, ou abrir um chamado para nosso time de suporte.

2. Representatividade do Cashback

É possível definir o percentual máximo do valor do pedido que pode ser pago com cashback.

Exemplo: configurado em 60%, em uma compra de R$ 100 o cliente pode utilizar até R$ 60 de cashback.

3. Consulta de Saldo

O saldo de cashback do consumidor pode ser consultado diretamente no histórico do cadastro do terceiro (cliente) no PDV. O painel exibe:

Saldo total disponível na carteira
Percentual máximo aplicável ao pedido (conforme configuração da loja)

A consulta também é exibida automaticamente ao iniciar um novo pedido para um cliente cadastrado com saldo disponível.

4. Fluxo de Resgate (Venda com Cashback)

Ao iniciar uma venda para um cliente cadastrado com saldo disponível, o PDV exibe automaticamente o saldo e o valor máximo que pode ser utilizado. O atendente pode aplicar ou ignorar o cashback disponível.

Sem validação de PIN

O cashback é aplicado diretamente, sem etapa de confirmação adicional

Com validação de PIN

O sistema solicita o PIN antes de concluir o resgate
PIN inválido bloqueia a operação até correção ou cancelamento da venda

5. Troca

A Varejo Online não possui um fluxo nativo de troca — toda troca é tratada como um cancelamento parcial do item devolvido seguido de uma nova venda pelo item recebido.

Comportamento na integração:

O item devolvido gera um cancelamento parcial, com remoção proporcional dos pontos da compra original
O novo item é registrado como uma nova venda com o valor real do produto (mesmo que o cliente não pague diferença) — a BonifiQ gera crédito com base nesse valor
No balanço final, os pontos permanecem equivalentes à compra original

Quando o item de troca tiver valor diferente do devolvido (ex.: boné R$ 50 trocado por boné R$ 60), a BonifiQ receberá o valor real do novo item (R$ 60), gerando crédito proporcional.

6. Devoluções e Cancelamentos

O comportamento da integração varia conforme o tipo de operação pós-venda realizada no PDV.

Operação	Pontos gerados pela compra	Cashback utilizado no pedido
Cancelamento	Removidos proporcionalmente ao valor cancelado	Estornado automaticamente para a carteira do cliente
Devolução total	Removidos integralmente	Opção de estorno automatico para a carteira do cliente*
Devolução parcial	Removidos proporcionalmente ao valor devolvido	Opção de estorno automatico para a carteira do cliente*

Obs: Nessa etapa é necessário solicitar essa ativação ao CS responsável por sua conta, ou abrir um chamado para nosso time de suporte.

Importante

A funcionalidade de integração está disponível para todos os clientes que possuem o módulo de integrações/API habilitado em seus planos ou seja, Growth e Advanced.