Cancelar transação de débito via MerchantOrderId

put

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

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

⚠️
Atenção
O cancelamento por MerchantOrderId afeta sempre a transação mais nova, ou seja, caso haja pedidos com o número do pedido duplicado, somente o pedido mais atual será cancelado. O pedido anterior não poderá ser cancelado por esse método.

ℹ️
Cancelamento parcial
Para cartão de débito, é possível fazer apenas um cancelamento parcial.

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.

Headers

MerchantId

string

required

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

Identificador da loja na API Cielo E-commerce. 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 Cielo E-commerce. 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

Atenção

Cancelamento parcial

200200