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.



ℹ️

Learn more about this feature in the documentation.

⚠️

Warning


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

  • The BraspagTransactionId field is required;
  • The BraspagTransactionId field corresponds to the PaymentId returned by the Gateway de Pagamento or API E-commerce Cielo;
  • The Tid, Nsu, AuthorizationCode, and SaleDate fields do not need to be sent;
  • If the e-commerce operates with antifraud before authorization, the authorization association must be implemented.
  • Important: The absence of the BraspagTransactionId parameter or of the analysis-authorization association will prevent automatic chargeback feedback to the antifraud provider.

If there is no integration with the Cielo Gateway de Pagamento API and API E-commerce Cielo:

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

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

⚠️

Warning

This call is used only for integrations that consume fraud analysis in a standalone manner.

If you use Antifraude integrated with the Gateway de Pagamento or the API E-commerce Cielo, this reference does not apply. See the specific documentation for the product used:

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 identifier. Corresponds to the PaymentId returned by the Gateway de Pagamento or API E-commerce Cielo. Required when integrated with either of these APIs.

date

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

int32

Number of installments.

Customer
object
Billing
object
Shipping
object
int32
required

Payment Type:
CreditCard = 1
DebitCard = 2

Card
object
CartItems
object
Hotels
object
Airline
object
string

Indicates the order's origin channel. Size: 150.

Headers
string
required

Bearer {access_token}

string
required

xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Response

Language
LoadingLoading…
Response
Choose an example:
application/json