Request a Pix refund

put

https://apisandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/void?amount=xxx

Request a refund for a Pix transaction

Path Params

PaymentId

string

required

Payment ID number. Size: 36.

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

Language

Response

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

application/json

200200