Cancelar transação de débito via PaymentId

put

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

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

Consulte os Códigos de retorno de cancelamento.

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

Path Params

PaymentId

string

required

Número de identificação do pagamento, necessário para operações como Consulta, Captura e Cancelamento. Tamanho: 36.

Query Params

Amount

int32

required

Valor a ser cancelado (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. 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 API Cielo E-commerce. Tamanho: 40.

RequestId

string

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

Response

Cancelamento parcial

200200