Cancelar transação de crédito via PaymentId

put

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

Cancela o valor total ou parcial de uma transação de crédito informando o PaymentId

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}`

⚠️
Não é possível estornar parcialmente uma transação não capturada.
Para fazer um cancelamento parcial, o campo Capture deve ser "true" na criação do pagamento com cartão de crédito.

ℹ️
Cancelamento parcial
Pode ocorrer inúmeras vezes, até que o valor total da transação seja cancelada.

⚠️
Novo campo obrigatório para cancelamento de transações por risco de fraude
A partir de 17/04/2026, será obrigatório informar o campo Reason quando o motivo do cancelamento for risco de fraude identificado pelo estabelecimento.
Informe Reason= "HighRisk" no corpo da requisição, conforme exemplo:
{
    "Reason": "HighRisk"
}

Path Params

PaymentId

string

required

Número de identificação do pagamento, retornado pela API na criação do pagamento de cartão de crédito. Tamanho: 36.

Query Params

Amount

int32

Valor do Pedido (ser enviado em centavos). Tamanho: 15.

Body Params

Reason

string

Indica que a transação foi cancelada por risco de fraude identificado pelo estabelecimento. Valor possível: "HighRisk". Tamanho: 8.
Obrigatório caso a transação seja cancelada porque há risco de fraude.
Válido para cancelamento total ou parcial.
ATENÇÃO: Este parâmetro estará funcional a partir de 17/04/2026.

Headers

MerchantId

string

required

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

Identificador da loja na Cielo. Tamanho: 36. Formato: GUID.
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 Cielo. Tamanho: 40. Formato: GUID.
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, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT. Tamanho: 36.

Response

Não é possível estornar parcialmente uma transação não capturada.

Cancelamento parcial

Novo campo obrigatório para cancelamento de transações por risco de fraude

200200