Anti-Fraud solutions Carat Portal Integration

After performing the registration alignment with Carat Portal support to enable integration with the anti-fraud service, at the start of a transaction HTML Payment (Learn more) the merchant must configure the property anti_fraud and send the appropriate anti-fraud parameters (depends on the institution that your merchant was set up), both properties must be within the scope of theadditional_data object.

The field anti_fraud determines how anti-fraud is applied and can contain the following values:

• enabled_before_auth - Risk analysis will be performed BEFORE authorization of the payment. If the analysis is rejected, payment will not be started.
• enabled_after_auth - Risk analysis will be performed AFTER authorization of the payment. If the analysis is rejected, the payment that has already been authorized will be canceled.

Attention:

For cases where the limits of intervals for automatic activation of Anti Fraud are configured in the merchant and a value of anti_fraud is passed in the creation of the transaction, the Carat Portal will only accept the value of anti_fraud passed if the transaction is between activation limits. And if the Anti Fraud automatic activation interval limits are configured in the merchant and an anti_fraud value is not passed in the transaction, the value enabled_after_auth will be assumed as default for the anti-fraud type. Important: intervals that allow the use of 3ds and anti-fraud together must not be used.

Anti-fraud parameters

The parameters depend on the institution that provides the anti-fraud service. Therefore, not all anti-fraud parameters available on Carat Portal will be effectively used.

Below are all anti-fraud parameters (regardless of institution). Some parameters may appear repeatedly (for example, the gift property) and this is due to the risk analysis characteristic of each institution. For more details on how each institution uses each anti-fraud parameter, see the page for each anti-fraud integration.

Property	Description	Format	Required
currency	Payment currency	3 A	Yes
b2b_b2c	e-commerce type	3 A	No
item_amount	Value in cents of the total sum of the values of the items	< 1024 N	Yes
total_order_amount	Value in cents of the orders	< 1024 N	Yes
delivery_time_cd	Delivery time	< 50 A	No
qty_payment_types	Number of payments	1 N	No
ip (deprecated)	Order IP	< 50 A	Yes
gift	1 - If order is a gift 0 - If order is not a gift	1 N	No
gift_message	Gift message	< 8000 A	No
obs	Order observations	< 8000 A	No
sla_custom	Analysis SLA	4 N	No
origin	Order origin	< 150 A	Yes
reservation_date	Date of the flight reservation. Only for flight tickets.	Format da data: yyyy-mm-ddThh:mm:ss	No
nationality	Nationality of the order (for request of international analysis)	< 50 A	No
list_type_id	List type ID (only for customers that have a specific list)	1 N	No
list_id	Store’s list ID	< 200 A	No
sequential	Sequence of the payment	1 N	No
interest	Interest rate. Example: 5.00	< 4 N	No
interest_value	Absolute value of interest in cents. Example: 1000 (10 reais).	< 20 N	No
shipping_type	Shipping type id. The following values are valid: 0 - Others 1 - Default 2 - Guaranteed 3 - ExpressaBR 4 - ExpressaSP 5 - High 6 - Economy 7 - Scheduled 8 - Extra fast 9 - Printed 10 - App 11 - Post office 12 - Motoboy 13 - Pick up in the Box Office 14 - Pick up in the Partner Store 15 - Credit Card Ticket 16 - Pick up in the Store	< 2 N	No
items	Purchase item information	Object JSON Array (Learn more)	Yes
payer	Payer information	Object json (Learn more)	Yes
billing_data	Bill information	Object json (Learn more)	Yes
shipment	Shipment information	Object JSON Array (Learn more)	Yes
browser	Browser information	Object json (Learn more)	Yes
travel	Air ticket information	Object json (Learn more)	Conditional by institution
passengers	Air ticket passengers information	Object JSON Array (Learn more)	Yes, if the item is an air ticket
connections	Air ticket connections information	Object JSON Array (Learn more)	Yes, if the item is an air ticket
hotel_reservations	Hotel reservation information	Object JSON Array (Learn more)	Yes, if the item is an hotel reservation
purchase_data	Purchase information	Object json (Learn more)	Yes
mdd	MDD (Merchant Data) information. Cybersource’s field	Object JSON Array (Learn more)	No

Object items

Property	Description	Format	Required
id	Unique Item ID	N	Yes
sku	Product code of the item	A	Conditional by institution
title	Product name	A	Yes
description	Product description	A	No
quantity	Quantity of items	< 4 N	Yes
unit_price	Item unit price	< 12 N	Yes
category_id	Item Category Id. Each institution has a different interpretation.	Conditional by institution	Conditional by institution
category_name	Product's category name	< 200 A	No
gift	1 - If order is a gift 0 - If order is not a gift	1 N	No
tax_amount	Tax amount	N	No
discount_amount	Discount amount in cents	N	No
creation_date	Product publication date in DD/MM/YYYY format.	AN	No

Object payer

Property	Description	Format	Required
id	Identification of the buyer. Usually the CPF.	N	Yes
name	Payer's name. Each institution has a different interpretation.	Conditional by institution	Conditional by institution
surname	Payer's surname	< 200 A	Yes
email	Payer's email	A	Yes
date_created	Creation date	A	Yes
password	Password of the buyer on the store	Conditional by institution	Conditional by institution
city	Address city (without abbreviations)	< 150 A	Yes
address_street_complement	Address complement (without abbreviations)	< 250 A	No
address_country	Address country (without abbreviations)	< 150 A	No
address_county	Address county (without abbreviations)	< 150 A	No
address_street_number	Address number	< 15 A	No
state	Address state abbreviation	2 A	No
address_street_name	Address street name (without abbreviations)	< 200 A	No
address_zip_code	Address zip code	< 10 N	No
address_reference	Landmark (without abbreviations)	< 250 A	No
legal_document	Payer document	< 100 A	No
phones	Phones information	Object JSON Array (Learn more)	No
address	Address information	Object json (Learn more)	No

Object phones of payer

Property	Description	Format	Required
ddi	Phone DDI	3 N	No
ddd	Phone DDD	3 N	No
number	Phone number	9 N	No

Object address of payer

Property	Description	Format	Required
street_name	Street name.	< 200 A	Yes
street_name2	Complement of the street name.	< 200 A	No
street_number	Number of the address	< 15 A	Yes
apartment	Apartment	N	No
complement	Complement of the address	< 250 A	No
county	County of the address (without abbreviations)	< 150 A	Yes
city	Address city (without abbreviations)	< 150 A	Yes
state	Federation Unit abbreviation (UF)	2 A	Yes
district	Address district	A	No
country	Address country	< 150 A	No
zip_code	Address zip code	< 10 N	Yes
reference	Address reference	< 250 A	No
building_number	House number. Example: if it is a condominium, it will be the house number inside the condominium.	< 10 A	No

Object billing_data

Property	Description	Format	Required
cliente_id	Customer ID	< 50 A	Yes
person	1 - Physical person 2 - Legal person	1 N	Yes
cnpj_cpf	CPF or CNPJ	< 100 A	Yes
identification_number	RG or inscrição estadual	< 100 A	No
name	Customer name	< 500 A	Yes
birth_date	Date of birth.	Date in format: yyyy-mm-ddThh:mm:ss	Yes
email	Customer email	< 150 A	No
gender	M - male F - female	1 A	No
address	Bill address	Object json (Learn more)	No
phones	Bill phones	Object JSON Array (Learn more)	No
documents	Bill documents	Object JSON Array (Learn more)	No

Object address of billing_data

Property	Description	Format	Required
street_name	Street name	< 200 A	Yes
street_name2	Complement of the street name	< 200 A	No
street_number	Street number	< 15 A	Yes
apartment	Apartment number	N	No
complement	Complementary address (without abbreviations)	< 250 A	No
county	Address county (without abbreviations)	< 150 A	Yes
city	Address city (without abbreviations)	< 150 A	Yes
state	Address State Acronym - UF	2 A	Yes
district	District name	A	No
country	Address country (without abbreviations).	< 150 A	No
zip_code	Address zipcode	< 10 N	Yes
reference	Landmark without abbreviations	< 250 A	No
building_number	House number. Example: if it is a condominium, it will be the house number inside the condominium.	< 10 A	No

Object phones of billing_data

Property	Description	Format	Required
type	Phone type: 0 - Not defined 1 - Residency 2 - Comercial 3 - Messages 4 - Billing 5 - Temporary 6 - Cellphone	1 N	Yes
ddi	Phone DDI	3 N	No
ddd	Phone DDD	3 N	Yes
number	Phone number	9 N	Yes
extension	Phone extension	< 10 A	No

Object documents of billing_data

Property	Description	Format	Required
type	Conditional by institution.	A	No
number	Document number	N	Yes

Object shipment

Property	Description	Format	Required
id	Customer ID	< 50 A	Yes
cost	Freight value in cents	< 1024 N	No
type	Document type 1 - Pessoa Física 2 - Pessoa Jurídica	< 1 N	Yes
legal_document1	CPF or CNPJ	< 100 A	Yes
legal_document2	RG or Inscrição Estadual	< 100 A	No
name	Customer's name	< 500 A	Yes
surname	Customer's surname	< 500 A	Yes
birth_date	Customer's birth date.	Date in format: yyyy-mm-ddThh:mm:ss	No
email	Email	< 150 A	No
gender	M - male F - female	1 A	No
address	Shipment address	Object json (Learn more)	Conditional by institution
receiver_address	Shipment address	Object json (Learn more)	Conditional by institution
phones	Shipment phones	Object JSON Array (Learn more)	Yes

Object address of shipment

Também equivale ao object receiver_address do shipment

Property	Description	Format	Required
street_name	Street name	< 200 A	Yes
street_name2	Complement of the street name	< 200 A	No
street_number	Street number	< 15 A	Yes
apartment	Apartment number	N	No
complement	Complementary address (without abbreviations)	< 250 A	No
county	Address county (without abbreviations)	< 150 A	Yes
city	Address city (without abbreviations)	< 150 A	Yes
state	Address State Acronym - UF	2 A	Yes
country	Address country	< 150 A	Yes
zip_code	Zip code of the address.	< 10 A	Yes
building_number	House number. Example: if it is a condominium, it will be the house number inside the condominium.	< 10 A	No

Object phones of shipment

Property	Description	Format	Required
type	Phone type: 0 - Not defined 1 - Residency 2 - Commercial 3 - Messages 4 - Billing 5 - Temporary 6 - Cellphone	1 N	Yes
ddi	Phone DDI	3 N	No
ddd	Phone DDD	3 N	Yes
number	Phone Number	9 N	Yes
extension	Phone extension	< 10 A	No

Object browser

Property	Description	Format	Required
ip_address	IP address	15 A	Yes

Object travel

Property	Description	Format	Required
route	Concatenation of the flight routes. To obtain the airport codes, use this link	Value must respect the format: XXX-XXX:XXX-XXX	Yes
journey_type	Trip type: round_trip or one_way	< 32 A	Yes
departure_date_time	Date and time of the first flight departure.	Format da data: yyyy-mm-ddThh:mm:ss	Yes

Object passengers

Property	Description	Format	Required
id	Passenger ID	< 32 A	No
name	Passenger's name. Conditional by institution	< 100 A	Yes
last_name	Passenger's last name	< 100 A	Conditional by institution
frequente_flyer_card	Mileage Card (Fidelity)	< 32 A	No
legal_document_type	Type of identification document: 1 - CPF 2 - CNPJ 3 - RG 4 - IE 5 - Passport 6 - CTPS 7 - Electoral card	1 N	Yes
legal_document	Document number	< 50 A	Yes
birth_date	Passenger's birth date.	Date in format: yyyy-mm-ddThh:mm:ss	No
email	Passenger email. Must be unique.	Format: name@domain.com	No
status	Status of the ticket reservation. Example: Reserved	< 32 A	No
rating	Passenger classification according the ticket price.	< 32 A	No
type	Passenger classification. ADT: Adult CNN: Child INF: Infant YTH: Youth STU: Student SCR: Senior Citizen MIL: Military	< 32 A	No
unit_price	Airfare unit price.	Format (in cents): 1000 (10 reais)	No
phones	Passenger phones	Object JSON Array (Learn more)	Yes

Object phones of passengers

Property	Description	Format	Required
ddi	Phone DDI	3 N	No
ddd	Phone DDD	3 N	Yes
number	Phone number	9 N	Yes

Object connections

Property	Description	Format	Required
company	Airline name	< 50 A	Yes
flight_number	Flight number	6 N	Yes
flight_date	Date of the flight.	Conditional by institution	Yes
class	Seat class	< 10 A	Yes
from	Origin	Conditional by institution	Yes
to	Destiny	Conditional by institution	Yes
departure_date	Boarding date.	Date in format: yyyy-mm-ddThh:mm:ss	Yes
arrival_date	Date of the landing.	Date in format: yyyy-mm-ddThh:mm:ss	Yes

Object hotel_reservations

Property	Description	Format	Required
hotel	Hotel name	< 200 A	Yes
city	Hotel city without abbreviations	< 150 A	Yes
state	Hotel state without abbreviations	< 150 A	Yes
country	Hotel country	< 150 A	Yes
reservation_date	Reservation Date.	Date in format: yyyy-mm-ddThh:mm:ss	Yes
reservation_expiration_date	Date of expiry of the reservation.	Date in format: yyyy-mm-ddThh:mm:ss	Yes
checkin_date	Date of arrival.	Date in format: yyyy-mm-ddThh:mm:ss	Yes
checkout_date	Departure date.	Date in format: yyyy-mm-ddThh:mm:ss	Yes

Object purchase_data

Property	Description	Format	Required
last_date_inserted_mail	Date that the email was last modified.	Date in format: yyyy-mm-ddThh:mm:ss	No
last_date_change_password	Date of the last change of the password.	Date in format: yyyy-mm-ddThh:mm:ss	No
last_date_change_phone	Date that the phone was last changed.	Date in format: yyyy-mm-ddThh:mm:ss	No
last_date_change_mobile_phone	Date that the mobile phone was last changed.	Date in format: yyyy-mm-ddThh:mm:ss	No
last_date_inserted_address	Date of the last address change.	Date in format: yyyy-mm-ddThh:mm:ss	No
purchase_logged	Bought authenticated on the store web site	1 N	No
purchase_logged_with_facebook	Purchase logged in via Facebook	1 N	No

Object mdd

Property	Description	Format	Required
id	It can range from 1 to 100 defined by the merchant in an agreement with Cybersource	< 255 A	No
value	Value of the field defined by the merchant in an agreement with Cybersource	< 255 A	No

For payments using Konduto, Cybersource and Antifraude Fiserv: Parameters that exist in payer, billing and shipment when not passed to the transaction creation service via additional_data, will be requested in the payment screen. If the parameters are passed in the transaction creation service, you will not be asked to fill in the fields on the payment screen.