API Reference

Status of a Pin Entry Device

In this section you will learn how to request the status of a Pin Entry Device

Suggest Edits

Status of a Pin Entry Device Overview

A PIN Entry Device query enables a merchant to check the status of a PIN Entry Device before a transaction is invoked.

418

How to request the status of a Pin Entry Device

The merchant's system sends a QueryPedRequest message to ANYpay POS which interacts with the PIN Entry Device. Section QueryPedRequest Element describes the elements required to build an QueryPedRequest message. An example of a QueryPedRequest message can be seen below.

<?xml version="1.0" encoding="utf-16"?>
<QueryPedRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"                                    xmlns="http://servebase.com/2009/06/pedframework">
  <Reference>00a9a6c2-9481-499f-858f-bce155b3aca5</Reference>
  <PedEndpointAddress>
    <EndpointAddressType>Serial</EndpointAddressType>
    <SerialEndpointAddress>
      <ComPort>com4</ComPort>
    </SerialEndpointAddress>
  </PedEndpointAddress>
</QueryPedRequest>

Handling a QueryPedResponse message

Section QueryPedResponse Element describes the elements that are returned in an QueryPedResponse message.

📘

Key elements of a QueryPedResponse

Status Either a 'INUSE', 'NOTINUSE' or 'OFFLINE' will be returned dependent on the state of the PIN Entry Device

An example of a QueryPedResponse message for can be seen below.

<?xml version="1.0" encoding="utf-16"?>
<QueryPedResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"                                        xmlns="http://servebase.com/2009/06/pedframework">
  <Reference>00a9a6c2-9481-499f-858f-bce155b3aca5</Reference>
  <FaultResponseCode>0</FaultResponseCode>
  <Status>INUSE</Status>
</QueryPedResponse>

<?xml version="1.0" encoding="utf-16"?>
<QueryPedResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://servebase.com/2009/06/pedframework">
  <Reference>00a9a6c2-9481-499f-858f-bce155b3aca5</Reference>
  <FaultResponseCode>0</FaultResponseCode>
  <Status>NOTINUSE</Status>
</QueryPedResponse>

<?xml version="1.0" encoding="utf-16"?>
<QueryPedResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"                                        xmlns="http://servebase.com/2009/06/pedframework">
  <Reference>00a9a6c2-9481-499f-858f-bce155b3aca5</Reference>
  <FaultResponseCode>0</FaultResponseCode>
  <Status>OFFLINE</Status>
</QueryPedResponse>

Updated over 5 years ago