Signature Capture
Code Samples
CWS
Request
Property | Description |
---|---|
method string | required | startSignatureCaptureOnCardReader |
requestId string | required | Transaction Request ID |
targetType string | required | cardReader |
parameters JSONObject | required | None |
Response
Property | Description |
---|---|
requestId string | Transaction Request ID As specified in the request. |
statusDetails string | Request Status |
data JSONObject | Object holding various responses. |
SignatureData JSONObject | SignatureData Object containing signatureBitmap . |
Request
{
"method" : "startSignatureCaptureOnCardReader",
"requestId" : "820378760",
"targetType" : "cardReader",
"version" : "1.0",
"parameters" : { }
}
Response
{
"requestId" : "820378760",
"statusDetails" : "REQUEST_ACCEPTED",
"data" : {
"cardReaderCommand" : {
"id" : "820378760",
"completed" : false,
"eventQueue" : [ ]
}
}
}
Later request …
{
"method" : "getCommandStatusOnCardReader",
"requestId" : "820378761",
"targetType" : "cardReader",
"version" : "1.0",
"parameters" : {
"id" : "820378760"
}
}
Later response
{
"requestId" : "820378761",
"statusDetails" : "REQUEST_ACCEPTED",
"data" : {
"cardReaderCommand" : {
"id" : "820378760",
"completed" : false,
"eventQueue" : [ {
"timeStamp" : "1681328314724",
"statusDetails" : "PIN_PAD_SIGNATURE_DRAWING_STARTED"
} ]
}
}
}
Later request …
{
"method" : "getCommandStatusOnCardReader",
"requestId" : "820378763",
"targetType" : "cardReader",
"version" : "1.0",
"parameters" : {
"id" : "820378760"
}
}
Later response - completed
{
"requestId" : "820378767",
"statusDetails" : "REQUEST_ACCEPTED",
"data" : {
"cardReaderCommand" : {
"id" : "820378760",
"completed" : true,
"eventQueue" : [ {
"timeStamp" : "1681328326367",
"statusDetails" : "PIN_PAD_SIGNATURE_DRAWING_COMPLETED"
}, {
"timeStamp" : "1681328326367",
"statusDetails" : "PIN_PAD_SIGNATURE_DRAWING_COMPLETED"
} ],
"signatureData" : {
"signatureBitmap" : {
"data" : "` ( ! !_ X p",
"format" : "SIG_BIN_2"
}
}
}
}
Java
cardReaderInterface.retrieveSignature(new ECLCardReaderRetrieveSignatureListener()
{
@Override
public void deviceOperationCompleted(ECLCardReaderInterface eclCardReaderInterface, ECLSignatureData sig)
{
displayMessage("Format: " + sig.getFormat().toString());
displayMessage("Data: " + sig.getData());
printMan.setSignatureData(sig);
}
@Override
public void deviceOperationError(ECLCardReaderInterface eclCardReaderInterface, ECCError error)
{
displayMessage("Error: " + error.toString());
}
@Override
public void deviceOperationProgress(ECLCardReaderInterface eclCardReaderInterface, ECLTransactionProgress progress)
{
displayMessage("Progress " + progress.toString());
}
});
C#
// Asynchronous
m_CWS.StartSigCapture(ne, completionDelegate);
// Synchronous
SigCaptureResults results = m_CWS.SigCapture(null);
MySignatureCaptureOnCardReaderComplete(results);
// MultiDevice && Asynchronous
CWSTransactionWsManager.Instance.StartSigCapture(selectedDeviceSerialNumber, ne, completionDelegate);
// MultiDevice && Synchronous
not supported
// do something with the signature
public void MySignatureCaptureOnCardReaderComplete(SigCaptureResults results)
{
Log("----------- Signature Capture Complete ------------");
SignatureData sd = results.SignatureData;
if (null != sd)
{
signatureBitmap sb = sd.signatureBitmap;
String format = sb.format;
String data = sb.data;
Log(String.Format("SigCaptured format {0}", format));
Log(String.Format("SigCaptured data {0}", data));
}
}