VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

Antifraude

Pontuação de risco dos pedidos com o ClearSale, fila de revisão manual e totais.

O antifraude avalia cada pedido antes de a loja entregar: um serviço externo, o ClearSale, dá uma pontuação de risco (de 0 a 100) e uma recomendação. Pedidos de risco baixo seguem; os de risco alto são reprovados; os do meio caem numa fila de revisão manual para uma pessoa decidir.

São as rotas do administrador da loja.

Pontos principais
  • Exige o módulo clearsale ativo e as credenciais do ClearSale configuradas no módulo. Privilégio: manage_fraud ou manage_orders.
  • O id de uma análise é um número inteiro. Cada pedido tem no máximo uma análise.
  • A decisão manual só altera a análise; ela não aprova nem cancela o pedido.
  • O estado vem como palavra (manual_review, approved...).
  • O erro de uma lista vazia: analyses volta null, não [].

Como funciona

Pendente→Aprovada, Reprovada ou Revisão manual→Decisão do revisor
statusSignificado
pendingEnviada, aguardando o ClearSale.
approvedAprovada, pelo ClearSale ou pelo revisor.
rejectedReprovada.
manual_reviewRisco intermediário: aguarda uma pessoa decidir.
cancelledCancelada pelo revisor.
errorO ClearSale não conseguiu concluir.
blocked, challenge, review_expiredDecisões do motor antifraude nativo da plataforma: bloqueio, desafio ao comprador (por exemplo, 3DS) e revisão que estourou o prazo.

A pontuação vira o nível de risco: até 30 é low, até 60 é medium e acima disso é high.

Conceitos-chave

Limites de aprovação

Dois limites do módulo decidem quando o ClearSale não dá um veredito claro: pontuação até o limite de aprovação (padrão 30) aprova; a partir do limite de reprovação (padrão 80) reprova; no meio vai para revisão manual.

Webhook

O ClearSale também avisa a plataforma de decisões tardias por um webhook próprio, protegido por um segredo configurado no módulo. Ele não faz parte desta API de administrador.

Endpoints

MétodoCaminhoPara que servePágina
POST/api/v1/admin/fraud/analyzeAnalisar um pedidoAnalisar
GET/api/v1/admin/fraud/analysesListar análisesAnálises
GET/api/v1/admin/fraud/{id}Consultar uma análiseAnálises
PUT/api/v1/admin/fraud/{id}Registrar a decisão manualAnálises
GET/api/v1/admin/fraud/statsTotaisAnálises

Erros comuns

  • Analisar o mesmo pedido duas vezes. Responde 500: já existe análise.
  • Chamar sem credenciais configuradas. Responde 500 pedindo a chave e o token do ClearSale.
  • Filtrar por um estado com erro de grafia. Vira pending em silêncio.
  • Achar que a decisão manual libera o pedido. Só a análise muda.
  • Ler analyses sem tratar null.

Próximos passos

Analisar um pedido
Envie um pedido ao ClearSale.
Análises e revisão
Trabalhe a fila de revisão manual.
Anterior
Ajustar, reembolsar e congelar
Próxima
Analisar um pedido
Nesta página
  • Como funciona
  • Conceitos-chave
  • Limites de aprovação
  • Webhook
  • Endpoints
  • Erros comuns
  • Próximos passos