Status e códigos APIs

Status da transação (payment_status)

Sobre os status de pagamento

  • O que é: payment_status é o campo que indica o estado atual de uma transação no Link de Pagamento Cielo e no Checkout Cielo.
  • Onde aparece:
    • Nas notificações de mudança de status (via POST e via JSON), como campo payment_status com valor numérico inteiro.
    • No conteúdo das notificações de finalização da transação.
    • Nas consultas de transação (GET por checkout_cielo_order_number ou por Id do link de pagamento), retorna como texto em inglês no campo payment.status.
  • O que representa: representa a etapa do ciclo de vida de uma transação — desde o estado inicial (autorizado ou pendente) até os estados finais (pago, negado, cancelado, expirado).

Importante: O Link de Pagamento e o Checkout Cielo possuem status próprios, diferentes do site Cielo ou da API Cielo E-commerce.

Tabela de valores de status

Onde visualizar os status

O campo payment_status deve ser monitorado em dois cenários:

  1. Notificações: a Cielo envia uma notificação de mudança de status sempre que o payment_status de uma transação é alterado. Ao recebê-la, consulte os detalhes completos da transação usando o checkout_cielo_order_number.

    • Notificação via POST: payment_status retorna como número inteiro.
    • Notificação via JSON: a notificação contém a URL para consulta; faça um GET nessa URL para obter o payment_status e demais dados.
  2. Consultas diretas: nas respostas das consultas de transação (GET por checkout_cielo_order_number ou GET por Id do link de pagamento), o campo payment.status retorna como texto em inglês (ex: "Paid", "Denied").

O integrador deve implementar a lógica de atualização de pedidos no sistema da loja com base nas transições de status recebidas.

Interpretação dos valores de status

  • Sucesso / finalizado positivo

    • 2 — Pago (Paid): fluxo concluído com sucesso. Crédito confirmado.
  • Transitórios / pendentes — requerem acompanhamento

    • 1 — Pendente (Pending): aguardando ação do portador (boleto não pago, Pix não realizado, QR Code não escaneado).
    • 7 — Autorizado (Authorized): transação aprovada pelo emissor, aguardando captura pela loja (válida por até 15 dias).
    • 10 — Aguardando biometria facial (AuthorizedIdPayPending): autenticação pendente; aguardar transição para 2 - pago, 3 - negado ou 5 - cancelado.
  • Finais / encerramento negativo

    • 3 — Negado (Denied): transação recusada. Sem possibilidade de retomada.
    • 4 — Expirado (Expired): prazo de captura ou de pagamento expirado.
    • 5 — Cancelado (Voided): transação cancelada pela loja.
  • Erro / indeterminado

    • 6 — Não Finalizado (NotFinalized): falha no processamento. Acionar Suporte Cielo E-commerce.

Observações importantes

  • Em notificações (POST e JSON), payment_status retorna como número inteiro.
  • Em consultas de transação (GET), o campo payment.status retorna como texto em inglês (coluna Status (EN) da tabela acima), ex.: "Paid", "Authorized".
  • Para obter os detalhes completos ao receber uma notificação de mudança de status, use o checkout_cielo_order_number para fazer uma consulta GET.
  • A notificação de mudança de status pode levar até 3 minutos para ser enviada após a notificação de finalização da transação.