For AI agents: visit https://docs.cielo.com.br/ecommerce-cielo/v3.0-en/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Cielo E-commerceCielo E-commerce
DocsReferência da APINovidades
AtendimentoAPI StatusCielo E-commerce
Referência da API
AtendimentoAPI Status
DocsReferência da APINovidades

API Architecture

  • Environments and API Architecture
  • Resource List
  • Authentication and credential management
    • Revoke and create API keys on the Cielo website
    • Get the 3DS credentials
    • Get credentials for Silent Order Post

API CODES

  • Codes returned by the API E-commerce (HTTP, status, and other codes)
    • HTTP codes
    • Transactional status
    • API business return codes (Return, Provider, and Reason)
    • API technical errors (Code and Message)
    • ABECS codes
    • Card Brands Retry Programs
    • Specific return codes and statuses
      • Void return codes
      • Capture return codes
      • Antifraude status list
      • Recurrence status list

sandbox

  • How to use the Sandbox
    • Test the API for free
  • Credit card in sandbox
  • Debit card in sandbox
  • Other payment methods in sandbox
  • Renova fácil in sandbox
  • Consulta BIN in sandbox
  • Zero Auth in sandbox
  • Postman
    • Download and register
    • Explaining Postman Components
    • Making a request
    • Collections and Environments Cielo

zero auth

  • Validate card with Zero Authpost
  • Validate card tokenized with Cartão Protegido
  • Validate e-wallet cardpost

Consulta BIN

  • Consulta BINget

Velocity

  • Prevent frauds with Velocity

credit card

  • Create a credit card paymentpost
    • Visa Intelligent Data Exchange (IDX)
  • Capture credit transaction after authorizationput
  • Void a credit transaction via PaymentIdput
  • Void a credit transaction via MerchantOrderIdput
  • Cancellation return codes
  • Card on file
    • First use of the stored card
    • Card already stored
      • Recurrence
      • Unscheduled recurrence
      • Recurrence installments
  • Credit card transaction status list

debit card

  • Create a debit card paymentpost
  • Void a debit transaction via PaymentIdput
  • Void a debit transaction via MerchantOrderIdput
  • Cancellation return codes
  • Card on file
    • First use of the stored card
  • Debit card transaction status list

pix

  • Create a payment with Pix QR Codepost
  • Request a Pix refundput
  • Error messages and codes - Pix
  • Pix transaction status list

PIX - NEW INTEGRATION

  • Updates on Pix fields
  • Create a Pix QR Code
  • Remove a Pix QR Code
  • Get details on a Pix transaction
  • Request a Pix refund

boleto

  • Create a boleto paymentpost
  • Boleto transaction status list

voucher

  • Create voucher paymentpost

e-wallets

  • Create an e-wallet payment using an encrypted cardpost
  • Create an e-wallet payment using a decrypted card
  • E-wallet transaction status list

Multi-benefit card

  • Multi-benefit card
    • Create payment with multi-benefit cardpost

qrcode

  • Generating a QR Code via APIpost

click-to-pay

  • Create a payment with Click to Paypost

carnê

  • Create carnê transactionpost

Get payment details

  • Get payment details by PaymentIdget
  • Get payment details by TIdget
  • Get payment details by MerchantOrderIdget
  • Get recurrent payment detailsget

Conversor de moedas e-commerce

  • Create payment with currency conversionpost
  • Confirm the currency conversionput
  • Currencies available for conversion

card tokenization

  • Create card token before authorizationpost
  • Create payment using a card tokenpost
  • Create a card token during authorization
  • Create payment with network token via external integration

recurrence

  • Create recurring payments
  • Create a recurrent paymentpost
  • Create a scheduled recurrence
  • Create recurring payment with tokenized card
  • Create a merchant recurrence
  • Schedule value adjustment in the scheduled recurrence
    • Schedule value adjustment in the scheduled recurrencepost
    • Modify value adjustment of a scheduled recurrenceput
    • Delete value adjustment of scheduled recurrencedel
  • Modify recurrent payment data
    • Modify shopper's dataput
    • Modify recurrent payment dataput
    • Modify recurrent payment amountput
    • Modify recurrent payment dayput
    • Modify next recurrent payment dateput
    • Modify recurrent payment intervalput
    • Modify recurrent payment end dateput
  • Deactivate recurrent paymentput
  • Reactivate recurrent paymentput

payment with fraud analysis clearsale

  • Implementing ClearSale fraud analysispost

payment with fraud analysis cybersource

  • Implementing Cybersource fraud analysispost

NOTIFICATION POST

  • Webhook

Payment facilitators: SDWO, subacquirers and marketplaces

  • Subacquirers and marketplaces
  • SDWO
    • SDWO for fund transfer arrangement
    • Me2Me - transfer to the same holder
    • P2P - transfer to another holder
    • Transfer to another arrangement
    • Unidentified boleto
    • Identified boleto
    • Toll
  • MCC performance program for individual registrations

SPECIFIC IMPLEMENTATIONS

  • Quasi Cash

Antifraude status list

Updated 7 days ago


Capture return codes
Recurrence status list
Did this page help you?

Updated 7 days ago


Capture return codes
Recurrence status list
Did this page help you?
Trabalhe conosco
Portal de Desenvolvedores
ICVA e Release
Blog
Central de Ajuda

CNPJ: 01.027. 058/0001-91 • Endereço da sede: Alameda Xingu, 512 – 21º ao 25º andar – Alphaville – SP – CEP: 06455-030

Copyright © 2026 Cielo S.A. – Instituição de Pagamento. Todos os direitos reservados.

CNPJ: 01.027. 058/0001-91 • Endereço da sede: Alameda Xingu, 512 – 21º ao 25º andar – Alphaville – SP – CEP: 06455-030

Nos acompanhe: