v1

latestOpenAPI 3.0.12026-07-261451591021.8 KB

AntiFraude

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

Campo	Tipo	Descrição	Obrigatório
Identificador	GUID	Identificador da transação de cartão de crédito que esta Pendente de Análise de Antifraude	Sim
IdentificadorSessao	GUID	Informe o campo IdentificadorSessao. O mesmo utilizado no envio do Finger Print	Sim
TipoEcommerce	Texto	B2B/B2C	Não
ClienteIP	Texto	IP do cliente final da transação	Não
MensagemParaPresente	Texto	Mensagem de presente informada pelo comprador	Não
Observação	Texto	Observações referente ao pedido	Não
OrigemPedido	Texto	Origem do Pedido	Não
OrigemComplementar	Texto	ID do canal	Não
DataReservaVoo	Texto	Data de reserva do voo	Não
IdentificadorProduto	Número	Identificador do tipo de análise realizado	Não
DadosCobranca	DadosCobranca	Dados do comprador	Sim
DadosEntrega	DadosEntrega	Dados da entrega	Não
DadosPagamentos	Array[DadosPagamentos]	Informação dos dados de pagamentos	Sim
ProdutosServicos	Array[ProdutosServicos]	Dados dos produtos e serviços adquiridos	Sim
Passageiros	Array[Passageiros]	Dados do(s) passageiro(s)	Não
ConexoesAereas	Array[ConexoesAereas]	Dados das conexões da passagem comprada	Não
DadosCobranca	-	-	-
CodigoCliente	Texto	Identificador do cliente	Não
TipoCliente	Texto	Opção do tipo do cliente, sendo pessoa física ou Jurídica[CPF ou CNPJ]	Sim
ClienteCPFCNPJ	Texto	CPF/CNPJ do cliente final da transação	Sim
ClienteRGIE	Texto	RG ou Inscrição estadual (IE) do cliente final	Não
ClienteNome	Texto	Nome do cliente final da transação	Sim
ClienteDataNascimento	Texto	Data de nascimento do cliente	Não
ClienteEmail	Texto	E-mail do cliente final da transação	Não
ClienteSexo	Texto	Sexo do cliente final da compra, podendo ser M (masculino) ou F (feminino)	Não
DadosEndereco	DadosEndereco	Dados do Endereço	Não
Telefones	Array[Telefone]	Dados do telefone do cliente	Não
DadosEntrega	-	-	-
CodigoCliente	Texto	Código de identificação do cliente final	Não
TipoCliente	Texto	Opção do tipo do cliente, sendo pessoa física ou Jurídica[CPF ou CNPJ]	Não
ClienteCPFCNPJ	Texto	CPF/CNPJ do cliente final da transação	Sim
ClienteRGIE	Texto	RG ou Inscrição estadual (IE) do cliente final	Não
ClienteNome	Texto	Nome do cliente final da transação	Não
ClienteDataNascimento	Texto	Data de nascimento do cliente	Não
ClienteEmail	Texto	E-mail do cliente final da transação	Não
ClienteSexo	Texto	Sexo do cliente final da compra, podendo ser M (masculino) ou F (feminino)	Não
DadosEndereco	Texto	Dados do Endereço	Não
Telefones	Array[Telefone]	Dados do telefone do cliente	Não
ProdutosServicos	Array[ProdutosServicos]	Descrição dos produtos e serviços adquiridos	Não
PrazoEntrega	Texto	Prazo da entrega previsto do produto	Não
ValorFrete	Número	Valor do frete da entrega	Não
DadosPagamento	-	-	-
NumeroSequencial	Número	Sequência de realização do pagamento	Não
DataPagamento	Texto	Data da efetivação do pagamento	Não
ValorPago	Numérico com 2 decimais	Valor pago da transação	Sim
TipoPagamento	Número	1 (Cartão de crédito)	Sim
QuantidadeParcelas	Numérico Inteiro	Quantidade 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
Cartao	Cartão	Dados do Cartão	Sim
ProdutoServico	-	-	-
CodigoProdutoServico	Texto	Código identificador do Produto ou Serviço	Não
NomeProdutoServico	Texto	Nome do produto ou descrição do serviço	Sim
ValorProdutoServico	Número	Valor do produto ou serviço	Não
QuantidadeProdutoServico	Número	Quantidade do produto ou serviço	Não
CodCategoriaProdutoServico	Número	Código para identificar a categoria do produto ou serviço	Não
NomeCategoriaProdutoServico	Texto	Nome para identificar a categoria do produto ou serviço	Não
NomeVendedorProdutoServico	Texto	Nome do vendedor	Não
VendedorProdutoServicoCPFCNPJ	Texto	CPF ou CNPJ do vendedor	Não
MarketPlace	Booleano	True ou False para informar se o vendedor é marketplace	Não
VendedorProdutoServicoSegmento	Texto	Area de atuação do vendedor	Não
Passageiro	-	-	-
NomePassageiro	Texto	Nome do passageiro
CompanhiaDeMilhagem	Texto	Companhia na qual é acumulado Milhagem	Não
CartaoDeMilhagem	Texto	Número do cartão de Milhagem	Não
TipoIdentificacao	Texto	Documento de identificação do passageiro, podendo ser: CPF, CNPJ, RG, IE, Passaporte, CTPS, Titulo Eleitor	Não
NumeroIdentificacao	Texto	Número de identificação do passageiro, conforme tipo de identificação selecionado	Não
PassageiroSexo	Texto	Sexo do passageiro, podendo ser M (masculino) ou F (feminino)	Não
PassageiroDataNascimento	Texto	Data de nascimento do passageiro	Não
PassageiroCPF	Texto	CPF do Passageiro	Não
ConexaoAerea	-	-	-
CompanhiaAerea	Texto	Companhia aérea do voo	Não
NumeroViagem	Número	Número da viagem do voo	Não
DataViagem	Data/hora	Data/hora da viagem	Não
ClasseAssento	Texto	Classe e Assento da passagem	Não
OrigemViagem	Texto	O local de origem da viagem	Não
DestinoViagem	Texto	O local de destino da viagem	Não
DataEmbarque	Texto	Data de embarque do voo	Não
DataDesembarque	Texto	Data de desembarque do voo	Não
ClasseTarifaria	Texto	Classe tarifária da passagem	Não
DadosEndereco	-	-	-
ClienteEndereco	Texto	Nome do logradouro	Não
ClienteNumero	Texto	Número do endereço do cliente final da compra	Não
ClienteComplemento	Texto	Complemento do endereço do cliente final da compra	Não
ClienteBairro	Texto	Bairro do cliente final da compra	Não
ClienteCidade	Texto	Cidade do cliente final da compra	Não
ClienteUF	Texto	UF do cliente final da compra	Sim
ClienteCEP	Texto	CEP do cliente final da compra	Sim
ClientePais	Texto	País do cliente final da compra	Sim
ClientePontoDeReferencia	Texto	Ponto de referência da localização do cliente final da compra	Não
Telefone	-	-	-
TelefoneTipo	Texto	Tipo de telefone	Não
DDI	Número	DDI do telefone do cliente final da compra	Não
DDD	Número	DDD do telefone do cliente final da compra	Não
TelefoneNumero	Número	Número do telefone do cliente final da transação	Não
TelefoneRamal	Texto	Número do ramal do cliente final da transação	Não
Cartao	-	-	-
NumeroCartao	Numérico de 16 posições	Número do Cartão	Não
CardToken	GUID	Código identificador do token do cartão	Não
Bin	Texto	6 primeiros números do cartão de crédito	Sim
End	Texto	4 últimos números do cartão de crédito	Sim
Bandeira	Texto	Bandeira do cartão	Não
DataValidade	Ano/Mês no formato AAAAMM	Data de validade do cartão	Não
NomeImpresso	Texto	Nome do cliente impresso no cartão	Não
ClienteCPFCNPJ	Texto	CPF/CNPJ do cliente final do proprietário do cartão	Sim
NsuOperacao	Texto	Número de identificador único de uma transação de cartão	Não

Resposta

Campo	Tipo	Descrição
Retorno	Texto	Retorno da chamada, podendo possuir os valores OK ou ERRO
Detalhes	Texto	Detalhes do erro gerado, caso o retorno seja ERRO
Identificador	Texto	Detalhes do erro gerado, caso o retorno seja ERRO
Status	Texto	Status é 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
Score	Número	Score é um valor de 0 a 100 atribuído a consulta que avalia o nível de risco de fraude de identidade

post/api/antifraude/incluir

Headers

Aeskeystring required

Request body

Identificadorstring required

IdentificadorSessaostring required

TipoEcommercestring

ClienteIPstring

MensagemParaPresentestring

Observacaostring

OrigemPedidostring

OrigemComplementarstring

DataReservaVoostring date-time

IdentificadorProdutointeger

Example request

{
  "Identificador": "ccb16f6e-bdd6-42fe-be8e-717424d83f03",
  "IdentificadorSessao": "20dac23c-a117-4621-a56a-51517d5861ea",
  "TipoEcommerce": "B2C",
  "ClienteIP": "127.0.0.1",
  "MensagemParaPresente": "Mensagem para presente",
  "Observacao": "Mensgem de observação",
  "OrigemPedido": "Exemplo OrigemPedido API",
  "OrigemComplementar": "Exemplo OrigemComplementar API",
  "DataReservaVoo": "2026-08-12T00:00:00",
  "IdentificadorProduto": 10,
  "DadosCobranca": {
    "CodigoCliente": "1234567890",
    "TipoCliente": "CPF",
    "ClienteCPFCNPJ": "48455151480",
    "ClienteRGIE": "97427574",
    "ClienteNome": "Renato Samuel Augusto Baptista",
    "ClienteDataNascimento": "1953-04-21T00:00:00",
    "ClienteEmail": "renatosamuel@umdominio.com.br",
    "ClienteSexo": "M",
    "DadosEndereco": {
      "ClienteEndereco": "Rua Canadá, 257",
      "ClienteNumero": "1000",
      "ClienteComplemento": "Casa 2",
      "ClienteBairro": "Bacacheri",
      "ClienteCidade": "Curitiba",
      "ClienteUF": "PR",
      "ClienteCEP": "82510290",
      "ClientePais": "Brasil",
      "ClientePontoDeReferencia": "Exemplo ponto referencia API"
    },
    "Telefones": [
      {
        "TelefoneTipo": "Celular",
        "DDI": 55,
        "DDD": 41,
        "TelefoneNumero": 999293802,
        "TelefoneRamal": "1234"
      }
    ]
  },
  "DadosEntrega": {
    "CodigoCliente": "1234567890",
    "TipoCliente": "CPF",
    "ClienteCPFCNPJ": "48455151480",
    "ClienteRGIE": "97427574",
    "ClienteNome": "Renato Samuel Augusto Baptista",
    "ClienteDataNascimento": "1953-04-21T00:00:00",
    "ClienteEmail": "renatosamuel@umdominio.com.br",
    "ClienteSexo": "M",
    "DadosEndereco": {
      "ClienteEndereco": "Rua Canadá, 257",
      "ClienteNumero": "1000",
      "ClienteComplemento": "Casa 2",
      "ClienteBairro": "Bacacheri",
      "ClienteCidade": "Curitiba",
      "ClienteUF": "PR",
      "ClienteCEP": "82510290",
      "ClientePais": "Brasil",
      "ClientePontoDeReferencia": "Exemplo ponto referencia API"
    },
    "Telefones": [
      {
        "TelefoneTipo": "Celular",
        "DDI": 55,
        "DDD": 41,
        "TelefoneNumero": 999293802,
        "TelefoneRamal": "1234"
      }
    ],
    "PrazoEntrega": "15 dias",
    "ValorFrete": 25
  },
  "DadosPagamentos": [
    {
      "NumeroSequencial": 1,
      "DataPagamento": "2026-05-21T00:00:00-03:00",
      "ValorPago": 150.99,
      "TipoPagamento": 1,
      "QuantidadeParcelas": 1,
      "Cartao": {
        "NumeroCartao": "4024007105862618",
        "CardToken": "e94ced3f-2b65-4298-82c0-82a15749a953",
        "Bin": "402400",
        "End": "2618",
        "Bandeira": "MasterCard",
        "DataValidade": "203005",
        "NomeImpresso": "Renato Samuel Augusto Baptista",
        "ClienteCPFCNPJ": "48455151480",
        "NsuOperacao": "123456789"
      }
    }
  ],
  "ProdutosServicos": [
    {
      "CodigoProdutoServico": "1",
      "NomeProdutoServico": "Explo API NomeProdutoServico",
      "ValorProdutoServico": 100,
      "QuantidadeProdutoServico": 1,
      "CodCategoriaProdutoServico": 1,
      "NomeCategoriaProdutoServico": "Explo API NomeCategoriaProdutoServico",
      "NomeVendedorProdutoServico": "Explo API NomeVendedorProdutoServico",
      "VendedorProdutoServicoCPFCNPJ": "41857509000132",
      "MarketPlace": false,
      "VendedorProdutoServicoSegmento": "Explo API VendedorProdutoServicoSegmento"
    }
  ],
  "Passageiros": [
    {
      "NomePassageiro": "Renato Samuel Augusto Baptista",
      "CompanhiaDeMilhagem": "Gol",
      "CartaoDeMilhagem": "5277749043667861",
      "TipoIdentificacao": "CPF",
      "NumeroIdentificacao": "48455151480",
      "PassageiroSexo": "M",
      "PassageiroDataNascimento": "1953-04-21T00:00:00",
      "PassageiroCPF": "48455151480"
    }
  ],
  "ConexoesAereas": [
    {
      "CompanhiaAerea": "Gol",
      "NumeroViagem": 123,
      "DataViagem": "2026-12-25T00:00:00",
      "ClasseAssento": "1",
      "OrigemViagem": "CWB",
      "DestinoViagem": "TOR",
      "DataEmbarque": "2026-12-25T00:00:00",
      "DataDesembarque": "2026-12-26T00:00:00",
      "ClasseTarifaria": "1"
    }
  ]
}

Response

Incluir Antifraude da Transacao

Retorno'OK' | 'ERRO'

Detalhesstring

Identificadorstring

Statusstring

Scorenumber double

All 145 operations