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 Gateway de Pagamento 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:

Na requisição de análise de fraude com a ClearSale, envie o campo Payment.FraudAnalysis.Provider como "ClearSale";

Só é possível utilizar o antifraude ClearSale no Split de pagamentos se ele for o único provedor de antifraude configurado para o merchant;

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

Ambiente	Método	Endpoint
Sandbox	post	`https://apisandbox.braspag.com.br/v2/sales/`
Produção	post	`https://api.braspag.com.br/v2/sales/`

{
  "MerchantOrderId": 9094008,
  "Customer": {
    "Name": "Bruno Silva",
    "Identity": "11111111111",
    "IdentityType": "CPF",
    "Email": "[email protected]",
    "Birthdate": "1996-11-14",
    "Phone": "+55 11 5555-1001",
    "Mobile": "+55 11 99999-9999",
    "Workphone": "+55 11 5555-2002",
    "Address": {
      "Street": "Alameda Xingu",
      "Number": "512",
      "Complement": "21 andar",
      "ZipCode": "06455030",
      "City": "Barueri",
      "State": "SP",
      "Country": "BR",
      "District": "Alphaville"
    },
    "DeliveryAddress": {
      "Street": "Alameda Xingu",
      "Number": "512",
      "Complement": "27 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",
    "CreditCard": {
      "CardNumber": "4000021231111111",
      "Holder": "Bruno Silva",
      "ExpirationDate": "08/2033",
      "SaveCard": false,
      "Brand": "Visa"
    },
    "FraudAnalysis": {
      "Provider": "ClearSale",
      "Sequence": "AuthorizeFirst",
      "SequenceCriteria": "OnSuccess",
      "CaptureOnLowRisk": false,
      "VoidOnHighRisk": false,
      "TotalOrderAmount": 100000,
      "FingerPrintId": "MzE5MjAzODg0NA==",
      "Shipping": {
        "Addressee": "Nome do destinatário",
        "Method": "LowCost",
        "Mobile": "+55 11 5555-1003",
        "Identity": "99988877711",
        "IdentityType": "CPF",
        "Street": "Alameda Xingu",
        "Number": "512",
        "Complement": "21 andar",
        "Neighborhood": "Alphaville",
        "City": "Barueri",
        "State": "SP",
        "Country": "BR",
        "ZipCode": "06455030",
        "Email": "[email protected]"
      },
      "Cart": {
        "IsGift": false,
        "ReturnsAccepted": true,
        "Items": [
          {
            "Name": "Mouse",
            "Quantity": 1,
            "Sku": "100010",
            "UnitPrice": 50000,
            "Type": "EletronicGood"
          },
          {
            "Name": "Windows 11 Professional",
            "Quantity": 2,
            "Sku": "50000",
            "UnitPrice": 85515,
            "Type": "EletronicSoftware"
          }
        ]
      },
      "Travel": {
        "Passengers": [
          {
            "Name": "Bruno Silva",
            "TravelLegs": [
              {
                "Origin": "SDU",
                "Destination": "CGH",
                "DepartureDate": "2023-10-10T18:30:00",
                "Boarding": "2023-10-10T18:45:00",
                "Arriving": "2023-10-10T20:00:00"
              }
            ]
          },
          {
            "Name": "Guilherme Silva",
            "TravelLegs": [
              {
                "Origin": "SDU",
                "Destination": "CGH",
                "DepartureDate": "2023-10-10T18:30:00",
                "Boarding": "2023-10-10T18:45:00",
                "Arriving": "2023-10-10T20: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 no Gateway de Pagamentos.	Text	36	Sim
`MerchantKey`	Chave pública para autenticação dupla no Gateway de Pagamentos.	Text	40	Sim
`RequestId`	Identificador da requisição, usado quando a loja usa diferentes servidores para cada GET/POST/PUT.	Text	36	Não

Parâmetros do corpo

Parâmetro	Tipo	Tamanho	Obrigatório	Descrição
`MerchantOrderId`	Texto	50	Sim	Número do pedido da loja
`Customer.Name`	Texto	120	Sim	Nome completo do comprador. Tamanho: 120. < 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	14	Sim	Número do documento de identificação do comprador
`Customer.IdentityType`	Texto	255	Sim	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	Sim	É 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.Workphone`	Texto	20	Não	É obrigatório enviar pelo menos um telefone. Telefone comercial. Fomato +DDI DDD NNNN-NNNN Exemplo: +55 11 5555-2002.
`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	19	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.Brand`	Texto	10	Sim	Bandeira do cartão de crédito
`Payment.FraudAnalysis.Provider`	Texto	10	Sim	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 o Split receber a notificação da alteração de status e esta for 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.FingerPrintId`	Texto	88	Sim	É o valor do `ProviderIdentifier`. Identificador utilizado para cruzar informações obtidas do dispositivo do comprador. Obs.: Este identificador poderá ser qualquer valor ou o número do pedido, mas deverá ser único durante 48 horas. Saiba como configurar o Fingerprint no manual do Antifraude
`Payment.FraudAnalysis.VoidOnHighRisk`	Booleano	--	Não	Indica se a transação após a análise de fraude será cancelada. Possíveis valores: “true” / “false” (default). Obs1.: 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, sendo cancelada após a Braspag receber notificação de alteração do status para alto risco (“Reject”). Obs3.: Para a utilização deste parâmetro, a sequência do fluxo de análise de risco (FraudAnalysis.Sequence) 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	Não	Critério do fluxo da análise de fraude. Possíveis valores: “OnSuccess” / “Always”.
`Payment.FraudAnalysis.FingerPrintId`	Texto	--	Sim	Identificador único da sessão do usuário. Saiba mais em Fingerprint com a ClearSale.
`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.Shipping.Phone`	Texto	20	Não	É obrigatório enviar pelo menos um telefone. Telefone residencial - Formato +DDI DDD NNNN-NNNN Exemplo: +55 11 3333-3333.
`Payment.FraudAnalysis.Shipping.Identity`	Texto	14	Sim	Documento do destinatário.
`Payment.FraudAnalysis.Shipping.IdentityType`	Texto	255	Não	1 = Pessoa Física < /br>2 = Pessoa Jurídica.
`Payment.FraudAnalysis.Shipping.Street`	Texto	200	Sim	Nome do logradouro do destinatário.
`Payment.FraudAnalysis.Shipping.Number`	Texto	15	Sim	Número do endereço do destinatário.
`Payment.FraudAnalysis.Shipping.Complement`	Texto	250	Não	Complemento do endereço do destinatário.
`Payment.FraudAnalysis.Shipping.Neighborhood`	Texto	150	Sim	Bairro do endereço do destinatário.
`Payment.FraudAnalysis.Shipping.City`	Texto	150	Sim	Cidade do destinatário.
`Payment.FraudAnalysis.Shipping.State`	Texto	2	Sim	Estado do destinatário - UF.
`Payment.FraudAnalysis.Shipping.Country`	Texto	150	Sim	País do destinatário.
`Payment.FraudAnalysis.Shipping.ZipCode`	Texto	10	Sim	CEP do destinatário.
`Payment.FraudAnalysis.Shipping.Email`	Texto	150	Não	E-mail do destinatário.
`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": "9094008",
  "Customer": {
    "Name": "Bruno Silva",
    "Identity": "11111111111",
    "IdentityType": "CPF",
    "Email": "[email protected]",
    "Phone": "+55 11 5555-1001",
    "Birthdate": "1996-11-14",
    "Address": {
      "Street": "Alameda Xingu",
      "Number": "512",
      "Complement": "21 andar",
      "ZipCode": "06455030",
      "City": "Barueri",
      "State": "SP",
      "Country": "BR",
      "District": "Alphaville",
      "AddressType": "NotInformed"
    },
    "DeliveryAddress": {
      "Street": "Alameda Xingu",
      "Number": "512",
      "Complement": "27 andar",
      "ZipCode": "06455030",
      "City": "Barueri",
      "State": "SP",
      "Country": "BR",
      "District": "Alphaville",
      "AddressType": "NotInformed"
    },
    "WorkPhone": "+55 11 5555-2002",
    "Mobile": "+55 11 99999-9999"
  },
  "Payment": {
    "ServiceTaxAmount": 0,
    "Installments": 1,
    "Interest": "ByMerchant",
    "Capture": false,
    "Authenticate": false,
    "Recurrent": false,
    "CreditCard": {
      "CardNumber": "400002******1111",
      "Holder": "Bruno Silva",
      "ExpirationDate": "08/2033",
      "SaveCard": false,
      "Brand": "Visa",
      "PaymentAccountReference": "D0NQG0GXB52F6R57B88Q4DG1DBS4D"
    },
    "ProofOfSale": "119977",
    "AcquirerTransactionId": "0516093556335",
    "AuthorizationCode": "111840",
    "SoftDescriptor": "Nome fantasia",
    "SentOrderId": "9094008",
    "FraudAnalysis": {
      "Sequence": "AuthorizeFirst",
      "SequenceCriteria": "OnSuccess",
      "FingerPrintId": "MzE5MjAzODg0NA==",
      "Provider": "ClearSale",
      "CaptureOnLowRisk": false,
      "VoidOnHighRisk": false,
      "TotalOrderAmount": 100000,
      "IsRetryTransaction": false,
      "Cart": {
        "IsGift": false,
        "ReturnsAccepted": true,
        "Items": [
          {
            "Type": "EletronicGood",
            "Name": "Mouse",
            "Risk": "Undefined",
            "Sku": "100010",
            "UnitPrice": 50000,
            "Quantity": 1,
            "HostHedge": "Undefined",
            "NonSensicalHedge": "Undefined",
            "ObscenitiesHedge": "Undefined",
            "PhoneHedge": "Undefined",
            "TimeHedge": "Undefined",
            "VelocityHedge": "Undefined",
            "GiftCategory": "Undefined",
            "OriginalPrice": 0,
            "Weight": 0,
            "CartType": 0
          },
          {
            "Type": "EletronicSoftware",
            "Name": "Windows 11 Professional",
            "Risk": "Undefined",
            "Sku": "50000",
            "UnitPrice": 85515,
            "Quantity": 2,
            "HostHedge": "Undefined",
            "NonSensicalHedge": "Undefined",
            "ObscenitiesHedge": "Undefined",
            "PhoneHedge": "Undefined",
            "TimeHedge": "Undefined",
            "VelocityHedge": "Undefined",
            "GiftCategory": "Undefined",
            "OriginalPrice": 0,
            "Weight": 0,
            "CartType": 0
          }
        ]
      },
      "Travel": {
        "Passengers": [
          {
            "Name": "Bruno Silva",
            "Rating": "Undefined",
            "TravelLegs": [
              {
                "Destination": "CGH",
                "Origin": "SDU",
                "DepartureDate": "2023-10-10T18:30:00",
                "Boarding": "2023-10-10T18:45:00",
                "Arriving": "2023-10-10T20:00:00"
              }
            ]
          },
          {
            "Name": "Guilherme Silva",
            "Rating": "Undefined",
            "TravelLegs": [
              {
                "Destination": "CGH",
                "Origin": "SDU",
                "DepartureDate": "2023-10-10T18:30:00",
                "Boarding": "2023-10-10T18:45:00",
                "Arriving": "2023-10-10T20:00:00"
              }
            ]
          }
        ]
      },
      "Shipping": {
        "Addressee": "Nome do destinatário",
        "Mobile": "+55 11 5555-1003",
        "Method": "LowCost",
        "Email": "[email protected]",
        "Identity": "99988877711",
        "IdentityType": "CPF"
      },
      "Status": 4,
      "StatusDescription": "Aborted"
    },
    "PaymentId": "2f91f74d-d6a8-4bda-bf89-324434417dde",
    "Type": "CreditCard",
    "Amount": 45500,
    "ReceivedDate": "2025-05-16 09:35:56",
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Simulado",
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "Status": 1,
    "ProviderReturnCode": "4",
    "ProviderReturnMessage": "Operation Successful",
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/2f91f74d-d6a8-4bda-bf89-324434417dde"
      },
      {
        "Method": "PUT",
        "Rel": "capture",
        "Href": "https://apisandbox.braspag.com.br/v2/sales/2f91f74d-d6a8-4bda-bf89-324434417dde/capture"
      },
      {
        "Method": "PUT",
        "Rel": "void",
        "Href": "https://apisandbox.braspag.com.br/v2/sales/2f91f74d-d6a8-4bda-bf89-324434417dde/void"
      }
    ]
  }
}