ClearSale

Credenciais necessárias#

Como mencionado no capítulo da "Visão Geral - Credenciais necessárias", cada instituição possui um conjunto de credenciais que devem ser obtida para a integração. Os serviços da ClearSale exigem as seguintes credenciais:

  • app_code (Merchant Code)
  • entity_code - Identificação da loja na ClearSale

IMPORTANTE: As credenciais acima devem ser obtidas com a ClearSale. O lojista deve entrar em contato com a ClearSale e receber as devidas orientações de como obter cada uma dessas credenciais. Após conseguir as credenciais, o lojista deve entrar em contato com o suporte do Carat e passar as credenciais para o cadastro no Carat.

Revisão manual#

Conforme explicado no capítulo "Fluxo da revisão manual", a ClearSale é uma das instituições de antifraude que possui o fluxo de revisão manual. Logo, confirme que o cadastro das URL de aviso da revisão manual estão configuradas adequadamente na ClearSale. Em caso de dúvida, entre em contato com o nosso suporte.

Parâmetros antifraude da ClearSale#

Abaixo segue uma relação de parâmetros de antifraude processados pela ClearSale. Alguns parâmetros possuem tratamentos diferenciados dependendo da instituição e a coluna de "Detalhe adicional" especifica o tratalmento especial da ClearSale. Para detalhe de cada parametro, veja a lista de parametro de antifraude

Propriedades
Carat
Propriedades
ClearSale
Detalhe adicional
b2b_b2cOrder.B2B_B2C-
item_amountOrder.TotalItems-
total_order_amountOrder.TotalOrder-
delivery_time_cdOrder.DeliveryTimeCD-
qty_payment_typesOrder.QtyPaymentTypes-
ip (deprecated)Order.IP-
giftOrder.Gift-
gift_messageOrder.GiftMessage-
obsOrder.Obs-
sla_customOrder.SlaCustom-
originOrder.Origin-
reservation_dateOrder.ReservationDate-
nationalityOrder.Nationality-
list_type_idOrder.ListTypeID-
list_idOrder.ListID-
sequentialPayment.Sequential-
interestPayment.Interest-
interest_valuePayment.InterestValue-
shipping_typeOrder.ShippingType-
itemsArrays de objeto json (Saiba mais)
payerObjeto json (Saiba mais)
billing_dataObjeto json (Saiba mais)
shipmentArray de objeto json (Saiba mais)
passengersArray de objeto json (Saiba mais)
connectionsArray de objeto json (Saiba mais)
hotel_reservationsArray de objeto json (Saiba mais)
purchase_dataObjeto json (Saiba mais)

Objeto items#

Propriedades
Carat
Propriedades
ClearSale
Detalhe adicional
idItem.ID-
titleItem.Name-
quantityItem.Qty-
unit_priceItem.ItemValue-
category_idItem.CategoryIDPreenchimento opcional e numérico com tamanho 1
category_nameItem.CategoryName-
giftItem.Gift-

Objeto payer#

Propriedades
Carat
Propriedades
ClearSale
Detalhe adicional
namePayment.NamePreenchimento opcional e formato <150 A
cityPayment.Address.City-
address_street_complementPayment.Address.Comp-
address_countryPayment.Address.Country-
address_countyPayment.Address.County-
address_street_numberPayment.Address.Number-
statePayment.Address.State-
address_street_namePayment.Address.Street-
address_zip_codePayment.Address.ZipCode-
address_referencePayment.Address.Reference-
legal_documentPayment.LegalDocument-

Objeto billing_data#

Propriedades
Carat
Propriedades
ClearSale
Detalhe adicional
cliente_idBillingData.ID-
personBillingData.Type-
cnpj_cpfBillingData.LegalDocument1-
identification_numberBillingData.LegalDocument2-
nameBillingData.Name-
birth_dateBillingData.BirthDate-
emailBillingData.Email-
genderBillingData.Gender-
addressObjeto json (Saiba mais)
phonesArray de objeto json (Saiba mais)
documentsArray de objeto json (Saiba mais)

Objeto address do billing_data#

Propriedades
Carat
Propriedades
ClearSale
Detalhe adicional
street_nameBillingData.Address.Street-
street_numberBillingData.Address.Number-
complementBillingData.Address.Comp-
countyBillingData.Address.County-
cityBillingData.Address.City-
stateBillingData.Address.State-
countryBillingData.Address.Country-
zip_codeBillingData.Address.ZipCode-
referenceBillingData.Address.Reference-

Objeto phones do billing_data#

Propriedades
Carat
Propriedades
ClearSale
Detalhe adicional
typeBillingData.Phones.Phone.Type-
ddiBillingData. Phones. Phone.DDI-
dddBillingData. Phones. Phone.DDD-
numberBillingData. Phones. Phone.Number-
extensionBillingData. Phones. Phone.Extension-

Objeto documents do billing_data#

Propriedades
Carat
Propriedades
ClearSale
Detalhe adicional
typeBillingData.TypeValores permitidos: CPF ou CNPJ

Objeto shipment#

Propriedades
Carat
Propriedades
ClearSale
Detalhe adicional
idShippingData.ID-
costOrder.ShippingPrice-
typeShippingData.Type-
legal_document1ShippingData.LegalDocument1-
legal_document2ShippingData.LegalDocument2-
nameShippingData.Name-
birth_dateShippingData.BirthDate-
emailShippingData.Email-
genderShippingData.Gender-
receiver_addressObjeto json (Saiba mais)
phonesArrays de objeto json (Saiba mais)

Objeto receiver_address do shipment#

Propriedades
Carat
Propriedades
ClearSale
Detalhe adicional
street_nameShippingData.Address.Street-
street_numberShippingData.Address.Number-
complementShippingData.Address.Comp-
countyShippingData.Address.County-
cityShippingData.Address.City-
stateShippingData.Address.State-
countryShippingData.Address.Country-
zip_codeShippingData.Address.ZipCode-

Objeto phones do shipment#

Propriedades
Carat
Propriedades
ClearSale
Detalhe adicional
typeShippingData.Phones.Phone.Type-
ddiShippingData.Phones.Phone.DDI-
dddShippingData.Phones.Phone.DDD-
numberShippingData.Phones.Phone.Number-
extensionShippingData.Phones.Phone.Extension-

Objeto passengers#

Propriedades
Carat
Propriedades
ClearSale
Detalhe adicional
namePassenger.NamePreencher com o nome completo
frequente_flyer_cardPassenger.FrequentFlyerCard-
legal_document_typePassenger.LegalDocumentType-
legal_documentPassenger.LegalDocument-
birth_datePassenger.BirthDate-

Objeto connections#

Propriedades
Carat
Propriedades
ClearSale
Detalhe adicional
companyConnection.Compay-
flight_numberConnection.FlightNumber-
flight_dateConnection.FlightDate-
classConnection.Class-
fromConnection.From-
toConnection.To-
departure_dateConnection.DepartureDate-
arrival_dateConnection.ArrivalDate-

Objeto hotel_reservations#

Propriedades
Carat
Propriedades
ClearSale
Detalhe adicional
hotelHotelReservation.Hotel-
cityHotelReservation.City-
stateHotelReservation.State-
countryHotelReservation.Country-
reservation_dateHotelReservation.ReservationDate-
reservation_expiration_dateHotelReservation.ReservationExpirationDate-
checkin_dateHotelReservation.CheckInDate-
checkout_dateHotelReservation.CheckOutDate-

Objeto purchase_data#

Propriedades
Carat
Propriedades
ClearSale
Detalhe adicional
last_date_inserted_mailPurchaseInformationData.LastDateInsertedMail-
last_date_change_passwordPurchaseInformationData.LastDateChangePassword-
last_date_change_phonePurchaseInformationData.LastDateChangePhone-
last_date_change_mobile_phonePurchaseInformationData.LasteDateChangeMobilePhone-
last_date_inserted_addressPurchaseInformationData.LastDateInsertedAddress-
purchase_loggedPurchaseInformationData.PurchaseLogged-
purchase_logged_with_facebookPurchaseInformationData.PurchaseLoggedWithFacebook-

Exemplo#

Segue abaixo um exemplo de request com os parâmetros mínimos para iniciar uma transação de pagamento com análise de risco. Saiba mais sobre os parâmetros do pagamento.

{
"merchant_id": "LOJATESTE",
"merchant_usn": "9876",
"order_id": "111",
"redirect": "M",
"authorizer_id": "",
"amount": "1000",
"installments": "",
"installment_type": "",
"style": "N",
"store_card": "",
"soft_descriptor": "",
"authenticate": "0",
"transaction_type": "payment",
"additional_data": {
"anti_fraud": "enabled_after_auth",
"extra_info": "",
"currency": "BRL",
"item_amount": "12343",
"total_order_amount": "13412",
"interest": "10.3",
"interest_value": "100",
"items": [
{
"id": "1",
"title": "bola 1",
"quantity": "1",
"unit_price": "50000",
"currency": "BRL",
"picture_url": "http://sportv.globo.com/platb/files/1103/2011/08/bola_futebol.gif",
"category_id": "others",
"description": "bola para jogar 1",
"weight": "200",
"shipping_cost": "1000"
},
{
"id": "2",
"title": "bola 2",
"quantity": "2",
"unit_price": "25000",
"currency": "BRL",
"picture_url": "http://sportv.globo.com/platb/files/1103/2011/08/bola_futebol.gif",
"category_id": "others",
"description": "bola para jogar 2",
"weight": "200",
"shipping_cost": "1000"
}
],
"payer": {
"name": "Joaquim",
"surname": "Severino",
"email": "js@softexpress.com.br",
"date_created": "2014-03-12T06:55:17.413-04:00",
"phone_area_code": "11",
"phone_number": "11111111",
"identification_type": "CPF",
"identification_number": "09719224703",
"address_street_name": "Rua Jose Ninguem",
"address_street_number": "11",
"address_street_complement": "ap 12",
"address_zip_code": "01230120",
"born_date": "12/12/1900",
"city": "Sao Paulo",
"state": "SP",
"address_country": "Brazil",
"address_county": "Campos Eliseos"
},
"purchase_data": {
"purchase_logged_with_facebook": "1",
"purchase_logged": "1",
"last_date_inserted_address": "2016-02-19T10:00:00",
"last_date_change_phone": "2016-02-19T10:00:00",
"last_date_change_password": "2016-02-19T10:00:00",
"last_date_inserted_mail": "2016-02-19T10:00:00",
"last_date_change_mobile_phone": "2016-02-19T10:00:00"
},
"billing_data": {
"phones": [
{
"number": "123123123",
"ddd": "11",
"ddi": "34",
"extension": "1234",
"type": "0"
}
],
"address": {
"zip_code": "02932900",
"street_number": "123",
"street_name": "rua legal",
"floor": "1",
"apartment": "1200",
"complement": "lala",
"city": "sao paulo",
"state": "SP",
"country": "Brazil",
"county": "jardim lala",
"reference": "lalelo"
},
"email": "email@gmail.com",
"birth_date": "1990-02-19T10:00:00",
"name": "John",
"identification_number": "48515484755",
"cnpj_cpf": "54861548806",
"person": "1",
"client_id": "123",
"gender": "M"
},
"shipment": {
"id": "98765432",
"cost": "2000",
"type": "1",
"name": "Joao",
"legal_document1": "1092384",
"receiver_address": {
"zip_code": "12345678",
"street_number": "Rua do Exemplo",
"street_name": "123",
"floor": "3",
"apartment": "901",
"city": "São Paulo",
"complement": "Sobreloja 3",
"country": "brazil",
"district": "Jardim do Exemplo",
"state": "SP",
"county": "jardins"
},
"phones": [
{
"number": "123123123",
"ddd": "11",
"ddi": "34",
"extension": "1234",
"type": "0"
}
]
}
}
}

ATENÇÃO: As transações que ficam pendentes de pagamento podem ser confirmadas ou desfeitas por limite de tempo. Saiba mais.

O Carat considera que o Payment da ClearSale possui os dados do usuário que faz a compra e o BillingData refere-se aos dados do dono do cartão. Considera também que o e-mail do pedido é o e-mail do comprador e a data do pedido é a data de criação da transação de pagamento.

Lista de Códigos de Retorno#

Conforme explicado no capítulo "Retorno da análise de risco", os códigos abaixo são as respostas específicas da ClearSale.

CódigoDescriçãoReenviar
00Transação ConcluídaN
01Usuário InexistenteN
02Erro na validação do XMLS
03Erro ao transformar XMLS
04Erro InesperadoS
05Pedido já enviado ou não está em reanaliseS
06Erro no Plugin de EntradaS
07Erro no Plugin de SaídaN