Last updated: 04-Dec-2024
This command directs the device to capture an email address from a customer.
Device UI Required: No
Request Packet
| Field | Rule | Type | Minimum | Maximum | Value(s) | Description |
|---|---|---|---|---|---|---|
| FUNCTION_TYPE | Required | Static value | N/A | N/A | PAYMENT | Type of function |
| COMMAND | Required | Static value | N/A | N/A | Command name | |
| EMAILDATA | Optional | Character | 257 | This field is for email data. This can be sent to pre-populate email address. Example: JohnDoe@email.com | ||
| 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 | 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>EMAIL</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: Email 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. |
| POS_RECON | Character | Ex: | POS reconciliation field echoed back if sent in request. Example: RetailPOS1 |
| EMAILDATA | Character | This returns the entered email data. Example: JohnDoe@email.com | |
| COUNTER | Numeric | Echoes counter sent in the request. Example: 100 |
Example
Following is an example of response packet
<RESPONSE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<COUNTER>1</COUNTER>
<RESULT_CODE>-1</RESULT_CODE>
<RESULT>OK</RESULT>
<RESPONSE_TEXT> Email Captured </RESPONSE_TEXT>
<EMAILDATA> {email address – could be same or different} </EMAILDATA>
</RESPONSE>
Rate this article:
