Reset Card Reader
This method clears the current commands in the event queue of the card reader.
info_outline
note
This method requires a valid connected card reader.
ROAM readers do not support an on-demand card reader reset.
Code Samples
CWS
Request
Property | Description |
---|---|
method string | required | startResetOnCardReader |
requestId string | required | Transaction Request ID |
targetType string | required | cardReader |
Response
Property | Description |
---|---|
requestId string | Transaction Request ID As specified in the request. |
statusDetails string | Request Status |
data JSONObject | Object holding various responses. |
completed boolean | Request Result On-demand card reader reset result. Valid values: - true - false |
Example
Request
{
"method" : "startResetOnCardReader",
"requestId" : "569998777",
"targetType" : "cardReader",
"version" : "1.0",
"parameters" : { }
}
Later…
{
"method" : "getCommandStatusOnCardReader",
"requestId" : "569998778",
"targetType" : "cardReader",
"version" : "1.0",
"parameters" : {
"id" : "569998777"
}
}
Response
{
"requestId" : "569998777",
"statusDetails" : "REQUEST_ACCEPTED",
"data" : {
"cardReaderCommand" : {
"eventQueue" : [ ],
"id" : "569998777",
"completed" : false
}
}
}
...
{
"requestId" : "569998778",
"statusDetails" : "REQUEST_ACCEPTED",
"data" : {
"cardReaderCommand" : {
"eventQueue" : [ {
"timeStamp" : "1468248272018",
"statusDetails" : "PIN_PAD_RESETTING"
}, {
"timeStamp" : "1468248272064",
"statusDetails" : "PIN_PAD_RESET_COMPLETED"
} ],
"id" : "569998777",
"completed" : true
}
}
}
Java
The ECLCardReaderInterface
method reset will return the card reader to the welcome screen.
// current instance of ECLCardReaderInterface
// may be retrieved through account.getCardReaders().getSelectedDevice();
ECLCardReaderInterface myReader;
myReader.reset();
Objective-C
The ECLCardReaderProtocol
method reset will return the card reader to the welcome screen, cancelling any currently running transaction or on-demand function.
// current instance of ECLCardReaderProtocol
// may be retrieved through [[account cardReaders] selectedDevice];
id<ECLCardReaderProtocol> cardReader;
[cardReader reset];
C#
m_CWS.StartReset(MyNotifyCSWEvent, MyResetComplete(); /* Kick off a card reader reset */
...
/* Called when complete */
public void MyResetComplete(ResetResults rr)
{
}