Referência da API
AtendimentoAPI Status
Start typing to search…

Análise de fraude com a Cybersource

Split de Pagamento com a solução de captura API E-commerce Cielo

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.

ℹ️

Importante: companhias aéreas

  • O campo ServiceTaxAmount é exclusivo para empresas aéreas.

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/

--header "Authorization: Bearer {access_token}"

{  
    "MerchantOrderId":"Loja123456",
    "Customer":{  
        "Name":"Nome do Comprador",
        "Identity":"12345678910",
        "IdentityType":"CPF",
        "Email":"[email protected]",
        "Birthdate":"1991-01-02",
        "Phone": "5521976781114",
        "BillingAddress":{  
            "Street":"Alameda Xingu",
            "Number":"512",
            "Complement":"27 andar",
            "ZipCode":"12345987",
            "City":"São Paulo",
            "State":"SP",
            "Country":"BR",
            "District":"Alphaville"
        },
        "DeliveryAddress":{  
            "Street":"Alameda Xingu",
            "Number":"512",
            "Complement":"27 andar",
            "ZipCode":"12345987",
            "City":"São Paulo",
            "State":"SP",
            "Country":"BR",
            "District":"Alphaville"
        }
    },
    "Payment":{  
        "Type":"CreditCard",
        "Amount":10000,
        "Currency":"BRL",
        "Country":"BRA",
        "ServiceTaxAmount":0,
        "Installments":1,
        "Interest":"ByMerchant",
        "Capture":false,
        "Authenticate":false,
        "SoftDescriptor":"Mensagem",
        "CreditCard":{  
            "CardNumber":"4551870000000181",
            "Holder":"Nome do Portador",
            "ExpirationDate":"12/2021",
            "SecurityCode":"123",
            "Brand":"Visa",
            "SaveCard":"false"
        },
        "FraudAnalysis":{  
            "Provider":"Cybersource",
            "Sequence":"AuthorizeFirst",
            "SequenceCriteria":"OnSuccess",
            "CaptureOnLowRisk":false,
            "VoidOnHighRisk":false,
            "TotalOrderAmount":10000,
            "Browser":{  
                "BrowserFingerprint":"074c1ee676ed4998ab66491013c565e2",
                "CookiesAccepted":false,
                "Email":"[email protected]",
                "HostName":"Teste",
                "IpAddress":"127.0.0.1",
                "Type":"Chrome"
            },
            "Cart":{  
                "IsGift":false,
                "ReturnsAccepted":true,
                "Items":[  
                    {  
                        "GiftCategory":"Undefined",
                        "HostHedge":"Off",
                        "NonSensicalHedge":"Off",
                        "ObscenitiesHedge":"Off",
                        "PhoneHedge":"Off",
                        "Name":"ItemTeste1",
                        "Quantity":1,
                        "Sku":"20170511",
                        "UnitPrice":10000,
                        "Risk":"High",
                        "TimeHedge":"Normal",
                        "Type":"AdultContent",
                        "VelocityHedge":"High"
                    },
                    {  
                        "GiftCategory":"Undefined",
                        "HostHedge":"Off",
                        "NonSensicalHedge":"Off",
                        "ObscenitiesHedge":"Off",
                        "PhoneHedge":"Off",
                        "Name":"ItemTeste2",
                        "Quantity":1,
                        "Sku":"20170512",
                        "UnitPrice":10000,
                        "Risk":"High",
                        "TimeHedge":"Normal",
                        "Type":"AdultContent",
                        "VelocityHedge":"High"
                    }
                ]
            },
            "MerchantDefinedFields":[  
                {  
                    "Id":2,
                    "Value":"100"
                },
                {  
                    "Id":4,
                    "Value":"Web"
                },
                {  
                    "Id":9,
                    "Value":"SIM"
                }
            ],
            "Shipping":{  
                "Addressee":"João das Couves",
                "Method":"LowCost",
                "Phone":"551121840540"
            },
            "Travel":{  
                "JourneyType":"OneWayTrip",
                "DepartureTime":"2018-01-09 18:00",
                "Passengers":[  
                    {  
                        "Name":"Passenger Test",
                        "Identity":"212424808",
                        "Status":"Gold",
                        "Rating":"Adult",
                        "Email":"[email protected]",
                        "Phone":"5564991681074",
                        "TravelLegs":[  
                            {  
                                "Origin":"AMS",
                                "Destination":"GIG"
                            }
                        ]
                    }
                ]
            }
        }
    }
}

Propriedade

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

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

15

Sim

Número do telefone do comprador. Ex.: 5521976781114

Customer.BillingAddress.Street

Texto

54

Sim

Logradouro do endereço de cobrança

Customer.BillingAddress.Number

Texto

5

Sim

Número do endereço de cobrança

Customer.BillingAddress.Complement

Texto

14

Não

Complemento do endereço de cobrança

Customer.BillingAddress.ZipCode

Texto

9

Sim

Código postal do endereço de cobrança

Customer.BillingAddress.City

Texto

50

Sim

Cidade do endereço de cobrança

Customer.BillingAddress.State

Texto

2

Sim

Estado do endereço de cobrança

Customer.BillingAddress.Country

Texto

2

Sim

País do endereço de cobrança. Mais informações em ISO 2-Digit Alpha Country Code

Customer.BillingAddress.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

Código postal 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

Não

Define comportamento do meio de pagamento (ver Anexo).
Obs.: Não obrigatório para Payment.Type igual a CreditCard

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.Currency

Texto

3

Não

Moeda na qual o pagamento será feito. Possíveis valores: BRL / USD / MXN / COP / CLP / ARS / PEN / EUR / PYN / UYU / VEB / VEF / GBP

Payment.Country

Texto

3

Não

País na qual o pagamento será realizado

Payment.ServiceTaxAmount

Número

15

Não

Aplicável apenas para empresas aéreas. Montante do valor da autorização que deve ser destinado à taxa de serviço. Obs.: Esse valor não é adicionado ao valor da autorização

Payment.Installments

Número

2

Sim

Número de parcelas

Payment.Interest

Texto

10

Não

Tipo de parcelamento. Possíveis valores:

  • ByMerchant_ (parcelado loja)
  • ByIssuer_ (parcelado emissor)

Payment.Capture

Booleano

Não

Indica se a autorização deverá ser com captura automática. Possíveis valores: true / false (default)

Payment.Authenticate

Booleano

Não

Indica se a transação deve ser autenticada junto ao emissor. Possíveis valores: true / false (default)

Payment.SoftDescriptor

Texto

13

Não

Texto que será impresso na fatura do portador. Obs.: O valor deste campo tem que ser claro e fácil de identificar pelo portador o estabelecimento onde foi realizada a compra, pois é um dos principais ofensores para chargeback

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

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.CreditCard.SaveCard

Booleano

Não

Booleano que identifica se o cartão será salvo para gerar o token (CardToken). Possíveis valores: true / false (default)

Payment.FraudAnalysis.Sequence

Texto

14

Sim

Tipo de fluxo da análise de fraude. Possíveis valores: AnalyseFirst / AuthorizeFirst

Payment.FraudAnalysis.SequenceCriteria

Texto

9

Sim

Critério do fluxo da análise de fraude. Possíveis valores: OnSuccess / Always

Payment.FraudAnalysis.Provider

Texto

10

Sim

Provedor de AntiFraude. Possíveis valores: Cybersource

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.1: 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

Obs.2: 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.3: Para a utilização deste parâmetro, a sequência do fluxo de análise de risco deve ser obrigatoriamente AuthorizeFirst

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).
Obs.1: 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
Obs.2: 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á cancelada após a Cielo receber o novo status da análise manual e este for alto risco (Reject)
Obs.3: 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.Browser.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.Browser.CookiesAccepted

Booleano

Sim

Identifica se o browser do comprador aceita cookies. Possíveis valores: true / false (default)

Payment.FraudAnalysis.Browser.Email

Texto

100

Não

E-mail registrado no browser do comprador. Pode diferenciar do e-mail de cadastro na loja(Customer.Email)

Payment.FraudAnalysis.Browser.HostName

Texto

60

Não

Nome do host informado pelo browser do comprador e identificado através do cabeçalho HTTP

Payment.FraudAnalysis.Browser.IpAddress

Texto

45

Sim

Endereço de IP do comprador. Formato IPv4 ou IPv6

Payment.FraudAnalysis.Browser.Type

Texto

40

Não

Nome do browser utilizado pelo comprador e identificado através do cabeçalho HTTP. Ex.: Google Chrome, Mozilla Firefox, Safari, etc

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.GiftCategory

Texto

9

Não

Identifica que avaliará os endereços de cobrança e entrega para diferentes cidades, estados ou países. Saiba mais na página de soluções

Payment.FraudAnalysis.Cart.Items.HostHedge

Texto

6

Não

Nível de importância dos endereços de IP e e-mail do comprador na análise de fraude. Saiba mais na página de soluções

Payment.FraudAnalysis.Cart.Items.NonSensicalHedge

Texto

6

Não

Nível de importância das verificações sobre os dados do comprador sem sentido na análise de fraude. Saiba mais

Payment.FraudAnalysis.Cart.Items.ObscenitiesHedge

Texto

6

Não

Nível de importância das verificações sobre os dados do comprador com obscenidade na análise de fraude. Saiba mais na página de soluções do e-commerce Cielo

Payment.FraudAnalysis.Cart.Items.PhoneHedge

Texto

6

Não

Nível de importância das verificações sobre os números de telefones do comprador na análise de fraude. Saiba mais na página de soluções

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

Sim

Preço unitário do produto. Ex: 10950 = r$ 109,50

Payment.FraudAnalysis.Cart.Items.Risk

Texto

6

Não

Nível de risco do produto associado a quantidade de chargebacks. Saiba mais

Payment.FraudAnalysis.Cart.Items.TimeHedge

Texto

6

Não

Nível de importância da hora do dia na análise de fraude que o comprador realizou o pedido. Saiba mais na página de soluções

Payment.FraudAnalysis.Cart.Items.Type

Texto

19

Não

Categoria do produto. A análise de fraude está disponível mediante contratação adicional. Saiba mais

Payment.FraudAnalysis.Cart.Items.VelocityHedge

Texto

6

Não

Nível de importância da frequência de compra do comprador na análise de fraude dentros dos 15 minutos anteriores. Saiba mais na página de soluções do e-commerce Cielo

Payment.FraudAnalysis.MerchantDefinedFields.Id

Número

2

Sim

ID das informações adicionais a serem enviadas. A análise de fraude está disponível mediante contratação adicional. Saiba mais

Payment.FraudAnalysis.MerchantDefinedFields.Value

Texto

255

Sim

Valor das informações adicionais a serem enviadas. A análise de fraude está disponível mediante contratação adicional. Saiba mais

Payment.FraudAnalysis.Shipping.Addressee

Texto

120

Não

Nome completo do responsável a receber o produto no endereço de entrega

Payment.FraudAnalysis.Shipping.Method

Texto

8

Não

Meio de entrega do pedido. A análise de fraude está disponível mediante contratação adicional. Saiba mais

Payment.FraudAnalysis.Shipping.Phone

Texto

15

Não

Número do telefone do responsável a receber o produto no endereço de entrega. Ex.: 552121114700

Payment.FraudAnalysis.Travel.JourneyType

Texto

32

Não

Tipo de viagem. A análise de fraude está disponível mediante contratação adicional. Saiba mais

Payment.FraudAnalysis.Travel.DepartureTime

DateTime

Não

Data e hora de partida. Ex.: 2018-03-31 19:16:38

Payment.FraudAnalysis.Travel.Passengers.Name

Texto

120

Não

Nome completo do passageiro

Payment.FraudAnalysis.Travel.Passengers.Identity

Texto

32

Não

Número do documento do passageiro

Payment.FraudAnalysis.Travel.Passengers.Status

Texto

15

Não

Classificação da empresa aérea. A análise de fraude está disponível mediante contratação adicional. Saiba mais

Payment.FraudAnalysis.Travel.Passengers.Rating

Texto

13

Não

Tipo do passageiro. A análise de fraude está disponível mediante contratação adicional. Saiba mais

Payment.FraudAnalysis.Travel.Passengers.Email

Texto

255

Não

E-mail do passageiro

Payment.FraudAnalysis.Travel.Passengers.Phone

Texto

15

Não

Telefone do passageiro. Ex.: 552121114700

Payment.FraudAnalysis.Travel.Passengers.TravelLegs.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

Resposta da criação de pagamento com análise de fraude

A resposta irá trazer os mesmos resultados que uma transação de crédito convencional, mais os parâmetros referentes ao resultado da análise de fraude.

PropriedadeDescriçãoTipo
Payment.FraudAnalysis.IsRetryTransactionRetentativa de uma análise, e deverá ser enviado com valor igual a "true" quando o código de retorno na primeira tentativa for igual a BP900.booleano
Payment.FraudAnalysis.IdIdentificação transação no AntifraudeGUID
Payment.FraudAnalysis.StatusStatus da transação no Antifraude.número
Payment.FraudAnalysis.StatusDescriptionDescrição do status do Antifraude.texto
Payment.FraudAnalysis.ReplyData.ProviderTransactionIdIdentificador da transação na Cybersource.string
{
    "MerchantOrderId":"2017051002",
    "Customer":{  
        "Name":"Nome do Comprador",
        "Identity":"12345678910",
        "IdentityType":"CPF",
        "Email":"[email protected]",
        "Birthdate":"1991-01-02",
        "Phone": "5521976781114",
        "BillingAddress":{  
            "Street":"Alameda Xingu",
            "Number":"512",
            "Complement":"27 andar",
            "ZipCode":"12345987",
            "City":"São Paulo",
            "State":"SP",
            "Country":"BR",
            "District":"Alphaville"
        },
        "DeliveryAddress":{  
            "Street":"Alameda Xingu",
            "Number":"512",
            "Complement":"27 andar",
            "ZipCode":"12345987",
            "City":"São Paulo",
            "State":"SP",
            "Country":"BR",
            "District":"Alphaville"
        }
    },
    "Payment": {
        "Type":"CreditCard",
        "Amount":10000,
        "Currency":"BRL",
        "Country":"BRA",
        "ServiceTaxAmount":0,
        "Installments":1,
        "Interest":"ByMerchant",
        "Capture":false,
        "Authenticate":false,
        "SoftDescriptor":"Mensagem",
        "CreditCard": {
            "CardNumber":"455187******0181",
            "Holder":"Nome do Portador",
            "ExpirationDate":"12/2021",
            "Brand": "Visa",
            "SaveCard": false
        },
        "FraudAnalysis": {
            "Provider":"Cybersource",
            "Sequence": "AuthorizeFirst",
            "SequenceCriteria": "OnSuccess",
            "CaptureOnLowRisk":false,
            "VoidOnHighRisk":false,
            "TotalOrderAmount":10000,
            "Browser":{  
                "BrowserFingerprint":"074c1ee676ed4998ab66491013c565e2",
                "CookiesAccepted":false,
                "Email":"[email protected]",
                "HostName":"Teste",
                "IpAddress":"127.0.0.1",
                "Type":"Chrome"
            },
            
            "Cart":{  
                "IsGift":false,
                "ReturnsAccepted":true,
                "Items":[  
                    {  
                        "GiftCategory":"Undefined",
                        "HostHedge":"Off",
                        "NonSensicalHedge":"Off",
                        "ObscenitiesHedge":"Off",
                        "PhoneHedge":"Off",
                        "Name":"ItemTeste1",
                        "Quantity":1,
                        "Sku":"20170511",
                        "UnitPrice":10000,
                        "Risk":"High",
                        "TimeHedge":"Normal",
                        "Type":"AdultContent",
                        "VelocityHedge":"High"
                    },
                    {  
                        "GiftCategory":"Undefined",
                        "HostHedge":"Off",
                        "NonSensicalHedge":"Off",
                        "ObscenitiesHedge":"Off",
                        "PhoneHedge":"Off",
                        "Name":"ItemTeste2",
                        "Quantity":1,
                        "Sku":"20170512",
                        "UnitPrice":10000,
                        "Risk":"High",
                        "TimeHedge":"Normal",
                        "Type":"AdultContent",
                        "VelocityHedge":"High"
                    }
                ]
            },
            "MerchantDefinedFields":[  
                {  
                    "Id":2,
                    "Value":"100"
                },
                {  
                    "Id":4,
                    "Value":"Web"
                },
                {  
                    "Id":9,
                    "Value":"SIM"
                }
            ],
            "Shipping":{  
                "Addressee":"João das Couves",
                "Method":"LowCost",
                "Phone":"551121840540"
            },
            "Travel":{  
                "JourneyType":"OneWayTrip",
                "DepartureTime":"2018-01-09 18:00",
                "Passengers":[  
                    {  
                        "Name":"Passenger Test",
                        "Identity":"212424808",
                        "Status":"Gold",
                        "Rating":"Adult",
                        "Email":"[email protected]",
                        "Phone":"5564991681074",
                        "TravelLegs":[  
                            {  
                                "Origin":"AMS",
                                "Destination":"GIG"
                            }
                        ]
                    }
                ]
            },
            "Id": "0e4d0a3c-e424-4fa5-a573-4eabbd44da42",
            "Status": 1,
            "ReplyData": {
                "AddressInfoCode": "COR-BA^MM-BIN",
                "FactorCode": "B^D^R^Z",
                "Score": 42,
                "BinCountry": "us",
                "CardIssuer": "FIA CARD SERVICES, N.A.",
                "CardScheme": "VisaCredit",
                "HostSeverity": 1,
                "InternetInfoCode": "FREE-EM^RISK-EM",
                "IpRoutingMethod": "Undefined",
                "ScoreModelUsed": "default_lac",
                "CasePriority": 3
            }
        },
        "ProofOfSale": "492115",
        "Tid": "12345678902606D31001",
        "AuthorizationCode": "123456",
        "PaymentId": "04096cfb-3f0a-4ece-946c-3b7dc5d38f19",
        "ExtraDataCollection": [],
        "Status": 1,
        "ReturnCode": "4",
        "ReturnMessage": "Transação autorizada",
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}"
            },
            {
                "Method": "PUT",
                "Rel": "capture",
                "Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/capture"
            },
            {
                "Method": "PUT",
                "Rel": "void",
                "Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/void"
            }
        ]
    }
}
Trabalhe conosco
Portal de Desenvolvedores
ICVA e Release
Blog
Central de Ajuda

CNPJ: 01.027. 058/0001-91 • Endereço da sede: Alameda Xingu, 512 – 21º ao 25º andar – Alphaville – SP – CEP: 06455-030

Copyright © 2024 Cielo S.A. – Instituição de Pagamento. Todos os direitos reservados.

CNPJ: 01.027. 058/0001-91 • Endereço da sede: Alameda Xingu, 512 – 21º ao 25º andar – Alphaville – SP – CEP: 06455-030