Consultar por MerchantOrderId

get

https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales

Consulta uma transação informando o MerchantOrderId

Ambiente	Método	Endpoint
Sandbox	get	`https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales?merchantOrderId={merchantOrderId}`
Produção	get	`https://apiquery.cieloecommerce.cielo.com.br/1/sales?merchantOrderId={merchantOrderId}`

ℹ️

Saiba mais sobre essa funcionalidade na documentação.

ℹ️

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

O MerchantOrderId é a identificação do pedido determinada pela loja na criação da transação (para qualquer meio de pagamento);
A consulta por MerchantOrderId irá retornar o PaymentId da transação.

Resposta da consulta pelo MerchantOrderId

A tabela a seguir apresenta os principais parâmetros que podem ser retornados pela API na consulta de transação pelo MerchantOrderId.

Propriedade	Descrição	Tipo	Tamanho
`ReasonCode`	Código que indica sucesso ou erro no fluxo da operação solicitada.	string	32
`ReasonMessage`	Mensagem que indica sucesso ou erro no fluxo da operação solicitada.	string	512
`PaymentId`	Número de identificação do pagamento, necessário para operações como Consulta, Captura e Cancelamento.	string	36
`ReceivedDate`	Data em que a transação foi recebida.	string	19

Query Params

MerchantOrderId

string

Defaults to Loja123456

Número de identificação do pedido. Atenção: Os caracteres permitidos são apenas a-z, A-Z, 0-9. Não são permitidos caracteres especiais e espaços em branco. Tamanho: 36.

Headers

MerchantId

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.

MerchantKey

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.

RequestId

string

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

Response

Saiba mais sobre essa funcionalidade na documentação.

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

Resposta da consulta pelo MerchantOrderId

200200