05 - Cancelamento

Objetivo

Informar o integrador que aquela operação de venda foi cancelada no PDV, para que a venda e os pagamentos realizados sejam devidamente cancelados e estornados pelo parceiro.

O parceiro deverá utilizar o ID da transação para verificar se foi realizado algum pagamento e cancelá-lo, caso o ID não for encontrado no banco de dados do parceiro o retorno deve ser apenas “ok”, conforme exemplo abaixo.

A aplicação de PDV não interromperá a operação de cancelamento, no caso de uma falha de comunicação entre a API e o Integrador, fica de responsabilidade do parceiro controlar os cancelamentos efetuados.

Request Example

{
 "Event": "cetBefore",
 "Execution": "cetContinue",
 "ID": "001212000628798",
 "Operation": "cotCancelSale",
 "ParkingTicket": null,
 "Pay": null,
 "Response": "",
 "Sale": null,
 "Version": 1
}

Response Example

{
 "version": 1,
 "sale": null,
 "pay": null,
 "return": {
    "code": 0,
    "messageText": "0"
  },
 "execution": "cetCompleted",
 "interpret": null,
 "vouchersPrint": [ ]
}

Exemplo Fluxo de Cancelamento

Início da venda no PDV, foi inserido um produto e teclado Enter. Após todos os produtos inserido, foi acionada a função para cancelar a venda.

Imagem 1 – Tela de Venda

Selecionado o motivo para cancelamento da venda.

Imagem 2 – Cancelamento da Venda

JSON enviado ao parceiro para informar o cancelamento

{
  "Event""cetBefore",
  "Execution""cetContinue",
  "ID""001600000591151",
  "Operation""cotCancelSale",
  "Version"1
}

Retorno do parceiro para o PDV

{
  "version"1,
  "execution""cetCompleted"
}