Requisição

Ambiente	Método	Endpoint
Sandbox	POST	`https://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/{PaymentId}/voids/`
Homologação	POST	`https://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/{PaymentId}/voids/`
Produção	POST	`https://api.cieloecommerce.cielo.com.br/1/physicalSales/{PaymentId}/voids/`

Path Parameters

Propriedade	Tipo	Tamanho	Obrigatório	Descrição
PaymentId	String uuid	—	Sim	Código do Pagamento

{
   "MerchantVoidId":"123456789123456",
   "MerchantVoidDate":"2025-01-08T18:08:15.779Z",
   "Card":{
      "InputMode":"Typed",
      "ExpirationDate":"12/2021",
      "CardNumber":"EC9A221AC2E165A7",
      "EncryptedCardData":{
         "EncryptionType":"Dukpt3DesCBC",
         "InitializationVector":"0000000000000000",
         "CardNumberKSN":"FFFFF99995C1B4400004"
      }
   }
}

Propriedade	Tipo	Tamanho	Obrigatório	Descrição
MerchantVoidId	String	—	Sim	Número do documento gerado automaticamente pelo terminal e incrementado a cada transação realizada
MerchantVoidDate	String	—	Sim	Data do cancelamento
Card.InputMode	String	—	Sim	Enum: Typed, MagStripe, Emv, ContactlessMagStripe, ContactlessEmv
Card.CardNumber	String	—	Sim	Número do cartão. Requerido quando a transação for digitada
Card.EncryptedCardData.EncryptionType	String	—	Sim	Tipo de encriptação utilizada: DukptDes (1), MasterKey (2), Dukpt3Des (3)
Card.EncryptedCardData.CardNumberKSN	String	—	—	Identificador KSN da criptografia do número do cartão
Card.EncryptedCardData.IsDataInTLVFormat	Bool	—	Não	Indica se os dados criptografados estão no formato TLV
Card.EncryptedCardData.InitializationVector	String	—	Sim	Vetor de inicialização da criptografia
Card.ExpirationDate	String	—	Sim	Data de expiração do cartão

Resposta

{
   "VoidId":"a23dbd82-1ff5-4a23-8573-27f4998b6460",
   "CancellationStatus":1,
   "InitializationVersion":1730810434149,
   "PrintMessage":[
      
   ],
   "Receipt":{
      "MerchantName":"TESTE API",
      "MerchantAddress":"Alameda Xingu, 512",
      "MerchantCity":"BARUERI",
      "MerchantState":"SP",
      "MerchantCode":"0023137868169300",
      "Terminal":"41786816",
      "Nsu":"864402",
      "Date":"08/01/25",
      "Hour":"15:21",
      "IssuerName":"CIELO#VISA CREDITO",
      "CardNumber":"476173-0010",
      "Brand":"VISA",
      "TransactionType":"CANCELAMENTO DE TRANSACAO",
      "AuthorizationCode":"609934",
      "TransactionMode":"ONL",
      "InputMethod":"X",
      "CpfCnpj":"73096766000195",
      "CancelValue":"1,00",
      "OriginalTransactonData":"DADOS DO PAGAMENTO ORIGINAL",
      "OriginalTransactonType":"VENDA A CREDITO",
      "OriginalTransactonNsu":"864375",
      "OriginalTransactonAuthCode":"609934",
      "OriginalTransactionDate":"08/01/25",
      "OriginalTransactionHour":"15:20",
      "OriginalTransactionValue":"1,00",
      "OriginalTransactionMode":"ONL",
      "OriginalInputMethod":"X"
   },
   "ConfirmationStatus":1,
   "Status":10,
   "PhysicalTransactionStatus":10,
   "ReasonCode":0,
   "ReasonMessage":"Successful",
   "ReturnCode":"000",
   "ReturnMessage":">CANCELAMENTO OK",
   "Links":[
      {
         "Method":"GET",
         "Rel":"self",
         "Href":"https://apiquerysandbox.cieloecommerce.cielo.com.br/1/physicalSales/afbcb354-9471-4982-b21b-e6d4a52d9c8f"
      },
      {
         "Method":"GET",
         "Rel":"self",
         "Href":"https://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/afbcb354-9471-4982-b21b-e6d4a52d9c8f/voids/a23dbd82-1ff5-4a23-8573-27f4998b6460"
      },
      {
         "Method":"DELETE",
         "Rel":"reverse",
         "Href":"https://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/afbcb354-9471-4982-b21b-e6d4a52d9c8f/voids/a23dbd82-1ff5-4a23-8573-27f4998b6460"
      }
   ]
}

Propriedade	Tipo	Tamanho	Obrigatório	Descrição
VoidId	String - uuid	—	—	Identificador do cancelamento
InitializationVersion	Integer (int16)	—	—	Número de versão dos parâmetros baixados na inicialização do equipamento
PrintMessage.Position	String	—	—	Default: Top. Enum: Top, Middle, Bottom. Define a posição da mensagem no comprovante. Top - Início do comprovante, antes do código do estabelecimento Middle - Meio do comprovante, após a descrição dos valores Bottom - Final do comprovante
PrintMessage.Message	String	—	—	Mensagem a ser impressa no comprovante conforme a posição
Status	Integer (int16)	—	—	Status da transação: 0 = Não Finalizado; 1 = Autorizado; 2 = Pago; 3 = Negado; 10 = Cancelado; 13 = Abortado
CancellationStatus	Integer (int16)	—	—	Status do cancelamento: 0 = Não Finalizado; 1 = Autorizado; 2 = Negado; 3 = Confirmado; 4 = Desfeito
ReasonCode	Integer (int16)	—	—	Código de referência para análises
ReasonMessage	String	—	—	Mensagem explicativa para análise
ReturnCode	String	—	—	Código de erro/resposta da adquirência
ReturnMessage	String	—	—	Mensagem de erro/resposta da adquirência
Payment.Receipt.MerchantName	String	255	Sim	Nome da loja
Payment.Receipt.MerchantAddress	String	255	Sim	Endereço da loja
Payment.Receipt.MerchantCity	String	255	Sim	Cidade da loja
Payment.Receipt.MerchantState	String	2	Sim	Estado da loja
Payment.Receipt.MerchantCode	String	16	Sim	Código da loja
Payment.Receipt.Terminal	String	8	Sim	Identificação do terminal
Payment.Receipt.Nsu	String	6	Sim	Número da transação Cielo
Payment.Receipt.Date	String	dd/MM/yy	Sim	Data da transação
Payment.Receipt.Hour	String	HH:mm	Sim	Hora da transação
Payment.Receipt.IssuerName	String	255	Sim	Nome do emissor obtido através do campo IssuerId no objeto BinEntry.
Payment.Receipt.CardHolder	String	255	Não	Nome do titular do cartão
Payment.Receipt.CardNumber	String	19	Sim	Número do cartão
Payment.Receipt.Brand	String	255	Sim	Bandeira
Payment.Receipt.TransactionType	String	255	Sim	Tipo de transação
Payment.Receipt.AuthorizationCode	String	6	Sim	Código de autorização
Payment.Receipt.TransactionMode	String	3	Sim	Modo da transação
Payment.Receipt.InputMethod	String	1	Sim	Método de entrada
Payment.Receipt.CancelValue	—	—	—	—
Payment.Receipt.OriginalTransactonData	—	—	—	—
Payment.Receipt.OriginalTransactonType	—	—	—	—
Payment.Receipt.OriginalTransactonNsu	—	—	—	—
Payment.Receipt.OriginalTransactonAuthCode	—	—	—	—
Payment.Receipt.OriginalTransactionDate	—	—	—	—
Payment.Receipt.OriginalTransactionHour	—	—	—	—
Payment.Receipt.OrignalTransactionValue	—	—	—	—
Payment.Receipt.OrignalTransactionCardHolder	—	—	—	—
Payment.Receipt.OriginalTransactionMode	—	—	—	—
Payment.Receipt.OriginalInputMethod	—	—	—	—
Links.Method	String	—	—	Enum: POST, GET, PUT. Método HTTP da operação
Links.Rel	String	—	—	Enum: self, cancel, confirm
Links.Href	String	—	—	Endereço de URL de chamada da API