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":"1736361959796",
   "MerchantVoidDate":"2025-01-08T18:45:59.796Z",
   "VoidAmount":500,
   "Card":{
      "InputMode":"ContactlessEmv",
      "EmvData":"9F02060000000001009F1A020076950500000000005F2A0209869A03210315820258005F340100",
      "TrackTwoData":"B1F9FFC37C7151EAE7C236AEDE4FA9043C3ED093E46A3152",
      "EncryptedCardData":{
         "EncryptionType":"Dukpt3DesCBC",
         "InitializationVector":"0000000000000000",
         "TrackTwoDataKSN":"FFFFF99995C18C800066"
      }
   }
}

Propriedade	Tipo	Tamanho	Obrigatório	Descrição
MerchantVoidId	String	—	Sim	Número do documento gerado automáticamente pelo terminal e incrementado de 1 acada transação realizada no terminal
MerchantVoidDate	String	—	Sim	Data do cancelamento.
VoidAmount	Integer(int64)	—	Sim	O atributo VoidAmount permite enviar cancelamentos parciais, quantos desejar para uma única transação, considerando o valor total da transação de pagamento
Card.InputMode	String	—	Sim	Enum: “Typed”, “MagStripe”, “Emv”, “ContactlessMagStripe”, “ContactlessEmv”
Card.TrackOneData	String	—	—	Dados da trilha 1 Obtidos através do comando PP_GetCard na BC no momento da captura da transação
Card.TrackTwoData	String	—	—	Dados da trilha 2 Obtidos através do comando PP_GetCard na BC no momento da captura da transação
Card.EmvData	String	—	—	Dados de cancelamento EMV
Card.AuthenticationMethod	String	—	Sim	Enum: “NoPassword”, , “OnlineAuthentication”, “OfflineAuthentication” Método de autenticação 1 - Sem senha = “NoPassword”; 2 - Senha online = “Online Authentication”; 3 - Senha off-line = “Offline Authentication”.
PinBlock.EncryptedPinBlock	String	—	Sim	PINBlock Criptografado - Para transações EMV, esse campo é obtido através do retorno da função PP_GoOnChip(), mais especificamente das posições 007 até a posição 022; - Para transações digitadas e com tarja magnética, verificar as posições 001 até 016 do retorno da função PP_GetPin().
Card.EncryptedCardData.EncryptionType	String	—	Sim	Tipo de encriptação utilizada Enum: “DukptDes” = 1, “MasterKey” = 2 “Dukpt3Des” = 3, “Dukpt3DesCBC” = 4
PinBlock.EmvData	String	—	Sim	Identificação do KSN - Para transações EMV esse campo é obtido através do retorno da função PP_GoOnChip() nas posições 023 até 042; Para transações digitadas e com tarja magnética, verificar as posições 017 até 036 do retorno da função PP_GetPin().

Resposta

{
   "VoidId":"8829e8de-18b3-4de3-ad28-c06e742a9f5a",
   "CancellationStatus":1,
   "InitializationVersion":1730810434149,
   "PrintMessage":[
      
   ],
   "Receipt":{
      "MerchantName":"TESTE API",
      "MerchantAddress":"Alameda Xingu, 512",
      "MerchantCity":"BARUERI",
      "MerchantState":"SP",
      "MerchantCode":"0023137868169300",
      "Terminal":"41786816",
      "Nsu":"864798",
      "Date":"08/01/25",
      "Hour":"18:53",
      "IssuerName":"CIELO#ELO CREDITO",
      "CardNumber":"************5488",
      "Brand":"ELO",
      "TransactionType":"CANCELAMENTO DE TRANSACAO",
      "AuthorizationCode":"854300",
      "TransactionMode":"ONL",
      "InputMethod":"L",
      "CpfCnpj":"73096766000195",
      "CancelValue":"5,00",
      "OriginalTransactonData":"DADOS DO PAGAMENTO ORIGINAL",
      "OriginalTransactonType":"VENDA A CREDITO",
      "OriginalTransactonNsu":"864797",
      "OriginalTransactonAuthCode":"854300",
      "OriginalTransactionDate":"08/01/25",
      "OriginalTransactionHour":"18:53",
      "OriginalTransactionValue":"13,00",
      "OriginalTransactionMode":"ONL",
      "OriginalInputMethod":"L"
   },
   "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/7901c768-dda3-4d4e-a2f4-0c40892c6b3d"
      },
      {
         "Method":"GET",
         "Rel":"self",
         "Href":"https://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/7901c768-dda3-4d4e-a2f4-0c40892c6b3d/voids/8829e8de-18b3-4de3-ad28-c06e742a9f5a"
      },
      {
         "Method":"DELETE",
         "Rel":"reverse",
         "Href":"https://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/7901c768-dda3-4d4e-a2f4-0c40892c6b3d/voids/8829e8de-18b3-4de3-ad28-c06e742a9f5a"
      }
   ]
}

Propriedade	Tipo	Tamanho	Obrigatório	Descrição
VoidId	String - uuid	—	—	Identificador do cancelamento
InitializationVersion	Integer int16	—	—	Número de versão dos parametros baixados na inicialização do equipamento.
PrintMessage.Position	String	—	—	Default: “Top” Enum: “Top”, “Middle”, “Bottom” 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	—	—	Indica a mensagem que deve ser impressa no comprovante de acordo com a posição indicada no campo Position
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 transação da Adquirência.
ReturnMessage	String	—	—	Mensagem de erro/resposta da transação 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	Codigo de identificação da loja
Payment.Receipt.Terminal	String	8	Sim	Identificação do Terminal
Payment.Receipt.Nsu	String	6	Sim	Numero de identificação da transação Cielo
Payment.Receipt.Date	String	dd/MM/yy	Sim	Data da transação
Payment.Receipt.Hour	String	HH:mm	Sim	Horario 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 do cartão
Payment.Receipt.TransactionType	String	255	Sim	Tipo de transação
Payment.Receipt.AuthorizationCode	String	6	Sim	Código da autorização
Payment.Receipt.TransactionMode	String	3	Sim	Modo da transação
Payment.Receipt.InputMethod	String	1	Sim	Metodo 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 a ser utilizado na operação.
Links.Rel	String	—	—	Enum: “self”, “cancel”, “confirm”. Referência da operação.
Links.Href	String	—	—	Endereço de URL de chamada da API