Cielo E-commerce API

Name: Cielo E-commerce API
Brand: Cielo E-commerce API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentPaymentsPayment ProcessingapiKey12 EndpointsREST

For Agents

Process Brazilian e-commerce payments through Cielo — credit, debit, Pix, boleto, recurring billing, and card tokenisation.

Install Jentic One Beta

Connect the Cielo E-commerce API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Cielo E-commerce API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Cielo E-commerce API.

Create credit card, debit card, Pix, and boleto payment transactions via POST /1/sales

Capture pre-authorised payments and void or refund transactions via PUT /1/sales/{paymentId} and PUT /1/sales/{paymentId}/void

Manage recurring payment plans including update, deactivate, and reactivate flows under /1/RecurrentPayment/{recurrentPaymentId}

GET STARTED

Start building with Cielo E-commerce API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for Cielo E-commerce API, keeping it validated and agent-ready. Cielo is one of the largest payment acquirers in Brazil and its e-commerce API processes credit cards, debit cards, Pix, boleto, e-wallets, QR code payments, and recurring billing through a single REST surface. The API covers transaction creation, capture, void, recurrence management, card tokenisation, and BIN lookup, with separate base URLs for transactional writes and queries. It is the standard payment integration for Brazilian merchants who need to support local payment methods alongside cards.

Use Cases

Patterns agents use Cielo E-commerce API for, with concrete tasks.

★ Brazilian E-commerce Checkout

Brazilian merchants accept payment at checkout via the local payment mix — credit cards, debit cards, Pix instant transfer, and boleto bancário. POST /1/sales accepts a single transaction payload that selects the payment method, and Cielo handles authorisation, settlement, and Pix QR code generation. This avoids needing separate integrations for each payment method.

POST /1/sales with a credit card transaction for R$199.90 and return the payment ID and authorisation status

Subscription Billing in Brazil

SaaS and subscription businesses in Brazil charge customers monthly or annually using Cielo's recurring payment endpoints. POST /1/sales creates the initial recurrence and the /1/RecurrentPayment/{recurrentPaymentId} endpoints allow update, deactivate, and reactivate flows for cancellations and reactivations. Card tokenisation through /1/card stores the payment method for future cycles without holding raw PAN data.

Create a recurring payment via POST /1/sales for R$49.90 monthly and store the resulting recurrentPaymentId for cancellation later

Pre-authorisation and Capture

Travel, hospitality, and marketplace merchants pre-authorise a card at booking and capture later when the service is delivered. POST /1/sales with capture=false reserves funds, and PUT /1/sales/{paymentId} captures the authorised amount when ready, or PUT /1/sales/{paymentId}/void releases the authorisation if the booking is cancelled.

POST /1/sales with capture=false for R$1500, then later PUT /1/sales/{paymentId} to capture R$1320 once final billing is known

Card Tokenisation and BIN Routing

Merchants who want to reduce PCI scope tokenise card details once and reference the token for future charges. POST /1/card returns a Cielo card token, /1/zeroauth validates the card without charging, and /1/consultabin/{bin} returns issuer and brand information so the front-end can route the payment to the optimal acquirer or apply card-specific rules.

POST /1/card to tokenise a credit card and use the returned token in a follow-up POST /1/sales for R$89

Agent-Driven Payment Reconciliation

An AI agent reconciling daily payments calls Cielo through Jentic to query each merchantOrderId against the orders system and confirm settlement status. The agent searches Jentic for 'query a Cielo payment by order ID', loads the operation, and walks through every order from the day to flag mismatches without an engineer building bespoke ETL.

Search Jentic for 'query a Cielo payment by order ID', load /1/sales/{merchantOrderId}, and check status for each order from yesterday

Key Endpoints

12 endpoints — jentic publishes the only available openapi specification for cielo e-commerce api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/1/sales

Create a payment transaction

GET

/1/sales/{paymentId}

Query a payment by ID

PUT

/1/sales/{paymentId}

Capture a pre-authorised payment

PUT

/1/sales/{paymentId}/void

Void or cancel a payment

POST

/1/card

Tokenise a card

POST

/1/zeroauth

Validate a card without charging

GET

/1/consultabin/{bin}

Look up card BIN information

POST

/1/sales

Create a payment transaction

GET

/1/sales/{paymentId}

Query a payment by ID

PUT

/1/sales/{paymentId}

Capture a pre-authorised payment

PUT

/1/sales/{paymentId}/void

Void or cancel a payment

POST

/1/card

Tokenise a card

POST

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

MerchantId and MerchantKey are stored encrypted in the Jentic vault. Agents receive scoped access — the secret MerchantKey never enters the agent's context or appears in logs.

Intent-based discovery

Agents search by intent (e.g., 'process a Brazilian payment with Cielo') and Jentic returns the matching /1/sales operation along with its payment method-specific schema.

Time to first call

Direct Cielo integration: 3-5 days for auth, transaction handling, recurrence flows, and Pix QR handling. Through Jentic: under 1 hour — search, load, execute.

FAQs

Specific to using Cielo E-commerce API through Jentic.

Why is there no official OpenAPI spec for Cielo E-commerce API?

Cielo does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Cielo E-commerce API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Cielo E-commerce API use?

Cielo uses two API key headers — MerchantId identifies the merchant and MerchantKey is the secret credential. Both must be present on every request. Through Jentic, both keys are stored encrypted in the vault and the agent never sees the raw values.

Can I accept Pix payments through the Cielo API?

Yes. POST /1/sales supports Pix as a payment method — the response includes the QR code payload and copia-e-cola string the customer uses to complete the transfer. Settlement notification arrives via webhook or via polling /1/sales/{paymentId} for status changes.

How do I set up recurring payments with Cielo?

Create the initial recurrence by passing recurrence parameters to POST /1/sales. Cielo returns a recurrentPaymentId you then manage via /1/RecurrentPayment/{recurrentPaymentId} for updates, /Deactivate to pause, and /Reactivate to resume — covering the full subscription lifecycle.

What are the rate limits for the Cielo E-commerce API?

Specific rate limits are not declared in the OpenAPI spec — Cielo applies tenant-level throttling on both the transaction host (api.cieloecommerce.cielo.com.br) and the query host (apiquery.cieloecommerce.cielo.com.br). Honour 429 responses and avoid tight polling loops on payment status.

How do I create a payment with Cielo through Jentic?

Run pip install jentic, search for 'process a Brazilian payment with Cielo', load the POST /1/sales operation, and execute with the order amount, payment method, and customer payload. Jentic injects the MerchantId and MerchantKey headers from the vault.

Cielo E-commerce API

Connect the Cielo E-commerce API to your agent

Capabilities

Start building with Cielo E-commerce API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs