Realizar uma análise de fraude na ClearSale

Analisa o risco de fraude de uma transação com o provider ClearSale

AmbienteMétodoEndpoint
Sandboxhttps://risksandbox.braspag.com.br/analysis/v2/
Produçãohttps://risk.braspag.com.br/analysis/v2/

ℹ️

Saiba mais sobre essa funcionalidade na documentação.

⚠️

Atenção


Se houver integração com a API do Gateway de Pagamento Cielo ou com a API E-commerce Cielo:

  • O campo BraspagTransactionId é obrigatório;
  • O campo BraspagTransactionId corresponde ao PaymentId retornado pelo Gateway de Pagamento ou API E-commerce Cielo;
  • Os campos Tid, Nsu, AuthorizationCode e SaleDate não precisam ser enviados;
  • Caso o e-commerce opere com antifraude antes da autorização, a associação de autorização deve ser implementada.
  • Importante: A ausência do parâmetro BraspagTransactionId ou associação da análise com autorização impedirá a retroalimentação automática de chargeback no provedor de antifraude.

Se não houver integração com a API Gateway de Pagamento Cielo e API E-commerce Cielo:

  • Os campos Tid, Nsu, AuthorizationCode e SaleDate tornam-se obrigatórios;
  • O campo BraspagTransactionId não precisa ser enviado.

*É obrigatório enviar o bloco Airline quando o segmento for companhia aérea.

ℹ️

CNPJs alfanuméricos serão implementados pela Receita Federal em julho de 2026

Essa mudança afeta apenas novas inscrições, não havendo mudanças em CNPJs existentes.

O CNPJ alfanumérico já está sendo suportado pela Cielo, sem mudanças na sua integração.

Recomendamos verificar a necessidade de possíveis ajustes nos sistemas próprios de checkout de sua loja.

⚠️

Atenção

Esta chamada é utilizada apenas para integrações que consomem a análise de fraude de forma apartada.

Caso você utilize o Antifraude integrado ao Gateway de Pagamento ou a API E-commerce Cielo, esta referência não se aplica. Consulte a documentação específica do produto utilizado:

Body Params
int64
required

Valor total dos itens.

int64

Valor cobrado neste pagamento.

string
enum
required

Provedor da análise de fraude. Neste caso, usar "ClearSale". Tabela 1 - Provider

Allowed:
string
required

Moeda. Mais informações em ISO 4217 Currency Codes. Tamanho: 3.

string

Identificador da transação. Corresponde ao PaymentId retornado pelo Gateway de Pagamento ou API E-commerce Cielo. Obrigatório quando houver integração com qualquer uma dessas APIs.

date

Data do pedido (se não enviado retornaremos a data da requisição).

int32

Quantidade de parcelas.

Customer
object
Billing
object
Shipping
object
int32
required

Tipo de Pagamento:
CreditCard = 1
DebitCard = 2

Card
object
CartItems
object
Hotels
object
Airline
object
string

Informa o canal de origem do pedido. Tamanho: 150.

Headers
string
required

Bearer {access_token}

string
required

xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Response

Language
LoadingLoading…
Response
Choose an example:
application/json