Serviço de análise de risco na Interface HTML
Após realizar o alinhamento cadastral com o suporte do e-SiTef para habilitar a integração com o serviço de anti-fraude, 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 anti-fraude (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 da anti-fraude 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.
Parâmetros de anti-fraude
Os parâmetros dependem da instituição que fornece o serviço de anti-fraude. Portanto, nem todos os parâmetros de anti-fraude disponíveis no e-SiTef serão efetivamente utilizados.
Abaixo seguem todos os parametros de anti-fraude (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.
Propriedades | Descrição | Formato | Obrigatório |
---|---|---|---|
currency | Moeda a ser utilizada | 3 A | Sim |
b2b_b2c | Tipo do ecommerce | 3 A | Não |
item_amount | Valor em centavos da soma total dos valores dos itens | < 1024 N | Sim |
total_order_amount | Valor em centravos dos pedidos | < 1024 N | Sim |
delivery_time_cd | Prazo de entrega | < 50 A | Não |
qty_payment_types | Quantidade de pagamentos | 1 N | Não |
ip (deprecated) | IP do pedido | < 50 A | Sim |
gift | 1 - É um presente0 - Não é um presente | 1 N | Não |
gift_message | Mensagem do presente | < 8000 A | Não |
obs | Observação do pedido | < 8000 A | Não |
sla_custom | SLA de análise | 4 N | Não |
origin | Origem do pedido | < 150 A | Sim |
reservation_date | Data de reserva de voo. Somente para empresas de passagens aéreas. | Formato da data: yyyy-mm-ddThh:mm:ss | Não |
nationality | Nacionalidade do pedido (para pedido de análise internacional) | < 50 A | Não |
list_type_id | ID do tipo de lista (somente para clientes que possuem lista específica) | 1 N | Não |
list_id | ID da lista na loja | < 200 A | Não |
sequential | Sequência de realização do pagamento | 1 N | Não |
interest | Taxa de juros. Exemplo: 5.00 | < 4 N | Não |
interest_value | Valor absoluto dos juros em centavos. Exemplo: 1000 (10 reais). | < 20 N | Não |
shipping_type | Id do tipo de entrega. Pode ser:
| < 2 N | Não |
items | Informações relativas aos itens da compra | Arrays de objeto json (Saiba mais) | Sim |
payer | Informações relativas ao pagador | Objeto json (Saiba mais) | Sim |
billing_data | Informações relativas a fatura | Objeto json (Saiba mais) | Sim |
shipment | Informações relativas a entrega | Array de objeto json (Saiba mais) | Sim |
browser | Informações relativas ao navegador utilizado na compra | Objeto json (Saiba mais) | Sim |
travel | Informações relativas a passagem aérea | Objeto json (Saiba mais) | Condicional por instituição |
passengers | Informações relativas ao passageiros | Array de objeto json (Saiba mais) | Sim, se o item for passagem aérea |
connections | Informações relativas ao navegador utilizado na compra | Array de objeto json (Saiba mais) | Sim, se o item for passagem aérea |
hotel_reservations | Informações relativas a reserva de hotel | Array de objeto json (Saiba mais) | Sim, se a compra for reserva de hotel |
purchase_data | Informações relativas a data da compra | Objeto json (Saiba mais) | Sim |
mdd | Informações relativas ao mdd (Merchant Data). Campo específico da Cybersource | Array de objeto json (Saiba mais) | Não |
items
Objeto Propriedades | Descrição | Formato | Obrigatório |
---|---|---|---|
id | Identificação única do item | N | Sim |
sku | Código de produto do item. | A | Condicional por instituição |
title | Nome do produto | A | Sim |
description | Descrição do produto | A | Não |
quantity | Quantidade de itens | < 4 N | Sim |
unit_price | Preço unitário do item | < 12 N | Sim |
category_id | Id da Categoria do Item. Cada instituição de análise possui uma interpretação diferente. | Condicional por instituição | Condicional por instituição |
category_name | Nome da categoria do produto | < 200 A | Não |
gift | 1 - É um presente0 - Não é um presente | 1 N | Não |
tax_amount | Montante da taxa | N | Não |
discount_amount | Valor de desconto em centavos | N | Não |
creation_date | Data de publicação do produto no formato DD/MM/AAAA . | AN | Não |
payer
Objeto Propriedades | Descrição | Formato | Obrigatório |
---|---|---|---|
id | Identificação do comprador. Normalmente é o CPF. | N | Sim |
name | Nome do comprador. Cada instituição de análise possui uma interpretação diferente. | Condicional por instituição | Condicional por instituição |
surname | Sobrenome do comprador | < 200 A | Sim |
email | Email do comprador | A | Sim |
date_created | Data de criação | A | Sim |
password | Senha do comprador | Condicional por instituição | Condicional por instituição |
city | Cidade do endereço sem abreviações | < 150 A | Sim |
address_street_complement | Complemento do endereço sem abreviações | < 250 A | Não |
address_country | País do endereço sem abreviações | < 150 A | Não |
address_county | Bairro do endereço sem abreviações | < 150 A | Não |
address_street_number | Número do endereço | < 15 A | Não |
state | Sigla do estado do endereço - UF | 2 A | Não |
address_street_name | Nome do logradouro (sem abreviações) | < 200 A | Não |
address_zip_code | CEP do endereço | < 10 N | Não |
address_reference | Referência do endereço (sem abreviações) | < 250 A | Não |
legal_document | Documento da pessoa de Cobrança | < 100 A | Não |
phones | Contatos telefônicos do comprador | Array de objeto json (Saiba mais) | Não |
address | Endereço do comprador | Objeto json (Saiba mais) | Não |
phones
do payer
Objeto Propriedades | Descrição | Formato | Obrigatório |
---|---|---|---|
ddi | DDI do telefone | 3 N | Não |
ddd | DDD do telefone | 3 N | Não |
number | Número do telefone | 9 N | Não |
address
do payer
Objeto Propriedades | Descrição | Formato | Obrigatório |
---|---|---|---|
street_name | Nome do Logradouro. | < 200 A | Sim |
street_name2 | Complemento do do nome do endereço. | < 200 A | Não |
street_number | Número do endereço | < 15 A | Sim |
apartment | Apartamento se houver | N | Não |
complement | Complemento do endereço sem abreviações | < 250 A | Não |
county | Bairro do endereço sem abreviações | < 150 A | Sim |
city | Cidade do endereço sem abreviações | < 150 A | Sim |
state | Sigla do estado do endereço - UF | 2 A | Sim |
district | Distrito se houver | A | Não |
country | País do endereço | < 150 A | Não |
zip_code | CEP do endereço | < 10 N | Sim |
reference | Referência do endereço sem abreviações | < 250 A | Não |
building_number | Numero da casa. Exemplo: caso seja um condomínio fechado, seria o numero da casa dentro deste condomínio. | < 10 A | Não |
billing_data
Objeto Propriedades | Descrição | Formato | Obrigatório |
---|---|---|---|
cliente_id | Código do cliente | < 50 A | Sim |
person | 1 - Pessoa Física2 - Pessoa Jurídica | 1 N | Sim |
cnpj_cpf | CPF ou CNPJ | < 100 A | Sim |
identification_number | RG ou inscrição estadual | < 100 A | Não |
name | Nome do cliente | < 500 A | Sim |
birth_date | Data de Nascimento. | Data no formato: yyyy-mm-ddThh:mm:ss | Sim |
email | < 150 A | Não | |
gender | M - masculinoF - feminino | 1 A | Não |
address | Endereço da fatura | Objeto json (Saiba mais) | Não |
phones | Contatos telefônicos da fatura | Array de objeto json (Saiba mais) | Não |
documents | Documentos da fatura | Array de objeto json (Saiba mais) | Não |
address
do billing_data
Objeto Propriedades | Descrição | Formato | Obrigatório |
---|---|---|---|
street_name | Nome do Logradouro | < 200 A | Sim |
street_name2 | Complemento do nome do logradouro. | < 200 A | Não |
street_number | Número do endereço | < 15 A | Sim |
apartment | Apartamento se houver | N | Não |
complement | Complemento do endereço sem abreviações | < 250 A | Não |
county | Bairro do endereço sem abreviações | < 150 A | Sim |
city | Cidade do endereço sem abreviações | < 150 A | Sim |
state | Sigla do estado do endereço - UF | 2 A | Sim |
district | Distrito se houver | A | Não |
country | País do endereço sem abreviações. | < 150 A | Não |
zip_code | CEP do endereço | < 10 N | Sim |
reference | Referência do endereço sem abreviações | < 250 A | Não |
building_number | Número da casa. Exemplo: caso seja um condomínio fechado, seria o numero da casa dentro deste condomínio. | < 10 A | Não |
phones
do billing_data
Objeto Propriedades | Descrição | Formato | Obrigatório |
---|---|---|---|
type | Tipo de telefone:
| 1 N | Sim |
ddi | DDI do telefone | 3 N | Não |
ddd | DDD do telefone | 3 N | Sim |
number | Número do telefone | 9 N | Sim |
extension | Ramal do telefone | < 10 A | Não |
documents
do billing_data
Objeto Propriedades | Descrição | Formato | Obrigatório |
---|---|---|---|
type | Condicional por instituição. | A | Não |
number | Número do documento | N | Sim |
shipment
Objeto Propriedades | Descrição | Formato | Obrigatório |
---|---|---|---|
id | Código do cliente | < 50 A | Sim |
cost | Valor em centavos do frete | < 1024 N | Não |
type | Tipo de pessoa 1 - Pessoa Física 2 - Pessoa Jurídica | < 1 N | Sim |
legal_document1 | CPF ou CNPJ | < 100 A | Sim |
legal_document2 | RG ou Inscrição Estadual | < 100 A | Não |
name | Nome do Cliente | < 500 A | Sim |
surname | Sobrenome do Cliente | < 500 A | Sim |
birth_date | Data de nascimento. | Data no formato: yyyy-mm-ddThh:mm:ss | Não |
email | < 150 A | Não | |
gender | M - masculinoF - feminino | 1 A | Não |
address | Endereço para a entrega | Objeto json (Saiba mais) | Condicional por instituição |
receiver_address | Endereço para a entrega | Objeto json (Saiba mais) | Condicional por instituição |
phones | Contatos telefônicos da entrega | Arrays de objeto json (Saiba mais) | Sim |
address
do shipment
Objeto Também equivale ao objeto receiver_address
do shipment
Propriedades | Descrição | Formato | Obrigatório |
---|---|---|---|
street_name | Nome do Logradouro. | < 200 A | Sim |
street_name2 | Complemento do nome do Logradouro. | < 200 A | Não |
street_number | Número do endereço | < 15 A | Sim |
apartment | Apartamento se houver | N | Não |
complement | Complemento do endereço sem abreviações | < 250 A | Não |
county | Bairro do endereço sem abreviações | < 150 A | Sim |
city | Cidade do endereço sem abreviações | < 150 A | Sim |
state | Sigla do estado do endereço - UF | 2 A | Sim |
country | País do endereço. | < 150 A | Sim |
zip_code | CEP do endereço. Apenas números. | < 10 A | Sim |
building_number | Numero da casa. Exemplo: caso seja um condomínio fechado, seria o numero da casa dentro deste condomínio. | < 10 A | Não |
phones
do shipment
Objeto Propriedades | Descrição | Formato | Obrigatório |
---|---|---|---|
type | Tipo de telefone:
| 1 N | Sim |
ddi | DDI do telefone | 3 N | Não |
ddd | DDD do telefone | 3 N | Sim |
number | Número do telefone | 9 N | Sim |
extension | Ramal do telefone | < 10 A | Não |
browser
Objeto Propriedades | Descrição | Formato | Obrigatório |
---|---|---|---|
ip_address | Endereço IP | 15 A | Sim |
travel
Objeto Propriedades | Descrição | Formato | Obrigatório |
---|---|---|---|
route | Concatenação das pernas dos vôos/trechos Para obter os códigos dos aeroportos, use este link | Valor deve respeitar formato: XXX-XXX:XXX-XXX | Sim |
journey_type | Tipo de viagem: round_trip ou one_way | < 32 A | Sim |
departure_date_time | Data e horário de partida do primeiro voo. | Formato da data: yyyy-mm-ddThh:mm:ss | Sim |
passengers
Objeto Propriedades | Descrição | Formato | Obrigatório |
---|---|---|---|
id | Id do passageiro | < 32 A | Não |
name | Condicional por instituição | < 100 A | Sim |
last_name | Último nome do Passageiro | < 100 A | Condicional por instituição |
frequente_flyer_card | Cartão de Milhagem (fidelidade) | < 32 A | Não |
legal_document_type | Tipo de documento de identificação:
| 1 N | Sim |
legal_document | Número do documento | < 50 A | Sim |
birth_date | Data de nascimento. | Data no formato: yyyy-mm-ddThh:mm:ss | Não |
email | Email do passageiro. Deve ser único na arrays de passengers . | Formato: name@domain.com | Não |
status | Status da reserva da passagem. Exemplo: Reserved | < 32 A | Não |
rating | Classificação do passageiro de acordo com preço do ticket. | < 32 A | Não |
type | Classificação do passageiro.
| < 32 A | Não |
unit_price | Preço unitário da passagem. | Formato (em centavos): 1000 (10 reais) | Não |
phones | Contatos telefônicos do passageiro | Arrays de objeto json (Saiba mais) | Sim |
phones
do passengers
Objeto Propriedades | Descrição | Formato | Obrigatório |
---|---|---|---|
ddi | DDI do telefone. Apenas números. Exemplo: 55 (Brasil) | 3 N | Não |
ddd | DDD do telefone. Apenas números. Exemplo: 11 (São Paulo) | 3 N | Sim |
number | Número do telefone. Apenas números. Exemplo: 12345789 | 9 N | Sim |
connections
Objeto Propriedades | Descrição | Formato | Obrigatório |
---|---|---|---|
company | Nome da companhia aérea | < 50 A | Sim |
flight_number | Número do voo | 6 N | Sim |
flight_date | Data e hora da partida da primeira perna do vôo. | Condicional por instituição | Sim |
class | Classe do assento | < 10 A | Sim |
from | Origem | Condicional por instituição | Sim |
to | Destino | Condicional por instituição | Sim |
departure_date | Data do embarque. | Data no formato: yyyy-mm-ddThh:mm:ss | Sim |
arrival_date | Data do desembarque. | Data no formato: yyyy-mm-ddThh:mm:ss | Sim |
hotel_reservations
Objeto Propriedades | Descrição | Formato | Obrigatório |
---|---|---|---|
hotel | Nome do hotel | < 200 A | Sim |
city | Cidade do hotel sem abreviações | < 150 A | Sim |
state | Estado do hotel sem abreviações | < 150 A | Sim |
country | País do hotel | < 150 A | Sim |
reservation_date | Data da Reserva. | Data no formato: yyyy-mm-ddThh:mm:ss | Sim |
reservation_expiration_date | Data da expiração da reserva. | Data no formato: yyyy-mm-ddThh:mm:ss | Sim |
checkin_date | Data da chegada. | Data no formato: yyyy-mm-ddThh:mm:ss | Sim |
checkout_date | Data da saída. | Data no formato: yyyy-mm-ddThh:mm:ss | Sim |
purchase_data
Objeto Propriedades | Descrição | Formato | Obrigatório |
---|---|---|---|
last_date_inserted_mail | Data da última alteração do email. | Data no formato: yyyy-mm-ddThh:mm:ss | Não |
last_date_change_password | Data da última alteração da senha. | Data no formato: yyyy-mm-ddThh:mm:ss | Não |
last_date_change_phone | Data da última alteração do telefone. | Data no formato: yyyy-mm-ddThh:mm:ss | Não |
last_date_change_mobile_phone | Data da última alteração do telefone móvel. | Data no formato: yyyy-mm-ddThh:mm:ss | Não |
last_date_inserted_address | Data da última alteração do endereço. | Data no formato: yyyy-mm-ddThh:mm:ss | Não |
purchase_logged | Compra logado | 1 N | Não |
purchase_logged_with_facebook | Compra logado através do Facebook | 1 N | Não |
mdd
Objeto Propriedades | Descrição | Formato | Obrigatório |
---|---|---|---|
id | Pode variar de 1 a 100 definidos pelo comércio em acordo com a Cybersource | < 255 A | Não |
value | Valor dos campos definidos pelo comércio em acordo com a Cybersource | < 255 A | Não |