Fluxo da API Checkout Cielo

ℹ️

Vá para a Referência da API para acessar os exemplos completos de requisição e resposta.

Na API do Checkout Cielo, a loja envia uma requisição de criação da tela de checkout e a API retorna uma URL para acesso à página de pagamento, chamada CheckoutUrl. Confira mais detalhes sobre o funcionamento da API no fluxo a seguir:


  1. A pessoa titular do cartão (comprador) escolhe os produtos na loja integrada ao Checkout Cielo e clica em Comprar;
  2. A loja envia a requisição de criação da página de pagamento para a API Checkout Cielo;
  3. A API Checkout Cielo retorna o CheckoutUrl, que é a URL da página de pagamento montada com base nos dados enviados pela loja (como dados do comprador, dos produtos, da entrega e outros);
  4. A loja redireciona o comprador para a URL retornada pela Cielo (página de pagamento). A tela apresentada é parte do ambiente de pagamento seguro Cielo;
  5. O comprador escolhe o meio de pagamento, tipo de frete e endereço de entrega na página de pagamento;
  6. O Checkout Cielo redireciona o cliente para a URL de Retorno escolhida pela loja (caso a loja tenha configurado uma URL de Retorno no site Cielo);
  7. A loja será notificada sobre a situação da transação (caso a loja tenha configurado uma URL de notificação no site Cielo);
  8. A loja processa o pedido de compra utilizando os dados da notificação e, se a transação estiver autorizada, libera o pedido.

ℹ️

O portador do cartão recebe um e-mail na finalização do pedido. Caso deseje desativar, confira o tópico Configure o e-mail de finalização ao comprador.

⚠️

O Checkout Cielo notifica a loja quando há alguma alteração no status do pagamento. Para receber notificações, é necessário configurar ao menos um tipo de URL de notificação nas Configurações da Loja.