SIGNATURE
Last updated: 06-Jan-2025
This command directs the device to capture signature from a customer.
Note
Signature Capture will not prompt on Manual, due to the CardPresent variable not being populated. For Manual, the xml tag <CARD_PRESENT>TRUE</CARD_PRESENT> is required to add in the transaction requests for Signature Capture functionality to work as expected. Signature data gathered outside of a transaction is sent back only to the POS and not to the Point/PAYware Connect gateway or host.
Device UI Required: Yes
Request Packet
| Field | Rule | Type | Minimum | Maximum | Value(s) | Description |
|---|---|---|---|---|---|---|
| FUNCTION_TYPE | Required | Static value | N/A | N/A | DEVICE | Type of function. |
| COMMAND | Required | Static value | N/A | N/A | SIGNATURE | Command name |
| DISPLAY_TEXT | Optional | Character | 1 | 4000 | Display allows for up to four lines of text before scroll bar is displayed. When four lines are exceeded, the box will include scroll bars to navigate up/down through text area. Example: I Hereby Agree to Pay The Amount in Full. NOTE: If not provided, display text will default to Example shown. | |
| FORMATTED_DISPLAY_TEXT | Optional | Binary |
|
Formatting the display text. | ||
| POS_RECON | Optional | Character | 1 | 30 | POS reconciliation. POS Reconciliation field to be echoed back in response to POS. Example: RetailPOS1 | |
| COUNTER | Required | Numeric | 1 | 10 | COUNTER is used for a given MAC label. Each COUNTER should be higher than the last one. This is used to authenticate the POS. Example: 100 | |
| MAC | Required | Base64 Encoded Data | N/A | N/A | N/A | Message Authentication Code. This is used to authenticate the POS. |
| MAC_LABEL | Required | Character | 1 | 50 | Associated label that tells the device which MAC_KEY to use to decrypt the value of MAC. This is used to authenticate the POS. Example: REG1 |
Example
Following is an example of request packet
<TRANSACTION>
<FUNCTION_TYPE>DEVICE</FUNCTION_TYPE>
<COMMAND>SIGNATURE</COMMAND>
<COUNTER>1</COUNTER>
<MAC> … </MAC>
<MAC_LABEL>REG2</MAC_LABEL>
</TRANSACTION>
Response Packet
| Field | Type | Value | Description |
|---|---|---|---|
| RESPONSE_TEXT | Character | Processor response text. Example: Signature Captured | |
| RESULT | Character | This indicates the Result details. Example: OK | |
| RESULT_CODE | Numeric | Expected result code: -1, 59001, 59006, 59040 | This indicates the result code. Refer to Result/Error Codes for details. |
| TERMINATION_STATUS | Character | SUCCESS or FAILURE | This indicates the transaction termination status. This is the overall status of the transaction irrespective of approved or declined. Like, if the output is generated then the status is SUCCESS and if no output is generated then the status will be FAILURE. |
| COUNTER | Numeric | Echoes counter sent in the request. Example: 100 | |
| SIGNATUREDATA | Base 64 encoded data | Signature data. | |
| MIME_TYPE | Character |
|
Mime type of the signature image. Example: Ex: image/png, image/bmp. NOTE: The response data for MIME_TYPE field is depending on the value set in SIGIMAGETYPE parameter (Application Parameters). |
| POS_RECON | Character | POS reconciliation field echoed back if sent in request. Example: RetailPOS1 |
Example
Following is an example of response packet
<RESPONSE>
<RESPONSE_TEXT>Signature Captured</RESPONSE_TEXT>
<RESULT>OK</RESULT>
<RESULT_CODE>-1</RESULT_CODE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<SIGNATUREDATA>{base64 encoded data}</SIGNATUREDATA>
<MIME_TYPE>image/png</MIME_TYPE>
<COUNTER>1</COUNTER>
</RESPONSE>
Rate this article:
