Documentação das APIs

Cria uma transação via boleto

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ção
IdentificadorTextoIdentificador da transação.
IdentificadorSessaoTextoInforme o campo IdentificadorSessao
TipoEcommerceTextoB2B/B2C(opcional)
ClienteIPTextoIP do cliente final da transação. (opcional)
MensagemParaPresenteTextoMensagem de presente informada pelo comprador(opcional)
ObservaçãoTextoObservações referente ao pedido(opcional)
OrigemPedidoTextoOrigem do Pedido(opcional)
OrigemComplementarTextoID do canal(opcional)
DataReservaVooTextoData de reserva do voo(opcional)
IdentificadorProdutoNúmeroIdentificador do tipo de análise realizado(opcional)
DadosCobrancaDadosCobrancaDados do comprador
DadosEntregaDadosEntregaDados da entrega(opcional)
DadosPagamentosArray[DadosPagamentos]Informação dos dados de pagamentos
ProdutosServicosArray[ProdutosServicos]Dados dos produtos e serviços adquiridos
PassageirosArray[Passageiros]Dados do(s) passageiro(s) (opcional)
ConexoesAereasArray[ConexoesAereas]Dados das conexões da passagem comprada(opcional)
DadosCobranca--
CodigoClienteTextoIdentificador do cliente(opcional)
TipoClienteTextoOpção do tipo do cliente, sendo pessoa física ou Jurídica[CPF ou CNPJ]
ClienteCPFCNPJTextoCPF/CNPJ do cliente final da transação.
ClienteRGIETextoRG ou Inscrição estadual (IE) do cliente final (pcional)
ClienteNomeTextoNome do cliente final da transação.
ClienteDataNascimentoTextoData de nascimento do cliente (pcional)
ClienteEmailTextoE-mail do cliente final da transação (opcional).
ClienteSexoTextoSexo do cliente final da compra, podendo ser M (masculino) ou F (feminino) (opcional).
DadosEnderecoDadosEnderecoDados do Endereço (opcional).
TelefonesArray[Telefone]Dados do telefone do cliente (opcional).
DadosEntrega--
CodigoClienteTextoCódigo de identificação do cliente final (opcional)
TipoClienteTextoOpção do tipo do cliente, sendo pessoa física ou Jurídica[CPF ou CNPJ] (opcional)
ClienteCPFCNPJTextoCPF/CNPJ do cliente final da transação.
ClienteRGIETextoRG ou Inscrição estadual (IE) do cliente final (opcional)
ClienteNomeTextoNome do cliente final da transação. (opcional)
ClienteDataNascimentoTextoData de nascimento do cliente (opcional)
ClienteEmailTextoE-mail do cliente final da transação (opcional).
ClienteSexoTextoSexo do cliente final da compra, podendo ser M (masculino) ou F (feminino) (opcional).
DadosEnderecoTextoDados do Endereço (opcional).
TelefonesArray[Telefone]Dados do telefone do cliente (opcional).
ProdutosServicosArray[ProdutosServicos]Descrição dos produtos e serviços adquiridos (opcional)
PrazoEntregaTextoPrazo da entrega previsto do produto (opcional)
ValorFreteNúmeroValor do frete da entrega (opcional)
DadosPagamento--
NumeroSequencialNúmeroSequência de realização do pagamento (opcional)
DataPagamentoTextoData da efetivação do pagamento (opcional)
ValorPagoNumérico com 2 decimaisValor pago da transação.
TipoPagamentoNúmeroCartão de crédito
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. (opcional)
CartaoCartãoDados do Cartão
ProdutoServico--
CodigoProdutoServicoTextoCódigo identificador do Produto ou Serviço (Opcional)
NomeProdutoServicoTextoNome do produto ou descrição do serviço
ValorProdutoServicoNúmeroValor do produto ou serviço (opcional)
QuantidadeProdutoServicoNúmeroQuantidade do produto ou serviço (opcional)
CodCategoriaProdutoServicoNúmeroCódigo para identificar a categoria do produto ou serviço (opcional)
NomeCategoriaProdutoServicoTextoNome para identificar a categoria do produto ou serviço (opcional)
NomeVendedorProdutoServicoTextoNome do vendedor (opcional)
VendedorProdutoServicoCPFCNPJTextoCPF ou CNPJ do vendedor (opcional)
MarketPlaceBoleanoTrue ou False para informar se o vendedor é marketplace (opcional)
VendedorProdutoServicoSegmentoTextoArea de atuação do vendedor (opcional)
Passageiro--
NomePassageiroTextoNome do passageiro
CompanhiaDeMilhagemTextoCompanhia na qual é acumulado Milhagem (opcional)
CartaoDeMilhagemTextoNúmero do cartão de Milhagem (opcional)
TipoIdentificacaoTextoDocumento de identificação do passageiro, podendo ser: CPF, CNPJ, RG, IE, Passaporte, CTPS, Titulo Eleitor (opcional)
NumeroIdentificacaoTextoNúmero de identificação do passageiro, conforme tipo de identificação selecionado (opcional)
PassageiroSexoTextoSexo do passageiro, podendo ser M (masculino) ou F (feminino) (opcional).
PassageiroDataNascimentoTextoData de nascimento do passageiro (Opcional)
PassageiroCPFTextoCPF do Passageiro (opcional)
ConexaoAerea--
CompanhiaAereaTextoCompanhia aérea do voo (opcional)
NumeroViagemNúmeroNúmero da viagem do voo (opcional)
DataViagemData/horaData/hora da viagem (opcional)
ClasseAssentoTextoClasse e Assento da passagem (opcional)
OrigemViagemTextoO local de origem da viagem (opcional)
DestinoViagemTextoO local de destino da viagem (opcional)
DataEmbarqueTextoData de embarque do voo (opcional)
DataDesembarqueTextoData de desembarque do voo (opcional)
ClasseTarifariaTextoClasse tarifária da passagem (opcional)
DadosEndereco--
ClienteEnderecoTextoNome do logradouro (opcional).
ClienteNumeroTextoNúmero do endereço do cliente final da compra (opcional).
ClienteComplementoTextoComplemento do endereço do cliente final da compra (opcional).
ClienteBairroTextoBairro do cliente final da compra (opcional).
ClienteCidadeTextoCidade do cliente final da compra (opcional).
ClienteUFTextoUF do cliente final da compra
ClienteCEPTextoCEP do cliente final da compra
ClientePaisTextoPaís do cliente final da compra
ClientePontoDeReferenciaTextoPonto de referência da localização do cliente final da compra (opcional).
Telefone--
TelefoneTipoTextoTipo de telefone, podendo ser: NaoDefinid, Residencial, Comercial, Recados, Cobranca, Temporario, Celular. (opcional)
DDINúmeroDDI do telefone do cliente final da compra (opcional).
DDDNúmeroDDD do telefone do cliente final da compra (opcional).
TelefoneNumeroNúmeroNúmero do telefone do cliente final da transação (opcional).
TelefoneRamalTextoNúmero do ramal do cliente final da transação (opcional).
Cartao--
NumeroCartaoNumérico de 16 posiçõesNúmero do Cartão (opcional)
CardTokenTextoCódigo identificador do token do cartão (opcional)
BinTexto6 primeiros números do cartão de crédito
EndTexto4 últimos números do cartão de crédito
BandeiraTextoBandeira do cartão, podendo ser: Diners, MasterCard, Visa, Outros, AmericanExpress, HiperCard, Aura, Elo. (opcional)
DataValidadeAno/Mês no formato AAAAMMData de validade do cartão. (opcional)
NomeImpressoTextoNome do cliente impresso no cartão. (opcional)
ClienteCPFCNPJTextoCPF/CNPJ do cliente final do proprietário do cartão.
NsuOperacaoTextoNúmero de identificador único de uma transação de cartão (opcional)
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!