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