Antifraude

As APIs de pagamentos antifraude funcionam como um intermediário entre o sistema de pagamento da loja e uma solução antifraude especializada. As lojas coletam dados da transação, como valor, endereço de entrega, dados do cartão, e os enviam para a solução antifraude para análise.
Com base na análise, a solução antifraude envia uma resposta, indicando se a transação deve ser aprovada ou recusada.

Requisição

CampoTipoDescriçãoObrigatório
IdentificadorGUIDIdentificador da transação de cartão de crédito que esta Pendente de Análise de Antifraude.Sim
IdentificadorSessaoGUIDInforme o campo IdentificadorSessao. O mesmo utilizado no envio do Finger PrintSim
TipoEcommerceTextoB2B/B2CNão
ClienteIPTextoIP do cliente final da transação.Não
MensagemParaPresenteTextoMensagem de presente informada peloNão
ObservaçãoTextoObservações referente ao pedidoNão
OrigemPedidoTextoOrigem do PedidoNão
OrigemComplementarTextoID do canalNão
DataReservaVooTextoData de reserva do vooNão
IdentificadorProdutoNúmeroIdentificador do tipo de análise realizadoNão
DadosCobrancaDadosCobrancaDados do compradorSim
DadosEntregaDadosEntregaDados da entregaNão
DadosPagamentosArray[DadosPagamentos]Informação dos dados de pagamentosSim
ProdutosServicosArray[ProdutosServicos]Dados dos produtos e serviços adquiridosSim
PassageirosArray[Passageiros]Dados do(s) passageiro(s)Não
ConexoesAereasArray[ConexoesAereas]Dados das conexões da passagem compradaNão
DadosCobranca---
CodigoClienteTextoIdentificador do clienteNão
TipoClienteTextoOpção do tipo do cliente, sendo pessoa física ou Jurídica[CPF ou CNPJ]Sim
ClienteCPFCNPJTextoCPF/CNPJ do cliente final da transação.Sim
ClienteRGIETextoRG ou Inscrição estadual (IE) do cliente finalNão
ClienteNomeTextoNome do cliente final da transação.Sim
ClienteDataNascimentoTextoData de nascimento do clienteNão
ClienteEmailTextoE-mail do cliente final da transação.Não
ClienteSexoTextoSexo do cliente final da compra, podendo ser M (masculino) ou F (feminino).Não
DadosEnderecoDadosEnderecoDados do Endereço.Não
TelefonesArray[Telefone]Dados do telefone do cliente.Não
DadosEntrega---
CodigoClienteTextoCódigo de identificação do cliente finalNão
TipoClienteTextoOpção do tipo do cliente, sendo pessoa física ou Jurídica[CPF ou CNPJ]Não
ClienteCPFCNPJTextoCPF/CNPJ do cliente final da transação.Sim
ClienteRGIETextoRG ou Inscrição estadual (IE) do cliente finalNão
ClienteNomeTextoNome do cliente final da transação.Não
ClienteDataNascimentoTextoData de nascimento do clienteNão
ClienteEmailTextoE-mail do cliente final da transação.Não
ClienteSexoTextoSexo do cliente final da compra, podendo ser M (masculino) ou F (feminino).Não
DadosEnderecoTextoDados do Endereço.Não
TelefonesArray[Telefone]Dados do telefone do cliente.Não
ProdutosServicosArray[ProdutosServicos]Descrição dos produtos e serviços adquiridosNão
PrazoEntregaTextoPrazo da entrega previsto do produtoNão
ValorFreteNúmeroValor do frete da entregaNão
DadosPagamento---
NumeroSequencialNúmeroSequência de realização do pagamentoNão
DataPagamentoTextoData da efetivação do pagamentoNão
ValorPagoNumérico com 2 decimaisValor pago da transação.Sim
TipoPagamentoNúmero1 (Cartão de crédito)Sim
QuantidadeParcelasNumérico InteiroQuantidade de parcelas, caso a forma de pagamento seja parcelada.Válidos valores de 2 até 12. Caso seja a vista, pode-se não enviar o valor ou enviar 1.Não
CartaoCartãoDados do CartãoSim
ProdutoServico---
CodigoProdutoServicoTextoCódigo identificador do Produto ou ServiçoNão
NomeProdutoServicoTextoNome do produto ou descrição do serviçoSim
ValorProdutoServicoNúmeroValor do produto ou serviçoNão
QuantidadeProdutoServicoNúmeroQuantidade do produto ou serviçoNão
CodCategoriaProdutoServicoNúmeroCódigo para identificar a categoria do produto ou serviçoNão
NomeCategoriaProdutoServicoTextoNome para identificar a categoria do produto ou serviçoNão
NomeVendedorProdutoServicoTextoNome do vendedorNão
VendedorProdutoServicoCPFCNPJTextoCPF ou CNPJ do vendedorNão
MarketPlaceBooleanoTrue ou False para informar se o vendedor é marketplaceNão
VendedorProdutoServicoSegmentoTextoArea de atuação do vendedorNão
Passageiro---
NomePassageiroTextoNome do passageiro
CompanhiaDeMilhagemTextoCompanhia na qual é acumulado MilhagemNão
CartaoDeMilhagemTextoNúmero do cartão de MilhagemNão
TipoIdentificacaoTextoDocumento de identificação do passageiro, podendo ser: CPF, CNPJ, RG, IE, Passaporte, CTPS, Titulo EleitorNão
NumeroIdentificacaoTextoNúmero de identificação do passageiro, conforme tipo de identificação selecionadoNão
PassageiroSexoTextoSexo do passageiro, podendo ser M (masculino) ou F (feminino).Não
PassageiroDataNascimentoTextoData de nascimento do passageiroNão
PassageiroCPFTextoCPF do PassageiroNão
ConexaoAerea---
CompanhiaAereaTextoCompanhia aérea do vooNão
NumeroViagemNúmeroNúmero da viagem do vooNão
DataViagemData/horaData/hora da viagemNão
ClasseAssentoTextoClasse e Assento da passagemNão
OrigemViagemTextoO local de origem da viagemNão
DestinoViagemTextoO local de destino da viagemNão
DataEmbarqueTextoData de embarque do vooNão
DataDesembarqueTextoData de desembarque do vooNão
ClasseTarifariaTextoClasse tarifária da passagemNão
DadosEndereco---
ClienteEnderecoTextoNome do logradouro.Não
ClienteNumeroTextoNúmero do endereço do cliente final da compra.Não
ClienteComplementoTextoComplemento do endereço do cliente final da compra.Não
ClienteBairroTextoBairro do cliente final da compra.Não
ClienteCidadeTextoCidade do cliente final da compra.Não
ClienteUFTextoUF do cliente final da compraSim
ClienteCEPTextoCEP do cliente final da compraSim
ClientePaisTextoPaís do cliente final da compraSim
ClientePontoDeReferenciaTextoPonto de referência da localização do cliente final da compra.Não
Telefone---
TelefoneTipoTextoTipo de telefone, podendo ser: NaoDefinid, Residencial, Comercial, Recados, Cobranca, Temporario, Celular.Não
DDINúmeroDDI do telefone do cliente final da compra.Não
DDDNúmeroDDD do telefone do cliente final da compra.Não
TelefoneNumeroNúmeroNúmero do telefone do cliente final da transação.Não
TelefoneRamalTextoNúmero do ramal do cliente final da transação.Não
Cartao---
NumeroCartaoNumérico de 16 posiçõesNúmero do CartãoNão
CardTokenGUIDCódigo identificador do token do cartãoNão
BinTexto6 primeiros números do cartão de créditoSim
EndTexto4 últimos números do cartão de créditoSim
BandeiraTextoBandeira do cartão, podendo ser: Diners, MasterCard, Visa, Outros, AmericanExpress, HiperCard, Aura, Elo.Não
DataValidadeAno/Mês no formato AAAAMMData de validade do cartão.Não
NomeImpressoTextoNome do cliente impresso no cartão.Não
ClienteCPFCNPJTextoCPF/CNPJ do cliente final do proprietário do cartão.Sim
NsuOperacaoTextoNúmero de identificador único de uma transação de cartãoNão

Resposta

CampoTipoDescrição
RetornoTextoRetorno da chamada, podendo possuir os valores OK ou ERRO.
DetalhesTextoDetalhes do erro gerado, caso o retorno seja ERRO.
IdentificadorTextoDetalhes do erro gerado, caso o retorno seja ERRO.
StatusTextoStatus é o resultada da análise, podendo ser: APA: (Aprovação Automática) – Pedido foi aprovado automaticamente segundo parâmetros definidos na regra de aprovação automática. RPA: (Reprovação Automática) – Pedido Reprovado Automaticamente por algum tipo de Regra de Negócio que necessite aplicá-la. RPP: (Reprovação Por Política) – Pedido reprovado automaticamente por política estabelecida pelo cliente ou Clearsale. APP: (Aprovação Por Política) – Pedido aprovado automaticamente por política estabelecida pelo cliente ou Clearsale.
ScoreNúmeroScore é um valor de 0 a 100 atribuído a consulta que avalia o nível de risco de fraude de identidade
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!