Webservice integration 1.5

The purpose of this documentation is to orientate the developer about how integrate with Cielo Webservice, describing its functionalities, the methods to be used, list information to be sent and received and provide examples.

The integration mechanism with Cielo E-commerce is Yesple, so that are necessary only an intermediate knowledge in programming language for Web, HTTP/HTTP requisitions and handling XML archive to implant Cielo E-commerce solution with success.

Importantly to use this platform, the website must comply with safety rules or use the PCI certification. For questions about web security, please send email to: Segurança Web.

After conclude the registration and receive the instructions, you need to develop the integration using this documentation as a guide. Once the integration is completed, it’s necessary to fill the homologation form fully and then send it to Cielo E-commerce Web Support that will inform the secure key to the establishment.

Finally, after the development, to start the operation on production environment, first, it’s necessary start the homologation at Cielo.

Cielo Support

After reading this documentation, if you still have questions (technical or not), you can check Cielo technical support 24 hours per day, 7 days of week, in Portuguese and English, in the following contacts:

Glossary

To facilitate the understanding, we listed below a small glossary with the main terms related to e-commerce, card market and acquiring services:

Products and Card Issuers supported

The current version of Cielo Webservice has support to the following products and card issuers:

Card Issuer Lump Sum Credit card installments Debt Voucher
Visa Yes Yes Yes No
Master Card Yes Yes Yes No
American Express Yes Yes No No
Elo Yes Yes No No
Diners Club Yes Yes No No
Discover Yes No No No
JCB Yes Yes No No
Aura Yes Yes No No
Hipercard Yes Yes No No

Extended Validation Certificate

What is SSL Certificate?

The Extended Validation Certificate for web server offers authenticity and integrity of data from a web site, provides customers of virtual stores the guarantee that they are actually accessing the site they want, and not a fraudster site.

Specialized companies are responsible for making domain validation and depending on the type of certificate, also the owner of the domain entity.

What is EV SSL Certificate?

The EV Certificate was released in the market recently and ensures a higher level of security for customers of online stores.

It is a certificate of greater confidence and when https is accessed, the address bar turns green, giving more reliability to site visitors.

Internet Explorer:

Certificado EV Internet Explorer

Firefox

Certificado EV Firefox

Google Chrome

Certificado EV Google Chrome

How to install the Extended Validation Certificate on the Store server?

Just install the following three files in the server Trustedstore. Cielo does not offer support to the installation of the Certificate. If you are unsure about how to install the EV Certificate, then you should contact your server vendor support.

Step by Step Installation

INSTALLATION ON THE SERVER OF ONLINE STORE

To install the EV Certificate you shall contact your server vendor support.

CUSTOMER ACCESS TO ONLINE STORE

Normally, the browser makes a Certificate update automatically, in case of failure and client contacted you to inform it, follow the steps:

1st STEP:

Save the files below into a new folder, or recall easily to be used later:

2nd STEP:

In the “Internet Explorer”, click on “Tools” menu and access the “Internet Options”:

Instalar IE

In the “Firefox” browser, click on “Open Menu” and go to “Advanced” and “Options”:

Instalar FF

In “Chrome”, click on “Customize and control Google Chrome” and go to “Settings” and “Show advanced settings …” “Change Proxy Settings” and “Content” and Certificates:

Instalar GC

3rd STEP:

In Internet Explorer, on “Certificates”, click “Import”.

Instalar IE

In Firefox click “View Certificates”, click “Import”

Instalar FF

In Chrome click “Manage Certificates”, click “Import”

Instalar GC

4th STEP:

In Internet Explorer and in Chrome, “Certificate import wizard”, click “Next”

Instalar IE e GC

Instalar IE e GC

In Firefox “Abba servers,” click “Import”

Instalar FF

5th STEP:

In Chrome and Internet Explorer “Certificate Import Assistent”, click “Browse”, find the folder where the files are and select the file “ecommerce.cielo.com.br.crt, click” Open “and then” Advance”.

Instalar IE e GC

Instalar IE e GC

6th STEP:

Select the desired option: add the certificate in a default folder or browse to the folder of your choice.

Instalar IE e GC

7th STEP:

Click “Finish”.

Instalar IE e GC

8th STEP:

Click “Ok” to complete the import.

Instalar IE e GC

The certificate can be viewed in the default tab “Others” or chosen by the customer.

9th STEP:

Repeat the same procedure for the 3 uploaded files.

Questions:

If you have questions at any stage or other technical information, contact the Support Web Cielo e-Commerce in the following channels:

Hours: 24 hours a day, 7 days a week.

Overview

In this documentation we will be present an overview of Cielo E-commerce and the technical mechanism of Webservice integration format (named in the previous version as “Buy Page Loja”).

To more information about integration at Checkout Cielo format (named in the previous versions as Buy Page Cielo or Integrated Solution) access: https://www.cielo.com.br/ecommerce.

For all purchase orders, the purpose is convert it in a sale. A sale using a card can be characterized as an authorized and captured transaction.

Solutions characteristics:

The Webservice solution at Cielo E-commerce platform has been developed based on XML technology, a market pattern and independent of technologies used by our customers. In this way, it’s possible to integrate it by using the various programing languages, like: ASP, ASP.NEt, Java, PHP, Ruby, Python, etc.

Among others characteristics, the most highlighted attributes of Cielo E-commerce platform are:

Consideration about integration

Architecture

The integration is realized through the available services as Web Services. The model employed is quite Yesple: there is an unique URL (endpoint) that receives the POSTs via HTTPs and, depending of XML format sent, a specific operation is realized.

The Web Service request is summarized for:

POST /servicos/ecommwsec.do HTTP/1.1
Host: ecommerce.cielo.com.br
Content-Type: application/x-www-form-urlencoded
Content-Length: length
mensagem=<?xml version="1.0" encoding="ISO-8859-1"?><requisicao-captura id="3e22bdd0-2017-4756-80b7-35a532e6c973" versao="1.2.1"><tid>10069930690101012005</tid><dados-ec><numero>1006993069</numero><chave>25fbb99741c739dd84d7b06ec78c9bac718838630f30b112d033ce2e621b34f3</chave></dados-ec><valor>3880</valor></requisicao-captura>

Transaction

The main element on Cielo E-commerce is the transaction, created from a HTTP request to Cielo Webservice. The unique identification of Cielo transactions is done through TID field, that is present at message’s return of authorization. This field is essential to realize inquires, captures and cancellations.

From transaction creation, it can assume the following status:

status transações

The transition of status can be realized through the message exchange between the store and Cielo, or automatically, for example, when an authorized transaction capture deadline expires.

Mandatory Updates

Payment Facilitators

All E-Commerce customers who are Payment Facilitators, as required by the flags and Central Bank must submit new fields in transactional messaging. Cielo will transmit the information to the flags through transactional messaging at the time of authorization.

The new fields are contained within the <subcredenciador> tag. In addition to the fields in this new node, facilitators will also have to send the <soft-descriptor> tag. Below is an example of sending and reply.

Request

<requisicao-transacao id="1abd5a36-fba5-4a92-9341-7c9e9d44aa1a" versao="1.3.0">
    <dados-ec>
        <numero>2000000001</numero>
        <chave>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</chave>
        <subcredenciador>
            <numero>12345678901</numero>
            <sub-ec>
                <numero>2000130733</numero>
                <mcc>5542</mcc>
                <endereco>Alameda Xingu, 512</endereco>
                <cidade>Barueri</cidade>
                <estado>SP</estado>
                <codigo-postal>06537085</codigo-postal>
                <telefone>11978962345</telefone>
                <documento>53976428000130</documento>
                <codigo-pais>076</codigo-pais>
            </sub-ec>
        </subcredenciador>
    </dados-ec>
    <dados-portador>
        <numero>518605152xxxxxx5923</numero>
        <validade>aaaamm</validade>
        <indicador>1</indicador>
        <codigo-seguranca>xxx</codigo-seguranca>
        <nome-portador>Jose Luis</nome-portador>
        <token/>
    </dados-portador>
    <dados-pedido>
        <numero>54583</numero>
        <valor>10000</valor>
        <moeda>986</moeda>
        <data-hora>2016-02-16T13:45:05</data-hora>
        <descricao>Compra Online</descricao>
        <idioma>PT</idioma>
        <soft-descriptor>lojinha</soft-descriptor>
    </dados-pedido>
    <forma-pagamento>
        <bandeira>mastercard</bandeira>
        <produto>1</produto>
        <parcelas>1</parcelas>
    </forma-pagamento>
    <url-retorno>http://www.cielo.com.br</url-retorno>
    <autorizar>3</autorizar>
    <capturar>true</capturar>
    <gerar-token>false</gerar-token>
</requisicao-transacao>

Response

<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
<transacao id="1abd5a36-fba5-4a92-9341-7c9e9d44aa1a" versao="1.3.0" xmlns="http://ecommerce.cbmp.com.br">
    <tid>2000153601009A0OCH1E</tid>
    <pan>qM5R3jZDvsXFU7KUAM5fmzKg7dA7ZaG2/gc2rFeFMW0=</pan>
    <dados-pedido>
        <numero>54583</numero>
        <valor>10000</valor>
        <moeda>986</moeda>
        <data-hora>2016-02-16T13:45:05</data-hora>
        <descricao>Compra Online</descricao>
        <idioma>PT</idioma>
    </dados-pedido>
    <forma-pagamento>
        <bandeira>mastercard</bandeira>
        <produto>1</produto>
        <parcelas>1</parcelas>
    </forma-pagamento>
    <status>6</status>
    <autenticacao>
        <codigo>6</codigo>
        <mensagem>Transacao sem autenticacao</mensagem>
        <data-hora>2020-01-10T15:32:45.843-03:00</data-hora>
        <valor>10000</valor>
        <eci>0</eci>
    </autenticacao>
    <autorizacao>
        <codigo>6</codigo>
        <mensagem>Transacao autorizada</mensagem>
        <data-hora>2020-01-10T15:32:45.844-03:00</data-hora>
        <valor>10000</valor>
        <lr>00</lr>
        <arp>192379</arp>
        <nsu>094004</nsu>
    </autorizacao>
    <captura>
        <codigo>6</codigo>
        <mensagem>Transacao capturada com sucesso</mensagem>
        <data-hora>2020-01-10T15:32:45.844-03:00</data-hora>
        <valor>10000</valor>
    </captura>
</transacao>
Property Type Size Required Description
subcredenciador.numero Number 11 Required for facilitators Facilitator’s establishment code. “Facilitator ID” (Registration of the facilitator with the card brands)
sub-ec.numero Number 15 Required for facilitators Sub Merchant establishment code. “Sub-Merchant ID” (Registration of sub-accredited with the facilitator)
sub-ec.mcc Number 4 Required for facilitators MCC do sub Merchant.
sub-ec.endereco Alphanumeric 22 Required for facilitators Sub Merchant Address.
sub-ec.cidade Alphanumeric 13 Required for facilitators City of the sub Merchant.
sub-ec.estado Alphanumeric 2 Required for facilitators State do sub Merchant.
sub-ec.codigo-postal Number 9 Required for facilitators Sub Merchant Postcode.
sub-ec.telefone Number 13 Required for facilitators Sub Merchant Phone Number.
sub-ec.documento Number 14 Required for facilitators CNPJ or CPF of the Sub Merchant.
sub-ec.codigo-pais Number 3 Required for facilitators Sub Merchant country code based on ISO 3166.
Ex: Brazil’s ISO 3166 code is 076. Complete list online.
dados.pedido.soft-descriptor Text 13 Required for facilitators Text printed on buyer bank invoice. Must be completed according to the data of the sub Merchant.

CBPS Transactions

Today, consumers often need to log in to several billing sites to pay their bills, many of which do not accept card payments. Suppliers of the Account Payment Service for Consumers (CBPS) simplify the process by allowing consumers to make all bill payments with a card and in a single channel. Generally, CBPS providers offer a mobile application or electronic commerce for the bearer to manage and make payments.

Visa requests that providers of this type of service start to inform which transactions are CBPS as of Oct20. This information must be sent in the transactional message in the field “payment-account” according to the XML below.

Request

<requisicao-transacao id="1abd5a36-fba5-4a92-9341-7c9e9d44aa1a" versao="1.3.0">
    <dados-ec>
        <numero>2000000001</numero>
        <chave>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</chave>
        <subcredenciador>
            <numero>12345678901</numero>
            <sub-ec>
                <numero>2000130733</numero>
                <mcc>5542</mcc>
                <endereco>Alameda Xingu, 512</endereco>
                <cidade>Barueri</cidade>
                <estado>SP</estado>
                <codigo-postal>06537085</codigo-postal>
                <telefone>11978962345</telefone>
                <documento>53976428000130</documento>
                <codigo-pais>076</codigo-pais>
            </sub-ec>
        </subcredenciador>
    </dados-ec>
    <dados-portador>
        <numero>518605152xxxxxx5923</numero>
        <validade>aaaamm</validade>
        <indicador>1</indicador>
        <codigo-seguranca>xxx</codigo-seguranca>
        <nome-portador>Jose Luis</nome-portador>
        <token/>
    </dados-portador>
    <dados-pedido>
        <numero>54583</numero>
        <valor>10000</valor>
        <moeda>986</moeda>
        <data-hora>2016-02-16T13:45:05</data-hora>
        <descricao>Compra Online</descricao>
        <idioma>PT</idioma>
        <soft-descriptor>lojinha</soft-descriptor>
        <pagamento-conta>true</pagamento-conta>
    </dados-pedido>
    <forma-pagamento>
        <bandeira>mastercard</bandeira>
        <produto>1</produto>
        <parcelas>1</parcelas>
    </forma-pagamento>
    <url-retorno>http://www.cielo.com.br</url-retorno>
    <autorizar>3</autorizar>
    <capturar>true</capturar>
    <gerar-token>false</gerar-token>
</requisicao-transacao>
Property Type Size Required Description
subcredenciador.numero Number 11 Required for facilitators Facilitator’s establishment code. “Facilitator ID” (Registration of the facilitator with the card brands)
sub-ec.numero Number 15 Required for facilitators Sub Merchant establishment code. “Sub-Merchant ID” (Registration of sub-accredited with the facilitator)
sub-ec.mcc Number 4 Required for facilitators MCC do sub Merchant.
sub-ec.endereco Alphanumeric 22 Required for facilitators Sub Merchant Address.
sub-ec.cidade Alphanumeric 13 Required for facilitators City of the sub Merchant.
sub-ec.estado Alphanumeric 2 Required for facilitators State do sub Merchant.
sub-ec.codigo-postal Number 9 Required for facilitators Sub Merchant Postcode.
sub-ec.telefone Number 13 Required for facilitators Sub Merchant Phone Number.
sub-ec.documento Number 14 Required for facilitators CNPJ or CPF of the Sub Merchant.
sub-ec.codigo-pais Number 3 Required for facilitators Sub Merchant country code based on ISO 3166.
dados.pedido.soft-descriptor Text 13 Required for facilitators Text printed on buyer bank invoice. Must be completed according to the data of the sub Merchant.
dados.pedido.pagamento-conta Boolean No True or false. Indicates whether it is a CBPS (Consumer Bill Payment Service) transaction)

Creating transactions

Every transaction on Cielo E-commerce starts through a POST (HTTPS) to Webservice at Cielo with a XML message <requisicao-transacao>, which group of TAGS defines a transaction configuration:

<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-transacao id="a97ab62a-7956-41ea-b03f-c2e9f612c293" versao="1.2.1">
  <dados-ec>
    <numero>1006993069</numero>
    <chave>25fbb997438630f30b112d033ce2e621b34f3</chave>
  </dados-ec>
  <dados-portador>
    <numero>4012001038443335</numero>
    <validade>201508</validade>
    <indicador>1</indicador>
    <codigo-seguranca>973</codigo-seguranca>
    <token/>
  </dados-portador>
  <dados-pedido>
    <numero>178148599</numero>
    <valor>1000</valor>
    <moeda>986</moeda>
    <data-hora>2011-12-07T11:43:37</data-hora>
    <descricao>[origem:10.50.54.156]</descricao>
    <idioma>PT</idioma>
    <taxa-embarque/>
    <soft-descriptor/>
    <numero-bilhete>123456</numero-bilhete>
  </dados-pedido>
  <forma-pagamento>
    <bandeira>visa</bandeira>
    <produto>A</produto>
    <parcelas>1</parcelas>
  </forma-pagamento>
  <url-retorno>http://localhost/lojaexemplo/retorno.jsp</url-retorno>
  <autorizar>1</autorizar>
  <capturar>false</capturar>
  <campo-livre>Informações extras</campo-livre>
  <bin>455187</bin>
  <gerar-token>false</gerar-token>
  <avs>
  <![CDATA[
    <dados-avs>
      <endereco>Rua Teste AVS</endereco>
      <complemento>Casa</complemento>
      <numero>123</numero>
      <bairro>Vila AVS</bairro>
      <cep>12345-123</cep>
      <cpf>11111111111</cpf>
    </dados-avs>
  ]]>
  </avs>
</requisicao-transacao>

ROOT Node

Element Type Mandatory Size Description
dados-ec n/a Yes n/a Establishment data
dados-portador n/a Yes n/a Holder data
dados-pedido n/a Yes n/a Order data
forma-pagamento n/a Yes n/a Payment-method
url-retorno alphanumeric Yes 1..1024 URL of return’s page. This page is that one used by Cielo to direct the browser in the end of authentication or authorized. It’s not only mandatory for a direct authorization, but the field must be inserted as null.
capturar Boolean Yes n/a true or false. Define if a transaction will be captured automatically in case of being authorized.
campo-livre alphanumeric optional 0..128 Free field available to the establishment.
bin numeric optional 6 Six first card numbers.
gerar-token Boolean optional n/a true ou false. Define if the current transaction must create an associate token to card.
avs#avs alphanumeric optional n/a String containing a XML block, encapsulated by CDATA, containing required information to realized a service consult.

dados-ec

Element Type Mandatory Size Description
numero numeric Yes 1..20 Affiliation number of Store with Cielo.
chave alphanumeric Yes 1..100 Store’s access key attributed by Cielo.

dados-portador

Element Type Mandatory Size Description
numero numeric Yes 19 Card number
validade Numénumericrico Yes 6 Card validity of format: yyyymm. Example: 201212 (dec/2012).
indicador numeric Yes 1 Card validity of Secure Code Sending: 0 - Not informed, 1- informed, 2-illegible, 9- Inexistent
codigo-seguranca numeric Condicional 3..4 Security code is required when indicator is 1
nome-portador alphanumeric Optional 0..50 Holder name
token Alfanumeric Conditional 0..100 Token must be used in replacement to card data to direct authorization or recurrent. It’s not allowed to send a token with the card information in the same transaction.

dados-pedido

Element Type Mandatory Size Description
numero Alphanumeric Yes 1..20 Order number of store. We recommend just one number per order.
valor Numeric Yes 1..12 Amount to be charged on the order (must be also included shipping costs, package, extras costs, boarding fees, etc). This amount will be charged from customer.
moeda Numeric Yes 3 Numeric code of currency at norm ISO 4217. For “Real”, the code is 986.
data-hora Alphanumeric Yes 19 Data hour of order. Format: yyyy-MM-ddTHH24:mm:ss
descricao Alphanumeric Optional 0..1024 Order description
idioma Alphanumeric Optional 2 Order language: PT (Portuguese), EN (English) or ES (Spanish). Based on this information the language is defined used on Cielo’ screens. If it won’t be sent, the system will assume “PT”.
taxa-embarque Numeric Optional 1..9 Amount of authorization value that must be destined to boarding fee.
soft-descriptor Alphanumeric Optional 0..13 Text until 13 characters that will be shown on holder’s invoice, after the Commercial Establishment name.
numero-bilhete Alphanumeric Optional 13 Notify the main air ticket number of the transaction.

forma-pagamento

Element Type Mandatory Size Description
bandeira Alphanumeric Yes n/a NomeCard issuer’s name (minuscule): “visa”, “mastercard”, “diners”, “discover”, “elo”, “amex”, “jcb”, “aura”, “hipercard”.
produto Alphanumeric Yes 1 Product code: 1- Repayable on demand, 2- Credit card installments on store, A- Debt
parcelas Numeric Yes 1..2 Installments number. To repayable on demand or debt, use 1.

Integration flux and redirection

After creating a transaction, the browsing flux can be directed to Cielo environment, if the retailer requests the authentication on XML message.

In this situation, the retailer’ system will obtain the amount of TAG of XML returned to realize a redirection on customer browser and continues the process. The redirecting must be realized in “Full Screen” mode. In the other words, there is no more support to the pop up window. This way, from a checkout screen must be realized a redirecting to URL returned at transaction’s creation.

After the authentication process, the flux is returned to the retailer through the present information on TAG, sent in the first request to Cielo.

The diagram below makes easier the view of complete flux of browsing:

fluxo

In the other hand, when there is no authentication, doesn’t exist the context exchange or redirections and the integration is more Yesple:

fluxo-Yesples

Return types

There are three types of return that can be created on WebService response:

  1. <transacao>
  2. <retorno-token>
  3. <erro>

To operations related to a transaction (consults, authorization, capture and cancellation) in case of success the response is always a XML of type <transacao>. In case of an exclusive request to create a token, the response expected is <retorno-token>.

The next example shows the more reduced way of a message of return such . Basically, it’s composed by order data and data from transaction’s configuration.

<?xml version="1.0" encoding="ISO-8859-1"?>
<transacao versao="1.6.2" id="af32f93c-5e9c-4f44-9478-ccc5aca9319e" xmlns="http://ecommerce.cbmp.com.br">
    <tid>100699306908642F1001</tid>
    <pan>uv9yI5tkhX9jpuCt+dfrtoSVM4U3gIjvrcwMBfZcadE=</pan>
    <dados-pedido>
        <numero>2132385784</numero>
        <valor>1000</valor>
        <moeda>986</moeda>
        <data-hora>2013-02-18T16:51:30.852-03:00</data-hora>
        <descricao>[origem:0:0:0:0:0:0:0:1]</descricao>
        <idioma>PT</idioma>
        <taxa-embarque>0</taxa-embarque>
    </dados-pedido>
    <forma-pagamento>
        <bandeira>visa</bandeira>
        <produto>1</produto>
        <parcelas>1</parcelas>
    </forma-pagamento>
    <status>4</status>
    <autenticacao>
        <codigo>4</codigo>
        <mensagem>Transacao sem autenticacao</mensagem>
        <data-hora>2013-02-18T16:51:31.158-03:00</data-hora>
        <valor>1000</valor>
        <eci>7</eci>
    </autenticacao>
    <autorizacao>
        <codigo>4</codigo>
        <mensagem>Transação autorizada</mensagem>
        <data-hora>2013-02-18T16:51:31.460-03:00</data-hora>
        <valor>1000</valor>
        <lr>00</lr>
        <arp>123456</arp>
        <nsu>549935</nsu>
        <par>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</par>
    </autorizacao>
</transacao>

The more important information are:

The table below details TAGS from basic-XML of return, identified by source node <transacao>:

Element Type Size Description
tid Alphanumeric 1..40 Transaction identifier
dados-pedido     identical to source sent by store on the creation of transaction.
forma-pagamento     identical to source sent by store on creation of transaction.
status Numeric 12 code of transaction. Look the appendix to a list of contacts.
url-autenticacao Alphanumeric 1..256 URL of redirection to Cielo.
par Numeric 29 The pair will only be returned for transactions sent in xml version 1.6.2. The PAR (payment account reference) is the number that associates different tokens with the same card. It will be returned by the Master and Visa brands and passed on to Cielo e-commerce customers. If the flag doesn’t send the information the field will not be returned.

Finally, there is another type of return which is employed every time a request can’t be executed, because it’s invalid or for some failure in its process. In this scenario, root node of XML response is like this <erro>.

<?xml version="1.0" encoding="ISO-8859-1"?>
<erro xmlns="http://ecommerce.cbmp.com.br">
  <codigo>001</codigo>
  <messagem><![CDATA[O XML informado nao e valido:- string value '' does not match pattern for type of valor element in DadosPedido in namespace http://ecommerce.cbmp. com.br: '<xml-fragment/>]]>
  </mensagem>
</erro>

When the transaction is invalid, we can classify the error in two types:

Security level and authentication

Depending of card issuer, the transaction of Cielo E-commerce platform can be configured to be authenticated on card bank issuer (holder), in order to ensure the mayor level of security to the retailer.

The authentication isn’t done automatically between systems, so it’s necessary the customer interaction in the process, according the following explanation:

This happens always on the bank website (Internet Banking), using mechanisms and technologies independently from Cielo. In this way, it’s possible for bank use an electronic token and password meanwhile another uses the password cards or CPF [c]to authenticate a transaction.

As shown previously, the mechanic of redirection is obtained through a tag <url-autenticacao> that is returned by Cielo on XML in the moment of a request of authorization to Web Service.

The authentication is mandatory for debt transactions and optional for credit. Nowadays only Visa and MasterCard support this functionality and consequently, only these two card issuers have the debt product.

When there is authentication, the flux to execute an authorization happens in two steps, according to the diagram below:

fluxo-autenticacao

  1. finishOrder() - it happens when a cardholder finishes the order and starts the payment purchase.
  2. createTransaction (authenticated) - the retailer system send a XML request <requisicao-transacao> requesting an authenticated transaction, in other words, the TAG will be 0,1 or 2. After this, Cielo will inform at XML returned a field with the address which the holder must be redirected for.
  3. access (url-authentication) - the holder’s browser is redirected to Cielo environment. Thereby, the Cielo’s page is accessed, it automatically is directed to an issuer bank (3.1). This redirect is so fast that is practically imperceptible.
  4. authenticate (token, cpf) - the holder will be on bank environment and will use some mechanism provided by his/her own issuer to realize the authentication of the transaction (generally token, “bingo card”/security card, cpf, electronic sign, etc).
  5. resultAuthentication ()- the issuer bank redirects the flux to Cielo with the result of authentication. Then, the flux backs to normal, according to item “2.3 Architecture of integration”. 1.process () - Cielo system process the return of authentication and submit to authorization and, optionally, to automatic capture. 2. sendRedirect(url-return) - Cielo system send a redirection to customer browser to the address specificated on URL of return, provided on the first request (<requisicao-transacao>)
    1. access (url-return) - the holder’s browser access the URL on store environment, where we recommend that you have a consult request via TID to Cielo Web Service.

Notes

The prerequisites for a transaction to be certified are listed below:

Looking at the diagram of section Transaction, you can see that all transactions will pass through status “Authenticated” or “not authenticated”. Consequently, all receive the node <autenticacao> in the merchant response XML. Below the XML with the authentication node:

<?xml version="1.0" encoding="ISO-8859-1"?>
<transacao versao="1.3.0" id="5e445904-963e-4fa1-95cd-55ef88c289cc" xmlns="http://ecommerce.cbmp.com.br">
  <tid>1001734898073E931001</tid>
  <pan>IqVz7P9zaIgTYdU41HaW/OB/d7Idwttqwb2vaTt8MT0=</pan>
  <dados-pedido>
    <numero>1196683550</numero>
    <valor>1000</valor>
    <moeda>986</moeda>
    <data-hora>2011-12-08T10:44:24.244-02:00</data-hora>
    <descricao>[origem:10.50.54.156]</descricao>
    <idioma>PT</idioma>
    <taxa-embarque>1000</taxa-embarque>
  </dados-pedido>
  <forma-pagamento>
    <bandeira>visa</bandeira>
    <produto>1</produto>
    <parcelas>1</parcelas>
  </forma-pagamento>
  <status>2</status>
  <autenticacao>
    <codigo>2</codigo>
    <mensagem>Autenticada com sucesso</mensagem>
    <data-hora>2011-12-08T10:44:47.311-02:00</data-hora>
    <valor>1000</valor>
    <eci>5</eci>
  </autenticacao>
</transacao>

Just the “node” fields <autenticacao> are listed on the table below:

Elemento Tipo Tamanho Descrição
codigo Numeric 1.2 Código do processamento
mensagem Alfanumeric 1..100 Detalhe do processamento
data-hora Alfanumeric 19 Data e hora do processamento
valor Numeric 1..12 Valor do processamento sem pontuação. Os dois últimos dígitos são os centavos.
eci Numeric 2 Nível de segurança.

The ECI field (Eletronic Commerce Indicator) represents how safety is a transaction. This amount must be considered for the retailer to decide about transaction capture.

Reply Codes Catalog

Authorization Codes LR

Below are the response codes that account for 99% of the returns generated in the authorization process. The other existing codes are not listed as rarely occur or in specific cases. For these cases must be assumed that they are not likely to retry.

If you have a high amount of return codes that are not listed below, please contact the Cielo Web Support E-commerce.

Return codes (ABECS)

The Brazilian Association of Credit Card and Services Companies (ABECS) establishes as of July 15, 2020, the standardization of the return code of refused sales authorizations for both the physical payment and e-commerce solutions of the Brazilian market .

This normative measure seeks to bring benefits to the entire payment market, providing greater transparency in the understanding of the reason for the refusal of transactions, in addition to enabling greater assertiveness in the adoption of sales retentive strategies.

Cielo informs its customers that it’s prepared to process transactions following this new market standard, below is the table of codes standardized by ABECS.

Message Code Type ELO VISA MASTERCARD/HIPER AMEX AMEX - From/To Cielo Message POS/Ecommerce
GENERIC REVERSIBLE 05 05 05 100 FA CONTACT YOUR CARD CENTER
INSUFFICIENT BALANCE/LIMIT REVERSIBLE 51 51 51 116 A5 NOT ALLOWED
INVALID PASSWORD REVERSIBLE 55 55 ou 86 55 117 A6 INVALID PASSWORD
TRANSACTION NOT ALLOWED FOR CARD IRREVERSIBLE 57 57 57 200 FD TRANSACTION NOT ALLOWED FOR CARD - DON’T TRY AGAIN
CARD NUMBER DOESN’T BELONG TO THE ISSUER | INVALID CARD NUMBER IRREVERSIBLE 14 ou 56 06 14 ou 01 122 08 CHECK THE CARD DATA
SECURITY BREACH IRREVERSIBLE 63 06 14 122 08 CHECK THE CARD DATA
SUSPECTED FRAUD REVERSIBLE 59 59 63 100 FA CONTACT YOUR CARD CENTER
INVALID MERCHANT IRREVERSIBLE 58 03 03 109 DA TRANSACTION NOT ALLOWED - DO NOT TRY AGAIN
REDOING THE TRANSACTION (ISSUER REQUESTS RETENTATIVE) REVERSIBLE 4 WITHOUT CORRESPONDING CODE SE WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE REDOING THE TRANSACTION
CONSULT ACCREDITATOR REVERSIBLE 6 WITHOUT CORRESPONDING CODE SE WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE MERCHANT, CONTACT THE PURCHASER
PROBLEM IN THE PURCHASER IRREVERSIBLE 19 19 30 WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE CARD ERROR - DON’T TRY AGAIN
CARD ERROR IRREVERSIBLE 12 06 WITHOUT CORRESPONDING CODE 115 A2 CHECK THE CARD DATA
FORMAT ERROR (MESSAGE) IRREVERSIBLE 30 12 30 181 A3 CARD ERROR - DON’T TRY AGAIN
VALUE OF THE INVALID TRANSACTION IRREVERSIBLE 13 13 13 110 JB TRANSACTION VALUE NOT ALLOWED - DON’T TRY AGAIN
VALUE OF INVALID PARCEL IRREVERSIBLE 23 WITHOUT CORRESPONDING CODE 12 115 A2 INVALID INSTALLMENT - DON’T TRY AGAIN
PASSWORD ATTEMPTS EXCEEDED | SHOPPING REVERSIBLE 38 75 75 106 A4 PASSWORD TRYING EXCEEDED. CONTACT YOUR CARD CENTER
LOST CARD IRREVERSIBLE 41 41 41 200 FD TRANSACTION NOT ALLOWED - DO NOT TRY AGAIN
STOLEN CARD IRREVERSIBLE 43 43 43 200 FD TRANSACTION NOT ALLOWED - DO NOT TRY AGAIN
EXPIRED CARD / INVALID EXPIRATION DATE IRREVERSIBLE 54 06 54 101 BV CHECK THE CARD DATA
TRANSACTION NOT ALLOWED | TERMINAL CAPACITY IRREVERSIBLE 57 58 58 116 A5 TRANSACTION NOT ALLOWED - DO NOT TRY AGAIN
EXCESS VALUE | WITHDRAW REVERSIBLE 61 61 ou N4 61 WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE EXCEEDED VALUE. CONTACT YOUR CARD CENTER
DOMESTIC CARD - INTERNATIONAL TRANSACTION IRREVERSIBLE 62 62 62 WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE CARD DOESN’T ALLOW INTERNATIONAL TRANSACTION
MINIMUM TRANSACTION VALUE INVALID IRREVERSIBLE 64 WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE TRANSACTION VALUE NOT ALLOWED - DON’T TRY AGAIN
AMOUNT OF WITHDRAWALS EXCEEDED REVERSIBLE 65 65 65 WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE AMOUNT OF WITHDRAWALS EXCEEDED. CONTACT YOUR CARD CENTER
PASSWORD EXPIRED / PASSWORD CRYPTOGRAPHY ERROR IRREVERSIBLE 74 74 ou 81 88 180 A7 INVALID PASSWORD - DON’T TRY AGAIN
PASSWORD ATTEMPTS EXCEEDED | WITHDRAW REVERSIBLE 75 75 75 106 A4 PASSWORD TRYING EXCEEDED. CONTACT YOUR CARD CENTER
INVALID OR NON-EXISTING DESTINATION ACCOUNT IRREVERSIBLE 76 WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE INVALID DESTINATION ACCOUNT - DON’T TRY AGAIN
ACCOUNT INVALID OR NON-EXISTING IRREVERSIBLE 77 WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE INVALID ORIGIN ACCOUNT - DON’T TRY AGAIN
NEW CARD WITHOUT UNLOCKING REVERSIBLE 78 78 WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE UNLOCK THE CARD
INVALID CARD (cryptogram) IRREVERSIBLE 82 82 88 180 A7 CARD ERROR - DON’T TRY AGAIN
EMITTER OUT OF AIR REVERSIBLE 91 91 91 912 A1 COMMUNICATION FAILURE - TRY LATER
SYSTEM FAILURE REVERSIBLE 96 96 96 911 AE COMMUNICATION FAILURE - TRY LATER
DIFFERENCE - PRE-AUTHORIZATION IRREVERSIBLE 99 N8 WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE DIFFERENT VALUE OF PRE-AUTHORIZATION - DON’T TRY AGAIN
INCORRECT FUNCTION (DEBIT) IRREVERSIBLE AB 52 ou 53 WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE USE CREDIT FUNCTION
INCORRECT FUNCTION (CREDIT) IRREVERSIBLE AC 39 WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE USE DEBIT FUNCTION
PASSWORD EXCHANGE / UNLOCKING IRREVERSIBLE P5 WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE INVALID PASSWORD - DON’T TRY AGAIN
NEW PASSWORD NOT ACCEPTED REVERSIBLE P6 WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE INVALID PASSWORD USE THE NEW PASSWORD
COLLECT CARD (THERE IS NO FRAUD) IRREVERSIBLE WITHOUT CORRESPONDING CODE 04 WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE CONTACT YOUR CARD CENTER - DON’T TRY AGAIN
DYNAMIC KEY CHANGE ERROR IRREVERSIBLE WITHOUT CORRESPONDING CODE 06 WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE CARD ERROR - DON’T TRY AGAIN
CONFIRMED FRAUD IRREVERSIBLE 57 07 04 200 FD TRANSACTION NOT ALLOWED FOR CARD - DON’T TRY AGAIN
ISSUER NOT LOCATED - INCORRECT BIN IRREVERSIBLE WITHOUT CORRESPONDING CODE 15 15 WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE INVALID CARD DATA - DON’T TRY AGAIN
(buyer’s negative) FAILURE TO COMPLY WITH THE LAWS OF ANTE MONEY LAUNDERING IRREVERSIBLE WITHOUT CORRESPONDING CODE 64 WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE CONTACT YOUR CARD CENTER - DON’T TRY AGAIN
INVALID REVERSION IRREVERSIBLE WITHOUT CORRESPONDING CODE 76 WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE CONTACT YOUR CARD CENTER - DON’T TRY AGAIN
NOT LOCATED BY ROUTER IRREVERSIBLE WITHOUT CORRESPONDING CODE 92 92 WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE CONTACT YOUR CARD CENTER - DON’T TRY AGAIN
TRANSACTION DENIED FOR INFRINGEMENT OF LAW IRREVERSIBLE 57 93 57 WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE TRANSACTION NOT ALLOWED FOR CARD - DON’T TRY AGAIN
DUPLICATE DATE OF TRACING DATE IRREVERSIBLE WITHOUT CORRESPONDING CODE 94 94 WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE CONTACT YOUR CARD CENTER - DON’T TRY AGAIN
SURCHARGE NOT SUPPORTED REVERSIBLE WITHOUT CORRESPONDING CODE B1 WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE CONTACT YOUR CARD CENTER
SURCHARGE NOT SUPPORTED BY THE DEBIT NETWORK REVERSIBLE WITHOUT CORRESPONDING CODE B2 WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE CONTACT YOUR CARD CENTER
FORCE STIP REVERSIBLE WITHOUT CORRESPONDING CODE N0 WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE CONTACT YOUR CARD CENTER
WITHDRAWAL NOT AVAILABLE IRREVERSIBLE WITHOUT CORRESPONDING CODE N3 WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE WITHDRAWAL NOT AVAILABLE - DON’T TRY AGAIN
RECURRENT PAYMENT SUSPENSION FOR A SERVICE IRREVERSIBLE WITHOUT CORRESPONDING CODE R0 WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE RECURRING SERVICE PAYMENT SUSPENSION - DON’T TRY AGAIN
RECURRENT PAYMENT SUSPENSION FOR ALL SERVICES IRREVERSIBLE WITHOUT CORRESPONDING CODE R1 WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE RECURRING SERVICE PAYMENT SUSPENSION - DON’T TRY AGAIN
TRANSACTION NOT QUALIFIED FOR VISA PIN IRREVERSIBLE WITHOUT CORRESPONDING CODE R2 WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE TRANSACTION NOT ALLOWED FOR CARD - DON’T TRY AGAIN
SUSPENSION OF ALL AUTHORIZATION ORDERS IRREVERSIBLE WITHOUT CORRESPONDING CODE R3 WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE RECURRING SERVICE PAYMENT SUSPENSION - DON’T TRY AGAIN
IT’S NOT POSSIBLE TO LOCATE THE REGISTRATION IN THE FILE IRREVERSIBLE WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE 25 WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE CONTACT YOUR CARD CENTER - DON’T TRY AGAIN
FILE NOT AVAILABLE FOR UPDATE IRREVERSIBLE WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE 28 WITHOUT CORRESPONDING CODE WITHOUT CORRESPONDING CODE CONTACT YOUR CARD CENTER - DON’T TRY AGAIN

Other return codes

Response Code Definitio Meaning Action Allows Retry
00 Successfully authorized transaction. Successfully authorized transaction. Successfully authorized transaction. No
02 Unauthorized transaction. Referred transaction. Unauthorized transaction. Referred (suspected fraud) by the issuing bank. Unauthorized transaction. Contact your issuing bank. No
11 Successfully authorized transaction for card issued abroad Successfully authorized transaction. Successfully authorized transaction. No
21 Cancellation not done. Non-localized transaction. Cancellation was not processed. If the error persists, contact Cielo. Cancellation was not processed. Try again later. If the error persists, contact the virtual store. No
22 Invalid installment. Invalid number of installments. Could not process transaction. Invalid number of installments. If the error persists, contact Cielo. Could not process transaction. Invalid value. Redo the transaction confirming the reported data. If the error persists, contact the virtual store. No
24 Invalid number of installments. Could not process transaction. Invalid number of installments. If the error persists, contact Cielo. Could not process transaction. Invalid number of installments. Redo the transaction confirming the reported data. If the error persists, contact the virtual store. No
60 Unauthorized transaction. Unauthorized transaction. Try again. If the error persists the carrier should contact the issuing bank. Could not process transaction. Try again later. If the error persists, contact your issuing bank. Only 4 times in 16 days.
67 Unauthorized transaction. Card locked for shopping today. Unauthorized transaction. Card locked for shopping today. Blocking may be due to excessive invalid attempts. Card will be automatically unlocked at midnight. Unauthorized transaction. Card locked temporarily. Contact your issuing bank. From the following day, only 4 times in 16 days.
70 Unauthorized transaction. Limit exceeded/no balance. Unauthorized transaction. Limit exceeded/no balance. Unauthorized transaction. Contact your issuing bank. From the following day, only 4 times in 16 days.
72 Cancellation not done. Not enough available balance for cancellation. Cancellation not done. Not enough available balance for cancellation. If the error persists, contact Cielo. Cancellation not done. Try again later. If the error persists, contact the virtual store.. No
80 Unauthorized transaction. Divergence on transaction/payment date. Unauthorized transaction. Invalid transaction date or first payment date. Unauthorized transaction. Redo the transaction confirming data. No
83 Unauthorized transaction. Error in password control Unauthorized transaction. Error in password control Unauthorized transaction. Redo the transaction confirming data. If the error persists, contact your issuing bank. No
85 Transaction not allowed. Operation failed. Transaction not allowed. There was a processing error. Ask the carrier to re-enter the card data, if there is a persistent error there may be a problem at the merchant’s terminal, in which case the merchant should contact Cielo. Transaction not allowed. Re-enter the card data. If the error persists, contact the virtual store. No
89 Transaction error. Unauthorized transaction. Transaction error. The carrier must try again and if the error persists, contact the issuing bank. Unauthorized transaction. Transaction error. Try again and if the error persists, contact your issuing bank. Only 4 times in 16 days.
90 Transaction not allowed. Operation failed. Transaction not allowed. There was a processing error. Ask the carrier to re-enter the card data, if there is a persistent error there may be a problem at the merchant’s terminal, in which case the merchant should contact Cielo. Transaction not allowed. Re-enter the card data. If the error persists, contact the virtual store. No
97 Value not allowed for this transaction. Unauthorized transaction. Value not allowed for this transaction. Unauthorized transaction. Value not allowed for this transaction. No
98 System/communication unavailable. There was no request response within the set time. The transaction may have been processed. To confirm, check the transaction by the store order number and evaluate whether it was actually processed. Retry only after reviewing the original transaction by the order number and confirm that it was not processed.
999 System/communication unavailable. Unauthorized transaction. Issuer system without communication. Try later. Can be error in SITEF, please check! Your Transaction can not be processed, try again later. If the error persists, contact the virtual store. From the following day, only 4 times in 16 days.
AA Time Exceeded Time exceeded in communication with the issuing bank. Orient the carrier to try again, if the error persists it will be necessary for the carrier to contact their issuing bank. Time exceeded in their communication with the issuing bank, try again later. If the error persists, contact your bank. Only 4 times in 16 days.
AF Transaction not allowed. Operation failed. Transaction not allowed. There was a processing error. Ask the carrier to re-enter the card data, if there is a persistent error there may be a problem at the merchant’s terminal, in which case the merchant should contact Cielo. Transaction not allowed. Re-enter the card data. If the error persists, contact the virtual store. No
AG Transação não permitida. Falha da operação. Transação não permitida. Houve um erro no processamento.Solicite ao portador que digite novamente os dados do cartão, se o erro persistir pode haver um problema no terminal do lojista, nesse caso o lojista deve entrar em contato com a Cielo. Transação não permitida. Informe os dados do cartão novamente. Se o erro persistir, entre em contato com a loja virtual. Não
AH Transaction not allowed. Credit card being used as debit. Use the credit function. Transaction not allowed. Credit card being used as debit. Ask the carrier to select the Credit Card payment option. Unauthorized transaction. Try again by selecting the credit card payment option. No
AI Unauthorized transaction. Authentication was not performed. Unauthorized transaction. Authentication was not performed. The carrier did not complete the authentication. Ask the carrier to review the data and try again. If the error persists, contact Cielo informing the BIN (6 first digits of the card) Unauthorized transaction. Authentication failed. Try again and correctly enter the requested data. If the error persists, contact the merchant. No
AJ Transaction not allowed. Credit or debit transaction in an operation that allows only Private Label. Try again by selecting the Private Label option. Transaction not allowed. Credit or debit transaction in an operation that allows only Private Label. Ask the carrier to try again by selecting the Private Label option. If not available the Private Label option check in Cielo if your establishment allows this operation. Transaction not allowed. Credit or debit transaction in an operation that allows only Private Label. Try again and select the Private Label option. In case of a new error, contact the virtual store. No
AV Unauthorized transaction. Invalid data Validation of transaction data failed. Guide the carrier to review the data and try again. Data validation failed. Review the reported data and try again. Only 4 times in 16 days.
BD Transaction not allowed. Operation failed. Transaction not allowed. There was a processing error. Ask the carrier to re-enter the card data, if there is a persistent error there may be a problem at the merchant’s terminal, in which case the merchant should contact Cielo. Transaction not allowed. Re-enter the card data. If the error persists, contact the virtual store. No
BL Unauthorized transaction. Daily limit exceeded. Unauthorized transaction. Daily limit exceeded. Ask the carrier to contact their issuing bank. Unauthorized transaction. Daily limit exceeded. Contact your issuing bank. From the following day, only 4 times in 16 days.
BM Unauthorized transaction. Invalid card Unauthorized transaction. Invalid card. It may be card locking at the issuing bank or incorrect data. Try to use the Lhum Algorithm (Mod 10) to avoid unauthorized transactions for this reason. Unauthorized transaction. Invalid card. Redo the transaction confirming the reported data. No
BN Unauthorized transaction. Card or account locked. Unauthorized transaction. Carrier’s card or account is locked. Ask the carrier to contact their issuing bank. Unauthorized transaction. Carrier’s card or account is locked. Contact your issuing bank. No
BO Transaction not allowed. Operation failed. Transaction not allowed. There was a processing error. Ask the carrier to re-enter the card data, if the error persists, contact the issuing bank. Transaction not allowed. There was a processing error. Re-enter card data, if error persists, contact issuing bank. Only 4 times in 16 days.
BP Unauthorized transaction. Non-existent checking account. Unauthorized transaction. The transaction could not be processed due to an error related to the carrier’s card or account. Ask the carrier to contact the issuing bank. Unauthorized transaction. Could not process the transaction due to an error related to the carrier’s card or account. Contact the issuing bank. No
C1 Transaction not allowed. Card can’t process debit transactions. Change the payment method or card used. Change the payment method or card used. No
C2 Transaction not allowed. Incorrect data. Please review the data on the payment screen. Incorrect data. Please review the data on the payment screen. No
C3 Transaction not allowed. Invalid period for this type of transaction. Invalid period for this type of transaction. No
CF Unauthorized transaction.C79:J79 Data validation failed. Unauthorized transaction. Data validation failed. Ask the carrier to contact the issuing bank. Unauthorized transaction. Data validation failed. Contact the issuing bank. No
CG Unauthorized transaction. Data validation failed. Unauthorized transaction. Data validation faileds. Ask the carrier to contact the issuing bank. Unauthorized transaction. Data validation failed. Contact the issuing bank. No
DF Transaction not allowed. Invalid card or card failure. Transaction not allowed. Invalid card or card failure. Ask the carrier to re-enter the card data, if the error persists, contact the bank Transaction not allowed. Invalid card or card failure. Re-enter card data, if error persists, contact bank Only 4 times in 16 days.
DM Unauthorized transaction. Limit exceeded/no balance. Unauthorized transaction. Limit exceeded/no balance. Unauthorized transaction. Contact your issuing bank. From the following day, only 4 times in 16 days.
DQ Unauthorized transaction. Data validation failed. Unauthorized transaction. Data validation failed. Ask the carrier to contact the issuing bank. Unauthorized transaction. Data validation failed. Contact the issuing bank. No
DS Transaction not allowed for the card Unauthorized transaction. Transaction not allowed for the card. Unauthorized transaction. Contact your issuing bank. Only 4 times in 16 days.
EB Unauthorized transaction. Daily limit exceeded. Unauthorized transaction. Daily limit exceeded. Ask the carrier to contact their issuing bank. Unauthorized transaction. Daily limit exceeded. Contact your issuing bank. A partir do dia seguinte, only 4 times in 16 days.
EE Transaction not allowed. Installment value below the minimum allowed. Transaction not allowed. Installment value below the minimum allowed. It is not permitted installments lower than R$5,00. It is necessary to revise the calculation for installments. Transaction not allowed. Installment value is below the minimum allowed. Contact the virtual store. No
EK Transaction not allowed for the card Unauthorized transaction. Transaction not allowed for the card. Unauthorized transaction. Contact your issuing bank. Only 4 times in 16 days.
FC Unauthorized transaction. Call the Issuer Unauthorized transaction. Guide the carrier to contact the issuing bank. Unauthorized transaction. Contact your issuing bank. No
FE Unauthorized transaction. Divergence on transaction/payment date. Unauthorized transaction. Invalid transaction date or first payment date. Unauthorized transaction. Redo the transaction confirming data. No
FF Cancellation OK Cancellation transaction authorized successfully. WARNING: This return is for cases of cancellations and not for cases of authorizations. Transação de cancelamento autorizada com sucesso No
FG Unauthorized transaction. Call AmEx 08007285090. Unauthorized transaction. Guide the carrier to contact AmEx Call Center. Unauthorized transaction. Contact the AmEx Call Center at the phone number 08007285090 No
GA Wait for contact Unauthorized transaction. Referred by Lynx Online in a preventive way. Unauthorized transaction. Contact the merchant. No
GD Transaction not allowed. Transaction can not be processed in the establishment. Contact Cielo for more details. Transaction not allowed. Contact the virtual store No
HJ Transaction not allowed. Invalid operation code. Transaction not allowed. Invalid Coban operation code. Transaction not allowed. Invalid Coban operation code. Contact the merchant. No
IA Transaction not allowed. Invalid operation indicator. Transaction not allowed. Invalid Coban operation indicator. Transaction not allowed. Invalid Coban operation indicator. Contact the merchant. No
KA Transaction not allowed. Data validation failed. Transaction not allowed. There was a failure in data validation. Ask the carrier to review the data and try again. If the error persists, check the communication between virtual store and Cielo. Transaction not allowed. There was a failure in data validation. Review the reported data and try again. If the error persists, contact the Virtual Store. No
KB Transaction not allowed. Incurred option selected. Transaction not allowed. Wrong option selected. Ask the carrier to review the data and try again. If the error persists, the communication between virtual store and Cielo must be checked. Transaction not allowed. Wrong option selected. Try again. If the error persists, contact the Virtual Store. No
KE Unauthorized transaction. Data validation failed. Unauthorized transaction. Data validation failed. Selected option is not enabled. Check the options available to the carrier. Unauthorized transaction. Data validation failed. Selected option is not enabled. Contact the virtual store. No
N7 Unauthorized transaction. Invalid security code. Unauthorized transaction. Invalid security code. Guide the carrier to correct the data and try again. Unauthorized transaction. Review the data and enter again. No
U3 Transaction not allowed. Data validation failed. Transaction not allowed. There was a failure in data validation. Ask the carrier to review the data and try again. If the error persists, check the communication between virtual store and Cielo. Transaction not allowed. There was a failure in data validation. Review the reported data and try again. If the error persists, contact the Virtual Store. No

Error Codes

The errors that may appear in the XML message through the TAG ‘’ are arranged as follows:

Table integration errors

Code Message Description Action
1 Invalid message The XML message is off the format specified by ecommerce.xsd file Review the information sent in front XML message specifications
2 Invalid Credentials Inability to authenticate a virtual store request. Check if the number of accreditation and the key are correct
3 Nonexistent transaction There is no transaction to the informed identifier Reviewing the application
8 Invalid Security Code The security code entered in the message is invalid. Review the card information sent in the XML message
10 Inconsistency in sending the card The transaction, with or without card, is divergent with the permission of sending this information Reviewing the Store Registration allows sending the card or not
11 Not enabled mode The transaction is configured with a non-authorized payment method to the store Review the payment method requested
12 Number of invalid portions The number of shares requested exceeds the maximum allowed Review the payment method
13 Automatic authorization flag Flag automatic authorization incompatible with the invalid payment method requested Review the rules for using the flag
14 Invalid Direct Authorization The Direct authorization request is invalid Review the rules for using the Direct Authorization
15 Direct authorization without card The direct authorization request is without a card Review the rules for using the Direct Authorization
16 Identifier, TID, invalid The supplied TID is duplicated Reviewing the application
17 Missing security code The card security code is not sent (this information is compulsory for Amex) Reviewing the application
18 Security Code indicator inconsistent Incorrect use of the security code indicator Review the card information sent in the XML message
19 Return URL not supplied The Return URL is mandatory, except for recurrence and direct authorization. Review the information sent in the XML message
20 Status does not allow authorization You may not engage authorization for the transaction status Revise authorization rules
21 Deadline authorization expired It’s not allowed to perform authorization, as the term is expired Revise authorization rules
22 Invalid number of installments It’s not allowed to perform authorization for this number of installments Revise authorization rules
25 Forward to authorization is not allowed The result of the transaction authentication does not allow the authorization request Revise authorization rules
30 Invalid status to capture The status of the transaction does not allow capture Review the capture rules
31 Capture deadline defeated The capture can not be performed because the time for capture is overdue Review the capture rules
32 Invalid capture value The amount requested for capture is not valid Review the capture rules
33 Failed to capture Could not perform the capture Perform retry. Persisting, contact the E-commerce support and inform the transaction TID.
34 Mandatory departure tax value The amount of the departure tax is required if the catch is partial and authorization has been made with departure tax. Send again capturing request tagged.
35 invalid issuer for use boarding fee The card issuer used in the transaction does not support the boarding rate. Remove the rate of shipment, or use a card that supports this feature: Visa or Mastercard.
36 Invalid product for use boarding fee The chosen product is not supported on the departure tax. Change the product.
40 Cancellation deadline defeated Cancellations can not be performed because the term has expired Review the cancellation rules.
42 Failure to cancel It was not possible to cancel Perform retry. Persisting, you should contact the E-commerce support and inform the transaction TID.
43 Cancellation value is higher than the allowed value. The value that is trying to cancel exceeds the total value of the transaction captured. Review the value of partial cancellation, it may not be larger than the captured value of the transaction.
51 Invalid recurrence The transaction settings do not allow the successful performance of the applicant transaction. Make sure to choose “Lump Sum”; Make sure you are sending only the token or only credit card
52 Invalid Token The token provided in the authorization request is not valid or is blocked. Ensure that the Token is correct. If it persists, contact support.
53 Recurrence not enabled Registration the shopkeeper does not allow sending recurring transactions. Contact support for enable the recurrence to register.
54 Transaction with invalid Token The transaction settings do not allow the direct authorization to use Token is successfully made. Make sure to choose “Lump Sum”; Make sure you are only sending the token or only credit card.
55 Card number not supplied It was requested the creation of Token, but the credit card number was not provided. Review the information sent on XML message in front of specifications
56 Card validity not supplied It was requested the creation of Token, but the validity of the credit card has not been provided. Review the information sent in the message across XML specifications.
57 Unexpected error generating Token System failure occurred at the time of generation of the Token. Try again. If it persists, contact Support.
61 Invalid Recurring Transaction The recurring transaction settings are invalid. Make sure the product is Lump Sum if the token or card were sent in the message.
77 XID not supplied authorization with external authentication was requested, but the XID field was not provided. Review the information sent in the message across XML specifications.
78 CAVV not supplied authorization with external authentication was requested, but CAVV field was not provided. Review the information sent in the message across XML specifications.
86 XID and CAVV not provided authorization with external authentication was requested, but the CAVV and XID fields were not provided. Review the information sent in the message across XML specifications.
87 CAVV with divergent size authorization with external authentication was requested, but CAVV field has a divergent size. Review the information sent in the message across XML specifications.
88 XID with differing size authorization with external authentication was requested, but the XID field has a divergent size. Review the information sent in the message across XML specifications.
89 ECI with divergent size authorization with external authentication was requested, but the ECI field possesses a divergent size. Review the information sent in the message across XML specifications.
90 ECI invalid authorization with external authentication was requested, but the ECI field has an invalid value. Review the information sent in the message across XML specifications.
95 Internal error authentication Failure in system If it persists, contact the support and tell the transaction TID.
97 Unavailable System System failure If it persists, contact support.
98 Timeout The application did not respond within 25 seconds If it persists, contact support.
99 Unexpected Error System failure If it persists, contact the support and tell the transaction TID.

Status of transactions

Status Code
Built Transaction 0
Transaction in Progress 1
Transaction Authenticated 2
Transaction Not Authenticated 3
Authorized Transaction 4
Unauthorized Transaction 5
Captured Transaction 6
Transaction Cancelled 9
Transaction Authentication 10
Transaction in Cancellation 12

ECI

Log Results Visa Mastercard Aura Other
Successfully authenticated carrier. 5 2 n / a n / a
Carrier not authenticated because the issuer didn’t provide authentication mechanisms. 6 1 n / a n / a
Carrier not authenticated successfully as an unexpected technical error. 7 1 n / a n / a
Carrier not authenticated successfully. 7 0 n / a n / a
The store chose to allow bypassing the authentication. 7 0 0 7

Operations and configurations

Creating an authorization of transaction

The request for an authorization is the main operation of Cielo E-commerce, because it’s through it, that a sale can be concreted and the sale process can be finished. The authorization has a sequence of configuration that can be customized, besides the functionalities that have value to customer and retailers.

Direct authorization

<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-transacao id="a97ab62a-7956-41ea-b03f-c2e9f612c293" versao="1.2.1">
  <dados-ec>
    <numero>1006993069</numero>
    <chave>25fbb997438630f30b112d033ce2e621b34f3</chave>
  </dados-ec>
  <dados-portador>
    <numero>4012001038443335</numero>
    <validade>201508</validade>
    <indicador>1</indicador>
    <codigo-seguranca>973</codigo-seguranca>
  </dados-portador>
  <dados-pedido>
    <!-- ... -->
  </dados-pedido>
  <forma-pagamento>
    <bandeira>visa</bandeira>
    <produto>1</produto>
    <parcelas>1</parcelas>
  </forma-pagamento>
  <url-retorno>http://localhost/lojaexemplo/retorno.jsp</url-retorno>
  <autorizar>3</autorizar>
  <capturar>false</capturar>
</requisicao-transacao>

The direct authorization is characterized for being a transaction without authentication from holder, because it’s a retailer option (and risk), or because the card issuer or emitter don’t have support. The direct authorization can be done in two ways: traditional (with card data) or using a token.

Traditional

Recurrent authorization

<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-transacao id="a97ab62a-7956-41ea-b03f-c2e9f612c293" versao="1.2.1">
  <dados-ec>
    <numero>1006993069</numero>
    <chave>25fbb997438630f30b112d033ce2e621b34f3</chave>
  </dados-ec>
  <dados-portador>
    <numero>4012001038443335</numero>
    <validade>201508</validade>
    <indicador>1</indicador>
    <codigo-seguranca>973</codigo-seguranca>
  </dados-portador>
  <dados-pedido>
    <!-- ... -->
  </dados-pedido>
  <forma-pagamento>
    <bandeira>visa</bandeira>
    <produto>1</produto>
    <parcelas>1</parcelas>
  </forma-pagamento>
  <url-retorno>http://localhost/lojaexemplo/retorno.jsp</url-retorno>
  <autorizar>4</autorizar>
  <capturar>false</capturar>
</requisicao-transacao>

The recurrent authorization must be done in two ways: sending a token previously registered, or using a card. The recurrent transaction is very Yesilar than traditional transaction, the changes consist on the rules that emitter and card issuer use to authorize or deny a transaction. Another difference is related to “Renova Fácil” (Easy Renew).

Recurrent authorization with card

EASY RENEW (Renova Fácil):

<?xml version="1.0" encoding="ISO-8859-1"?>
<transacao xmlns="http://ecommerce.cbmp.com.br" versao="1.2.1" id="d35b67189442">
  <tid>10069930690362461001</tid>
  <pan>uv9yI5tkhX9jpuCt+dfrtoSVM4U3gIjvrcwMBfZcadE=</pan>
  <dados-pedido>
    <!-- ... -->
  </dados-pedido>
  <forma-pagamento>
    <!-- ... -->
  </forma-pagamento>
  <status>5</status>
  <!-- ... -->
  <autorizacao>
    <codigo>5</codigo>
    <mensagem>Autorização negada</mensagem>
    <data-hora>2011-12-09T10:58:45.847-02:00</data-hora>
    <valor>1000</valor>
    <lr>57</lr>
    <nsu>221766</nsu>
  </autorizacao>
  <dados-portador>
    <numero>4012001038443335</numero>
    <validade>201508</validade>
    <codigo-seguranca/>
  </dados-portador>
</transacao>

This functionality makes easier to identify a card which has been replaced for another at emitter bank. In this way, when a recurrent transaction is submitted to Web Service and Cielo identifies that the card used is outdated, the system will behave like that:

  1. If the recurrent transaction has been send through a card, the authorization will be declined and it will returned the data of new card, according to the diagram below:

remova fácil

Authorization of a transaction previously created

<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-autorizacao-tid id="0000000000" versao="1.2.0">
  <tid>1006993069990BCAA001</tid>
  <dados-ec>
    <numero>1006993069</numero>
    <chave>25fbb997438630f30b112d033ce2e621b34f3</chave>
  </dados-ec>
</requisicao-autorizacao-tid>

To the establishments that use the authentication process of authentication it’s possible to request an authorization of transaction that stopped after the execution of this process. The message to perform this operation is “requisicao-autorizacao-tid”, as described below:

Element Type Mandatory Size Description
tid Alphanumeric Yes 20 transaction identifier
dados-ec.numero Numeric Yes 1..20 affiliation store number with Cielo.
dados-ec.chave Alphanumeric Yes 1..100 store access key attributed by Cielo.

Transaction with token

<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-token id="8fc889c7-004f-42f1-963a-31aa26f75e5c" versao="1.2.1">
  <dados-ec>
    <numero>1006993069</numero>
    <chave>25fbb99741c739dd84d7b06ec78c9bac718838630f30b112d033ce2e621b34f3</chave>
  </dados-ec>
  <dados-portador>
    <numero>4012001038443335</numero>
    <validade>201508</validade>
    <nome-portador>FULANO DA SILVA</nome-portador>
  </dados-portador>
</requisicao-token>
Element Type Mandatory Size Description
dados-ec.numero Numeric Yes 1..20 Store affiliation number with Cielo
dados-ec.chave Alfanumeric Yes 1..100 Store access key assigned by Cielo.
daods-portador n/a Optional n/a Node with card data
dados-portador.numero Numeric Yes 19 Card number
dados-portador.validade Numeric Yes 6 Card validity on yyyymm format. Example: 201212 (dec/2012)
dados-portador.nome-portador Alfanumeric Optional 0..50 Name printed as in the card

Response

<?xml version="1.0" encoding="ISO-8859-1"?>
<retorno-token xmlns="http://ecommerce.cbmp.com.br" versao="1.2.1" id="57239017">
  <token>
    <dados-token>
      <codigo-token>TuS6LeBHWjqFFtE7S3zR052Jl/KUlD+tYJFpAdlA87E=</codigo-token>
      <status>1</status>
      <numero-cartao-truncado>455187******0183</numero-cartao-truncado>
    </dados-token>
  </token>
</retorno-token>

The return will be like: when a request has been concluded with success, or in case of failure .

Element Type Size Description
codigo-token Alfanumeric 100 Code of token created
status Numeric 1 Token Status: 0 – Locked, 1 – Unlocked
numero-cartao-truncado Alfanumeric 1..16 truncated-card-number

Direct Authorization via TOKEN

<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-transacao id="a97ab62a-7956-41ea-b03f-c2e9f612c293" versao="1.2.1">
  <dados-ec>
    <numero>1006993069</numero>
    <chave>25fbb997438630f30b112d033ce2e621b34f3</chave>
  </dados-ec>
  <dados-portador>
    <token>TuS6LeBHWjqFFtE7S3zR052Jl/KUlD+tYJFpAdlA87E=</token>
  </dados-portador>
  <dados-pedido>
    <!-- ... -->
  </dados-pedido>
  <forma-pagamento>
    <bandeira>visa</bandeira>
    <produto>1</produto>
    <parcelas>1</parcelas>
  </forma-pagamento>
  <url-retorno>http://localhost/lojaexemplo/retorno.jsp</url-retorno>
  <autorizar>3</autorizar>
  <capturar>true</capturar>
</requisicao-transacao>

Recurrent Authorization with TOKEN

<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-transacao id="a97ab62a-7956-41ea-b03f-c2e9f612c293" versao="1.2.1">
  <dados-ec>
    <numero>1006993069</numero>
    <chave>25fbb997438630f30b112d033ce2e621b34f3</chave>
  </dados-ec>
  <dados-portador>
    <token>TuS6LeBHWjqFFtE7S3zR052Jl/KUlD+tYJFpAdlA87E=</token>
  </dados-portador>
  <dados-pedido>
    <!-- ... -->
  </dados-pedido>
  <forma-pagamento>
    <bandeira>visa</bandeira>
    <produto>1</produto>
    <parcelas>1</parcelas>
  </forma-pagamento>
  <url-retorno>http://localhost/lojaexemplo/retorno.jsp</url-retorno>
  <autorizar>4</autorizar>
  <capturar>true</capturar>
</requisicao-transacao>

Easy Renew with TOKEN

<?xml version="1.0" encoding="ISO-8859-1"?>
<transacao xmlns="http://ecommerce.cbmp.com.br" versao="1.2.1" id="d35b67189442">
  <tid>10069930690362461001</tid>
  <pan>uv9yI5tkhX9jpuCt+dfrtoSVM4U3gIjvrcwMBfZcadE=</pan>
  <dados-pedido>
    <!-- ... -->
  </dados-pedido>
  <forma-pagamento>
    <!-- ... -->
  </forma-pagamento>
  <status>5</status>
  <!-- ... -->
  <autorizacao>
    <codigo>5</codigo>
    <mensagem>Autorização negada</mensagem>
    <data-hora>2011-12-09T10:58:45.847-02:00</data-hora>
    <valor>1000</valor>
    <lr>57</lr>
    <nsu>221766</nsu>
  </autorizacao>
  <token>
    <dados-token>
      <codigo-token>TuS6LeBHWjqFFtE7S3zR052Jl/KUlD+tYJFpAdlA87E=</codigo-token>
      <status>1</status>
      <numero-cartao-truncado>455187******0183</numero-cartao-truncado>
    </dados-token>
  </token>
</transacao>

This functionality makes easier to identify a card which has been replaced for another in emitter bank. So, when a recurrent transaction is submitted to Web Service and Cielo identifies a card in use outdated, the system will behave like that:

  1. In case of recurrent transaction had been sent through a token, the authorization will be declined and a new token will return to be used, according to the diagram below:

remova fácil com token

Creating TOKEN

<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-transacao id="a97ab62a-7956-41ea-b03f-c2e9f612c293" versao="1.2.0">
  <!-- ... -->
  <gerar-token>true</gerar-token>
</requisicao-transacao>

Card On File

The cardholder may allow his card data to be stored securely for future transactions at the Merchant.

Below are the situations to identify if it’s the first or subsequent transaction through the first transaction TAG:

<credencial-armazenada>
  <primeira-transacao>S</primeira-transacao>
</credencial-armazenada>
<credencial-armazenada>
  <primeira-transacao>N</primeira-transacao>
</credencial-armazenada>

Request

<?xml version="1.0"?>
<requisicao-transacao id="1abd5a36-fba5-4a92-9341-7c9e9d44aa1a" versao="1.3.0">
  <dados-ec>
    <numero>2000019700</numero>
    <chave>65d156641f765861451c7c1270a4c09a617863b031b2e4b0c4a09cd390783c82</chave>
  </dados-ec>
  <dados-portador>
    <numero>4096031111110011</numero>
    <validade>201712</validade>
    <indicador>1</indicador>
    <codigo-seguranca>123</codigo-seguranca>
    <nome-portador>TESTE CUCUMBER</nome-portador>
  </dados-portador>
  <dados-pedido>
    <numero>77115</numero>
    <valor>315000</valor>
    <moeda>986</moeda>
    <data-hora>2016-02-16T13:45:05</data-hora>
    <descricao>Compra Online</descricao>
    <idioma>PT</idioma>
    <soft-descriptor>soft cucumber</soft-descriptor>
  </dados-pedido>
  <forma-pagamento>
    <bandeira>visa</bandeira>
    <produto>1</produto>
    <parcelas>1</parcelas>
  </forma-pagamento>
  <url-retorno>http://www.cielo.com.br</url-retorno>
  <autorizar>3</autorizar>
  <capturar>false</capturar>
  <credencial-armazenada>
    <primeira-transacao>S</primeira-transacao>
  </credencial-armazenada>
  <gerar-token>false</gerar-token>
</requisicao-transacao>
Element Type Mandatory Size Description
dados-ec.numero Numeric Yes 1..20 Store affiliation number with Cielo.
dados-ec.chave Alfanumeric Yes 1..100 Store access key assigned by Cielo.
dados-portador.numero Numeric Yes 19 Card number.
dados-portador.validade Numeric Yes 1 Card validity in aaaamm format. Example: 201212 (dec/2012).
dados-portador.indicador Numeric Yes 1 Security Code submission indicator: 0 - not reported, 1 - reported, 2 - unreadable, 9 - nonexistent
dados-portador.codigo-seguranca Numeric Conditional 3..4 Required if indicator is 1.
dados-portador.nome-portador Alfanumeric Optional 0..100 Name as printed on card.
dados-pedido.numero Alfanumeric Yes 1..20 Store order number. It is recommended to be a single value per order.
dados-pedido.valor Numeric Yes 1..12 Amount to be charged for the order (must already include freight, wrapping, extra costs, shipping fee, etc.). This amount is what will be charged to the consumer.
dados-pedido.moeda Numeric Yes 3 Numeric currency code in ISO 4217. For Real, the code is 986.
dados-pedido.data-hora Alfanumeric Yes 19 Date time of order. Format: aaaa-MM-ddTHH24:mm:ss
dados-pedido.descricao Alfanumeric Optional 0..1024 Order description
dados-pedido.idioma Alfanumeric Optional 2 Order language: PT (Portuguese), EN (English) or ES (Spanish). Based on this information, the language to be used on Cielo’s screens is defined. If not sent, the system will assume “PT”.
dados-pedido.soft-descriptor Alfanumeric Optional 0..13 Text of up to 13 characters will be displayed on the carrier invoice after the name of the merchant.
forma-pagamento.bandeira Alfanumeric Yes n/a Flag Name (lowercase): “visa”, “mastercard”, “diners”, “discover”, “link”, “amex”, “jcb”, “aura”, “hypercard”
forma-pagamento.produto Alfanumeric Yes 1 Product code: 1 - Cash Credit, 2 - Installment store, A - Debit.
forma-pagamento.parcelas Numeric Yes 1..2 Number of installments. For cash credit or debit, use 1.
url-retorno Alfanumeric Yes 1..1024 Return page URL. This is where Cielo will direct the browser to end authentication or authorization. It isn’t only required for direct authorization, but the field must be entered as null.
autorizar Alfanumeric Yes 1 Defines whether the transaction authorization type is authentication.
0 - Do not authorize
1 - Authorize only if authenticated
2 - Authorize unauthenticated and authenticated
3 - Only authorize (do not authenticate) )
4 - recurring authorization
capturar Boolean Yes n/a true or false. Defines whether the transaction will be automatically captured if it’s authorized.
credencial-armazenada.primeira-transacao Alfanumeric Optional 1 Stored cardholder data.
Defines whether this is the first transaction (S) or subsequent transaction (N).
gerar-token Boolean Optional n/a true or false. Defines whether the current transaction should generate a token associated with the card.

Response

<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
<transacao id="1abd5a36-fba5-4a92-9341-7c9e9d44aa1a" versao="1.3.0" xmlns="http://ecommerce.cbmp.com.br">
  <tid>20000197008CTDEP7DHC</tid>
  <pan>iwcdiV9SLhtb/dsQNXRHT426+tgjcLtMzchw5YggfP8=</pan>
  <dados-pedido>
    <numero>77115</numero>
    <valor>315000</valor>
    <moeda>986</moeda>
    <data-hora>2016-02-16T13:45:05</data-hora>
    <descricao>Compra Online</descricao>
    <idioma>PT</idioma>
  </dados-pedido>
  <forma-pagamento>
    <bandeira>elo</bandeira>
    <produto>A</produto>
    <parcelas>1</parcelas>
  </forma-pagamento>
  <status>6</status>
  <autenticacao>
    <codigo>6</codigo>
    <mensagem>Autenticada com sucesso</mensagem>
    <data-hora>2019-08-28T13:45:43.959-03:00</data-hora>
    <valor>315000</valor>
    <eci>5</eci>
  </autenticacao>
  <autorizacao>
    <codigo>6</codigo>
    <mensagem>Transacao autorizada</mensagem>
    <data-hora>2019-08-28T13:45:43.959-03:00</data-hora>
    <valor>315000</valor>
    <lr>00</lr>
    <arp>882114</arp>
    <nsu>248001</nsu>
  </autorizacao>
  <captura>
    <codigo>6</codigo>
    <mensagem>Transacao capturada com sucesso</mensagem>
    <data-hora>2019-08-28T13:45:43.959-03:00</data-hora>
    <valor>315000</valor>
  </captura>
</transacao>
Element Type Mandatory Size Description
tid Alfanumeric Yes 1..40 Transaction identifier.
pan Alfanumeric Yes n/a  
dados-pedido.numero Alfanumeric Yes 1..20 Store order number. It’s recommended to be a single value per order.
dados-pedido.valor Numeric Yes 1..12 Amount to be charged for the order (must already include freight, wrapping, extra costs, shipping fee, etc.). This amount is what will be charged to the consumer.
dados-pedido.moeda Numeric Yes 3 Numeric currency code in ISO 4217. For Real, the code is 986.
dados-pedido.data-hora Alfanumeric Yes 19 Date time of order. Format: aaaa-MM-ddTHH24:mm:ss
dados-pedido.descricao Alfanumeric Optional 0..1024 Order description
dados-pedido.idioma Alfanumeric Optional 2 Order language: PT (Portuguese), EN (English) or ES (Spanish). Based on this information, the language to be used on Cielo’s screens is defined. If not sent, the system will assume “PT”.
forma-pagamento.bandeira Alfanumeric Yes n/a Flag Name (lowercase): “visa”, “mastercard”, “diners”, “discover”, “link”, “amex”, “jcb”, “aura”, “hypercard”
forma-pagamento.produto Alfanumeric Yes 1 Product code: 1 - Cash Credit, 2 - Installment store, A - Debit.
forma-pagamento.parcelas Numeric Yes 1..2 Number of installments. For cash credit or debit, use 1.
autenticacao.codigo Numeric Yes 1.2 Processing code
autenticacao.mensagem Alfanumeric Yes 1..100 Message with the response about transaction processing.
autenticacao.data-hora Alfanumeric Yes 19 Processing date and time
autenticacao.valor Numeric Yes 1..12 Processing value without punctuation. The last two digits are the cents.
autenticacao.eci Numeric Yes 2 Security level.
autorizacao.codigo Numeric Yes 1.2 Processing code
autorizacao.mensagem Alfanumeric Yes n/a Message with the response about transaction processing.
autorizacao.data-hora Alfanumeric Yes 19 Processing date and time
autorizacao.valor Numeric Yes 1..12 Processing value without punctuation. The last two digits are the cents.
autorizacao.lr Alfanumeric Yes 4 Literal code of authorization.
autorizacao.arp Alfanumeric Yes 6 Authorization ARP.
autorizacao.nsu Alfanumeric Yes 6 Authorization NSU
captura.codigo Numeric Yes 1.2 Processing code
captura.mensagem Alfanumeric Yes n/a Message with the response about transaction processing.
captura.data-hora Alfanumeric Yes 19 Processing date and time
captura.valor Numeric Yes 1..12 Processing value without punctuation. The last two digits are the cents.

Flag Tokenization

Customers who card tokenize along with the flags can send the information to Cielo in the transactional flow.

Request

<?xml version="1.0"?>
<requisicao-transacao id="1abd5a36-fba5-4a92-9341-7c9e9d44aa1a" versao="1.3.0">
    <dados-ec>
        <numero>2000019700</numero>
        <chave>65d156641f765861451c7c1270a4c09a617863b031b2e4b0c4a09cd390783c82</chave>
    </dados-ec>
    <dados-portador>
        <numero>4084359300407900</numero>
        <validade>201712</validade>
        <indicador>1</indicador>
        <codigo-seguranca>123</codigo-seguranca>
        <nome-portador>TESTE CUCUMBER</nome-portador>
        <token/>
        <carteira>
            <tipo>MERCHANT</tipo>
            <codigo-captura/>
            <cavv>A901234A5678A0123A567A90120=</cavv>
            <eci>4</eci>
        </carteira>
    </dados-portador>
    <dados-pedido>
        <numero>86785</numero>
        <valor>315000</valor>
        <moeda>986</moeda>
        <data-hora>2016-02-16T13:45:05</data-hora>
        <descricao>Compra Online</descricao>
        <idioma>PT</idioma>
        <soft-descriptor>soft cucumber</soft-descriptor>
    </dados-pedido>
    <forma-pagamento>
        <bandeira>visa</bandeira>
        <produto>1</produto>
        <parcelas>1</parcelas>
    </forma-pagamento>
    <url-retorno>http://www.cielo.com.br</url-retorno>
    <autorizar>3</autorizar>
    <capturar>false</capturar>
    <gerar-token>false</gerar-token>
    <avs>
        <![CDATA[<dados-avs><endereco>Rua Credito</endereco><complemento>Apto 504</complemento><numero>745</numero><bairro>Vila Cucumber</bairro><cep>13040-144</cep><cpf>30652698501</cpf></dados-avs>]]>
    </avs>
</requisicao-transacao>
Property Type Size
carteira.eci Numeric 1
carteira.cavv Alfanumeric 29
carteira.tipo Fixed  

Response

<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
<transacao id="1abd5a36-fba5-4a92-9341-7c9e9d44aa1a" versao="1.3.0" xmlns="http://ecommerce.cbmp.com.br">
    <tid>2000019700008C730BOC</tid>
    <pan>Ma7WOe2ciLGucTokmn5mX2mkpeVJGkqVTavqR42Pm5k=</pan>
    <dados-pedido>
        <numero>86785</numero>
        <valor>315000</valor>
        <moeda>986</moeda>
        <data-hora>2016-02-16T13:45:05</data-hora>
        <descricao>Compra Online</descricao>
        <idioma>PT</idioma>
    </dados-pedido>
    <forma-pagamento>
        <bandeira>visa</bandeira>
        <produto>1</produto>
        <parcelas>1</parcelas>
    </forma-pagamento>
    <status>4</status>
    <autenticacao>
        <codigo>4</codigo>
        <mensagem>Nao autenticada</mensagem>
        <data-hora>2020-01-09T11:28:39.732-03:00</data-hora>
        <valor>315000</valor>
        <eci>4</eci>
    </autenticacao>
    <autorizacao>
        <codigo>4</codigo>
        <mensagem>Transacao autorizada</mensagem>
        <data-hora>2020-01-09T11:28:39.732-03:00</data-hora>
        <valor>315000</valor>
        <lr>00</lr>
        <arp>144716</arp>
        <nsu>549201</nsu>
        <codigo-avs-cep>C</codigo-avs-cep>
        <mensagem-avs-cep>Confere</mensagem-avs-cep>
        <codigo-avs-end>C</codigo-avs-end>
        <mensagem-avs-end>Confere</mensagem-avs-end>
    </autorizacao>
</transacao>

Aggregated functionality

Authentication and transaction with debit card

<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-transacao id="a97ab62a-7956-41ea-b03f-c2e9f612c293" versao="1.2.1">
  <!-- ... -->
  <forma-pagamento>
    <bandeira>visa</bandeira>
    <produto>A</produto>
    <parcelas>1</parcelas>
  </forma-pagamento>
  <!-- ... -->
  <autorizar>1</autorizar>
</requisicao-transacao>

The authenticated transaction will ensure an extra security for the retailer against Chargebacks, however, according to presented on chapter “2.5 - Authentication and security level”, neither all card issuers and emitters make this kind of service available.

The debit product mandatorily requires an authenticated transaction, otherwise, the transaction won’t be authorized.

Allows the retailer to send a text (Soft Descriptor)

<requisicao-transacao id="a97ab62a-7956-41ea-b03f-c2e9f612c293" versao="1.2.1">
  <!-- ... -->
  <dados-pedido>
    <numero>178148599</numero>
    <valor>1000</valor>
    <moeda>986</moeda>
    <data-hora>2011-12-07T11:43:37</data-hora>
    <descricao>[origem:10.50.54.156]</descricao>
    <idioma>PT</idioma>
    <soft-descriptor>soft-descriptor</soft-descriptor>
  </dados-pedido>
  <!-- ... -->
</requisicao-transacao>

Automatic Capture

<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-transacao id="a97ab62a-7956-41ea-b03f-c2e9f612c293" versao="1.2.1">
  <!-- ... -->
  <capturar>true</capturar>
  <!-- ... -->
</requisicao-transacao>

Boarding fee

<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-transacao id="a97ab62a-7956-41ea-b03f-c2e9f612c293" versao="1.2.1">
  <!-- ... -->
  <dados-pedido>
    <numero>178148599</numero>
    <valor>10000</valor>
    <moeda>986</moeda>
    <data-hora>2011-12-07T11:43:37</data-hora>
    <descricao>[origem:10.50.54.156]</descricao>
    <idioma>PT</idioma>
    <soft-descriptor>softdescriptor</soft-descriptor>
    <taxa-embarque>1000</taxa-embarque>
  </dados-pedido>
  <!-- ... -->
</requisicao-transacao>

AVS (Address Verification Service)

<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-transacao id="a97ab62a-7956-41ea-b03f-c2e9f612c293" versao="1.2.1">
  <!-- ... -->
  <dados-pedido>
    <numero>178148599</numero>
    <valor>10000</valor>
    <moeda>986</moeda>
    <data-hora>2011-12-07T11:43:37</data-hora>
    <descricao>[origem:10.50.54.156]</descricao>
    <idioma>PT</idioma>
    <soft-descriptor>softdescriptor</soft-descriptor>
    <taxa-embarque>1000</taxa-embarque>
    <avs>
  <![CDATA[
      <dados-avs>
        <endereco>Rua Teste AVS</endereco>
        <complemento>Casa</complemento>
        <numero>123</numero>
        <bairro>Vila AVS</bairro>
        <cep>12345-123</cep>
        <cpf>11111111111</cpf>
      </dados-avs>
  ]]>
    </avs>
  </dados-pedido>
  <!-- ... -->
</requisicao-transacao>

Capture

An authorized transaction only creates the credit for a commercial establishment in case being captured. That’s why all sales that the retailer want effective must be necessary realize the capture (or confirmation).

For sales on Credit modality, this confirmation happens in two moments:

In the first case, it’s not necessary to send a request to capture, because it’s done automatically by Cielo after the authorization of transaction. For this purpose, it’s necessary configure the request of transaction defining the value “true” for a TAG , according to section “Creating a transaction”.

In the second case, it’s necessary to do a “later capture”, through the new request to Cielo Webservice to confirm the transaction and receive the sale value.

Total and Partial Capture

<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-captura id="0374f305-0e23-4aad-82a2-055788c8cf4d" versao="1.2.1">
  <tid>10069930690360EF1001</tid>
  <dados-ec>
    <numero>1006993069</numero>
    <chave>25fbb99741c739dd84d7b06ec78c9bac718838630f30b112d033ce2e621b34f3</chave>
  </dados-ec>
  <valor>10000</valor>
  <taxa-embarque>1000</taxa-embarque>
</requisicao-captura>

Return

<?xml version="1.0" encoding="ISO-8859-1"?>
<transacao xmlns="http://ecommerce.cbmp.com.br" versao="1.2.1" id="0378c8cf4d">
  <tid>10069930690360EF1001</tid>
  <pan>uv9yI5tkhX9jpuCt+dfrtoSVM4U3gIjvrcwMBfZcadE=</pan>
  <!-- ... -->
  <captura>
    <codigo>6</codigo>
    <mensagem>Transacao capturada com sucesso</mensagem>
    <data-hora>2011-12-08T14:23:08.779-02:00</data-hora>
    <valor>900</valor>
    <taxa-embarque>900</taxa-embarque>
  </captura>
</transacao>

The field of node <captura> are detailed below:

Element Type Size Description
captura     Node with capture data in case that it has been passed for this step.
captura.codigo Numeric 1..2 Processing code
captura.mensagem Alfanumeric 1..100 Processing details
captura.datahora Alfanumeric 19 Date and time of processing.
captura.valor Numeric 1..12 Processing value without points. The last two numbers are “centavos”
captura.taxa-embarque Numeric 1..9 Montante declarado como taxa de embarque que foi capturado.

Cancellation

The cancellation is used when the retailer decides for don’t effective a purchase order, because the stock is not enough, because the customer gave up, ot any other reason. Its usage is necessary especially if the transaction has been captured, because there will be a debit on holder’s invoice if it won’t be cancelled.

Total and Partial Cancellation

<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-cancelamento id="13368079-dedc-4cdf-9140-84473faf83d4" versao="1.2.1">
  <tid>100699306903613D1001</tid>
  <dados-ec>
    <numero>1006993069</numero>
    <chave>25fbb99741c739dd84d7b06ec78c9bac718838630f30b112d033ce2e621b34f3
</chave>
  </dados-ec>
  <valor>200</valor>
</requisicao-cancelamento>
Element Type Mandatory Size Description
tid Alfanumeric Yes 1..40 Transaction identifier
dados-ec.numero Numeric Yes 1..10 Store credential number
dados-ec.chave Alfanumeric Yes 1..100 Store access key assigned by Cielo
valor Numeric Optional 1..12 Value to be cancelled. If not being informed, it will be a total concellation.

Return

<?xml version="1.0" encoding="ISO-8859-1"?>
<transacao xmlns="http://ecommerce.cbmp.com.br" versao="1.2.1" id="2c18f00a-3ff6-4c85-8865-a4fde599b2b2">
  <tid>100699306903613E1001</tid>
  <pan>uv9yI5tkhX9jpuCt+dfrtoSVM4U3gIjvrcwMBfZcadE=</pan>
  <!-- ... -->
  <cancelamentos>
    <cancelamento>
      <codigo>9</codigo>
      <mensagem>Transacao cancelada com sucesso</mensagem>
      <data-hora>2011-12-08T16:46:35.109-02:00</data-hora>
      <valor>1000</valor>
    </cancelamento>
  </cancelamentos>
</transacao>

Testing and homologation

Endpoint

The integrating tests must be realized before the homologation starts, during the development (codification) of solution. For this purpose, you must considered an enviroment like EndPoint to Webservice: https://sandbox1-5.hdevelo.com.br/sandsky/xml

Testing data

The data gross to realize the tests on this environment will be displayed on table below:

Card issuer Authentication Testing number card Validity Secure code - - CVC
Visa Sim 4012001037141112 202405 123
Mastercard Sim 5453010000066167 202405 123
Visa Não 4012001038443335 202405 123
Mastercard Não 5453010000066167 202405 123
Amex Não 376449047333005 202405 1234
Diners Não 36490102462661 202405 123
Elo Não 6362970000457013 202405 123
Elo (Corona Voucher) Não 5067220000000000 202405 123
Discover Não 6011020000245045 202405 123
JCB Não 3566007770004971 202405 123
Aura Não 5078601912345600019 202405 123

Testing key

To make easier the development we provided two key for tests, one for each modality of integration. Based on initial configurations done on your registration, choose the correct data to realize the tests:

Commercial establishment number Testing key
2000019700 8c08a0d0f00b73dedd2673a06fa725b0bd8edbf71c4c7dd0614bf408e4d16120

After conclude the development, the Homologation step will ensure that the implementation was appropriate and the customer solution is ready to interact with production environment of Cielo. It’s always happens after the development has been finished and tested. It’s composed by the next steps:

fluxo testes

  1. Conclusion of Registration: at this stage, the customer must send an email to cieloecommerce@cielo.com.br, requesting a production key. The message will contain the next information, that will complete the registration:
    • Definitive URL of website (production environment).
    • Name of responsible company by the development of integration.
    • Name and technical email (responsible developer) by integration.
    • Credential number (at Cielo) of online store.
    • Legal name and fictitious name of online store.
    • User and password to perform testing purchases.
    • URL of store logo on GIF format and size of 112X25 pixels.

In response, Cielo will return the valid key on production environment. Therefore, the store will be enable to realize tests on this environment. It starts the second step. It’s important that the tests be realized to cover the next topics:

At this moment, you have to consider the environment: https://ecommerce.cielo.com.br/servicos/ecommwsec.do

Production tests have to be done with card that belongs to the store or which holder authorized its usage, once in this environment exists a financial commitment about transaction realized.

At the end, a new request must be sent to cieloecommerce@cielo.com.br, to Cielo realize the homologation, indeed. The mass of tests will be executed to approve or deny the transactions.

The result “homologated” will be sent by e-mail. If there is any point that doesn’t allow the conclusion of homologation, the information will be also sent by e-mail requesting the corrections that are necessary.

Final considerations

Reading rules to store’s card

The reading of card data on own environment is controlled by rules defined by security program imposed by card issuers.

For Visa, this program is known as AIS (Account Information Security) PCI. To more information, access: https://www.cielo.com.br > Service > Security Service > AIS - Information Security Program or contact us.

For Mastercard, the security program is SDP (Site Data Protection) PCI. For more information, access: http://www.mastercard.com/us/sdp/index.html, or contact us.

Moreover, once requests are attended, at the credential (register) on e-commerce website, must be mentioned the option for reading the card from your own store.

Digital Certificate

In some environment is necessary extract the Digital Certificate that the Cielo E-commerce application uses to be installed on TrustStore of customer, specially in Java and PHP environments.

o obtain the certificate, please, open a browser and access: http://ecommerce.cielo.com.br; click on the icon that displays the information about the certificate:

Google Chrome:

Certificado no Google Chrome

Mozilla Firefox:

Certificado no Mozilla Firefox

Internet Explorer:

Certificado no Internet Explorer

Verified Program by Visa (Visa)

International Program of Visa allows the customer authentication at the purchase moment on e-commerce environment. Visit: http://www.verifiedbyvisa.com.br/ to more information.

Secure Code Program (Mastercard)

International Program of Mastercard allows the customer authentication at the purchase moment on e-commerce environment. Visit: http://www.verifiedbyvisa.com.br/ to more information.