Analyzing a transaction on ClearSale

Analyze the fraud risk of a transaction with the ClearSale provider

EnvironmentMethodEndpoint
Sandboxhttps://risksandbox.braspag.com.br/analysis/v2/
Productionhttps://risk.braspag.com.br/analysis/v2/
ℹ️

Alphanumeric CNPJs will be implemented by the Brazilian Federal Revenue Service in July 2026

This change applies only to new registrations. There will be no changes to existing CNPJs.

The alphanumeric CNPJ is already supported by Cielo, with no changes required to your integration.

We recommend checking whether adjustments are needed in your merchant’s own checkout systems.


🚧

Warning:


If there is integration with the Cielo Payment Gateway API or the Cielo E-commerce API:

  • The BraspagTransactionId field is required.
  • In the BraspagTransactionId field, send the value received during authorization in the Payment.PaymentId parameter.
  • The Tid, Nsu, AuthorizationCode, and SaleDate fields do not need to be sent.
  • If the merchant operates with Antifraude before authorization, the authorization association must be implemented

Warning:
The absence of the BraspagTransactionId parameter or the association between analysis and authorization will prevent automatic chargeback feedback to the Antifraude provider.


If there is no integration with the Cielo Payment Gateway API or the Cielo E-commerce API:

  • The Tid, Nsu, AuthorizationCode, and SaleDate fields become required.
  • The BraspagTransactionId field does not need to be sent.

*It is mandatory to send the Airline block when the segment is an airline.

Body Params
int64
required

Total amount of items.

int64

Amount charged for this payment.

string
enum
required

Antifraude Gateway solution provider. In this case, use "ClearSale". Table 1 - Provider

Allowed:
string
required

Currency. More information at ISO 4217 Currency Codes

string

Transaction ID in Braspag Pagador. Note: You can send this field if your fraud analysis flow is AuthorizeFirst, in which authorization happens first. If you do not have integration with Pagador Braspag, you can send the fields Tdi, Nsu, AuthorizationCode and SaleDate instead of the BraspagTransactionId field.

Customer
object
date

Order date (if not sent, we will return the date of the request).

int32

Number of installments.

Billing
object
Shipping
object
int32
required

Payment Type:
CreditCard = 1
DebitCard = 2

Card
object
CartItems
object
Hotels
object
Airline
object
string

Order channel origin. Length: 150.

Headers
string
required

Bearer {access_token}

string
required

xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Response

Language
LoadingLoading…
Response
Choose an example:
application/json