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
MerchantOrderIdirá retornar oPaymentIdda 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 |