Cancel card acquisition

Outlines cancelling a request for shopper details if they are not required.


Card acquisition allows you to retrieve shopper details before creating a payment request. You may want to cancel this request if you do not require CardAcquisition, for example, if the retrieved cardData does not qualify for a transaction.

Endpoint

The URL used to send  Terminal API  messages depends on your type of implementation. For more information on the architectures available, see the Terminal API Overview .

EnableService Request

For a list of EnableServiceRequest fields, see EnableServiceRequest fields. The elements of the request are wrapped in a EnableServiceRequest envelope.

The SaleID and ServiceID in the MessageHeader should be unique. SaleID and ServiceID combinations are rejected if used recently, within 48 hours.

Pass the following fields when making a EnableServiceRequest call to the Terminal API.

CardAcquisitionRequest
 {
   "SaleToPOIRequest":{
      "MessageHeader":{
         "ProtocolVersion":"3.0",
         "MessageClass":"Service",
         "MessageCategory":"EnableService",
         "MessageType":"Request",
         "ServiceID":"$ServiceID",
         "SaleID":"$SaleID",
         "POIID":"$POIID"
      },
      "EnableServiceRequest":{
         "TransactionAction":"AbortTransaction",
         "DisplayOutput":{
            "Device":"CustomerDisplay",
            "InfoQualify":"Display",
            "OutputContent":{
               "PredefinedContent":{
                  "ReferenceID":"CustomAnimated"
               },
               "OutputFormat":"Text",
               "OutputText":[
                  {
                     "Text":"MESSAGE TITLE"
                  },
                  {
                     "Text":"MESSAGE BODY"
                  }
               ]
            }
         }
      }
   }
}

EnableService Response

For a list of EnableServiceResponse fields, see EnableServiceResponse fields.

The response contains information about the status of the request in the following fields:

CardAcquisitionResponse
{
   "SaleToPOIResponse":{
      "EnableServiceResponse":{
         "Response":{
            "Result":"Success"
         }
      },
      "MessageHeader":{
         "ProtocolVersion":"3.0",
         "SaleID":"Demo",
         "MessageClass":"Service",
         "MessageCategory":"EnableService",
         "ServiceID":"130822ec5",
         "POIID":"V400cPlus-401484835",
         "MessageType":"Response"
      }
   }
}