Skip to content

api-evangelist/cielo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 

Repository files navigation

Cielo (cielo)

Cielo is one of the largest Brazilian card acquirers and a publicly traded company (B3:CIEL3), originally formed as a joint venture between Banco Bradesco and Banco do Brasil. The company processes credit, debit, Pix, QR Code, and boleto transactions for hundreds of thousands of merchants across Brazil, providing both in-person acquiring through its family of Cielo Smart (formerly LIO) Android POS terminals and Tap on Phone, and online payment processing through its e-Commerce API, Checkout, Payment Links, and Braspag gateway. Cielo exposes a broad developer surface through developercielo.github.io and the newer docs.cielo.com.br portal, including APIs for sales, queries, tokenization, 3DS 2.2 authentication, Pix with mTLS, chargeback management, refunds, reconciliation (Conciliador), and merchant promotions, along with open-source SDKs in Python, PHP, Java, C#, Kotlin, Swift, and Dart published from the DeveloperCielo GitHub organization.

URL: https://developercielo.github.io/

Run: Capabilities Using Naftiko

Tags

  • Payments
  • Acquiring
  • Fintech
  • Brazil
  • Point of Sale
  • Card Processing

Timestamps

  • Created: 2026-05-25
  • Modified: 2026-05-25

APIs

Cielo E-commerce API

The Cielo E-commerce API (also known as Cielo API 3.0) is the company's flagship online payment processing API, accepting credit cards from Visa, Mastercard, Amex, Elo, Hipercard, and more, as well as debit with 3DS 2.2, Pix, boleto, QR Code, and installments.

Human URL: https://developercielo.github.io/manual/cielo-ecommerce

Tags

  • E-commerce, Payments, Credit Card, Debit Card, Tokenization, Sales

Properties

Cielo 3DS 2.2 Authentication API

EMVCo-compliant cardholder authentication exposed via Braspag MPI; shifts chargeback liability to the issuer for authenticated card-not-present transactions.

Human URL: https://developercielo.github.io/manual/3ds

Tags

  • 3D Secure, Authentication, Fraud Prevention, Card Not Present

Properties

Cielo Pix API

Brazilian Central Bank Pix rails surfaced over OAuth 2.0 with certificate-bound tokens and mTLS, covering immediate charges, recurring charges, refunds, and webhooks.

Human URL: https://developercielo.github.io/manual/apipix

Tags

  • Pix, Instant Payments, Real-time Payments, mTLS, Brazil

Properties

Cielo Payment Link API

OAuth 2.0-secured API that generates short, shareable payment URLs for social commerce, with mobile SDKs for iOS, Android, and Flutter.

Human URL: https://developercielo.github.io/manual/linkdepagamentos5

Tags

  • Payment Link, Checkout, OAuth2, Social Commerce

Properties

Cielo Checkout API

Hosted payment-page solution handling card, Pix, and boleto flows end-to-end with PCI scope reduction and webhook notifications.

Human URL: https://developercielo.github.io/manual/checkout-cielo

Tags

  • Checkout, Hosted Payment Page, E-commerce

Properties

Cielo Refunds API

OAuth 2.0 (Keycloak) plus mTLS API for single and batch refund requests, with PDF and ZIP letter generation.

Human URL: https://developercielo.github.io/manual/api-refunds

Tags

  • Refunds, Cancellations, OAuth2, mTLS

Properties

Cielo Chargeback API

Programmatic dispute lifecycle management — accept, refuse, query, and download issuer evidence — secured by OAuth 2.0 and mTLS.

Human URL: https://developercielo.github.io/manual/api-chargeback-2-0

Tags

  • Chargeback, Disputes, OAuth2, mTLS

Properties

Cielo Conciliador API

F360-powered reconciliation API exposing card installments, title installments, bank statements, and asynchronous report generation with webhook callbacks.

Human URL: https://developercielo.github.io/manual/edi-cielo-conciliador

Tags

  • Reconciliation, Conciliation, Reports, Webhooks, F360

Properties

Cielo Promo API

OAuth 2.0 authorization-code API for distributing merchant promotions and discounts to cardholders through partner apps.

Human URL: https://developercielo.github.io/manual/promotions

Tags

  • Promotions, Discounts, Loyalty, OAuth2

Properties

Cielo LIO Remote Integration API

Cloud API for driving Cielo Smart (formerly LIO) Android POS terminals from ERP and commercial-automation systems, with Java, Android, C#, PHP, and Kotlin SDKs.

Human URL: https://developercielo.github.io/manual/cielo-lio

Tags

  • Point of Sale, LIO, Cielo Smart, Remote Integration, In-Person Payments

Properties

Cielo BIN Query API

BIN lookup service exposing card metadata so e-commerce checkouts can validate brand and card type before authorization.

Human URL: https://developercielo.github.io/manual/cielo-ecommerce

Tags

  • BIN, Card Validation, Lookup

Properties

Cielo E-Wallets API

Extension of the e-Commerce API for accepting Apple Pay, Google Pay, Samsung Pay, and other digital wallets.

Human URL: https://developercielo.github.io/manual/e-wallets-ecommercecielo

Tags

  • Wallets, Digital Wallets, Apple Pay, Google Pay

Properties

Cielo Tap on Phone

SoftPOS solution turning NFC-capable smartphones into card acceptance devices with no separate hardware.

Human URL: https://www.cielo.com.br/maquininha-cartao/cielo-tap

Tags

  • Tap to Pay, SoftPOS, Mobile Acceptance, Contactless

Properties

Common

Features

  • One of the largest Brazilian card acquirers, listed on B3 as CIEL3
  • Originally a joint venture of Banco Bradesco and Banco do Brasil
  • Accepts 80+ card brands, Pix, QR Code, NFC, and boleto
  • Family of Cielo Smart (formerly LIO) Android POS terminals (Flash, Smart)
  • SoftPOS via Cielo Tap (Tap on Phone) — no separate hardware
  • Online acquiring via Cielo e-Commerce API (Cielo API 3.0)
  • Hosted Cielo Checkout and Payment Links for low-code acceptance
  • 3DS 2.2 authentication via Braspag MPI with liability shift
  • Tokenization and recurring payments via the e-Commerce API
  • Pix via OAuth 2.0 with certificate-bound tokens and mTLS
  • Programmatic chargeback and refund lifecycle management
  • Financial reconciliation via Cielo Conciliador (F360-powered)
  • Promotion distribution to cardholders via Cielo Promo
  • Braspag-powered Gateway, Payment Split, and Risk Management
  • Pre-built connectors for major Brazilian e-commerce platforms
  • Open-source SDKs across Python, PHP, Java, C#, Kotlin, Swift, Dart

Use Cases

  • In-Person Card Acceptance — POS acceptance on Cielo Smart Android terminals
  • SoftPOS / Tap on Phone — Contactless acceptance on NFC smartphones via Cielo Tap
  • Online Card Acquiring — Cielo e-Commerce API for web and app checkout
  • Hosted Checkout and Payment Links — Low-code acceptance over shareable URLs
  • Pix Charges and Refunds — Immediate and recurring Pix with mTLS-secured access
  • 3DS 2.2 Authentication — Liability-shifted CNP authentication via Braspag MPI
  • Dispute and Refund Management — Bulk chargeback and refund processing
  • Financial Reconciliation — Card and title installments via the Conciliador API
  • Recurring Payments and Tokenization — Card-on-file billing with Zero Auth
  • Merchant Promotion Distribution — Discount surfacing through partner apps

Integrations

  • Banco Bradesco — Founding shareholder; merchant onboarding channel
  • Banco do Brasil — Founding shareholder; merchant onboarding channel
  • Braspag — Cielo subsidiary powering Gateway, Split, Risk, and 3DS MPI
  • F360 — Powers the Cielo Conciliador reconciliation API
  • Banco Central do Brasil (BCB) Pix — Underlying instant-payments rail
  • Visa, Mastercard, Elo, Amex, Hipercard — Card schemes (80+ brands total)
  • Apple Pay, Google Pay, Samsung Pay — Digital wallets via E-Wallets API
  • VTEX, Magento, WooCommerce — E-commerce connectors on docs.cielo.com.br

Solutions

  • Cielo e-Commerce — Online acquiring stack (API, Checkout, Links, 3DS, BIN, Wallets)
  • Cielo Smart (LIO) — Android POS hardware and software platform
  • Cielo Tap — SoftPOS / Tap on Phone solution
  • Braspag — Enterprise gateway, payment split, and risk management
  • Cielo Promo — Promotion distribution to consumer-facing partner apps
  • Cielo Conciliador — Reconciliation and back-office reporting (F360)

Maintainers

About

Cielo is one of the largest Brazilian card acquirers and a publicly traded company (B3:CIEL3), originally formed as a joint venture between Banco Bradesco and Banco do Brasil. The company processes credit, debit, Pix, QR Code, and boleto transactions for hundreds of thousands of merchants across Brazil, providing both in-person acquiring through…

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors