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 obtidas para a integração. Os serviços da ClearSale exigem as seguintes credenciais:

Login (Identificação da Loja) - Login do cadastro da loja na ClearSale.
Senha (Merchant Code) - Senha do cadastro 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.

Configuração de URL webhook#

Para que possamos receber as atualizações de status de transações de análise de risco, é necessário realizar a configuração da URL de webhook no ambiente de configuração da ClearSale.

URL de Produção:

https://esitef-ec.softwareexpress.com.br/e-sitef/processarPost.se?src=clearsale_rest

URL de Homologação:

https://esitef-homologacao.softwareexpress.com.br/e-sitef/processarPost.se?src=clearsale_rest

Essa URL deve ser configurada para qualquer troca de status. Para realizar essa configuração, por favor entre em contato com o Suporte da ClearSale.

Iniciando uma transação com Anti-Fraude#

Após realizar o alinhamento cadastral com o suporte do Carat para habilitar a integração com o serviço de anti-fraude, na inicialização de uma transação Pagamento REST (saiba mais) ou Pré Autorização REST (saiba mais), o lojista deve enviar 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. No caso da pré autorização com roteamentos não-SiTef, caso a análise de risco fique como análise manual, o Carat deixa a transação no estado PPC (Pagamento Pendente de Confirmação) e fica no aguardo de uma conclusão da análise manual.
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. No caso da pré autorização com roteamentos não-SiTef, o Carat deixa a transação no estado PPC (Pagamento Pendente de Confirmação) e fica no aguardo de uma conclusão da análise manual.

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

Configuração ClearSale Realtime#

Após realizar o ajuste cadastral junto ao time de suporte do carat para habilitar a integração com o serviço da ClearSale, a loja deverá inicializar uma transação de pagamento REST ou HTML enviando a propriedade "anti_fraud" e enviar os parâmetros adicionais coletados para análise de risco da transação sendo enviado no objeto additional_data.

Versões do serviço ClearSale suportadas por interface de pagamento:#

ClearSale - Total

ClearSale - RealTime

Parâmetros antifraude da ClearSale#

Abaixo segue uma relação de parâmetros de antifraude processados pela ClearSale.

ATENÇÃO: Os campos abaixo são específicos da integração ClearSale e os seus critérios de obrigatoriedade e formato dizem respeito às validações feitas pela instituição de análise de fraude. É importante que esses critérios sejam respeitados para uma análise eficaz e precisa.

Dados adicionais da transação Informações relativas ao comprador Informações relativas ao navegador do comprador Informações relativas à compra Informações relativas as redes sociais vinculadas Informações relativas à cobrança Informações relativas aos telefones de cobrança (os campos marcados com SIM só são obrigatórios caso seja criado o objeto phones) Informações relativas aos documentos de identificação para cobrança Informações relativas aos telefones de entrega (os campos marcados com SIM só são obrigatórios caso seja criado o objeto phones) Informações relativas aos documentos de identificação para entrega Informações relativas aos itens comprados Informações relativas ao endereço de pagamento (os campos marcados com SIM só são obrigatórios caso seja criado o objeto receiver_address) Informações relativas ao passageiro (os campos marcados com SIM só são obrigatórios caso seja criado o objeto passenger_data) Informações relativas às conexões aéreas (os campos marcados com SIM só são obrigatórios caso seja criado o objeto flight_connection) Informações relativas às reservas de hotel

Parâmetro	Descrição	Obrigatório	Formato
`additional_data`
`b2b_b2c`	Tipo de ecommerce.	NÃO	3 A
`item_amount`	Valor Total dos Itens em centavos	SIM	<1024 N
`total_order_amount`	Valor Total do Pedido em centavos. Composto pelo Valor Total dos Itens + Valor do Frete + Eventual Valor de Juros da Compra	SIM	<1024 N
`gift`	Identifica se o pedido é um presente: `1` - é um presente `0` - não é um presente Se ausente, assume-se valor `0`.	NÃO	1 N
`gift_message`	Mensagem de Presente	NÃO	<1024 AN
`obs`	Observação do Pedido	NÃO	<1024 AN
`sla_custom`	Valor em Minutos de SLA máximo de Análise do Pedido, se houver	NÃO	4 N
`origin`	Canal de Origem do Pedido (ex: TELEVENDAS, WEBSITE, APP, etc.)	SIM	<150 A
`channel_id`	Canal de Origem complementar, se houver. (ex: ANDROID, IOS, etc.)	NÃO	<1024 AN
`reservation_date`	Data do Primeiro Voo do Pedido (em caso de passagens aéreas).	NÃO	`yyyy-mm-ddThh:mm:ss`
`nationality`	Nacionalidade	NÃO	<50 AN
`product`	Identificador do produto ClearSale: `-1` (Outros) `1` (Application) `3` (Total) `4` (Total Garantido) `9` (Score) `10` (Realtime Decision) `11` (Tickets)	NÃO	2N
`bank_authentication`	Tipo de autenticação do banco	NÃO	<1024 AN
`sub_acquirer`	Nome do subadquirente	NÃO	<1024 AN
`list_type_id`	Tipo de Lista: `1` - Lista Não Cadastrada `2` - Lista de Chá de Bebê `3` - Lista de Casamento `4` - Lista de Desejos `5` - Lista de Aniversário `6` - Chá Bar / Chá de Panela	NÃO	1N
`list_id`	ID da lista na Loja	NÃO	<200 AN
`additional_data` `.payer`
`email`	E-mail do comprador	SIM	<1024 AN
`name`	Nome do comprador	SIM	<150 A
`legal_document`	Número do documento do comprador	SIM	<100 A
`additional_data` `.browser`
`ip_address`	IP do Pedido	NÃO	<1024 AN
`additional_data` `.purchase_information_data`
`last_date_change_inserted_mail`	Data da última alteração do e-mail	NÃO	`yyyy-mm-ddThh:mm:ss`
`last_date_change_password`	Data da última alteração da senha	NÃO	`yyyy-mm-ddThh:mm:ss`
`last_date_change_phone`	Data da última alteração do telefone	NÃO	`yyyy-mm-ddThh:mm:ss`
`last_date_change_mobile_phone`	Data da última alteração do telefone móvel	NÃO	`yyyy-mm-ddThh:mm:ss`
`last_date_inserted_address`	Data da última alteração do endereço	NÃO	`yyyy-mm-ddThh:mm:ss`
`purchase_logged`	Flag que indica compra com usuário logado: `1` para SIM `0` para NÃO Se ausente ou inválido, assume-se valor `0`	NÃO	1N
`email`	E-mail de Cadastro	NÃO	<1024 AN
`login`	Login de Acesso	NÃO	<1024 AN
`additional_data` `.social_network`
`social_network.opt_in_buy_and_trust`	Flag indicando se cliente aceita ingressar no movimento Compre e Confie: `1` para SIM `0` para NÃO Se ausente ou inválido, assume-se valor `0`	NÃO	1N
`social_network.type_social_network`	Identificador da Rede Social vinculada: `1` - Facebook `2` - Twitter `3` - Linkedin `4` - Google `5` - Outros	NÃO	1N
`social_network.authentication_token`	Token retornado pela Rede Social	NÃO	<1024 AN
`additional_data` `.billing_data`
`client_id`	Código do cliente	NÃO	<1024 AN
`person`	Tipo de Pessoa: `1` - Pessoa Física `2` - Pessoa Jurídica	SIM	1N
`cnpj_cpf`	CPF ou CNPJ. Caso ausente, ClearSale utiliza do valor informado na lista `additional_data.billing_data.documents[]` utilizando as chaves `CPF` ou `CNPJ`, o que ocorrer primeiro.	COND	<1024 AN
`identification_number`	RG ou Inscrição Estadual. Caso ausente, ClearSale utiliza do primeiro valor informado na lista `additional_data.billing_data.documents[]` utilizando a chave `RG`.	COND	<1024 AN
`name`	Nome do cliente	SIM	<1024 A
`birth_date`	Data de Nascimento	NÃO	`yyyy-mm-ddThh:mm:ss`
`email`	E-mail	NÃO	<1024 AN
`gender`	Sexo do comprador: `M` - Masculino `F` - Feminino	NÃO	1A
`billing_data` `.address`
`street_name`	Nome do logradouro	SIM	<1024 AN
`street_number`	Número do Endereço	SIM	<1024 AN
`complement`	Complemento do Endereço	NÃO	<1024 AN
`county`	Bairro do Endereço	SIM	<1024 AN
`city`	Cidade do Endereço	SIM	<1024 AN
`state`	Sigla do Estado do Endereço	SIM	2 A
`country`	País do Endereço	NÃO	<1024 AN
`zip_code`	CEP do Endereço	SIM	<1024 AN
`reference`	Referência do Endereço	NÃO	<1024 AN
`billing_data` `.phones[]`
`type`	Tipo do telefone: `0` - Não definido `1` - Residencial `2` - Comercial `3` - Recados `4` - Cobrança `5` - Temporário `6` - Celular	SIM	1N
`ddi`	DDI do Telefone	NÃO	3 N
`ddd`	DDD do Telefone	SIM	2 N
`number`	Número do Telefone	SIM	9 N
`extension`	Ramal do Telefone	NÃO	10 N
`billing_data` `.documents[]`
`type`	Tipo de Documento: `CPF` `CNPJ`	NÃO	<1024 AN
`number`	Número do Documento	NÃO	<1024 AN
`additional_data` `.shipment`
`client_id`	Código do cliente	NÃO	<1024 AN
`person`	Tipo de Pessoa: `1` - Pessoa Física `2` - Pessoa Jurídica	SIM	1N
`cnpj_cpf`	CPF ou CNPJ. Caso ausente, ClearSale utiliza do valor informado na lista `additional_data.shipment.documents[]` utilizando as chaves `CPF` ou `CNPJ`, o que ocorrer primeiro.	COND	<1024 AN
`identification_number`	RG ou Inscrição Estadual. Caso ausente, ClearSale utiliza do primeiro valor informado na lista `additional_data.shipment.documents[]` utilizando a chave `RG`.	COND	<1024 AN
`name`	Nome do destinatário	SIM	<1024 AN
`birth_date`	Data de nascimento do destinatário	NÃO	`yyyy-mm-ddThh:mm:ss`
`email`	Email do destinatário	NÃO	<1024 AN
`gender`	Sexo do destinatário: `M` - Masculino `F` - Feminino	NÃO	1A
`delivery_type`	Tipo de entrega: `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 `17` - Retirada via Lockers (Parceiros) `18` - Retirada em Agencia dos Correios `19` - Entrega Garantida no mesmo dia da compra `20` - Entrega Garantida no dia seguinte da compra `21` - Retirada em loja - Expresso	SIM	< 2N
`delivery_time`	Prazo de Entrega	NÃO	<1024 AN
`cost`	Valor do frete em centavos	NÃO	<1024 N
`pickup_store_document`	CPF para retirada em loja (caso o pedido seja de algum tipo de entrega "Retirada")	NÃO	<1024 N
`shipment` `.address`
`street_name`	Nome do logradouro	SIM	<1024 AN
`street_number`	Número do Endereço	SIM	<1024 AN
`complement`	Complemento do Endereço	NÃO	<1024 A
`county`	Bairro do Endereço	SIM	<1024 AN
`city`	Cidade do Endereço	SIM	<1024 AN
`state`	Sigla do Estado do Endereço	SIM	2 A
`country`	País do Endereço	NÃO	<1024 AN
`zip_code`	CEP do Endereço	SIM	<1024 AN
`reference`	Referência do Endereço	NÃO	<1024 AN
`shipment` `.phones[]`
`type`	Tipo do telefone: `0` - Não definido `1` - Residencial `2` - Comercial `3` - Recados `4` - Cobrança `5` - Temporário `6` - Celular	SIM	1N
`ddi`	DDI do Telefone	NÃO	3 N
`ddd`	DDD do Telefone	SIM	2 N
`number`	Número do Telefone	SIM	9N
`extension`	Ramal do Telefone	NÃO	10 N
`billing_data` `.documents[]`
`type`	Tipo de Documento: `CPF` `CNPJ`	NÃO	<1024 AN
`number`	Número do Documento	NÃO	<1024 AN
`additional_data` `.items[]`
`id`	Código do Produto	NÃO	<1024 AN
`title`	Nome do Produto	SIM	<1024 AN
`ean`	EAN (Código de barras) do produto	NÃO	<1024 AN
`unit_price`	Valor Unitário em centavos	NÃO	<1024 N
`quantity`	Quantidade	NÃO	<1024 N
`category_id`	Código da Categoria do Produto	NÃO	<1024 N
`category_name`	Nome da Categoria do Produto	NÃO	<1024 AN
`gift`	Identifica se o pedido é um presente: `1` - é um presente `0` - não é um presente Se ausente, assume-se valor `0`	NÃO	1N
`sellerName`	Nome fantasia do seller/parceiro	NÃO	<1024 AN
`sellerDocument`	CNPJ do seller/parceiro	NÃO	<1024 AN
`marketPlace`	Flag indicando se o estabelecimento é um market place: `true` ou `false`	NÃO	<5 A
`sellerSegment`	Segmento do seller/parceiro.	NÃO	<1024 AN
`shippingCompany`	Nome da Transportadora	NÃO	<1024 AN
`sequential`	Sequência de realização do pagamento	NÃO	<1024 N
`voucher_order_origin`	ID do pedido que gerou vale troca (caso a forma de pagamento atual seja `Vale`)	NÃO	<1024 AN
`payer` `.receiver_address`
`street_name`	Nome do logradouro	SIM	<1024 AN
`street_number`	Número do Endereço	SIM	<1024 AN
`complement`	Complemento do Endereço	NÃO	<1024 A
`county`	Bairro do Endereço	SIM	<1024 AN
`city`	Cidade do Endereço	SIM	<1024 AN
`state`	Sigla do Estado do Endereço	SIM	2 A
`country`	País do Endereço	NÃO	<1024 AN
`zip_code`	CEP do Endereço	SIM	<1024 AN
`reference`	Referência do Endereço	NÃO	<1024 AN
`additional_data` `.passenger_data[]`
`name`	Nome do Passageiro	SIM	<1024 AN
`company_mile`	Companhia de Milhagem (Fidelidade)	NÃO	<1024 AN
`frequente_flyer_card`	Cartão de Milhagem (Fidelidade)	NÃO	<1024 AN
`legal_document_type`	Tipo de documento de identificação: `1` - CPF `2` - CNPJ `3` - RG `4` - IE `5` - Passaporte `6` - CTPS `7` - Título Eleitor	NÃO	1N
`legal_document`	Número do Documento	NÃO	<1024 N
`birth_date`	Data de nascimento	NÃO	`yyyy-mm-ddThh:mm:ss`
`gender`	Sexo do Passageiro: `M` - Masculino `F` - Feminino	NÃO	1A
`additional_data` `.flight_connection[]`
`company`	Nome da Companhia Aérea	NÃO	<1024 AN
`flight_number`	Número do Voo	NÃO	<1024 AN
`flight_date`	Data do Voo	SIM	`yyyy-mm-ddThh:mm:ss`
`class`	Classe do Assento	NÃO	<1024 AN
`from`	Origem	NÃO	<1024 AN
`to`	Destino	NÃO	<1024 AN
`departure_date`	Data de Embarque	SIM	`yyyy-mm-ddThh:mm:ss`
`arrival_date`	Data de Desembarque	SIM	`yyyy-mm-ddThh:mm:ss`
`class_code`	Classe Tarifária	NÃO	<1024 AN
`additional_data` `.reservation_hotel[]`
`hotel`	Nome do Hotel	NÃO	<1024 AN
`city`	Cidade	NÃO	<1024 AN
`state`	Estado	NÃO	<1024 AN
`country`	País	NÃO	<1024 AN
`reservation_date`	Data da Reserva	NÃO	`yyyy-mm-ddThh:mm:ss`
`reservation_expiration_date`	Data da Expiração da Reserva	NÃO	`yyyy-mm-ddThh:mm:ss`
`checkin_date`	Data da Chegada	NÃO	`yyyy-mm-ddThh:mm:ss`
`checkout_date`	Data da Saída	NÃO	`yyyy-mm-ddThh:mm:ss`

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.

Requisição:

curl
--request POST "https://{{url}}/e-sitef/api/v1/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "merchant_usn":"27112936137",
   "order_id":"27112936137",
   "installments":"1",
   "installment_type":"4",
   "authorizer_id":"2",
   "amount":"1000",
   "additional_data":{
      "payer":{
         "email":"payer@email.com",
         "name" : "Payer Name",
         "legal_document" : "7777777777"
      },
      "shipment":{
         "type":"1",
         "name":"ShipmentName",
         "person":"1",
         "address":{
            "zip_code":"1111111",
            "street_number":"111",
            "street_name":"Billing StreetName",
            "city":"Billing City",
            "state":"Billing State",
            "county":"Billing County"
         }
      },
      "anti_fraud":"enabled_before_auth",
      "billing_data":{
         "person":"1",
         "name":"BillingName",
         "address":{
            "zip_code":"1111111",
            "street_number":"111",
            "street_name":"Billing StreetName",
            "city":"Billing City",
            "state":"Billing State",
            "county":"Billing County"
         }
      },
      "item_amount":"10",
      "origin":"origin",
      "total_order_amount":"10"
   }
}
--verbose

Resposta:

{
    "code": "0",
    "message": "OK. Transaction successful.",
    "payment": {
        "status": "NOV",
        "nit": "50f36d5b28510b0fb2b83951b533c5a9f9306b9ef54fc0a9220a5ce3c7845d17",
        "order_id": "27112936137",
        "merchant_usn": "27112936137",
        "amount": "1000"
    }
}

Exemplo de request com os demais parâmetros, para iniciar uma transação de pagamento com análise de risco.#

Requisição:

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor
esitef-homologacao.softwareexpress.com.br

curl
--request POST "https://{{url}}/e-sitef/api/v1/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "merchant_usn":"8032934075",
   "order_id":"08032934333",
   "installments":"1",
   "installment_type":"4",
   "authorizer_id":"2",
   "amount":"1000",
   "additional_data":{
      "items":[
         {
            "title":"title1",
            "quantity":"1",
            "unit_price":"1",
            "category_id":"categoryId1",
            "id":"id1",
            "gift":"true",
            "category_name":"categoryName1",
            "ean":"ean1",
            "seller_name":"sellerName1",
            "seller_document":"sellerDocument1",
            "market_place":"true",
            "seller_segment":"sellerSegment1",
            "shipping_company":"shippingCompany1"
         },
         {
            "title":"title2",
            "quantity":"2",
            "unit_price":"2",
            "category_id":"categoryId2",
            "id":"id2",
            "gift":"false",
            "category_name":"categoryName2",
            "ean":"ean2",
            "seller_name":"sellerName2",
            "seller_document":"sellerDocument2",
            "market_place":"false",
            "seller_segment":"sellerSegment2",
            "shipping_company":"shippingCompany2"
         }
      ],
      "payer":{
         "name":"Payer Name",
         "email":"payer@email.com",
         "city":"Payer City",
         "state":"SP",
         "legal_document":"7777777777",
         "address_street_name":"Payer Street",
         "address_street_number":"444",
         "address_zip_code":"6666666",
         "address_street_complement":"Payer Complement",
         "address_country":"Payer Country",
         "address_reference":"Payer Reference",
         "address_county":"Payer County",
         "neighborhood":"Payer County"
      },
      "shipment":{
         "type":"1",
         "cost":"5",
         "id":"ShipmentClientId",
         "name":"ShipmentName",
         "person":"1",
         "birth_date":"1990-01-10T00:00:00.000",
         "email":"Shipment@Email",
         "gender":"M",
         "address":{
            "zip_code":"2222222",
            "street_number":"111",
            "street_name":"Shipping StreetName",
            "complement":"Shipping Complement",
            "city":"Shipping City",
            "state":"Shipping State",
            "country":"Brasil",
            "county":"Shipping County",
            "reference":"Shipping Reference"
         },
         "legal_document1":"0987654321",
         "legal_document2":"87654321",
         "delivery_type":"1",
         "delivery_deadline":"2 dias uteis",
         "pickup_store_document":"12345678910"
      },
      "item_amount":"10",
      "anti_fraud":"enabled_before_auth",
      "passengers":[
         {
            "name":"Name1",
            "frequent_flyer_card":"frequentFlyerCard1",
            "legal_document_type":"1",
            "legal_document":"111111111",
            "birth_date":"2000-01-01T00:00:00",
            "company_mile":"companyMile1",
            "gender":"M"
         },
         {
            "name":"Name2",
            "frequent_flyer_card":"frequentFlyerCard2",
            "legal_document_type":"0",
            "legal_document":"22222222",
            "birth_date":"2000-01-02T00:00:00",
            "company_mile":"companyMile2",
            "gender":"M"
         }
      ],
      "connections":[
         {
            "company":"company1",
            "flight_number":"666",
            "flight_date":"2000-01-03T00:00:00",
            "class":"ECONOMY",
            "from":"BRA",
            "to":"ARG",
            "departure_date":"2000-01-04T00:00:00",
            "arrival_date":"2000-01-05T00:00:00",
            "class_code":"classCode1"
         },
         {
            "company":"company2",
            "flight_number":"333",
            "flight_date":"2000-01-06T00:00:00",
            "class":"ECONOMY",
            "from":"BRA",
            "to":"ENG",
            "departure_date":"2000-01-07T00:00:00",
            "arrival_date":"2000-01-08T00:00:00",
            "class_code":"classCode2"
         }
      ],
      "hotel_reservations":[
         {
            "hotel":"hotel1",
            "city":"city1",
            "state":"state1",
            "country":"country1",
            "reservation_date":"2000-01-09T00:00:00.000",
            "reservation_expiration_date":"2000-01-10T00:00:00.000",
            "checkin_date":"2000-01-11T00:00:00.000",
            "checkout_date":"2000-01-12T00:00:00.000"
         }
      ],
      "purchase_information_data":{
         "last_date_inserted_mail":"2020-01-01T01:01:01",
         "last_date_change_password":"2020-01-02T02:02:02",
         "last_date_change_phone":"2020-01-03T03:03:03",
         "last_date_change_mobile_phone":"2020-01-04T04:04:04",
         "last_date_inserted_address":"2020-01-05T05:05:05",
         "purchase_logged":"false",
         "email":"purchaseInformation@email",
         "login":"purchaseInformationLogin"
      },
      "billing_data":{
         "client_id":"BillingClientId",
         "person":"1",
         "gender":"M",
         "name":"BillingName",
         "birth_date":"1990-01-10T00:00:00.000",
         "email":"Billing@Email",
         "address":{
            "zip_code":"1111111",
            "street_number":"111",
            "street_name":"Billing StreetName",
            "complement":"Billing Complement",
            "city":"Billing City",
            "state":"Billing State",
            "country":"Brasil",
            "county":"Billing County",
            "reference":"Billing Reference"
         },
         "phones":[
            {
               "number":"199999999",
               "ddd":"11",
               "ddi":"55",
               "extension":"1888",
               "type":"1"
            },
            {
               "number":"299999999",
               "ddd":"11",
               "ddi":"55",
               "extension":"2888",
               "type":"2"
            }
         ],
         "cnpj_cpf":"12345678911",
         "identification_number":"12345678"
      },
      "b2b_b2c":"b2b",
      "sla_custom":"1",
      "gift":"true",
      "gift_message":"giftMessage",
      "obs":"obs",
      "origin":"origin",
      "nationality":"nationality",
      "product":"4",
      "list_type_id":"1",
      "list_id":"listId",
      "sequential":"33",
      "interest_value":"2",
      "interest":"10",
      "total_order_amount":"10",
      "browser":{
         "ip_address":"1111.222.333.444"
      },
      "bank_authentication":"bankAuthentication",
      "sub_acquirer":"subAcquirer",
      "social_network":{
         "opt_in_buy_and_trust":"1",
         "type_social_network":"1",
         "authentication_token":"authenticationToken"
      },
      "voucher_order_origin":"voucherOrderOrigin",
      "channel_id":"channelId"
   }
}
--verbose

Resposta:

{
    "code": "0",
    "message": "OK. Transaction successful.",
    "payment": {
        "status": "NOV",
        "nit": "0cbaaa37480ebb0f6480a944f99af1b4976a3a91db270f2dd20c15ac01dbaea4",
        "order_id": "08032934333",
        "merchant_usn": "8032934075",
        "amount": "1000"
    }
}

Request com os parâmetros mínimos para iniciar uma transação de pre-autorização com análise de risco#

Requisição:

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor
esitef-homologacao.softwareexpress.com.br

curl
--request POST "https://{{url}}/e-sitef/api/v1/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "merchant_usn":"27112936137",
   "order_id":"27112936137",
   "installments":"1",
   "transaction_type":"preauthorization",
   "installment_type":"4",
   "authorizer_id":"2",
   "amount":"1000",
   "additional_data":{
      "payer":{
         "email":"payer@email.com",
         "name" : "Payer Name",
         "legal_document" : "7777777777"
      },
      "shipment":{
         "type":"1",
         "name":"ShipmentName",
         "person":"1",
         "address":{
            "zip_code":"1111111",
            "street_number":"111",
            "street_name":"Billing StreetName",
            "city":"Billing City",
            "state":"Billing State",
            "county":"Billing County"
         }
      },
      "anti_fraud":"enabled_before_auth",
      "billing_data":{
         "person":"1",
         "name":"BillingName",
         "address":{
            "zip_code":"1111111",
            "street_number":"111",
            "street_name":"Billing StreetName",
            "city":"Billing City",
            "state":"Billing State",
            "county":"Billing County"
         }
      },
      "item_amount":"10",
      "origin":"origin",
      "total_order_amount":"10"
   }
}

--verbose

Resposta:

{
    "code": "0",
    "message": "OK. Transaction successful.",
    "pre_authorization": {
        "status": "NOV",
        "nit": "25b0bfc9ef3d38f1ca09fbcf6d6cb6957b78a04c731da707884dbaf85185f380",
        "order_id": "27112936137",
        "merchant_usn": "27112936137",
        "amount": "1000"
    }
}

Exemplo de request com os demais parâmetros, para iniciar uma transação de pre-autorização com análise de risco.#

Requisição:

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor
esitef-homologacao.softwareexpress.com.br

curl
--request POST "https://{{url}}/e-sitef/api/v1/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "merchant_usn":"8032934075",
   "order_id":"08032934333",
   "installments":"1",
   "installment_type":"4",
   "transaction_type":"preauthorization",
   "authorizer_id":"2",
   "amount":"1000",
   "additional_data":{
      "items":[
         {
            "title":"title1",
            "quantity":"1",
            "unit_price":"1",
            "category_id":"categoryId1",
            "id":"id1",
            "gift":"true",
            "category_name":"categoryName1",
            "ean":"ean1",
            "seller_name":"sellerName1",
            "seller_document":"sellerDocument1",
            "market_place":"true",
            "seller_segment":"sellerSegment1",
            "shipping_company":"shippingCompany1"
         },
         {
            "title":"title2",
            "quantity":"2",
            "unit_price":"2",
            "category_id":"categoryId2",
            "id":"id2",
            "gift":"false",
            "category_name":"categoryName2",
            "ean":"ean2",
            "seller_name":"sellerName2",
            "seller_document":"sellerDocument2",
            "market_place":"false",
            "seller_segment":"sellerSegment2",
            "shipping_company":"shippingCompany2"
         }
      ],
      "payer":{
         "name":"Payer Name",
         "email":"payer@email.com",
         "city":"Payer City",
         "state":"SP",
         "legal_document":"7777777777",
         "address_street_name":"Payer Street",
         "address_street_number":"444",
         "address_zip_code":"6666666",
         "address_street_complement":"Payer Complement",
         "address_country":"Payer Country",
         "address_reference":"Payer Reference",
         "address_county":"Payer County",
         "neighborhood":"Payer County"
      },
      "shipment":{
         "type":"1",
         "cost":"5",
         "id":"ShipmentClientId",
         "name":"ShipmentName",
         "person":"1",
         "birth_date":"1990-01-10T00:00:00.000",
         "email":"Shipment@Email",
         "gender":"M",
         "address":{
            "zip_code":"2222222",
            "street_number":"111",
            "street_name":"Shipping StreetName",
            "complement":"Shipping Complement",
            "city":"Shipping City",
            "state":"Shipping State",
            "country":"Brasil",
            "county":"Shipping County",
            "reference":"Shipping Reference"
         },
         "legal_document1":"0987654321",
         "legal_document2":"87654321",
         "delivery_type":"1",
         "delivery_deadline":"2 dias uteis",
         "pickup_store_document":"12345678910"
      },
      "item_amount":"10",
      "anti_fraud":"enabled_before_auth",
      "passengers":[
         {
            "name":"Name1",
            "frequent_flyer_card":"frequentFlyerCard1",
            "legal_document_type":"1",
            "legal_document":"111111111",
            "birth_date":"2000-01-01T00:00:00",
            "company_mile":"companyMile1",
            "gender":"M"
         },
         {
            "name":"Name2",
            "frequent_flyer_card":"frequentFlyerCard2",
            "legal_document_type":"0",
            "legal_document":"22222222",
            "birth_date":"2000-01-02T00:00:00",
            "company_mile":"companyMile2",
            "gender":"M"
         }
      ],
      "connections":[
         {
            "company":"company1",
            "flight_number":"666",
            "flight_date":"2000-01-03T00:00:00",
            "class":"ECONOMY",
            "from":"BRA",
            "to":"ARG",
            "departure_date":"2000-01-04T00:00:00",
            "arrival_date":"2000-01-05T00:00:00",
            "class_code":"classCode1"
         },
         {
            "company":"company2",
            "flight_number":"333",
            "flight_date":"2000-01-06T00:00:00",
            "class":"ECONOMY",
            "from":"BRA",
            "to":"ENG",
            "departure_date":"2000-01-07T00:00:00",
            "arrival_date":"2000-01-08T00:00:00",
            "class_code":"classCode2"
         }
      ],
      "hotel_reservations":[
         {
            "hotel":"hotel1",
            "city":"city1",
            "state":"state1",
            "country":"country1",
            "reservation_date":"2000-01-09T00:00:00.000",
            "reservation_expiration_date":"2000-01-10T00:00:00.000",
            "checkin_date":"2000-01-11T00:00:00.000",
            "checkout_date":"2000-01-12T00:00:00.000"
         }
      ],
      "purchase_information_data":{
         "last_date_inserted_mail":"2020-01-01T01:01:01",
         "last_date_change_password":"2020-01-02T02:02:02",
         "last_date_change_phone":"2020-01-03T03:03:03",
         "last_date_change_mobile_phone":"2020-01-04T04:04:04",
         "last_date_inserted_address":"2020-01-05T05:05:05",
         "purchase_logged":"false",
         "email":"purchaseInformation@email",
         "login":"purchaseInformationLogin"
      },
      "billing_data":{
         "client_id":"BillingClientId",
         "person":"1",
         "gender":"M",
         "name":"BillingName",
         "birth_date":"1990-01-10T00:00:00.000",
         "email":"Billing@Email",
         "address":{
            "zip_code":"1111111",
            "street_number":"111",
            "street_name":"Billing StreetName",
            "complement":"Billing Complement",
            "city":"Billing City",
            "state":"Billing State",
            "country":"Brasil",
            "county":"Billing County",
            "reference":"Billing Reference"
         },
         "phones":[
            {
               "number":"199999999",
               "ddd":"11",
               "ddi":"55",
               "extension":"1888",
               "type":"1"
            },
            {
               "number":"299999999",
               "ddd":"11",
               "ddi":"55",
               "extension":"2888",
               "type":"2"
            }
         ],
         "cnpj_cpf":"12345678911",
         "identification_number":"12345678"
      },
      "b2b_b2c":"b2b",
      "sla_custom":"1",
      "gift":"true",
      "gift_message":"giftMessage",
      "obs":"obs",
      "origin":"origin",
      "nationality":"nationality",
      "product":"4",
      "list_type_id":"1",
      "list_id":"listId",
      "sequential":"33",
      "interest_value":"2",
      "interest":"10",
      "total_order_amount":"10",
      "browser":{
         "ip_address":"1111.222.333.444"
      },
      "bank_authentication":"bankAuthentication",
      "sub_acquirer":"subAcquirer",
      "social_network":{
         "opt_in_buy_and_trust":"1",
         "type_social_network":"1",
         "authentication_token":"authenticationToken"
      },
      "voucher_order_origin":"voucherOrderOrigin",
      "channel_id":"channelId"
   }
}
--verbose

Resposta:

{
    "code": "0",
    "message": "OK. Transaction successful.",
    "pre_authorization": {
        "status": "NOV",
        "nit": "73fbbb226b2e66a4a731cda5459fdca45bc371da4f76d91d53cd48035e12a102",
        "order_id": "08032934333",
        "merchant_usn": "8032934075",
        "amount": "1000"
    }
}

Exemplo de request com os demais parâmetros, para iniciar uma transação de pagamento rest com realtime#

Requisição:

curl --location --request POST 'https://192.168.48.135/e-sitef/api/v1/transactions' \
--header 'Content-Type: application/json' \
--header 'merchant_id: CLEARSALERESTRT' \
--header 'merchant_key: D43B1ECD36CA0893AC6163A1913AFA084290530B861C84C672A21794CDC190C0' \
--data-raw '{
    "merchant_usn": "27112936137",
    "order_id": "1654629291772",
    "installments": "1",
    "installment_type": "4",
    "authorizer_id": "2",
    "amount": "3400",
    "additional_data": {
        "payer": {
            "email": "payer@email.com",
            "name": "Payer Name",
            "legal_document": "7777771777"
        },
        "shipment": {
            "type": "1",
            "name": "ShipmentName",
            "person": "1",
            "address": {
                "zip_code": "1111111",
                "street_number": "111",
                "street_name": "Billing StreetName",
                "city": "Billing City",
                "state": "Billing State",
                "county": "Billing County"
            }
        },
        "anti_fraud": "enabled_after_auth",
        "billing_data": {
            "person": "1",
            "name": "BillingName",
            "cnpj_cpf": "12345678901",
            "identification_number": "12345678999",
            "address": {
                "zip_code": "1111111",
                "street_number": "111",
                "street_name": "Billing StreetName",
                "city": "Billing City",
                "state": "Billing State",
                "county": "Billing County"
            }
        },
        "item_amount": "11",
        "origin": "origin",
        "total_order_amount": "11"
    }
}'

Resposta:

{
    "code": "0",
    "message": "OK. Transaction successful.",
    "payment": {
        "status": "NOV",
        "nit": "602d8e43b33427ac2c7f3a0f136a8f763d934d395c2727d3e292a94990179f17",
        "order_id": "1654629291772",
        "merchant_usn": "27112936137",
        "amount": "3400"
    }
}

Home

Credenciais necessárias#

Configuração de URL webhook#

Iniciando uma transação com Anti-Fraude#

Configuração ClearSale Realtime#

Versões do serviço ClearSale suportadas por interface de pagamento:#

Parâmetros antifraude da ClearSale#

Exemplo#

Exemplo de request com os demais parâmetros, para iniciar uma transação de pagamento com análise de risco.#

Request com os parâmetros mínimos para iniciar uma transação de pre-autorização com análise de risco#

Exemplo de request com os demais parâmetros, para iniciar uma transação de pre-autorização com análise de risco.#

Exemplo de request com os demais parâmetros, para iniciar uma transação de pagamento rest com realtime#