Consultar por PaymentId

Consulta uma transação informando o PaymentId

AmbienteMétodoEndpoint
Sandboxhttps://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}
Produçãohttps://apiquery.cieloecommerce.cielo.com.br/1/sales/{PaymentId}

ℹ️

Saiba mais sobre essa funcionalidade na documentação.


ℹ️

Apenas as transações dentro dos últimos três meses podem ser consultadas via API.

  • O PaymentId é o identificador retornado na criação da transação (de qualquer meio de pagamento);
  • A consulta por PaymentId irá retornar todas as informações da transação, como dados do comprador, dados de pagamento e outras informações que foram enviadas e/ou retornadas na criação do pagamento.

TLID Mastercard

O Transaction Link Identifier (TLID) é um identificador único gerado pela bandeira Mastercard durante uma transação, utilizado para estabelecer a continuidade entre transações relacionadas.

FaseDescrição
Fase 1O campo TransactionLinkId está disponível na resposta da validação de cartão por Zero Auth, criação de pagamento com cartão de crédito, criação de pagamento com cartão de débito e na consulta por PaymentId.
Fase 2Envio obrigatório do TransactionLinkId no request a partir de 23/10/2026 (MIT).

Saiba mais em Identificadores de bandeira.


Path Params
string
required

Número de identificação do pagamento, necessário para futuras operações como Consulta, Captura e Cancelamento. Tamanho: 36.

Headers
string
required
Defaults to 8937bd5b-9796-494d-9fe5-f76b3e4da633

Identificador da loja na Cielo. Tamanho: 36. Formato: GUID.
Esta documentação traz um MerchantId padrão para permitir os testes em sandbox, mas você também pode informar o MerchantId habilitado durante o processo de implantação.

string
required
Defaults to XKGHUBSBKIRXKAVPSKWLVXYCLVJUGTNZLIHPUSYV

Chave pública para autenticação dupla na Cielo. Tamanho: 40. Formato: GUID.
Esta documentação traz um MerchantKey padrão para permitir os testes em sandbox, mas você também pode informar o MerchantKey habilitado durante o processo de implantação.

string

Identificador do Request, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT. Tamanho: 36.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json