Cancelar coleta de entrada

Enquanto uma solicitação de entrada está em andamento, você pode cancelá-la da mesma forma que pode cancelar um pagamento em andamento. Você também pode:

• Faça um AbortRequest de sua caixa registradora.
• Pressione a tecla Cancel o teclado do terminal.

Cancelar na caixa registradora

Para cancelar uma InputRequest da sua caixa registradora:

1. Faça uma solicitação POST para um endpoint da API de Terminais, especificando:

   • MessageHeader: the standard SaleToPOIRequest.MessageHeader object. Specify:

     Parameter	Required	Description
     ProtocolVersion		3.0
     MessageClass		Service
     MessageCategory		Abort
     MessageType		Request
     ServiceID		Your unique ID for this request, consisting of 1-10 alphanumeric characters. Must be unique within the last 48 hours for the terminal (POIID) being used.
     SaleID		Your unique ID for the POS system component to send this request from.
     POIID		The unique ID of the terminal to send this request to. Format: [device model]-[serial number].

   • AbortRequest: corpo da solicitação com:

     Parâmetro	Requerimentos	Descrição
     AbortReason		MerchantAbort
     MessageReference		Um objeto com: MessageCategory: Input SaleID: Seu ID exclusivo da caixa registradora que fez a solicitação de entrada. ServiceID: O ServiceID da solicitação de entrada sendo cancelada.

   Para obter mais detalhes, consulte a referência da API AbortRequest.

   O exemplo abaixo mostra como você faria uma solicitação para cancelar uma solicitação de entrada em andamento com um ServiceID de 21796.

   AbortRequest para cancelar um InputRequest

   Expand view

   Copy link to code block

   Copy code

   Copy code

   {
      "SaleToPOIRequest":{
         "MessageHeader":{
            "ProtocolVersion":"3.0",
            "MessageClass":"Service",
            "MessageCategory":"Abort",
            "MessageType":"Request",
            "SaleID":"POSSystemID12345",
            "ServiceID":"29239",
            "POIID":"V400m-324688179"
         },
         "AbortRequest":{
            "AbortReason":"MerchantAbort",
            "MessageReference":{
               "MessageCategory":"Input",
               "SaleID":"POSSystemID12345",
               "ServiceID":"21796"
            }
         }
      }
   }

   Uma AbortRequest bem-sucedida etorna uma resposta com um 200 OK código de status HTTP e sem corpo.

2. Verifique se o cancelamento foi bem-sucedido:

   • A tela gerada pelo seu InputRequest desaparece da tela do terminal.
   • O InputRequest retorna uma resposta contendo:
     • Result: Failure
     • ErrorCondition: Aborted

   O exemplo a seguir mostra a resposta para uma solicitação de entrada de confirmação que foi cancelada.

   InputResponse após cancelar o InputRequest

   Expand view

   Copy link to code block

   Copy code

   Copy code

   {
       "SaleToPOIResponse": {
           "InputResponse": {
               "InputResult": {
                   "Device": "CustomerInput",
                   "InfoQualify": "Input",
                   "Response": {
                       "Result": "Failure",
                       "ErrorCondition": "Aborted"
                   },
                   "Input": {
                       "InputCommand": "GetConfirmation"
                   }
               },
               "OutputResult": {
                   "Device": "CustomerDisplay",
                   "InfoQualify": "Display",
                   "Response": {
                       "Result": "Success"
                   }
               }
           },
           "MessageHeader": {
               "ProtocolVersion": "3.0",
               "SaleID": "POSSystemID12345",
               "MessageClass": "Device",
               "MessageCategory": "Input",
               "ServiceID": "010",
               "POIID": "V400m-324688179",
               "MessageType": "Response"
           }
       }
   }

Cancelar do terminal

Para cancelar uma solicitação de entrada em andamento de um terminal:

• Pressione a tecla Cancel no teclado do terminal.

e tiver sucesso:

• A tela gerada pelo seu InputRequest desaparece da tela do terminal.

• O InputRequest retorna uma resposta. Dependendo do tipo de entrada, este InputResponse contém:

  Tipo de entrada	Result	ConfirmedFlag

  Tipo de entrada	Result	ConfirmedFlag
  Confirmation	Success	false
  Signature	Success	false

  Tipo de entrada	Result	ErrorCondition

  Tipo de entrada	Result	ErrorCondition
  Menu	Failure	Cancel
  Digit	Failure	Cancel
  Text	Failure	Cancel

Veja também