Cancelar transação de crédito via MerchantOrderId

put

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

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

Path Params

MerchantOrderId

string

required

Identificação do pedido, informada na criação da transação.
Atenção: Os caracteres permitidos são apenas a-z, A-Z, 0-9. Não são permitidos caracteres especiais e espaços em branco.
Tamanho: 50.

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

200200