Serviço de análise de risco na Interface HTML

Após realizar o alinhamento cadastral com o suporte do Carat para habilitar a integração com o serviço de antifraude, na inicialização de uma transação Pagamento HTML (Saiba mais) o lojista deve configurar a propriedade anti_fraud e enviar os devidos parâmetros de antifraude (depende da instituição que a sua loja foi configurada), sendo que as duas propriedades devem estar no escopo do objeto additional_data.

O campo anti_fraud determina o modo de aplicação do antifraude e pode conter os seguintes valores:

  • enabled_before_auth - A análise antifraude será realizada ANTES da autorização do pagamento. Caso a análise seja rejeitada, o pagamento não será iniciado.
  • enabled_after_auth - A análise antifraude será realizada APÓS a autorização do pagamento. Caso a análise seja rejeitada, o pagamento que já foi autorizado será cancelado.

Atenção:

Para casos em que os limites de intervalos para ativação automática de Antifraude estiverem configurados na loja e seja passado um valor de anti_fraud na criação da transação, o Carat só irá acatar o valor de anti_fraud passado se a transação estiver entre os limites de ativação. E caso os limites de intervalos para ativação automática de Antifraude estiverem configurados na loja e não seja passado um valor de anti_fraud na transação, será assumido o valor enabled_after_auth como padrão para o tipo de antifraude. Importante: intervalos que possibilitem a utilização de 3ds e antifraude juntos não devem ser utilizados.

Parâmetros de antifraude#

Os parâmetros dependem da instituição que fornece o serviço de antifraude. Portanto, nem todos os parâmetros de antifraude disponíveis no Carat serão efetivamente utilizados.

Abaixo seguem todos os parametros de antifraude (independente da instituição). Alguns parâmetros podem aparecer repetidamente (por exemplo, a propriedade gift) e isto ocorre devido a característica de análise de risco de cada instituição. Para maiores detalhes de como cada instituição utiliza cada parametro de antifraude, consulte a página de cada integração de antifraude.

PropriedadesDescriçãoFormatoObrigatório
currencyMoeda a ser utilizada3 ASim
b2b_b2cTipo do ecommerce3 ANão
item_amountValor em centavos da soma total dos valores dos itens< 1024 NSim
total_order_amountValor em centravos dos pedidos< 1024 NSim
delivery_time_cdPrazo de entrega< 50 ANão
qty_payment_typesQuantidade de pagamentos1 NNão
ip (deprecated)IP do pedido< 50 ASim
gift1 - É um presente
0 - Não é um presente
1 NNão
gift_messageMensagem do presente< 8000 ANão
obsObservação do pedido< 8000 ANão
sla_customSLA de análise4 NNão
originOrigem do pedido< 150 ASim
reservation_dateData de reserva de voo. Somente para empresas de passagens aéreas.Formato da data: yyyy-mm-ddThh:mm:ssNão
nationalityNacionalidade do pedido (para pedido de análise internacional)< 50 ANão
list_type_idID do tipo de lista (somente para clientes que possuem lista específica)1 NNão
list_idID da lista na loja< 200 ANão
sequentialSequência de realização do pagamento1 NNão
interestTaxa de juros.
Exemplo: 5.00
< 4 NNão
interest_valueValor absoluto dos juros em centavos.
Exemplo: 1000 (10 reais).
< 20 NNão
shipping_typeId do tipo de entrega. Pode ser:
  • 0 - Outros
  • 1 - Normal
  • 2 - Garantida
  • 3 - ExpressaBR
  • 4 - ExpressaSP
  • 5 - Alta
  • 6 - Econômica
  • 7 - Agendada
  • 8 - Extra Rápida
  • 9 - Impresso
  • 10 - Aplicativo
  • 11 - Correio
  • 12 - Motoboy
  • 13 - Retirada Bilheteria
  • 14 - Retirada Loja Parceira
  • 15 - Cartão de Crédito Ingresso
  • 16 - Retirada Loja
< 2 NNão
itemsInformações relativas aos itens da compraArrays de objeto json (Saiba mais)Sim
payerInformações relativas ao pagadorObjeto json (Saiba mais)Sim
billing_dataInformações relativas a faturaObjeto json (Saiba mais)Sim
shipmentInformações relativas a entregaArray de objeto json (Saiba mais)Sim
browserInformações relativas ao navegador utilizado na compraObjeto json (Saiba mais)Sim
travelInformações relativas a passagem aéreaObjeto json (Saiba mais)Condicional por instituição
passengersInformações relativas ao passageirosArray de objeto json (Saiba mais)Sim, se o item for passagem aérea
connectionsInformações relativas ao navegador utilizado na compraArray de objeto json (Saiba mais)Sim, se o item for passagem aérea
hotel_reservationsInformações relativas a reserva de hotelArray de objeto json (Saiba mais)Sim, se a compra for reserva de hotel
purchase_dataInformações relativas a data da compraObjeto json (Saiba mais)Sim
mddInformações relativas ao mdd (Merchant Data). Campo específico da CybersourceArray de objeto json (Saiba mais)Não

Objeto items#

PropriedadesDescriçãoFormatoObrigatório
idIdentificação única do itemNSim
skuCódigo de produto do item.ACondicional por instituição
titleNome do produtoASim
descriptionDescrição do produtoANão
quantityQuantidade de itens< 4 NSim
unit_pricePreço unitário do item< 12 NSim
category_idId da Categoria do Item. Cada instituição de análise possui uma interpretação diferente.Condicional por instituiçãoCondicional por instituição
category_nameNome da categoria do produto< 200 ANão
gift1 - É um presente
0 - Não é um presente
1 NNão
tax_amountMontante da taxaNNão
discount_amountValor de desconto em centavosNNão
creation_dateData de publicação do produto no formato DD/MM/AAAA.ANNão

Objeto payer#

PropriedadesDescriçãoFormatoObrigatório
idIdentificação do comprador. Normalmente é o CPF.NSim
nameNome do comprador. Cada instituição de análise possui uma interpretação diferente.Condicional por instituiçãoCondicional por instituição
surnameSobrenome do comprador< 200 ASim
emailEmail do compradorASim
date_createdData de criaçãoASim
passwordSenha do compradorCondicional por instituiçãoCondicional por instituição
cityCidade do endereço sem abreviações< 150 ASim
address_street_complementComplemento do endereço sem abreviações< 250 ANão
address_countryPaís do endereço sem abreviações< 150 ANão
address_countyBairro do endereço sem abreviações< 150 ANão
address_street_numberNúmero do endereço< 15 ANão
stateSigla do estado do endereço - UF2 ANão
address_street_nameNome do logradouro (sem abreviações)< 200 ANão
address_zip_codeCEP do endereço< 10 NNão
address_referenceReferência do endereço (sem abreviações)< 250 ANão
legal_documentDocumento da pessoa de Cobrança< 100 ANão
phonesContatos telefônicos do compradorArray de objeto json (Saiba mais)Não
addressEndereço do compradorObjeto json (Saiba mais)Não

Objeto phones do payer#

PropriedadesDescriçãoFormatoObrigatório
ddiDDI do telefone3 NNão
dddDDD do telefone3 NNão
numberNúmero do telefone9 NNão

Objeto address do payer#

PropriedadesDescriçãoFormatoObrigatório
street_nameNome do Logradouro.< 200 ASim
street_name2Complemento do do nome do endereço.< 200 ANão
street_numberNúmero do endereço< 15 ASim
apartmentApartamento se houverNNão
complementComplemento do endereço sem abreviações< 250 ANão
countyBairro do endereço sem abreviações< 150 ASim
cityCidade do endereço sem abreviações< 150 ASim
stateSigla do estado do endereço - UF2 ASim
districtDistrito se houverANão
countryPaís do endereço< 150 ANão
zip_codeCEP do endereço< 10 NSim
referenceReferência do endereço sem abreviações< 250 ANão
building_numberNumero da casa. Exemplo: caso seja um condomínio fechado, seria o numero da casa dentro deste condomínio.< 10 ANão

Objeto billing_data#

PropriedadesDescriçãoFormatoObrigatório
cliente_idCódigo do cliente< 50 ASim
person1 - Pessoa Física
2 - Pessoa Jurídica
1 NSim
cnpj_cpfCPF ou CNPJ< 100 ASim
identification_numberRG ou inscrição estadual< 100 ANão
nameNome do cliente< 500 ASim
birth_dateData de Nascimento.Data no formato: yyyy-mm-ddThh:mm:ssSim
emailEmail< 150 ANão
genderM - masculino
F - feminino
1 ANão
addressEndereço da faturaObjeto json (Saiba mais)Não
phonesContatos telefônicos da faturaArray de objeto json (Saiba mais)Não
documentsDocumentos da faturaArray de objeto json (Saiba mais)Não

Objeto address do billing_data#

PropriedadesDescriçãoFormatoObrigatório
street_nameNome do Logradouro< 200 ASim
street_name2Complemento do nome do logradouro.< 200 ANão
street_numberNúmero do endereço< 15 ASim
apartmentApartamento se houverNNão
complementComplemento do endereço sem abreviações< 250 ANão
countyBairro do endereço sem abreviações< 150 ASim
cityCidade do endereço sem abreviações< 150 ASim
stateSigla do estado do endereço - UF2 ASim
districtDistrito se houverANão
countryPaís do endereço sem abreviações.< 150 ANão
zip_codeCEP do endereço< 10 NSim
referenceReferência do endereço sem abreviações< 250 ANão
building_numberNúmero da casa. Exemplo: caso seja um condomínio fechado, seria o numero da casa dentro deste condomínio.< 10 ANão

Objeto phones do billing_data#

PropriedadesDescriçãoFormatoObrigatório
typeTipo de telefone:
  • 0 - Não definido
  • 1 - Residencial
  • 2 - Comercial
  • 3 - Recados
  • 4 - Cobrança
  • 5 - Temporário
  • 6 - Celular
1 NSim
ddiDDI do telefone3 NNão
dddDDD do telefone3 NSim
numberNúmero do telefone9 NSim
extensionRamal do telefone< 10 ANão

Objeto documents do billing_data#

PropriedadesDescriçãoFormatoObrigatório
typeCondicional por instituição.ANão
numberNúmero do documentoNSim

Objeto shipment#

PropriedadesDescriçãoFormatoObrigatório
idCódigo do cliente< 50 ASim
costValor em centavos do frete< 1024 NNão
typeTipo de pessoa
1 - Pessoa Física
2 - Pessoa Jurídica
< 1 NSim
legal_document1CPF ou CNPJ< 100 ASim
legal_document2RG ou Inscrição Estadual< 100 ANão
nameNome do Cliente< 500 ASim
surnameSobrenome do Cliente< 500 ASim
birth_dateData de nascimento.Data no formato: yyyy-mm-ddThh:mm:ssNão
emailEmail< 150 ANão
genderM - masculino
F - feminino
1 ANão
addressEndereço para a entregaObjeto json (Saiba mais)Condicional por instituição
receiver_addressEndereço para a entregaObjeto json (Saiba mais)Condicional por instituição
phonesContatos telefônicos da entregaArrays de objeto json (Saiba mais)Sim

Objeto address do shipment#

Também equivale ao objeto receiver_address do shipment

PropriedadesDescriçãoFormatoObrigatório
street_nameNome do Logradouro.< 200 ASim
street_name2Complemento do nome do Logradouro.< 200 ANão
street_numberNúmero do endereço< 15 ASim
apartmentApartamento se houverNNão
complementComplemento do endereço sem abreviações< 250 ANão
countyBairro do endereço sem abreviações< 150 ASim
cityCidade do endereço sem abreviações< 150 ASim
stateSigla do estado do endereço - UF2 ASim
countryPaís do endereço.< 150 ASim
zip_codeCEP do endereço. Apenas números.< 10 ASim
building_numberNumero da casa. Exemplo: caso seja um condomínio fechado, seria o numero da casa dentro deste condomínio.< 10 ANão

Objeto phones do shipment#

PropriedadesDescriçãoFormatoObrigatório
typeTipo de telefone:
  • 0 - não definido
  • 1 - Residencial
  • 2 - Comercial
  • 3 - Recados
  • 4 - Cobrança
  • 5 - Temporário
  • 6 - Celular
1 NSim
ddiDDI do telefone3 NNão
dddDDD do telefone3 NSim
numberNúmero do telefone9 NSim
extensionRamal do telefone< 10 ANão

Objeto browser#

PropriedadesDescriçãoFormatoObrigatório
ip_addressEndereço IP15 ASim

Objeto travel#

PropriedadesDescriçãoFormatoObrigatório
routeConcatenação das pernas dos vôos/trechos

Para obter os códigos dos aeroportos, use este link
Valor deve respeitar formato: XXX-XXX:XXX-XXXSim
journey_typeTipo de viagem: round_trip ou one_way< 32 ASim
departure_date_timeData e horário de partida do primeiro voo.Formato da data: yyyy-mm-ddThh:mm:ssSim

Objeto passengers#

PropriedadesDescriçãoFormatoObrigatório
idId do passageiro< 32 ANão
nameCondicional por instituição< 100 ASim
last_nameÚltimo nome do Passageiro< 100 ACondicional por instituição
frequente_flyer_cardCartão de Milhagem (fidelidade)< 32 ANão
legal_document_typeTipo de documento de identificação:
  • 1 - CPF
  • 2 - CNPJ
  • 3 - RG
  • 4 - IE
  • 5 - Passaporte
  • 6 - CTPS
  • 7 - Título Eleitor
1 NSim
legal_documentNúmero do documento< 50 ASim
birth_dateData de nascimento.Data no formato: yyyy-mm-ddThh:mm:ssNão
emailEmail do passageiro. Deve ser único na arrays de passengers.Formato: name@domain.comNão
statusStatus da reserva da passagem. Exemplo: Reserved< 32 ANão
ratingClassificação do passageiro de acordo com preço do ticket.< 32 ANão
typeClassificação do passageiro.
  • ADT: Adult
  • CNN: Child
  • INF: Infant
  • YTH: Youth
  • STU: Student
  • SCR: Senior Citizen
  • MIL: Military
< 32 ANão
unit_pricePreço unitário da passagem.Formato (em centavos): 1000 (10 reais)Não
phonesContatos telefônicos do passageiroArrays de objeto json (Saiba mais)Sim

Objeto phones do passengers#

PropriedadesDescriçãoFormatoObrigatório
ddiDDI do telefone. Apenas números. Exemplo: 55 (Brasil)3 NNão
dddDDD do telefone. Apenas números. Exemplo: 11 (São Paulo)3 NSim
numberNúmero do telefone. Apenas números. Exemplo: 123457899 NSim

Objeto connections#

PropriedadesDescriçãoFormatoObrigatório
companyNome da companhia aérea< 50 ASim
flight_numberNúmero do voo6 NSim
flight_dateData e hora da partida da primeira perna do vôo.Condicional por instituiçãoSim
classClasse do assento< 10 ASim
fromOrigemCondicional por instituiçãoSim
toDestinoCondicional por instituiçãoSim
departure_dateData do embarque.Data no formato: yyyy-mm-ddThh:mm:ssSim
arrival_dateData do desembarque.Data no formato: yyyy-mm-ddThh:mm:ssSim

Objeto hotel_reservations#

PropriedadesDescriçãoFormatoObrigatório
hotelNome do hotel< 200 ASim
cityCidade do hotel sem abreviações< 150 ASim
stateEstado do hotel sem abreviações< 150 ASim
countryPaís do hotel< 150 ASim
reservation_dateData da Reserva.Data no formato: yyyy-mm-ddThh:mm:ssSim
reservation_expiration_dateData da expiração da reserva.Data no formato: yyyy-mm-ddThh:mm:ssSim
checkin_dateData da chegada.Data no formato: yyyy-mm-ddThh:mm:ssSim
checkout_dateData da saída.Data no formato: yyyy-mm-ddThh:mm:ssSim

Objeto purchase_data#

PropriedadesDescriçãoFormatoObrigatório
last_date_inserted_mailData da última alteração do email.Data no formato: yyyy-mm-ddThh:mm:ssNão
last_date_change_passwordData da última alteração da senha.Data no formato: yyyy-mm-ddThh:mm:ssNão
last_date_change_phoneData da última alteração do telefone.Data no formato: yyyy-mm-ddThh:mm:ssNão
last_date_change_mobile_phoneData da última alteração do telefone móvel.Data no formato: yyyy-mm-ddThh:mm:ssNão
last_date_inserted_addressData da última alteração do endereço.Data no formato: yyyy-mm-ddThh:mm:ssNão
purchase_loggedCompra logado1 NNão
purchase_logged_with_facebookCompra logado através do Facebook1 NNão

Objeto mdd#

PropriedadesDescriçãoFormatoObrigatório
idPode variar de 1 a 100 definidos pelo comércio em acordo com a Cybersource< 255 ANão
valueValor dos campos definidos pelo comércio em acordo com a Cybersource< 255 ANão

Para pagamentos utilizando Konduto, Cybersource e Fraud Detect: Os parâmetros que existem no payer, billing e shipment quando não são passados no serviço de criação de transação através do additional_data, serão solicitados na tela de pagamento. Caso os parâmetros sejam passados no serviço de criação de transação, não será solicitado o preenchimento dos campos na tela de pagamento.