For AI agents: visit https://docs.cielo.com.br/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

EXPLORE A API E-COMMERCE CIELO

  • Como usar a Referência da API

ARQUITETURA DA INTEGRAÇÃO

  • Ambientes e arquitetura da API
  • Lista de recursos
  • Autenticação e credenciais
    • Revogar e criar credenciais no site Cielo
    • Obter as credenciais 3DS
    • Obter credenciais do Silent Order Post

CÓDIGOS DA API E-COMMERCE

  • Códigos retornados pela API E‑commerce (HTTP, status e códigos de negócio)
    • Códigos HTTP
    • Status da transação
    • Códigos de retorno de negócio da API (Return, Provider e Reason)
    • Erros técnicos da API (Code e Message)
    • Códigos ABECS
    • Programa de Retentativa das Bandeiras
    • Códigos de retorno e status específicos
      • Códigos de retorno de cancelamento
      • Lista de status do Antifraude
      • Lista de status da recorrência de cartão de crédito

Testando a API em Sandbox

  • Como testar a API em sandbox
    • Zero Auth em sandbox
    • Consulta BIN em sandbox
    • Cartão de crédito em sandbox
    • Cartão de débito em sandbox
    • Outros meios de pagamento em sandbox
    • Renova Fácil em sandbox
  • Postman
    • Download e cadastro
    • Explicando Componentes do Postman
    • Ambientes e coleções
    • Collections e Environments Cielo
    • Realizando uma requisição

Zero Auth

  • Validar cartão com o Zero Authpost
  • Validar cartão tokenizado com Cartão Protegido
  • Validar cartão de e-walletpost

Consulta BIN

  • Consultar BIN do cartãoget

velocity

  • Prevenir fraudes com o Velocity

Cartão de crédito

  • Criar pagamento com cartão de créditopost
    • Visa Intelligent Data Exchange (IDX)
  • Capturar transação de crédito após a autorizaçãoput
  • Cancelar transação de crédito via PaymentIdput
  • Cancelar transação de crédito via MerchantOrderIdput
  • Card on file
    • Primeiro uso do cartão armazenado
    • Cartão já armazenado
      • Recorrência
      • Recorrência não agendada
      • Parcelamento de recorrência
  • Indicador de início da transação - CIT e MIT
  • Lista de status da transação para cartão de crédito

Cartão de débito

  • Criar pagamento com cartão de débitopost
  • Cancelar transação de débito via PaymentIdput
  • Cancelar transação de débito via MerchantOrderIdput
  • Card on file
    • Primeiro uso do cartão armazenado
  • Indicador de início da transação - CIT e MIT
  • Lista de status da transação para cartão de débito

Pix

  • Criar pagamento com QRCode Pixpost
  • Solicitar uma devolução Pixput
  • Códigos e mensagens de erro Pix
  • Lista de status da transação Pix

PIX - NOVA INTEGRAÇÃO

  • Atualizações nos campos Pix
  • Criar pagamento com QR Code Pix
  • Remover um QR Code Pix
  • Consultar transação de Pix
  • Solicitar devolução de transação Pix

Boleto

  • Criar pagamento com boletopost
  • Lista de status da transação boleto

Voucher

  • Criar pagamento com voucherpost

Cartão multibenefícios

  • Cartão multibenefícios
    • Criar pagamento com cartão multibenefíciospost

Click to Pay

  • Criar pagamento com Click to Paypost

E-wallets

  • Criar pagamento com e-wallet com cartão criptografadopost
  • Criar pagamento com e-wallet com cartão descriptografado
  • Lista de status da transação e-wallets

QRCode

  • Gerar um QR Code via APIpost

Carnê

  • Criar transação de carnêpost

Consultas

  • Consultar por PaymentIdget
  • Consultar por Tidget
  • Consultar por MerchantOrderIdget
  • Consultar recorrênciaget

Conversor de moedas e-commerce

  • Criar pagamento com conversão de moedapost
  • Confirmar a conversão de moedaput
  • Moedas disponíveis para conversão

Tokenização de cartões

  • Criar cartão tokenizado antes da autorizaçãopost
  • Criar pagamento com cartão tokenizadopost
  • Criar cartão tokenizado durante a autorização
  • Criar pagamento com token da bandeira via integração externa

Recorrência

  • Criando pagamentos recorrentes
  • Criar pagamento recorrentepost
  • Agendar recorrência programada
  • Criar pagamento recorrente com cartão tokenizado
  • Criar recorrência própria
  • Alterar dados da recorrência
    • Alterar dados do compradorput
    • Alterar dados do pagamento da recorrênciaput
    • Alterar valor da recorrênciaput
    • Agendar atualização de valor na recorrência programada
      • Agendar atualização de valor na recorrência programadapost
      • Alterar atualização de valor de uma recorrência programadaput
      • Cancelar atualização de valor de recorrência programadadel
    • Alterar dia da recorrênciaput
    • Alterar data do próximo pagamentoput
    • Alterar intervalo da recorrênciaput
    • Alterar data final da recorrênciaput
  • Desativar recorrênciaput
  • Reativar recorrênciaput

Pagamentos com Análise de Fraude - ClearSale

  • Criar pagamento com análise de fraude ClearSalepost
  • Lista de status do Antifraude

Pagamentos com Análise de Fraude - CyberSource

  • Criar pagamento com análise fraude Cybersourcepost
  • Lista de status do Antifraude

Facilitadores de pagamento: SDWO, subcredenciadores e marketplaces

  • Subcredenciadores e marketplaces
  • SDWO
    • SDWO de arranjo de transferência de fundos
      • Transferência para o mesmo portador (Me2Me)
      • Transferência para outro portador (P2P)
      • Transferência para outro arranjo
      • Pagamento de conta identificada
      • Pagamento de conta não identificada
      • Transferência para carteira de pedágio
  • Programa de performance de MCC cadastros de pessoa física

Implementações específicas

  • Quasi Cash

Agendar recorrência programada

Updated 6 months ago


Criar pagamento recorrente
Criar pagamento recorrente com cartão tokenizado
Did this page help you?

Updated 6 months ago


Criar pagamento recorrente
Criar pagamento recorrente com cartão tokenizado
Did this page help you?
    • Requisição
    • Resposta
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: