get https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales?merchantOrderId=
Query a transaction by providing the MerchantOrderId.
| Environment | Method | Endpoint |
|---|---|---|
| Sandbox | get | https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales?merchantOrderId={merchantOrderId} |
| Production | get | https://apiquery.cieloecommerce.cielo.com.br/1/sales?merchantOrderId={merchantOrderId} |
Response to query by MerchantOrderId
The table below presents the main parameters that can be returned by the API when querying a transaction by MerchantOrderId.
| Property | Description | Type | Length |
|---|---|---|---|
ReasonCode | Code indicating success or error in the requested operation flow. | string | 32 |
ReasonMessage | Message indicating success or error in the requested operation flow. | string | 512 |
PaymentId | Payment identification number, required for operations such as query, capture, and cancellation. | string | 36 |
ReceivedDate | Date when the transaction was received. | string | 19 |
Only transactions within the last three months can be queried via API.