Indicações
Entendendo indicações - vendas rastreadas atribuídas via códigos de cupom.
Indicações
Uma indicação é uma venda rastreada que foi atribuída a um membro via seu código de cupom único. Quando um novo cliente usa o cupom de um membro no checkout, o Rafobase cria um registro de indicação e credita a carteira do membro.
Fluxo de Indicação
Propriedades da Indicação
| Propriedade | Tipo | Descrição |
|---|---|---|
id | string | Identificador único (UUID) |
referrerId | string | O indicador que recebe crédito |
refereeEmail | string | Email do novo cliente |
refereeExternalId | string | Seu ID para o novo cliente |
externalOrderId | string | ID de pedido externo do checkout |
orderAmount | number | Valor total do pedido em centavos |
rewardAmount | number | Recompensa calculada em centavos |
source | enum | Plataforma de origem (guru, yampi) |
couponUsed | string | Código de cupom utilizado na compra |
status | enum | pending, approved, rejected, cancelled |
createdAt | datetime | Quando a indicação foi criada |
Status da Indicação
| Status | Descrição | Efeito na Carteira |
|---|---|---|
pending | Aguardando período de garantia | Sem crédito imediato — aguardando garantia |
approved | Garantia passou, válida | Cria transação credit com status available |
rejected | Falhou na validação (fraude, etc.) | Sem crédito |
cancelled | Pedido reembolsado/cancelado | Reverte crédito |
Transições de Status
┌───────────┐
│ pending │
└─────┬─────┘
│
┌──────────┼──────────┐
▼ ▼ ▼
┌─────────┐ ┌─────────┐ ┌─────────┐
│approved │ │rejected │ │cancelled│
└─────────┘ └─────────┘ └─────────┘Cálculo de Recompensa
A recompensa é calculada com base nas configurações da sua campanha:
Baseada em Percentual
reward = order_value × (campaign.reward_percentage / 100)Exemplo: Recompensa de 10% em pedido de R$200 = R$20
Valor Fixo
reward = campaign.fixed_reward_amountExemplo: Recompensa fixa de R$15 independentemente do valor do pedido
A transação na carteira é criada somente quando a indicação é aprovada após o período de garantia. Enquanto a indicação está pendente, nenhum crédito é registrado na carteira.
Período de Garantia
O período de garantia protege contra:
- Cancelamentos de pedido
- Reembolsos
- Contestações
Durante este período:
- O crédito está em status
pending - O membro não pode resgatar este crédito
- Se o pedido for cancelado/reembolsado, o crédito é automaticamente revertido
Períodos de garantia típicos: 7-30 dias
Validação Anti-Fraude
Rafobase valida automaticamente as indicações para prevenir fraude de auto-indicação:
| Verificação | Descrição |
|---|---|
| Correspondência de Email | Email do indicado ≠ Email do indicador |
| Correspondência de CPF | CPF do indicado ≠ CPF do indicador (se disponível) |
| Mesmo Lar | Verificações opcionais de IP/dispositivo |
Validações com falha resultam em status rejected com um código de motivo.
Visualizando Indicações
Painel
Navegue para Indicações para ver todas as indicações com opções de filtro:
- Por status
- Por membro
- Por intervalo de data
- Por valor do pedido
API
# Liste indicações de um membro
curl "https://api.rafobase.com/api/v1/member/referrals?email=customer@example.com" \
-H "X-API-Key: $RAFOBASE_API_KEY"Relacionado
- Membros - Quem pode fazer indicações
- Carteira - Como os créditos funcionam
- Guia de Webhooks - Configurando webhooks de pedidos