Request a Pix refund

put

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

Request a refund for a Pix transaction

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

In order to request a Pix refund, the merchant's Cielo digital account must be scheduled transfer type.

📘
Check the rules for requesting a Pix refund.

Path Params

PaymentId

string

required

Payment ID number. Size: 36.

Query Params

Amount

int32

required

Amount to be cancelled/refunded in cents. Check if the acquirer supports cancellations or refunds. Size: 15.

Headers

MerchantId

string

required

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

Store identifier in 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 at 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

Check the rules for requesting a Pix refund.

200200