Get payment details by MerchantOrderId

get

https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales?merchantOrderId={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.

Path Params

MerchantOrderId

string

required

Order identification number. Warning: Allowed characters are a-z, A-Z, 0-9. Special characters and blank spaces are not allowed. Size: 36.

Headers

MerchantId

string

required

Defaults to 8937bd5b-9796-494d-9fe5-f76b3e4da633

Store identifier in API E-commerce Cielo. Size: 36. This documentation provides a default MerchantId to allow testing in the sandbox, but you can also provide the enabled MerchantId during the deployment process.

MerchantKey

string

required

Defaults to XKGHUBSBKIRXKAVPSKWLVXYCLVJUGTNZLIHPUSYV

Public Key for Double Authentication in API E-commerce Cielo. Size: 40. This documentation provides a default MerchantKey to allow testing in the sandbox, but you can also provide the enabled MerchantKey during the deployment process.

RequestId

string

Request Identifier, used when the merchant uses different servers for each GET/POST/PUT

Response

Response to query by MerchantOrderId

Only transactions within the last three months can be queried via API.

200