Análise de Fraude com a ClearSale

Crie um pagamento de cartão de crédito pelo Split de Pagamento usando a solução de captura API E-commerce Cielo e realize a análise de fraude para a gestão de risco do seu e-commerce.

A análise de fraude está disponível mediante contratação adicional. Saiba mais na página de soluções do e-commerce Cielo.

ℹ️
Saiba mais sobre essa funcionalidade na documentação.

🚧
Atenção:

Os campos do nó FraudAnalysis.Travel são obrigatórios caso o segmento do seu negócio seja o aéreo;

Para configurar o Fingerprint com a ClearSale, consulte o manual de Gestão de Risco.

Requisição


{
  "MerchantOrderId": "Loja123456",
  "Customer": {
    "Name": "Aline de Souza",
    "Identity": "11111111111",
    "IdentityType": "CPF",
    "Email": "[email protected]",
    "Birthdate": "1996-11-14",
    "Phone": "+55 11 5555-1001",
    "Mobile": "+55 11 5555-1001",
    "DeliveryAddress": {
      "Street": "Alameda Xingu",
      "Number": "512",
      "Complement": "27 andar",
      "ZipCode": "06455030",
      "City": "Barueri",
      "State": "SP",
      "Country": "BR",
      "District": "Alphaville"
    },
    "BillingAddress": {
      "Street": "Alameda Xingu",
      "Number": "512",
      "Complement": "21 andar",
      "ZipCode": "06455030",
      "City": "Barueri",
      "State": "SP",
      "Country": "BR",
      "District": "Alphaville"
    }
  },
  "Payment": {
    "Type": "CreditCard",
    "Provider": "Simulado",
    "Amount": 45500,
    "Installments": 1,
    "Capture": false,
    "Recurrent": false,
    "SoftDescriptor": "Nome fantasia da loja",
    "CreditCard": {
      "CardNumber": "4000021231111111",
      "Holder": "Guilherme Silva",
      "ExpirationDate": "08/2033",
      "SaveCard": false,
      "Brand": "Visa"
    },
    "FraudAnalysis": {
      "Provider": "ClearSale",
      "Sequence": "AuthorizeFirst",
      "SequenceCriteria": "OnSuccess",
      "CaptureOnLowRisk": false,
      "VoidOnHighRisk": false,
      "TotalOrderAmount": 46000,
      "Cart": {
        "IsGift": false,
        "ReturnsAccepted": true,
        "Items": [
          {
            "Name": "Mouse",
            "Quantity": 1,
            "Sku": "100010",
            "UnitPrice": 532400,
            "Type": "EletronicGood"
          },
          {
            "Name": "Windows 11 Professional",
            "Quantity": 2,
            "Sku": "100011",
            "UnitPrice": 85515,
            "Type": "EletronicSoftware"
          }
        ]
      },
      "Travel": {
        "Passengers": [
          {
            "Name": "Aline de Souza",
            "TravelLegs": [
              {
                "Origin": "SDU",
                "Destination": "CGH",
                "DepartureDate": "2025-10-09T18:30:00",
                "Boarding": "2025-10-09T18:45:00",
                "Arriving": "2025-10-09T20:00:00"
              }
            ]
          },
          {
            "Name": "Guilherme Silva",
            "TravelLegs": [
              {
                "Origin": "SDU",
                "Destination": "CGH",
                "DepartureDate": "2025-10-09T18:30:00",
                "Boarding": "2025-10-09T18:45:00",
                "Arriving": "2025-10-09T20:00:00"
              }
            ]
          }
        ]
      }
    }
  },
  "splitpayments": [
    {
      "subordinatemerchantid": "f2d6eb34-2c6b-4948-8fff-51facdd2a28f",
      "amount": 5000,
      "fares": {
        "mdr": 5,
        "fee": 30
      }
    },
    {
      "subordinatemerchantid": "f2d6eb34-2c6b-4948-8fff-51facdd2a28f",
      "amount": 5000,
      "fares": {
        "mdr": 4,
        "fee": 15
      }
    }
  ]
}

Parâmetros do cabeçalho

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
`MerchantId`	Identificador da loja na API E-commerce Cielo.	GUID	36	Sim
`MerchantKey`	Chave pública para autenticação dupla na API E-commerce Cielo.	string	40	Sim
`RequestId`	Identificador da requisição, usado quando a loja usa diferentes servidores para cada GET/POST/PUT.	GUID	36	Não

Parâmetros do corpo

Parâmetro	Tipo	Tamanho	Obrigatório	Descrição
`MerchantOrderId`	Texto	20	Sim	Número de identificação do pedido. *Atenção: Os caracteres permitidos são apenas a-z, A-Z, 0-9. Não são permitidos caracteres especiais e espaços em branco
`Customer.Name`	Texto	120	Sim	Nome completo do comprador. < br/>Atenção: Os caracteres permitidos são apenas a-z, A-Z. Não são permitidos caracteres especiais e números.
`Customer.Identity`	Texto	16	Sim	Número do documento de identificação do comprador
`Customer.IdentityType`	Texto	255	Não	Tipo de documento de identificação do comprador Possíveis valores: CPF ou CNPJ
`Customer.Email`	Texto	100	Sim	E-mail do comprador
`Customer.Birthdate`	Date	10	Sim	Data de nascimento do comprador Ex.: 1991-01-10
`Customer.Phone`	Texto	20	Não	É obrigatório enviar pelo menos um telefone. Telefone residencial. Formato +DDI DDD NNNN-NNNN Exemplo: +55 11 5555-1001.
`Customer.Mobile`	Texto	20	Não	É obrigatório enviar pelo menos um telefone. Celular. Formato +DDI DDD NNNNN-NNNN Exemplo: +55 11 99999-9999.
`Customer.Address.Street`	Texto	54	Sim	Logradouro do endereço de cobrança
`Customer.Address.Number`	Texto	5	Sim	Número do endereço de cobrança
`Customer.Address.Complement`	Texto	14	Não	Complemento do endereço de cobrança
`Customer.Address.ZipCode`	Texto	9	Sim	CEP do endereço de cobrança
`Customer.Address.City`	Texto	50	Sim	Cidade do endereço de cobrança
`Customer.Address.State`	Texto	2	Sim	Estado do endereço de cobrança
`Customer.Address.Country`	Texto	2	Sim	País do endereço de cobrança. Mais informações em ISO 2-Digit Alpha Country Code
`Customer.Address.District`	Texto	45	Sim	Bairro do endereço de cobrança
`Customer.DeliveryAddress.Street`	Texto	54	Não	Logradouro do endereço de entrega
`Customer.DeliveryAddress.Number`	Texto	5	Não	Número do endereço de entrega
`Customer.DeliveryAddress.Complement`	Texto	14	Não	Complemento do endereço de entrega
`Customer.DeliveryAddress.ZipCode`	Texto	9	Não	CEP do endereço de entrega
`Customer.DeliveryAddress.City`	Texto	50	Não	Cidade do endereço de entrega
`Customer.DeliveryAddress.State`	Texto	2	Não	Estado do endereço de entrega
`Customer.DeliveryAddress.Country`	Texto	2	Não	País do endereço de entrega. Mais informações em ISO 2-Digit Alpha Country Code
`Customer.DeliveryAddress.District`	Texto	45	Não	Bairro do endereço de entrega
`Payment.Provider`	Texto	15	Sim	Nome da provedor da autorização
`Payment.Type`	Texto	100	Sim	Tipo do meio de pagamento. Obs.: Somente o tipo CreditCard funciona com análise de fraude
`Payment.Amount`	Número	15	Sim	Valor da transação financeira em centavos Ex: 150000 = r$ 1.500,00
`Payment.Installments`	Número	2	Sim	Número de parcelas
`Payment.Capture`	Booleano		Não	Indica se a autorização deverá ser com captura automática Possíveis valores: "true"/"false" (default) Obs.: Deverá verificar junto à adquirente a disponibilidade desta funcionalidade Obs2.: Este campo deverá ser preenchido de acordo com o fluxo da análise de fraude.
`Payment.Recurrent`	Booleano		Não	Indica se a transação é do tipo recorrente Possíveis valores: true / false (default) Obs.: Este campo igual a true não irá criar uma recorrência, apenas permitirá a realização de uma transação sem a necessidade de envio do CVV e servindo de indicação para a adquirente que é a cobrança de uma transação de uma recorrência Obs2.: Somente para transações Cielo Obs3.: O campo `Payment.Authenticate` deve ser igual a false quando este for igual a true
`Payment.SoftDescriptor`	Texto	13	Não	Texto que será impresso na fatura do portador . O valor deste campo deve tornar fácil para o portador a identificação do estabelecimento onde foi realizada a compra, pois é um dos principais ofensores para chargeback
`Payment.DoSplit`	Booleano		Não	Indica se a transação será dividida entre vários participantes Possíveis valores: true / false (default)
`Payment.SplitPayments.SubordinateMerchantId`	Texto	36	Não	`MerchantId` (identificador) do seller.
`Payment.SplitPayments.Amount`	Número	--	Não	Valor líquido da participação do seller na transação, em centavos. O desconto da taxa será calculado pelo Split.
`Payment.SplitPayments.Fares.Mdr`	Texto	--	Não	MDR(%) do master a ser descontado do valor referente a participação do seller.
`Payment.SplitPayments.Fares.Fee`	Número	--	Não	Tarifa Fixa(R$) a ser descontada do valor referente a participação do seller, em centavos.
`Payment.CreditCard.CardNumber`	Texto	16	Sim	Número do cartão de crédito
`Payment.CreditCard.Holder`	Texto	25	Sim	Nome do portador impresso no cartão de crédito. Obs.: Regras de tamanho do campo podem variar de acordo com a adquirente
`Payment.CreditCard.ExpirationDate`	Texto	7	Sim	Data de validade do cartão de crédito
`Payment.CreditCard.SecurityCode`	Texto	4	Sim	Código de segurança no verso do cartão de crédito
`Payment.CreditCard.SaveCard`	Booleano	--	Não	Bandeira do cartão de crédito
`Payment.CreditCard.Brand`	Texto	10	Sim	Bandeira do cartão de crédito
`Payment.FraudAnalysis.Provider`	Texto	10	Não	Provedor de AntiFraude Nesse caso, use "ClearSale".
`Payment.FraudAnalysis.CaptureOnLowRisk`	Booleano		Não	Indica se a transação após a análise de fraude será capturada Possíveis valores: true / false (default) Obs.: Quando enviado igual a true e o retorno da análise de fraude for de baixo risco (Accept) a transação anteriormente autorizada será capturada Obs2.: Quando enviado igual a true e o retorno da análise de fraude for revisão (Review) a transação ficará autorizada. A mesma será capturada após a Cielo receber o novo status da análise manual e este for de baixo risco (Accept) Obs.: Para a utilização deste parâmetro, a sequência do fluxo de análise de risco deve ser obrigatoriamente AuthorizeFirst
`Payment.FraudAnalysis.TotalOrderAmount`	Número	15	Sim	Valor total do pedido em centavos Ex: 123456 = r$ 1.234,56
`Payment.FraudAnalysis.VoidOnHighRisk`	Booleano	--	Não	Indica se a transação será cancelada após a análise de fraude se o retorno for alto risco. Possíveis valores: true / false (default) Obs.: Quando enviado igual a true e o retorno da análise de fraude for de alto risco (Reject) a transação anteriormente autorizada será cancelada Obs2.: Quando enviado igual a true e o retorno da análise de fraude for revisão (Review) a transação ficará autorizada. A transação será cancelada após a Cielo receber o novo status da análise manual e este for alto risco (Reject) Obs.: Para a utilização deste parâmetro, a sequência do fluxo de análise de risco deve ser obrigatoriamente AuthorizeFirst
`Payment.FraudAnalysis.Sequence`	Texto	14	Sim	Tipo de fluxo da análise de fraude. Possíveis valores: “AnalyseFirst” / “AuthorizeFirst”.
`Payment.FraudAnalysis.SequenceCriteria`	Texto	09	Sim	Critério do fluxo da análise de fraude. Possíveis valores: “OnSuccess” / “Always”.
`Payment.FraudAnalysis.BrowserFingerprint`	Texto	100	Sim	Identificador utilizado para cruzar informações obtidas do dispositivo do comprador. Este mesmo identificador deve ser utilizado para gerar o valor que será atribuído ao campo `session_id` do script ou utilizando os SDKs (iOS ou Android) que será incluído na página de checkout. Obs.: Este identificador poderá ser qualquer valor ou o número do pedido, mas deverá ser único durante 48 horas.
`Payment.FraudAnalysis.Cart.IsGift`	Booleano		Não	Indica se o pedido realizado pelo comprador é para presente
`Payment.FraudAnalysis.Cart.ReturnsAccepted`	Booleano		Não	Indica se o pedido realizado pelo comprador pode ser devolvido a loja Possíveis valores: true / false (default)
`Payment.FraudAnalysis.Cart.Items.Name`	Texto	255	Sim	Nome do Produto
`Payment.FraudAnalysis.Cart.Items.Quantity`	Número	15	Sim	Quantidade do produto
`Payment.FraudAnalysis.Cart.Items.Sku`	Texto	255	Sim	SKU (Stock Keeping Unit - Unidade de Controle de Estoque) do produto
`Payment.FraudAnalysis.Cart.Items.UnitPrice`	Número	15	Não	Preço unitário do produto Ex: 10950 = r$ 109,50
`Payment.FraudAnalysis.Cart.Items.Type`	Texto	19	Sim	Categoria do produto. Tabela 36 - CartItem[n].Category..
`Payment.FraudAnalysis.Shipping.Addressee`	Texto	60	Sim	Nome do destinatário.
`Payment.FraudAnalysis.Shipping.Method`	Texto	--	Não	Meio de entrega. Lista de Valores - Payment.FraudAnalysis.Shipping.Method
`Payment.FraudAnalysis.Travel.Passengers.Name`	Texto	120	Não	Nome completo do passageiro
`Payment.FraudAnalysis.Travel.Passengers.Origin`	Texto	3	Não	Código do aeroporto de partida. Mais informações em IATA 3-Letter Codes.
`Payment.FraudAnalysis.Travel.Passengers.TravelLegs.Destination`	Texto	3	Não	Código do aeroporto de chegada. Mais informações em IATA 3-Letter Codes
`Payment.FraudAnalysis.Travel.Passengers.TravelLegs.DepartureDate`	Data	--	Não	Data do voo
`Payment.FraudAnalysis.Travel.Passengers.TravelLegs.Boarding`	Data	--	Não	Data de embarque
`Payment.FraudAnalysis.Travel.Passengers.TravelLegs.Arriving`	Data	--	Não	Data de desembarque

Resposta

{
    "MerchantOrderId": "Loja123456",
    "Customer": {
        "Name": "Aline de Souza",
        "Identity": "11111111111",
        "IdentityType": "CPF",
        "Email": "[email protected]",
        "Birthdate": "1996-11-14",
        "Phone": "+55 11 5555-1001",
        "Mobile": "+55 11 5555-1001"
        "DeliveryAddress": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "27 andar",
            "ZipCode": "12345987",
            "City": "São Paulo",
            "State": "SP",
            "Country": "BR",
            "District": "Alphaville",
            "AddressType": 0,
        },
        "BillingAddress": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "21 andar",
            "ZipCode": "06455030",
            "City": "Barueri",
            "State": "SP",
            "Country": "BR",
            "District": "Alphaville"
        }
    },
    "Payment": {
        "ServiceTaxAmount": 0,
        "Installments": 1,
        "Interest": 0,
        "Capture": false,
        "Authenticate": false,
        "Recurrent": false,
        "CreditCard": {
            "CardNumber": "400002******1111",
            "Holder": "Guilherme Silva",
            "ExpirationDate": "08/2033",
            "SaveCard": false,
            "Brand": "Visa",
            "PaymentAccountReference": "2UKZQRDOXLRMGW3B41E8IB5KZOH8V"
        },
        "Tid": "1020115320892",
        "ProofOfSale": "039771",
        "AuthorizationCode": "616672",
        "SoftDescriptor": "Nome fantasia da loja",
        "Provider": "Simulado",
        "FraudAnalysis": {
            "Id": "7bc9a7ea-25a9-483c-1f61-08dbbaaa0d60",
            "Status": 1,
            "StatusDescription": "Accept",
            "ReplyData": {
                "ProviderTransactionId": "7BC9A7EA-25A9-483C-1F61-08DBBAAA0D60"
            },            
            "Sequence": "AuthorizeFirst",
            "SequenceCriteria": "OnSuccess",
            "TotalOrderAmount": 46000,
            "TransactionAmount": 0,
            "Cart": {
                "IsGift": false,
                "ReturnsAccepted": true,
                "Items": [
                    {
                        "Type": 4,
                        "Name": "Mouse",
                        "Risk": 0,
                        "Sku": "100010",
                        "OriginalPrice": 0,
                        "UnitPrice": 532400,
                        "Quantity": 1,
                        "GiftCategory": 0,
                        "Weight": 0,
                        "CartType": 0
                    },
                    {
                        "Type": 5,
                        "Name": "Windows 11 Professional",
                        "Risk": 0,
                        "Sku": "100011",
                        "OriginalPrice": 0,
                        "UnitPrice": 85515,
                        "Quantity": 2,
                        "GiftCategory": 0,
                        "Weight": 0,
                        "CartType": 0
                    }
                ]
            },
            "Travel": {
                "Passengers": [
                    {
                        "Name": "Aline de Souza",
                        "Rating": 0,
                        "PassengerType": "Undefined",
                        "TravelLegs": [
                            {
                                "Destination": "CGH",
                                "Origin": "SDU",
                                "DepartureDate": "2025-10-09T18:30:00",
                                "Boarding": "2025-10-09T18:45:00",
                                "Arriving": "2025-10-09T20:00:00"
                            }
                        ]
                    },
                    {
                        "Name": "Guilherme Silva",
                        "Rating": 0,
                        "PassengerType": "Undefined",
                        "TravelLegs": [
                            {
                                "Destination": "CGH",
                                "Origin": "SDU",
                                "DepartureDate": "2025-10-09T18:30:00",
                                "Boarding": "2025-10-09T18:45:00",
                                "Arriving": "2025-10-09T20:00:00"
                            }
                        ]
                    }
                ]
            },
            "Shipping": {
                "Addressee": "Nome Comprador",
                "Phone": "+55 11 5555-1001",
                "Method": 5,
                "Email": "[email protected]",
                "WorkPhone": "+55 11 5555-1002",
                "Mobile": "+55 11 5555-1003",
                "Identity": "99988877711",
                "IdentityType": "CPF"
            },
            "CaptureOnLowRisk": false,
            "VoidOnHighRisk": false,
            "FraudAnalysisReasonCode": 1,
            "Provider": "ClearSale",
            "IsRetryTransaction": false
        },
        "IsQrCode": false,
        "Amount": 45500,
        "ReceivedDate": "2025-10-20 11:53:18",
        "Status": 1,
        "IsSplitted": false,
        "ReturnMessage": "Operation Successful",
        "ReturnCode": "4",
        "PaymentId": "d0109922-2cd3-4a3f-89fc-4c69230d3438",
        "Type": "CreditCard",
        "Currency": "BRL",
        "Country": "BRA",
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/d0109922-2cd3-4a3f-89fc-4c69230d3438"
            },
            {
                "Method": "PUT",
                "Rel": "capture",
                "Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/sales/d0109922-2cd3-4a3f-89fc-4c69230d3438/capture"
            },
            {
                "Method": "PUT",
                "Rel": "void",
                "Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/sales/d0109922-2cd3-4a3f-89fc-4c69230d3438/void"
            }
        ]
    }
}