Cielo migration guide

For new integrations, check Cielo E-commerce API

This guide has the purpose of making the integration between the Web Service 1.5 and the API 3.0 solutions easier. Before reading this guide, it is highly recommended that you have read the integration manual from the solution in which you intend to migrate your current integration. The manuals can be found in:

• Webservice 1.5 solution
• API 3.0 solution

Overview

In general, the first big difference between the two solutions, is on the send of commercial establishments credentials. On Webservice 1.5, the credentials are only send on the dados-ec node, through the number and key elements; On the API 3.0, the credentials are sent using the HTTP headers, through the MerchantId and MerchantKey fields.

A segunda grande diferença entre as duas soluções está no envio dos dados relacionados ao comprador; como na solução Webservice 1.5 esses dados não são enviados na integração, a loja poderá precisar implementar essa coleta de dados caso queira enviá-los.

The second big difference between the two solutions is on the AVS; since the API 3.0 doesn’t suuport AVS yet, there isn’t on the platform, a way to send them.

Environments from 3.0

Besides those differences, the HTTP requisitions are also made in different environments using HTTP methods specified for each requisition; they are:

Production Rnvironemnt

• Transaction requisition: https://api.cieloeCommerce.cielo.com.br/
• Transaction query: https://apiquery.cieloeCommerce.cielo.com.br/

Sandbox Environment

• Transaction requisition: https://apisandbox.cieloeCommerce.cielo.com.br
• Transaction query: https://apiquerysandbox.cieloeCommerce.cielo.com.br

HTTP methods from 3.0

Sales creation

Sales capture or cancellation

Sales query

Comparative tables

The comparative tables sections shows, field by field, each specificity of the solutions in each case of use; the GUIDE BY columns are used to set the focus to one of the solutions.

Compare Solutions:

In case your current integration uses a Webservice 1.5 solution and you want to make a comparison with the API 3.0 or vice versa, just view the tables below:

Integration with credit card

Credit Requisition Table

In this section, you will be able to analyse, field by field, each specificity of the solutions on the scenario of a requisition of a credit sale.

Table of the Credit Answer

In this section, you’ll be able to analyse, field by field, each specificity of the solutions on the answer scenario of a credit sale requisition.

Integration with debit card

Table of Debit Requisition

In this section, you’ll be able to analyse, field by field, each specificity from the solutions on the answer scenario of a debit sale requisition.

Table of Debit answer

In this section, you’ll be able to analyse, field by field, each specificity from the solutions on the answer scenario of a debit sale requisition.

Glossary

To make the understanding easier, we’ve listed below a little glossary with the main terms related to e-Commerce, cards market and acquiring:

• Authentication: process to ensure that the buyer really is the one he claims to be (legit holder), generally occurs on the issuing bank with the use of a digital token or card with security keys.
• Authorization: process to verify if a purchase may or not be performed with a card. At this moment, several verifications are made with the card and the holder (example: compliance, blockings, etc.) Also on this moment that the card limit is sensitized with the transaction amount.
• Cancellation: process to cancel a purchase performed with card.
• Capture: process that confirms an authorization that was previously performed . Only after the capture, is that the card holder will be able to view it in his statement or invoice.
• Access Key: is a security code specific from each store, generated by Cielo, used to perform the authentication and communication in all messages exchanged with Cielo. Also known as production key and key data.
• Buyer: The one that effects the buying on the virtual store.
• Issuer (issuing bank): Is the financial institution that emits the credit card, debit or voucher.
• Commercial Establishment or CE: Entity that responds for the virtual store.
• Gateway of payments: Company responsible for the technical integration and transactions processing.
• Accreditation Number: it’s an identifier number that the retailer gets after his accreditation along with Cielo.
• Holder: It’s the card holder at the moment of the sale.
• SecureCode: international program from MasterCard to make possible the authentication of the buyer at the moment of a purchase in e-Commerce environment.
• TID (Transaction Identifier): code composed by 20 characters that identifies uniquely a Cielo e-Commerce transaction.
• Transaction: is the purchase request by the holder of the card on Cielo.
• VBV (Verified by Visa): International Visa program that allows the authentication of the buyer at the moment of a purchase in e-Commerce environment.