Solicitar uma devolução Pix

put

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

Solicita a devolução de uma transação Pix.

Ambiente	Método	Endpoint
Sandbox	put	`https://apisandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/void?amount={Amount}`
Produção	put	`https://api.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/void?amount={Amount}`

Para solicitar uma devolução Pix, é necessário que a loja tenha a conta do tipo transferência programada.

ℹ️
Confira as regras para solicitação da devolução Pix.

Path Params

PaymentId

string

required

Número de identificação do pagamento, retornado pela API na criação do QR Code Pix. Tamanho: 36.

Query Params

Amount

string

Valor a ser cancelado/estornado, em centavos. Verifique se a adquirente contratada suporta a operação de cancelamento ou estorno. Tamanho: 15.

Headers

MerchantId

string

required

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

Identificador da loja na API. Tamanho: 36.
Esta documentação traz um MerchantId padrão para permitir os testes em sandbox, mas você também pode informar o MerchantId habilitado durante o processo de implantação.

MerchantKey

string

required

Defaults to XKGHUBSBKIRXKAVPSKWLVXYCLVJUGTNZLIHPUSYV

Chave pública para autenticação dupla na API. Tamanho: 40.
Esta documentação traz um MerchantKey padrão para permitir os testes em sandbox, mas você também pode informar o MerchantKey habilitado durante o processo de implantação.

RequestId

string

Identificador do request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT. Tamanho: 36.

Response

Confira as regras para solicitação da devolução Pix.

200200