Void a debit transaction via MerchantOrderId

put

https://apisandbox.cieloecommerce.cielo.com.br/1/sales/OrderId/{MerchantOrderId}/void

Environment	Method	Endpoint
Sandbox	put	`https://apisandbox.cieloecommerce.cielo.com.br/1/sales/OrderId/{MerchantOrderId}/void?amount={Amount}`
Production	put	`https://api.cieloecommerce.cielo.com.br/1/sales/OrderId/{MerchantOrderId}/void?amount={Amount}`

⚠️
Warning
The cancellation by MerchantOrderId always affects the newest transaction. That is, if there are orders with duplicate order numbers, only the most recent order will be canceled. The previous order cannot be canceled by this method.

ℹ️
Partial cancellation
For debit cards, only one partial void is allowed.

Path Params

MerchantOrderId

string

required

MerchantOrderId

Query Params

Amount

int32

Order Amount (to be sent in cents). Size: 15.

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. Size: 36.

Response

Warning

Partial cancellation

200200