ClearSale · e-SiTef

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 e-SiTef e passar as credenciais para o cadastro no e-SiTef.

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 e-SiTef	Propriedades ClearSale	Detalhe adicional
`b2b_b2c`	`Order.B2B_B2C`	-
`item_amount`	`Order.TotalItems`	-
`total_order_amount`	`Order.TotalOrder`	-
`delivery_time_cd`	`Order.DeliveryTimeCD`	-
`qty_payment_types`	`Order.QtyPaymentTypes`	-
`ip` (deprecated)	`Order.IP`	-
`gift`	`Order.Gift`	-
`gift_message`	`Order.GiftMessage`	-
`obs`	`Order.Obs`	-
`sla_custom`	`Order.SlaCustom`	-
`origin`	`Order.Origin`	-
`reservation_date`	`Order.ReservationDate`	-
`nationality`	`Order.Nationality`	-
`list_type_id`	`Order.ListTypeID`	-
`list_id`	`Order.ListID`	-
`sequential`	`Payment.Sequential`	-
`interest`	`Payment.Interest`	-
`interest_value`	`Payment.InterestValue`	-
`shipping_type`	`Order.ShippingType`	-
`items`		Arrays de objeto json (Saiba mais)
`payer`		Objeto json (Saiba mais)
`billing_data`		Objeto json (Saiba mais)
`shipment`		Array de objeto json (Saiba mais)
`passengers`		Array de objeto json (Saiba mais)
`connections`		Array de objeto json (Saiba mais)
`hotel_reservations`		Array de objeto json (Saiba mais)
`purchase_data`		Objeto json (Saiba mais)

Objeto `items`

Propriedades e-SiTef	Propriedades ClearSale	Detalhe adicional
`id`	`Item.ID`	-
`title`	`Item.Name`	-
`quantity`	`Item.Qty`	-
`unit_price`	`Item.ItemValue`	-
`category_id`	`Item.CategoryID`	Preenchimento opcional e numérico com tamanho 1
`category_name`	`Item.CategoryName`	-
`gift`	`Item.Gift`	-

Objeto `payer`

Propriedades e-SiTef	Propriedades ClearSale	Detalhe adicional
`name`	`Payment.Name`	Preenchimento opcional e formato <150 A
`city`	`Payment.Address.City`	-
`address_street_complement`	`Payment.Address.Comp`	-
`address_country`	`Payment.Address.Country`	-
`address_county`	`Payment.Address.County`	-
`address_street_number`	`Payment.Address.Number`	-
`state`	`Payment.Address.State`	-
`address_street_name`	`Payment.Address.Street`	-
`address_zip_code`	`Payment.Address.ZipCode`	-
`address_reference`	`Payment.Address.Reference`	-
`legal_document`	`Payment.LegalDocument`	-

Objeto `billing_data`

Propriedades e-SiTef	Propriedades ClearSale	Detalhe adicional
`cliente_id`	`BillingData.ID`	-
`person`	`BillingData.Type`	-
`cnpj_cpf`	`BillingData.LegalDocument1`	-
`identification_number`	`BillingData.LegalDocument2`	-
`name`	`BillingData.Name`	-
`birth_date`	`BillingData.BirthDate`	-
`email`	`BillingData.Email`	-
`gender`	`BillingData.Gender`	-
`address`		Objeto json (Saiba mais)
`phones`		Array de objeto json (Saiba mais)
`documents`		Array de objeto json (Saiba mais)

Objeto `address` do `billing_data`

Propriedades e-SiTef	Propriedades ClearSale	Detalhe adicional
`street_name`	`BillingData.Address.Street`	-
`street_number`	`BillingData.Address.Number`	-
`complement`	`BillingData.Address.Comp`	-
`county`	`BillingData.Address.County`	-
`city`	`BillingData.Address.City`	-
`state`	`BillingData.Address.State`	-
`country`	`BillingData.Address.Country`	-
`zip_code`	`BillingData.Address.ZipCode`	-
`reference`	`BillingData.Address.Reference`	-

Objeto `phones` do `billing_data`

Propriedades e-SiTef	Propriedades ClearSale	Detalhe adicional
`type`	`BillingData.Phones.Phone.Type`	-
`ddi`	`BillingData. Phones. Phone.DDI`	-
`ddd`	`BillingData. Phones. Phone.DDD`	-
`number`	`BillingData. Phones. Phone.Number`	-
`extension`	`BillingData. Phones. Phone.Extension`	-

Objeto `documents` do `billing_data`

Propriedades e-SiTef	Propriedades ClearSale	Detalhe adicional
`type`	`BillingData.Type`	Valores permitidos: `CPF` ou `CNPJ`

Objeto `shipment`

Propriedades e-SiTef	Propriedades ClearSale	Detalhe adicional
`id`	`ShippingData.ID`	-
`cost`	`Order.ShippingPrice`	-
`type`	`ShippingData.Type`	-
`legal_document1`	`ShippingData.LegalDocument1`	-
`legal_document2`	`ShippingData.LegalDocument2`	-
`name`	`ShippingData.Name`	-
`birth_date`	`ShippingData.BirthDate`	-
`email`	`ShippingData.Email`	-
`gender`	`ShippingData.Gender`	-
`receiver_address`		Objeto json (Saiba mais)
`phones`		Arrays de objeto json (Saiba mais)

Objeto `receiver_address` do `shipment`

Propriedades e-SiTef	Propriedades ClearSale	Detalhe adicional
`street_name`	`ShippingData.Address.Street`	-
`street_number`	`ShippingData.Address.Number`	-
`complement`	`ShippingData.Address.Comp`	-
`county`	`ShippingData.Address.County`	-
`city`	`ShippingData.Address.City`	-
`state`	`ShippingData.Address.State`	-
`country`	`ShippingData.Address.Country`	-
`zip_code`	`ShippingData.Address.ZipCode`	-

Objeto `phones` do `shipment`

Propriedades e-SiTef	Propriedades ClearSale	Detalhe adicional
`type`	`ShippingData.Phones.Phone.Type`	-
`ddi`	`ShippingData.Phones.Phone.DDI`	-
`ddd`	`ShippingData.Phones.Phone.DDD`	-
`number`	`ShippingData.Phones.Phone.Number`	-
`extension`	`ShippingData.Phones.Phone.Extension`	-

Objeto `passengers`

Propriedades e-SiTef	Propriedades ClearSale	Detalhe adicional
`name`	`Passenger.Name`	Preencher com o nome completo
`frequente_flyer_card`	`Passenger.FrequentFlyerCard`	-
`legal_document_type`	`Passenger.LegalDocumentType`	-
`legal_document`	`Passenger.LegalDocument`	-
`birth_date`	`Passenger.BirthDate`	-

Objeto `connections`

Propriedades e-SiTef	Propriedades ClearSale	Detalhe adicional
`company`	`Connection.Compay`	-
`flight_number`	`Connection.FlightNumber`	-
`flight_date`	`Connection.FlightDate`	-
`class`	`Connection.Class`	-
`from`	`Connection.From`	-
`to`	`Connection.To`	-
`departure_date`	`Connection.DepartureDate`	-
`arrival_date`	`Connection.ArrivalDate`	-

Objeto `hotel_reservations`

Propriedades e-SiTef	Propriedades ClearSale	Detalhe adicional
`hotel`	`HotelReservation.Hotel`	-
`city`	`HotelReservation.City`	-
`state`	`HotelReservation.State`	-
`country`	`HotelReservation.Country`	-
`reservation_date`	`HotelReservation.ReservationDate`	-
`reservation_expiration_date`	`HotelReservation.ReservationExpirationDate`	-
`checkin_date`	`HotelReservation.CheckInDate`	-
`checkout_date`	`HotelReservation.CheckOutDate`	-

Objeto `purchase_data`

Propriedades e-SiTef	Propriedades ClearSale	Detalhe adicional
`last_date_inserted_mail`	`PurchaseInformationData.LastDateInsertedMail`	-
`last_date_change_password`	`PurchaseInformationData.LastDateChangePassword`	-
`last_date_change_phone`	`PurchaseInformationData.LastDateChangePhone`	-
`last_date_change_mobile_phone`	`PurchaseInformationData.LasteDateChangeMobilePhone`	-
`last_date_inserted_address`	`PurchaseInformationData.LastDateInsertedAddress`	-
`purchase_logged`	`PurchaseInformationData.PurchaseLogged`	-
`purchase_logged_with_facebook`	`PurchaseInformationData.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 e-SiTef 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ódigo	Descrição	Reenviar
`00`	Transação Concluída	N
`01`	Usuário Inexistente	N
`02`	Erro na validação do XML	S
`03`	Erro ao transformar XML	S
`04`	Erro Inesperado	S
`05`	Pedido já enviado ou não está em reanalise	S
`06`	Erro no Plugin de Entrada	S
`07`	Erro no Plugin de Saída	N

Credenciais necessárias

Revisão manual

Parâmetros antifraude da ClearSale

Objeto items

Objeto payer

Objeto billing_data

Objeto address do billing_data

Objeto phones do billing_data

Objeto documents do billing_data

Objeto shipment

Objeto receiver_address do shipment

Objeto phones do shipment

Objeto passengers

Objeto connections

Objeto hotel_reservations

Objeto purchase_data