ClearSale

Required credentials#

As mentioned in "Overview - Required credentials", each institution has credentials that must be obtained for the integration. ClearSale's services demand credentials below:

Login (Merchant ID) - Login of the ClearSale merchant registration.
Password (Merchant Code) - Password of the store registration at ClearSale.

IMPORTANT: The credentials above should be obtained from ClearSale. It is recommended to contact ClearSale and receive guidance on how to obtain the credentials. Then, the merchant should contact Carat Portal support and send the credentials to register in Carat Portal.

Webhook URL Configuration#

In order for us to receive status updates from the risk analysis transactions, it is necessary to configure the webhook URL on the Konduto configuration environment.

Production URL:

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

This URL must be configured for any status changes. To perform this configuration, please contact ClearSale Support.

Starting a transaction with Anti-Fraud#

After performing the registration alignment with Carat Portal support to enable integration with the anti-fraud service, at the start of a transaction REST Payment (Learn more) or REST Pre Authorization (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 the additional_data object.

The anti_fraud field 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. In the case of pre-authorization with non-SiTef routings, if the risk analysis remains as a manual analysis, Carat leaves the transaction in the PPC (Payment Pending Confirmation) state and waits for a conclusion of the manual analysis.
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. In the case of pre-authorization with non-SiTef routings, Carat leaves the transaction in the PPC (Payment Pending Confirmation) state and waits for a conclusion of the manual analysis.

NOTE: Transactions that are pending payment can be confirmed or undone by time limit. Learn more.

Realtime ClearSale Configuration#

After performing the registration adjustment with the carat support team to enable the integration with the clearSale service, the store must initiate a REST or HTML payment transaction by sending the "anti_fraud" property and sending the parameters additional data collected for risk analysis of the transaction being sent in the additional_data object.

ClearSale service versions supported by payment interface:#

ClearSale - Total

ClearSale - RealTime

ClearSale REST Anti-Fraud Parameters#

Below is a list of anti-fraud parameters processed by ClearSale.

Attention: The fields below are specific to the ClearSale integration and their mandatory criteria and format refer to the validations made by the fraud analysis institution. It is important that these criteria are respected for an effective and accurate analysis.

Additional transaction data Buyer related information Information relating to the buyer's browser Purchase related information Information about linked social networks Billing information Information regarding billing phones (fields marked with YES are only mandatory if the phones object is created) Information regarding billing identification documents Information regarding delivery phones (fields marked with YES are only mandatory if the phones object is created) Information regarding identification documents for delivery Information regarding purchased items Information regarding the payment address (fields marked with YES are only mandatory if the receiver_address object is created) Passenger information (fields marked with YES are only required if the passenger_data object is created) Information regarding air connections (fields marked with YES are only mandatory if the flight_connection object is created) Information regarding hotel reservations

Parameter	Description	Mandatory	Format
`additional_data`
`b2b_b2c`	Ecommerce type.	NO	3 A
`item_amount`	Total Value of Items in cents	YES	<1024 N
`total_order_amount`	Total Order Amount in cents. Composed of the Total Value of the Items + Shipping Value + Possible Interest Value of the Purchase	YES	<1024 N
`gift`	Identifies if the order is a gift: `1` - is a gift `0` - is not a gift If absent, the value `0` is assumed.	NO	1 N
`gift_message`	Gift Message	NO	<1024 AN
`obs`	Order Observation	NO	<1024 AN
`sla_custom`	Maximum Order Review SLA Minutes Value, if any	NO	4 N
`origin`	Order Origin Channel (ex: TELE SALES, WEBSITE, APP, etc.)	YES	<150 A
`channel_id`	Complementary Source Channel, if any. (ex: ANDROID, IOS, etc.)	NO	<1024 AN
`reservation_date`	Date of First Flight of the Request (in case of airline tickets).	NO	`yyyy-mm-ddThh:mm:ss`
`nationality`	Nationality	NO	<50 AN
`product`	ClearSale product identifier: `-1` (Others) `1` (Application) `3` (Total) `4` (Total Garantido) `9` (Score) `10` (Realtime Decision) `11` (Tickets)	NO	2N
`bank_authentication`	Bank authentication type	NO	<1024 AN
`sub_acquirer`	Sub-acquirer name	NO	<1024 AN
`list_type_id`	List Type: `1` - Unregistered List `2` - Baby Shower List `3` - Wedding List `4` - Wish List `5` - Birthday List `6` - Bridal Shower	NO	1N
`list_id`	List ID in Store	NO	<200 AN
`additional_data` `.payer`
`email`	Buyer's email	YES	<1024 AN
`name`	Buyer name	YES	<150 A
`legal_document`	Buyer's document number	YES	<100 A
`additional_data` `.browser`
`ip_address`	Order IP	NO	<1024 AN
`additional_data` `.purchase_information_data`
`last_date_change_inserted_mail`	Date of last email change	NO	`yyyy-mm-ddThh:mm:ss`
`last_date_change_password`	Date of last password change	NO	`yyyy-mm-ddThh:mm:ss`
`last_date_change_phone`	Date of last phone change	NO	`yyyy-mm-ddThh:mm:ss`
`last_date_change_mobile_phone`	Mobile phone last change date	NO	`yyyy-mm-ddThh:mm:ss`
`last_date_inserted_address`	Date of last address change	NO	`yyyy-mm-ddThh:mm:ss`
`purchase_logged`	Flag that indicates purchase with logged in user: `1` for YES `0` for NO If absent or invalid, value `0` is assumed	NO	1N
`email`	Registration Email	NO	<1024 AN
`login`	Access Login	NO	<1024 AN
`additional_data` `.social_network`
`social_network.opt_in_buy_and_trust`	Flag indicating if the customer accepts to join the Buy and Trust movement: `1` for YES `0` for NO If absent or invalid, value `0` is assumed	NO	1N
`social_network.type_social_network`	Linked Social Network Identifier: `1` - Facebook `2` - Twitter `3` - Linkedin `4` - Google `5` - Others	NO	1N
`social_network.authentication_token`	Token returned by the Social Network	NO	<1024 AN
`additional_data` `.billing_data`
`client_id`	Customer code	NO	<1024 AN
`person`	Type of Person: `1` - Individual `2` - Legal Entity	YES	1N
`cnpj_cpf`	CPF or CNPJ. If absent, ClearSale uses the value informed in the `additional_data.billing_data.documents[]` list using the keys `CPF` or `CNPJ`, whichever comes first.	COND	<1024 AN
`identification_number`	RG or State Registration. If absent, ClearSale uses the first value informed in the `additional_data.billing_data.documents[]` list using the `RG` key.	COND	<1024 AN
`name`	Client name	YES	<1024 A
`birth_date`	Birth date	NO	`yyyy-mm-ddThh:mm:ss`
`email`	E-mail	NO	<1024 AN
`gender`	Buyer's Gender: `M` - Male `F` - Female	NO	1A
`billing_data` `.address`
`street_name`	Street name	YES	<1024 AN
`street_number`	Address Number	YES	<1024 AN
`complement`	Address complement	NO	<1024 AN
`county`	Address county	YES	<1024 AN
`city`	Address City	YES	<1024 AN
`state`	Address State Abbreviation	YES	2 A
`country`	Address Country	NO	<1024 AN
`zip_code`	Address zip code	YES	<1024 AN
`reference`	Address Reference	NO	<1024 AN
`billing_data` `.phones[]`
`type`	Phone type: `0` - Not defined `1` - Residential `2` - Commercial `3` - Messages `4` - Billing `5` - Temporary `6` - Mobile	YES	1N
`ddi`	Telephone DDI	NO	3 N
`ddd`	Telephone DDD	YES	2 N
`number`	Telephone number	YES	9 N
`extension`	Telephone extension	NO	10 N
`billing_data` `.documents[]`
`type`	Document Type: `CPF` `CNPJ`	NO	<1024 AN
`number`	Document number	NO	<1024 AN
`additional_data` `.shipment`
`client_id`	customer code	NO	<1024 AN
`person`	Type of Person: `1` - Individual `2` - Legal Entity	YES	1N
`cnpj_cpf`	CPF or CNPJ. If absent, ClearSale uses the value informed in the `additional_data.shipment.documents[]` list using the keys `CPF` or `CNPJ`, whichever comes first.	COND	<1024 AN
`identification_number`	RG or State Registration. If absent, ClearSale uses the first value informed in the `additional_data.shipment.documents[]` list using the `RG` key.	COND	<1024 AN
`name`	Recipient's name	YES	<1024 AN
`birth_date`	Recipient's date of birth	NO	`yyyy-mm-ddThh:mm:ss`
`email`	Recipient's Email	NO	<1024 AN
`gender`	Recipient's Gender: `M` - Male `F` - Female	NO	1A
`delivery_type`	Delivery type: `0` - Other `1` - Normal `2` - Guaranteed `3` - ExpressBR `4` - ExpressSP `5` - High `6` - Economic `7` - Scheduled `8` - Extra Fast `9` - Printed `10` - Application `11` - Mail `12` - Motoboy `13` - Ticket office withdrawal `14` - Partner Store withdrawal `15` - Ticket Credit Card `16` - Store Pickup `17` - Withdrawal via Lockers (Partners) `18` - Post Office Pickup `19` - Guaranteed delivery on the same day of purchase `20` - Guaranteed delivery on the next day of purchase `21` - Pickup in store - Express	YES	< 2N
`delivery_time`	Deadline	NO	<1024 AN
`cost`	Shipping cost in cents	NO	<1024 N
`pickup_store_document`	CPF for pick up in store (if the order is for some type of delivery "Withdrawal")	NO	<1024 N
`shipment` `.address`
`street_name`	Street name	YES	<1024 AN
`street_number`	Address Number	YES	<1024 AN
`complement`	Address complement	NO	<1024 A
`county`	Address county	YES	<1024 AN
`city`	Address City	YES	<1024 AN
`state`	Address State Abbreviation	YES	2 A
`country`	Address Country	NO	<1024 AN
`zip_code`	Address zip code	YES	<1024 AN
`reference`	Address Reference	NO	<1024 AN
`shipment` `.phones[]`
`type`	Phone type: `0` - Not defined `1` - Residential `2` - Commercial `3` - Messages `4` - Billing `5` - Temporary `6` - Mobile	YES	1N
`ddi`	Telephone DDI	NO	3 N
`ddd`	Telephone DDD	YES	2 N
`number`	Telephone number	YES	9N
`extension`	Telephone extension	NO	10 N
`billing_data` `.documents[]`
`type`	Document Type: `CPF` `CNPJ`	NO	<1024 AN
`number`	Document number	NO	<1024 AN
`additional_data` `.items[]`
`id`	Product code	NO	<1024 AN
`title`	Product's name	YES	<1024 AN
`ean`	EAN (Barcode) of the product	NO	<1024 AN
`unit_price`	Unit Value in cents	NO	<1024 N
`quantity`	Quantity	NO	<1024 N
`category_id`	Product Category Code	NO	<1024 N
`category_name`	Product Category Name	NO	<1024 AN
`gift`	Identifies if the order is a gift: `1` - it is a gift `0` - not a gift If absent, the `0` value is assumed	NO	1N
`sellerName`	Seller's/partner's trade name	NO	<1024 AN
`sellerDocument`	Seller/partner CNPJ	NO	<1024 AN
`marketPlace`	Flag indicating whether the establishment is a market place: `true` or `false`	NO	<5 A
`sellerSegment`	Seller/Partner Segment.	NO	<1024 AN
`shippingCompany`	Carrier name	NO	<1024 AN
`sequential`	Sequence of making the payment	NO	<1024 N
`voucher_order_origin`	Order ID that generated the exchange voucher (if the current payment method is `Vale`)	NO	<1024 AN
`payer` `.receiver_address`
`street_name`	Street name	YES	<1024 AN
`street_number`	Address Number	YES	<1024 AN
`complement`	Address complement	NO	<1024 A
`county`	Address county	YES	<1024 AN
`city`	Address City	YES	<1024 AN
`state`	Address State Abbreviation	YES	2 A
`country`	Address Country	NO	<1024 AN
`zip_code`	Address zip code	YES	<1024 AN
`reference`	Address Reference	NO	<1024 AN
`additional_data` `.passenger_data[]`
`name`	Passenger name	YES	<1024 AN
`company_mile`	Mileage Company (Loyalty)	NO	<1024 AN
`frequente_flyer_card`	Mileage Card (Loyalty)	NO	<1024 AN
`legal_document_type`	Type of identification document: `1` - CPF `2` - CNPJ `3` - RG `4` - IE `5` - Passport `6` - CTPS `7` - Voter Title	NO	1N
`legal_document`	Document number	NO	<1024 N
`birth_date`	Date of birth	NO	`yyyy-mm-ddThh:mm:ss`
`gender`	Passenger's Gender: `M` - Male `F` - Female	NO	1A
`additional_data` `.flight_connection[]`
`company`	Airline name	NO	<1024 AN
`flight_number`	Flight number	NO	<1024 AN
`flight_date`	Flight date	YES	`yyyy-mm-ddThh:mm:ss`
`class`	Seat Class	NO	<1024 AN
`from`	Origin	NO	<1024 AN
`to`	Destiny	NO	<1024 AN
`departure_date`	Boarding Date	YES	`yyyy-mm-ddThh:mm:ss`
`arrival_date`	Landing date	YES	`yyyy-mm-ddThh:mm:ss`
`class_code`	Tariff Class	NO	<1024 AN
`additional_data` `.reservation_hotel[]`
`hotel`	Hotel name	NO	<1024 AN
`city`	City	NO	<1024 AN
`state`	State	NO	<1024 AN
`country`	Country	NO	<1024 AN
`reservation_date`	Booking Date	NO	`yyyy-mm-ddThh:mm:ss`
`reservation_expiration_date`	Reservation Expiration Date	NO	`yyyy-mm-ddThh:mm:ss`
`checkin_date`	Date of arrival	NO	`yyyy-mm-ddThh:mm:ss`
`checkout_date`	Departure Date	NO	`yyyy-mm-ddThh:mm:ss`

Example#

The following is an example of a request with the minimum parameters to start a payment transaction with risk analysis. Learn more about payment parameters.

To use this example, don't forget to define the variable {{url}} to the value
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",
   "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

Response:

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

Example of a request with all parameters to begin a risk analysis payment transaction#

Request:

To use this example, don't forget to define the variable {{url}} to the value
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

Response:

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

Example of a request with the minimum parameters to begin a Pre-Authorization transaction with risk analysis.#

Request:

To use this example, don't forget to define the variable {{url}} to the value
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

Response:

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

Example of a request with the other parameters to start a Pre-Authorization transaction with risk analysis.#

Request:

To use this example, don't forget to define the variable {{url}} to the value
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

Response:

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

Example of request with the other parameters, to start a payment transaction rest with Realtime#

Request:

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"
    }
}'

Response:

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

Home

Required credentials#

Webhook URL Configuration#

Starting a transaction with Anti-Fraud#

Realtime ClearSale Configuration#

ClearSale service versions supported by payment interface:#

ClearSale REST Anti-Fraud Parameters#

Example#

Example of a request with all parameters to begin a risk analysis payment transaction#

Example of a request with the minimum parameters to begin a Pre-Authorization transaction with risk analysis.#

Example of a request with the other parameters to start a Pre-Authorization transaction with risk analysis.#

Example of request with the other parameters, to start a payment transaction rest with Realtime#