Void a credit transaction via MerchantOrderId

put

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

Cancel the total or partial amount of a credit transaction by providing the MerchantOrderId.

Path Params

PaymentId

string

required

Payment ID number. Size: 36.

Query Params

Amount

int32

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

Body Params

Reason

string

required

Indicates that the transaction was voided due to a fraud risk identified by the merchant. Possible value: "HighRisk". Size: 8.
Required if the transaction is voided because there is a fraud risk.
Valid for full or partial void.
Warning: This parameter will be available as of 04/17/2026.

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.

Content-type

string

Defaults to application/json

application/json

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200