e-SiTef

e-SiTef

  • Portal do Desenvolvedor
  • Fale Conosco
  • English

›REST Payment

REST Payment

  • Overview
  • Quick start
  • Transaction creation service
  • Payment effectuation service
  • Payment confirmation service
  • Transaction status query
  • Multiple transactions status query
  • Card query service
  • Payment with multiple payment methods service
  • Payment with multiple payment methods confirmation service
  • External origin payment confirmation service

REST Store

  • Overview

REST Cancel

  • Flow
  • Quick start
  • Cancel via host
  • Cancel external origin
  • Cancel creation service
  • Cancel service

REST Pre-Authorization

  • Overview
  • Quick start
  • Pre-Authorization Creation Service
  • Pre-Authorization effectuation service
  • Pre-Authorization Status Query
  • Pre-Authorization Editing Service
  • Pre-Authorization Editing External Origin Service
  • Pre-Authorization Increment Service
  • Card Query Service
  • Pre-Authorization Capture Service
  • Pre-Authorization Capture External Origin Service

REST Schedule

  • Overview
  • Quick start
  • Transaction creation service
  • Schedule activation service
  • Execution of the scheduled payments
  • Schedule editing flow
  • Quick start: schedule editing
  • Schedule editing creation service
  • Schedule editing service

REST Recharge

  • Overview
  • Quick start
  • Recharge creation service
  • List dealers service
  • List branch data service
  • Recharge effectuation service
  • Recharge confirmation service
  • Recharge query service

HTML Payment

  • Overview
  • Quick start
  • Initializing a payment transaction
  • Status notification
  • Transaction status query
  • Payment with card storage
  • Pages Customization
  • Payment link
  • Split Payment
  • Payment with multiple payment methods
  • 3DS 2.0 Integration

HTML Pre-Authorization

  • Overview

HTML Recharge

  • Overview
  • Quick start
  • Initializing a Recharge transaction

REST Generic Operations

  • Overview
  • Token creation service
  • Generic operation service

JavaScript Payment

  • Overview
  • Quick start
  • Transaction creation service
  • Virtual store's payment page
  • Transaction query service

JavaScript Store

  • Overview
  • Quick start
  • Transaction creation service
  • Virtual store's page

Merchant Web Page

  • Introduction
  • Access to web page
  • Two-Factor Authentication
  • User Configuration
  • Configure Authorizers
  • Transaction Report
  • Daily Summary Report
  • Store Report
  • Recharge Report
  • Analytical Report
  • Transaction Cancellation
  • Schedule
  • Configure Risk Analysis
  • Configure Order Authorizers
  • Users Administration
  • Generate Payment Link

Retry

  • Overview
  • Flow
  • Retry and Schedule

SiTef Routings

  • Bradescard
  • Cetelem
  • GetnetLac
  • Orbitall
  • Vero
  • Bin
  • Sipag

Non SiTef Routings

  • Banco do Brasil
  • Banrisul Vero
  • Cielo e-Commerce
  • EPX
  • e.Rede Rest
  • Fepas HUB
  • Getnet WS
  • GlobalPayments WS
  • IPG
  • Itaú Shopline
  • Mercado Pago
  • PagSeguro
  • PayPal
  • SafraPay
  • Stone WS

Digital Wallet

  • Overview
  • VEE Digital Wallet via CardSE
  • Pix via CardSE
  • Google Pay
  • Visa Checkout
  • Masterpass
  • Samsung Pay
  • Apple Pay
  • Configuration for Digital Wallets

Anti-Fraud Integration

  • Overview
  • Risk analysis service on the HTML Interface
  • Risk analysis response
  • Manual review flow
  • Fraud notification service
  • ClearSale
  • CyberSource
  • Konduto
  • Fraud Detect

General Information

  • Authorizers
  • Digital Certificates
  • API codes
  • Soft Descriptor
  • Signature authentication

Batch Registrations

  • Batch Store Registration
  • Batch Routing Configuration

REST Merchants Registration

  • Overview
  • Quick start
  • Token creation service
  • Merchant creation service
  • Merchant editing service
  • Merchant query service
  • Merchant status query service
  • List merchants service
  • API codes

3DS Server

  • Overview
  • Quick start
  • Transaction creation service
  • Authentication service
  • Transaction query service
  • Challenge messages
  • Decoupled notification
  • Initiating a 3DS Method
  • API codes

Transaction creation service

Consuming the transaction creation service is mandatory in both the payment and scheduling flows. As a result of this operation, the merchant will obtain a NIT (payment) and/or a SID (schedule) which will be necessary for the next steps of the flow, as the utilization of transaction query service.

The NIT and the SID have a time limit for their utilization. This deadline is configured on e-SiTef, and if it's exceeded, the transaction will be altered from status NOV (new) to EXP (expired), which blocks further operations with this transaction, making it necessary to consume the transaction creation service again.

Call details

  • Resource: /v1/transactions
  • HTTP Method: POST
  • Request format: JSON
  • Response format: JSON
  • Header parameters:
ParameterDescriptionFormatMandatory
merchant_idMerchant code on e-SiTef. The production and certification codes will be different.< 15 ANYES
merchant_keyMerchant authentication key on e-SiTef. The production and certification keys will be different.< 80 ANYES
Content-TypeIt must be sent with the value application/json.= 15 ANYES

Examples

Below are some examples of the transaction creation service call using the cURL tool.

Creating a payment with automatic confirmation

Request:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header “merchant_key: xxxxxxxxxxx”
--data-binary
{
   "merchant_usn":"12042142155",
   "order_id":"12042142155",
   "installments":"1",
   "installment_type":"4",
   "authorizer_id":"2",
   "amount":"1000"
}
--verbose

Response:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "payment":{
      "status":"NOV",
      "nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
      "order_id":"12042142155",
      "merchant_usn":"12042142155",
      "amount":"1000"
   }
}

Creating a payment with late confirmation

Request:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header “merchant_key: xxxxxxxxxxx”
--data-binary
{
   "merchant_usn":"12050620649",
   "order_id":"12050620649",
   "installments":"1",
   "installment_type":"4",
   "authorizer_id":"2",
   "amount":"1000",
   "additional_data":{
      "postpone_confirmation":"true"
   }
}
--verbose

Response:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "payment":{
      "status":"NOV",
      "nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
      "order_id":"12050620649",
      "merchant_usn":"12050620649",
      "amount":"1000"
   }
}

Creating a payment with schedule

Request:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "merchant_usn":"12053724147",
   "order_id":"12053724147",
   "installments":"1",
   "installment_type":"4",
   "authorizer_id":"2",
   "amount":"1000",
   "schedule":{
      "amount":"900",
      "initial_date":"03/08/2017",
      "number_of_times":"3",
      "interval":"1",
      "installments":"1",
      "installment_type":"4",
      "soft_descriptor":"Assinatura",
      "show_times_invoice":"false"
   },
   "additional_data":{
      "payer":{
         "store_identification":"98253053045"
      }
   }
}
--verbose

Response:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "payment":{
      "status":"NOV",
      "nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
      "order_id":"12053724147",
      "merchant_usn":"12053724147",
      "amount":"1000"
   },
   "schedule":{
      "status":"NOV",
      "sid":"qwertyuiopasdfghjklzxcvbnm0123456789qwertyuiopasdfghjklzxcvbnm01",
      "amount":"900",
      "order_id":"12053724147",
      "merchant_usn":"12053724147"
   }
}

Creating a schedule without payment

Request:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxxxxxx"
--data-binary
{
   "merchant_usn":"12055523043",
   "order_id":"12055523043",
   "authorizer_id":"2",
   "schedule":{
      "amount":"900",
      "do_payment_now":"false",
      "initial_date":"03/08/2017",
      "number_of_times":"3",
      "interval":"1",
      "installments":"1",
      "installment_type":"4",
      "soft_descriptor":"Assinatura",
      "show_times_invoice":"false"
   },
   "additional_data":{
      "payer":{
         "store_identification":"98253053045"
      }
   }
}
--verbose

Response:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "schedule":{
      "status":"NOV",
      "sid":"qwertyuiopasdfghjklzxcvbnm0123456789qwertyuiopasdfghjklzxcvbnm01",
      "amount":"900",
      "order_id":"12055523043",
      "merchant_usn":"12055523043"
   }
}

Creating a payment with Cielo e-Commerce fraud analysis

Request:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header “merchant_key: xxxxxxxxxxx”
--data-binary
{
   "merchant_usn":"12042142155",
   "order_id":"12042142155",
   "installments":"1",
   "installment_type":"4",
   "authorizer_id":"2",
   "amount":"1000",
   "additional_data":{
      "payer":{
         "name":"Comprador",
         "surname":"credito AF",
         "email":"compradorteste@live.com",
         "city":"Rio de Janeiro",
         "state":"RJ",
         "address_street_name":"Rua Jupiter",
         "address_street_number":"174",
         "address_zip_code":"21241140",
         "born_date":"1991-01-02T08:30:00",
         "address_street_complement":"AP 201",
         "address_country":"BRA"
      },
      "shipment":{
         "method":"LOW_COST",
         "name":"Sr Comprador Teste",
         "phones":[
            {
               "number":"21114740",
               "ddd":"16",
               "ddi":"55"
            }
         ],
         "receiver_address":{
            "complement":"AP 201",
            "city":"Rio de Janeiro",
            "state":"RJ",
            "country":"BRA",
            "zip_code":"21241140",
            "street_number":"174",
            "street_name":"Rua Jupiter"
         }
      },
      "connections":[
         {
            "from":"RAO",
            "to":"SAO",
            "flight_date":"2020-01-02T20:15:00"
         }
      ],
      "gift":"false",
      "browser":{
         "email":"compradorteste@live.com",
         "agent":"Chrome",
         "cookies_accepted":"false",
         "host_name":"Teste",
         "ip_address":"200.190.150.350"
      },
      "items":[
         {
            "title":"ItemTeste",
            "quantity":"1",
            "id":"1487337308522",
            "risk":"HIGH",
            "hedge":{
               "time":"NORMAL",
               "host":"OFF",
               "nonSensical":"OFF",
               "obscenities":"OFF",
               "phone":"OFF",
               "velocity":"HIGH"
            },
            "passenger":{
               "name":"Comprador accept",
               "email":"compradorteste@live.com",
               "rating":"ADULT",
               "phone":{
                  "number":"999994444",
                  "ddd":"11",
                  "ddi":"55"
               },
               "legal_document":"1234567890",
               "customer_class":"Gold"
            },
            "unit_price":"1000",
            "category_id":"other",
            "gift_category":"OFF"
         }
      ],
      "extra_param":{
         "acquirer_params":[
            {
               "key":"95",
               "value":"Eu defini isso"
            }
         ]
      },
      "anti_fraud":"enabled_before_auth",
      "anti_fraud_institution":"AUTHORIZER",
      "anti_fraud_criteria":"ALWAYS",
      "finger_print_id":"074c1ee676ed4998ab66491013c565e2",
      "returns_accepted":"true",
      "journey_type":"OUTWARD"
   }
}
--verbose

Response:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "payment":{
      "status":"NOV",
      "nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
      "order_id":"12042142155",
      "merchant_usn":"12042142155",
      "amount":"1000"
   }
}

Creating a payment with risk analysis (using Konduto antifraud)

For further information, please refer to our specific Konduto section.

Request:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "merchant_usn":"2423423434",
   "order_id":"2432342343",
   "installments":"1",
   "installment_type":"4",
   "authorizer_id":"2",
   "amount":"1300",
   "additional_data":{
      "anti_fraud":"enabled_before_auth",
      "visitor_id":"XKhas09jcks",
      "items":[
         {
            "title":"title1",
            "quantity":"1",
            "unit_price":"1111",
            "description":"description1",
            "id":"id1",
            "discount_amount":"111",
            "sku":"sku1",
            "creation_date":"11/01/2011"
         }
      ],
      "payer":{
         "name":"Marcos",
         "surname":"da Silva",
         "email":"marocs@dasilva.com",
         "born_date":"1990-01-01T11:11:11",
         "creation_date":"02/03/2004",
         "is_new_client":"true",
         "is_vip_client":"true",
         "phones":[
            {
               "number":"333333333",
               "ddd":"22",
               "ddi":"11"
            },
            {
               "number":"666666666",
               "ddd":"55",
               "ddi":"44"
            }
         ],
         "identification_number":"47764543004"
      },
      "shipment":{
         "name":"Fernando",
         "surname":"Bezerra",
         "address":{
            "zip_code":"98764312",
            "street_number":"987",
            "street_name":"Rua Shipment",
            "complement":"ap. 587",
            "city":"São Shipment",
            "state":"MA",
            "country":"BRA"
         }
      },
      "passengers":[
         {
            "name":"Miguel",
            "last_name":"Herrera",
            "frequent_flyer_card":"frequentFlyerCard",
            "legal_document_type":"1",
            "legal_document":"12312312312",
            "birth_date":"1980-07-28T10:40:00",
            "customer_class":"customerClass",
            "nationality":"BRA",
            "is_frequent_traveler":"true",
            "is_with_special_needs":"true"
         }
      ],
      "connections":[
         {
            "company":"Verde",
            "class":"first",
            "from":"GRU",
            "to":"CGH",
            "departure_date":"2023-09-07T07:09:00",
            "journey_type":"OUTWARD",
            "origin_city":"San Juan",
            "destination_city":"Homero Lopez",
            "class_code":"VIP"
         },
         {
            "company":"Rosa",
            "class":"economy",
            "from":"BSB",
            "to":"VCP",
            "departure_date":"2022-10-21T16:39:00",
            "journey_type":"RETURN",
            "origin_city":"San Pablo",
            "destination_city":"Juanito Cruz",
            "class_code":"ECONOMY"
         }
      ],
      "hotel_reservations":[
         {
            "hotel":"Hotel Green Tree",
            "address":{
               "zip_code":"83392019",
               "street_number":"529",
               "street_name":"Rua Hoteleira",
               "complement":"ap. 019",
               "city":"San Hotel",
               "state":"AC",
               "country":"EN"
            },
            "rooms":[
               {
                  "number":"902",
                  "code":"ROOM902",
                  "type":"King Size",
                  "check_in_date":"2020-01-09T12:30:00",
                  "check_out_date":"2020-01-19T13:00:00",
                  "number_of_guests":"1",
                  "board_basis":"Vegan",
                  "guests":[
                     {
                        "name":"José Aníbal",
                        "document":"98798798712",
                        "document_type":"cpf",
                        "birth_date":"12/03/1970",
                        "nationality":"BRA"
                     }
                  ]
               }
            ],
            "category":"categoryhotel"
         }
      ],
      "billing_data":{
         "address":{
            "zip_code":"12341234",
            "street_number":"666",
            "street_name":"Rua Billing",
            "complement":"ap. 2369",
            "city":"São Billing",
            "state":"AM",
            "country":"BRA"
         }
      },
      "travel":{
         "transport_type":"flight",
         "expiration_date":"2022-02-14T01:30:00"
      },
      "discount_info":"Informações de desconto",
      "events":[
         {
            "name":"Evento de Rock",
            "date":"2021-11-22T09:28:00",
            "type":"show",
            "subtype":"music",
            "venue":{
               "name":"Debicard Hall",
               "street_name":"Rua do Evento",
               "street_number":"928",
               "city":"Jardinópolis",
               "state":"MS",
               "country":"DO",
               "capacity":"300"
            },
            "tickets":[
               {
                  "id":"12h374612h4h",
                  "category":"social",
                  "section":"Seção 1",
                  "premium":"true",
                  "attendee":{
                     "name":"Daniel Almeida",
                     "document":"71728293945",
                     "document_type":"other",
                     "birth_date":"03/10/1990"
                  }
               }
            ]
         }
      ]
   }
}
--verbose

Response:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "payment":{
      "status":"NOV",
      "nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
      "order_id":"12042142155",
      "merchant_usn":"2432342343",
      "amount":"1300"
   }
}

Request parameters

The table below describes the request parameters of the transaction creation service:

ParameterDescriptionFormatMandatory
merchant_usnUnique sequential number for each order, created by the merchant. The USN will be used during the whole communication with the merchant to help identifying the order. As it is a possible access key on the merchant's side, even though it's optional to e-SiTef, it's strongly recommended that the field is formatted and sent by the merchant's application.< 12 NNO
order_idOrder code defined by the merchant. It's advised that it is different for each order so that it becomes easier to track it.
If the merchant's integration with the acquirers (Cielo, Rede, etc) is with e-SiTef and SiTef, the order_id field that has a maximum length of 40 characters, will be reduced to 12 characters, due to a restriction on SiTef. This reduction will be done maintaining the characters from left to right (example: if the inserted order ID is 12345678901234567890 on e-SiTef, on SiTef it will be only 123456789012).
< 40 ANNO
installmentsNumber of installments. Send 1 for spot sales.< 2 NYES
installment_typeInstallment financing type:
Value 3 = installments with interest.
Value 4 = installments without interest (use this value also on spot sales).
Value 6 = installments with interest (IATA).
Value 7 = installments without interest (IATA).
The IATA financing types are only used by companies that work with air transportation.
< 2 NYES
authorizer_idCode of the authorizer on e-SiTef. Learn more.< 3 NNO
amountTotal price of the purchase (in cents). Example: 1,00 = 100 or 1.100,00 = 110000 – send the value without the comma and the dots.< 12 NYES
soft_descriptorAdditional text that will be presented alongside the name of the establishment in the credit card invoice. Learn more< 30 ANNO
authorizer_authenticationThis field must be sent with value true if a payment with authentication is desired. This functionality is only available to Cielo e-Commerce and e.Rede REST.< 5 T/FNO
encrypted_cardThis field must be sent with value true if the card number to be sent in the step of the flow uses SiTef's encryption.
The option to send the encrypted card will only be possible with a SiTef routing and it's necessary to pre-configure the SiTef used by the merchant accordingly.
< 5 T/FNO
iata This element contains specific fields for IATA transactions.
departure_taxDeparture tax in cents.< 12 NYES only for installment_type = 6 or 7
first_installmentAmount of the first installment on IATA transactions in cents. This functionality is only available to the Rede acquirer.< 12 NNO
schedule Sending the schedule element implies on using the schedule functionality. None of its fields are mandatory if making a simple payment only is desired.
amountAmount in cents of the recurrent payments. If this field is not sent, the payment amount will be used.< 12 NYES
initial_dateExecution date of the first scheduled payment. This date must have at least two days ahead of the current day and the days 29, 30 and 31 are never allowed.
The date format to be followed is: DD/MM/YYYY
Example: 20/04/2021
= 10 DYES
number_of_timesNumber of scheduled payments to be executed. If this field is not sent, the schedule will be active infinitely.< 3 NNO
intervalInterval in months between each scheduled payment. If this field is not sent, the value 1 will be used (monthly executions).< 2 NNO
do_payment_nowSend this field with the value false if a schedule without immediate payment is desired.
If this field is absent or any value other than false, a schedule with immediate payment will be created.
< 5 T/FNO
installmentsNumber of installments of each scheduled payment. If this field is not sent, the value 1 will be used.<2 NNO
installment_typeInstallment financing type of the scheduled payments:
Value 3 = installments with interest.
Value 4 = installments without interest (use this value also on spot sales).
If this field is not sent, the value 4 will be used.
< 2 NNO
soft_descriptorAdditional text that will be presented alongside the name of the establishment in the credit card invoice. Learn more< 30 ANNO
show_times_invoiceFor finite time schedules, send this field with value true if you want to add at the end of the soft_descriptor field the current times/number of times (e.g. Subscription 3/12).< 5 T/FNO
additional_data Element for sending additional data.
postpone_confirmationThis field must be sent with value true if a payment with late confirmation is desired.< 5 T/FNO
financing_planFinancing Plan code used for Via Certa Financiadora routed payments, only in case of installments plan with interest.< 4 NCOND.
additional_data.payer Element for sending data related to the payer.
identification_numberIdentification document number of the customer (CPF/RG).< 20 ANNO
store_identificationIdentification of the customer for card storage. This identification must be unique for each of the merchant's users. But attention, this uniqueness assurance is of total responsibility of the merchant, e-SiTef won't do any validations.< 20 ANYES para agendamento
additional_data.merchant Element for sending data related to the merchant.
emailMerchant's e-mail address.< 1024 ANNO
additional_data. extra_param.prefixes Element for sending SiTef prefixes, like CICLOS, CPLANO and VLRADD. If the prefix that was sent is not supported by card, e-SiTef will invalidate the transaction, preventing that a false impression of the use of a functionality is given.

Example:
{ "key" : "value" } -> { "CICLO" : "01" }
keyPrefix name.< 1024 ANNO
valuePrefix value.< 1024 ANNO

The table below describes the additional parameters that must be sent on a payment with fraud analysis (for the time being only available for Cielo e-Commerce):

ParameterDescriptionFormatMandatory
additional_data
anti_fraud_institutionInstitution that will carry out the fraud analysis to the merchant. It must be send with the value AUTHORIZER.= 10 ANYES para análise de fraude
anti_fraudEnables the fraud analysis service. Allowed values:
enabled_before_auth – fraud analysis will be done BEFORE the payment authorization. If the analysis is rejected, the payment won't be initiated.
enabled_after_auth – fraud analysis will be done AFTER the payment authorization. If the analysis is rejected, the payment will be cancelled.
< 19 ANYES para análise de fraude
anti_fraud_criteriaCriteria for fraud analysis execution. Allowed values:
ON_SUCCESS – only perform the analysis if the transaction had succeeded.
ALWAYS – always perform the analysis.
< 10 ANNO
finger_print_idIdentifier used to cross information obtained by the internet user's Browser with the data sent for analysis. This same value must be passed in the SESSIONID variable of the DeviceFingerPrint script. Further details can be found on http://apidocs.braspag.com.br/#CriandoumavendacomAnalisedeFraude.< 50 ANNO
giftBoolean that indicates whether the order is a gift or not.< 5 T/FNO
returns_acceptedBoolean that defines whether returns are accepted for this order.< 5 T/FNO
journey_typeType of the trip. Allowed values:
ROUND_TRIP – round trip.
OUTWARD – outward.
RETURN – return.
< 10 ANNO
additional_data.payer
nameName of the customer.
Note: the concatenation of name and surname must not surpass 255 characters.
< 200 ANNO
surnameSurname of the customer.
Note: the concatenation of name and surname must not surpass 255 characters.
< 200 ANNO
emailE-mail of the customer.< 255 ANNO
born_dateBirthdate of the costumer, in YYYY-MM-DDTHH:MM:SS format. E.G.: 1991-01-02T08:30:00.= 19 ANNO
adress_street_nameAddress street name of the customer.< 255 ANNO
adress_street_numberAddress street number of the customer.< 15 ANNO
adress_street_complementAddress complement of the customer.< 50 ANNO
adress_zip_codeZip code of the customer. E.G.: 21241140.< 9 ANNO
cityCity of the customer.< 50 ANNO
stateState of the customer. E.G.: SP.= 2 ANNO
address_countryCountry of the customer, following ISO 3166-1. Ex.: BRA.< 35 ANNO
additional_data.shipment.receiver_address
street_nameShipment address street name.< 255 ANNO
street_numberShipment address street number.< 15 ANNO
complementShipment address complement.< 50 ANNO
zip_codeShipment zip code. E.G.: 21241-140.< 9 ANNO
cityShipment city.< 50 ANNO
stateShipment state.= 2 ANNO
countryShipment country, following ISO 3166-1. E.G.: BRA= 3 ANNO
additional_data.browser
cookies_acceptedBoolean to identify whether the customer's browser accepts cookies. Send true if positive.< 5 T/FNO
emailEmail registered in the customer's browser.< 100 ANNO
host_nameHost name where the customer was before entering the store's website.< 60 ANNO
ip_addressCustomer's IP address. It is strongly recommended sending this field.< 15 ANNO
agentName of the browser used by the customer. E.G.: Chrome.< 40 ANNO
additional_data.items[]
gift_categoryField that will evaluate the billing and delivery addresses for different cities, states or countries. Allowed values:
OFF – Ignores fraud analysis for divergent addresses.
YES – In case of divergence between billing and delivery addresses, mark with small risk.
NO – In case of divergence between billing and delivery addresses, mark with high risk.
< 3 ANNO
riskProduct risk level. Allowed values:
LOW – The product has a history of few chargebacks.
NORMAL – The product has a history of chargebacks considered normal.
HIGH – The product has a history of chargebacks above average.
< 6 ANNO
titleProduct name.< 255 ANNO
quantityQuantity of the product to be acquired.< 15 NNO
idProduct identifier.< 255 ANNO
unit_priceUnit price of the product.< 15 NNO
category_idProduct type. Allowed values: art, baby, coupon, donation, computing, camera, video_game, television, car_electronic, electronic, automotive, entertainment, fashion, game, home, musical, phone, service, learning, ticket, travel, virtual_good, physical, other, adult_content, gift_certificate, handling, shipping, shipping_and_handling ou subscription.< 21 ANNO
additional_data.items[].hedge
timeLevel of importance of client order day time. Allowed values:
LOW – Low importance in the time of day when the purchase was made, for the fraud analysis.
NORMAL – Normal importance in the time of day when the purchase was made, for the fraud analysis.
HIGH – High importance in the time of day when the purchase was made, for the fraud analysis.
OFF – Purchase time does not affect fraud analysis.
< 6 ANNO
hostLevel of importance of email and IP addresses of clients at scoring risk. Allowed values:
LOW – Low importance of e-mail and IP address in fraud analysis.
NORMAL – Normal importance of e-mail and IP address in fraud analysis.
HIGH – High importance of e-mail and IP address in fraud analysis.
OFF – E-mail and IP address do not affect fraud analysis.
< 6 ANNO
non_sensicalLevel of testing performed on buyer data with meaningless received orders. Allowed values:
LOW – Low importance of the verification made on the buyer's order, in fraud analysis.
NORMAL – Normal importance of the verification made on the buyer's order, in fraud analysis.
HIGH – High importance of the verification made on the buyer's order, in fraud analysis.
OFF – Verification of buyer's order does not affect fraud analysis.
< 6 ANNO
obscenitiesLevel of obscenity of received orders. Allowed values:
LOW – Low importance of obscenity verification of buyer's order, in fraud analysis.
NORMAL – Normal importance of obscenity verification of buyer's order, in fraud analysis.
HIGH – High importance of obscenity verification of buyer's order, in fraud analysis.
OFF – Obscenity verification of buyer's order does not affect fraud analysis.
< 6 ANNO
phoneLevel of tests performed with telephone numbers. Allowed values:
LOW – Low importance on tests performed with telephone numbers.
NORMAL – Normal importance on tests performed with telephone numbers.
HIGH – High importance on tests performed with telephone numbers.
OFF – Phone number tests do not affect fraud analysis.
< 6 ANNO
velocityLevel of importance of customer purchase frequency. Allowed values:
LOW – Low importance in the number of purchases made by the client in the last 15 minutes.
NORMAL – Normal importance in the number of purchases made by the client in the last 15 minutes.
HIGH – High importance in the number of purchases made by the client in the last 15 minutes.
OFF – The frequency of purchases made by the client does not affect the fraud analysis.
< 6 ANNO
additional_data.items[].passenger
emailPassenger email.< 255 ANNO
legal_documentId of the passenger to whom the ticket was issued.< 32 ANNO
namePassenger name.< 120 ANNO
ratingPassenger classification. Allowed values:
ADULT – Adult passenger.
CHILD – Child passenger.
INFANT – Infant passenger.
YOUTH – Teenage passenger.
STUDENT – Student passenger.
SENIOR_CITIZEN – Elderly passenger.
MILITARY – Military passenger.
< 14 ANNO
customer_classClassification of the Airline. Values such as Gold or Platinum can be used.< 32 ANNO
additional_data.items[].passenger.phone
ddiPassenger phone IDD.< 3 NNO
dddPassenger phone DDD.< 3 NNO
numberPassenger phone number.< 9 NNO
additional_data.extra_param.acquirer_params[]
keyId of the additional information to be sent. For further details about this field, see https://developercielo.github.io/Webservice-3.0/english.html#merchant-defined-data.< 1024 NNO
valueValue of additional information to be sent.< 1024 ANNO
additional_data.shipment
nameDelivery recipient name.< 255 ANNO
methodType of product delivery service. Allowed values:
SAME_DAY – Delivery on the same day.
ONE_DAY – Delivery overnight or on the next day.
TWO_DAY – Delivery in two days.
THREE_DAY – Delivery in three days.
LOW_COST – Low cost delivery service.
PICKUP – Product to be picked up in the store.
OTHER – Other method.
NONE – No delivery service, as it is a service or subscription.
< 9 ANNO
additional_data.shipment.phones[]
ddiAddressee phone IDD.< 3 NNO
dddAddressee phone DDD.< 3 NNO
numberAddressee phone number.< 9 NNO
additional_data.connections[]
flight_dateDate, hour and minute of flight departure in the YYYY-MM-DDTHH:MM:SS format. E.G.: 1991-01-02T08:30:00.= 19 ANNO
fromAirport code of the starting point of the trip. E.G.: CGH.= 3 ANNO
toAirport code of the ending point of the trip. Ex.: GYN.= 3 ANNO

Response parameters

In case of success, the HTTP response code will be 201. Any other code must be interpreted as an error. The table below describes de response parameters of the transaction creation service:

ParameterDescriptionFormat
codee-SiTef response code. Any code different from 0 means failure. Learn more.< 4 N
messagee-SiTef response message.< 500 AN
payment
statusStatus of the payment transaction on e-SiTef. Learn more.= 3 AN
nitPayment transaction identifier on e-SiTef.= 64 AN
order_idOrder code sent by the merchant on the creation of the transaction.< 40 AN
merchant_usnUnique sequential number sent by the merchant on the creation of the transaction.< 12 N
amountTotal price of the purchase specified by the merchant (in cents) on the creation of the transaction.< 12 N
schedule
sidSchedule transaction identifier on e-SiTef.= 64 AN
amountAmount of the scheduled payments specified by the merchant (in cents) on the creation of the transaction.< 12 N
statusStatus of the schedule on e-SiTef. Learn more.= 3 AN
order_idOrder code sent by the merchant on the creation of the transaction.< 40 AN
merchant_usnUnique sequential number sent by the merchant on the creation of the transaction.< 12 N
← Quick startPayment effectuation service →
  • Call details
  • Examples
    • Creating a payment with automatic confirmation
    • Creating a payment with late confirmation
    • Creating a payment with schedule
    • Creating a schedule without payment
    • Creating a payment with Cielo e-Commerce fraud analysis
    • Creating a payment with risk analysis (using Konduto antifraud)
  • Request parameters
  • Response parameters
e-SiTef
Relacionamento com o cliente
+55 (11) 3170-5300+55 (11) 4766-8000comercial@softwareexpress.com.br
Acessos
Portal do DesenvolvedorPortal e-SiTefVersão para impressão
Copyright © 2021 Software Express Informática Ltda - Todos os direitos reservados