Portuguese (BR)
Docs
API StatusSupport

How to start using the Cielo E-commerce API

Learn how to get started with the E-commerce API and begin selling online.

Hire the E-commerce API

Enter your monthly revenue and discover the best rate offer for your business. The E-commerce API has no monthly fees, and your store can be activated within up to 5 business days*.

🟢

Hire now

🔵

Hire with a specialist

ℹ️

EC Cielo

As soon as your store is enabled to create transactions in the production environment, you will receive a welcome email containing your merchant number, referred to as EC Cielo. On the Cielo website, you must select the EC corresponding to the E-commerce API in order to access the site settings.

If you hire other Cielo solutions, you will have a separate EC for each solution.


In the meantime, test the E-commerce API for free

  1. Obtain your test credentials;
  2. Make your first API call – create a credit card transaction;
  3. Test 3DS authentication**
  4. Check the return codes and the retry rules for declined transactions.

🔎

Testing the API in the sandbox environment is optional.

Available Features for Testing the API

Once you obtain the test credentials, most of the E-commerce API features will already be enabled. However, some payment methods and features need to be enabled through Cielo Customer Support.

Features automatically enabled for testing after registration in the sandbox
- Zero Auth : validate test card;
- Consulta BIN : retrieve card information;
- Credit card : create, capture, query, and void payment;
- Debit card : create, capture, query, and void payment;
- QR Code : create and query payment;
- Recurring payments : create recurring transactions;
- Tokenization : create card token and initiate transaction with tokenized card.
Sandbox testing features that must be enabled by Cielo Support
- Boleto;
- E-wallets ;
- Pix ;
- Silent Order Post;
- Velocity ;
- Fraud analysis (Fraud analysis must be contracted separately).

For production use, features may be subject to additional charges.

ℹ️

Learn more about the features enabled for testing at How to test the API.


Go live – start accepting online payments

1. Obtain your production credentials;

2. Contact E-commerce Support to enable Pix and additional features** ;

3. Integrate all payment methods and start selling online.


ℹ️

Enabling features in the production environment

In the production environment, most features will already be enabled by default.

However, each merchant must contact E-commerce Support to request the activation of the following features:

  • Recurrence (and retry of recurring payments);
  • Zero Auth;
  • Consulta BIN;
  • Velocity;
  • Fraud analysis (requires an additional contract).

For production use, features may be subject to additional charges.

* Cielo will evaluate the accuracy of the information provided and may approve or reject the registration.

** The features that must be enabled separately through E-commerce Support are Zero Auth, Consulta BIN, Velocity, Recurrence, and Fraud Analysis, and may be subject to additional charges.

Updated 6 days ago