Unsolicited Consumer Notification Responses
This section discusses optional unsolicited consumer notification response messages back to the POS.
Note
Unsolicited Consumer Notification response messages to the POS will be MAC’d or encrypted based upon pairing.
The URL and port must be provided at the start of the session to receive unsolicited consumer selections back to the POS in real time.
To receive unsolicited consumer selection events or notifications, sendunsolmsgduringpymttran parameter must be set to ENABLE and the POS should send its IP listening address and POS listening port with the START or BARCODEASYNC_START (in case of Barcode commands) request.
Configuration parameter sendunsolmsgduringpymttran is required to set, which affects the operation. Refer to Application Parameters table for more details on the below parameter.
Field | Rule | Type | Minimum | Maximum | Value(s) | Description |
---|---|---|---|---|---|---|
POS_IP | Optional | Character | For Consumer Unsolicited Responses to POS. POS IP listening address. Example: 192.168.31.100 | |||
POS_PORT | Optional | Numeric | 4 | 4 | Unsolicited Responses port is 5017 | For Consumer Unsolicited Responses to POS. POS listening port. Example: 5017 |
Note
The following SCA notification responses will return automatically if POS_IP and POS_PORT is sent with the START request and sendunsolmsgduringpymttran (Application Parameters) configuration parameter is set to Y.
Card Entry Method
Note
Card Entry Method Notification will happen automatically once card details are captured from the user if POS_IP and POS_PORT is sent with the START request.
<RESPONSE>
<RESPONSE_TEXT>CONSUMER CARD ENTRY</RESPONSE_TEXT>
<RESULT>OK</RESULT>
<RESULT_CODE>1</RESULT_CODE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<CARD_ENTRY_METHOD>INSERTED|SWIPED|TAPPED|MANUAL</CARD_ENTRY_METHOD>
</RESPONSE>
Transaction in Flight
<RESPONSE>
<RESPONSE_TEXT>TRANSACTION IN FLIGHT</RESPONSE_TEXT>
<RESULT>OK</RESULT>
<RESULT_CODE>2</RESULT_CODE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<CARD_ENTRY_METHOD>SWIPED</CARD_ENTRY_METHOD>
</RESPONSE>
Card Entry Screen
<RESPONSE>
<RESPONSE_TEXT>CARD ENTRY SCREEN</RESPONSE_TEXT>
<RESULT>OK</RESULT>
<RESULT_CODE>5</RESULT_CODE>
</RESPONSE>
Card Read Error
Insert Error
<RESPONSE>
<RESPONSE_TEXT>CARD READ ERROR</RESPONSE_TEXT>
<RESULT>ERROR</RESULT>
<RESULT_CODE>6</RESULT_CODE>
<CARD_ENTRY_METHOD>INSERTED</CARD_ENTRY_METHOD>
</RESPONSE>
Tap Error
<RESPONSE>
<RESPONSE_TEXT>CARD READ ERROR</RESPONSE_TEXT>
<RESULT>ERROR</RESULT>
<RESULT_CODE>6</RESULT_CODE>
<CARD_ENTRY_METHOD>TAPPED</CARD_ENTRY_METHOD>
</RESPONSE>
Swipe Error
<RESPONSE>
<RESPONSE_TEXT>CARD READ ERROR</RESPONSE_TEXT>
<RESULT>ERROR</RESULT>
<RESULT_CODE>6</RESULT_CODE>
<CARD_ENTRY_METHOD>SWIPED</CARD_ENTRY_METHOD>
</RESPONSE>
EMV Use Chip
<RESPONSE>
<RESPONSE_TEXT>USE CHIP READER</RESPONSE_TEXT>
<RESULT>ERROR</RESULT>
<RESULT_CODE>7</RESULT_CODE>
<CARD_ENTRY_METHOD>SWIPED</CARD_ENTRY_METHOD>
</RESPONSE>
EMV Fallback
Insert Card - Error Retry Exceeded
<RESPONSE>
<RESPONSE_TEXT>CHIP ERROR, SWIPE CARD</RESPONSE_TEXT>
<RESULT>ERROR</RESULT>
<RESULT_CODE>8</RESULT_CODE>
<CARD_ENTRY_METHOD>INSERTED</CARD_ENTRY_METHOD>
</RESPONSE>
Empty Candidate List
<RESPONSE>
<RESPONSE_TEXT>APPLICATION NOT AVAILABLE, SWIPE CARD</RESPONSE_TEXT>
<RESULT>ERROR</RESULT>
<RESULT_CODE>14</RESULT_CODE>
</RESPONSE>
Authorizing I and II
<RESPONSE>
<RESPONSE_TEXT>TRANSACTION IN FLIGHT</RESPONSE_TEXT>
<RESULT>OK</RESULT>
<RESULT_CODE>2</RESULT_CODE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<CARD_ENTRY_METHOD>INSERTED</CARD_ENTRY_METHOD>
</RESPONSE>
Remove Card
<RESPONSE>
<RESPONSE_TEXT>REMOVE CARD</RESPONSE_TEXT>
<RESULT>OK</RESULT>
<RESULT_CODE>9</RESULT_CODE>
<CARD_ENTRY_METHOD>INSERTED</CARD_ENTRY_METHOD>
</RESPONSE>
Redo Without CTLS
<RESPONSE>
<RESPONSE_TEXT>REDO WITHOUT CTLS</RESPONSE_TEXT>
<RESULT>ERROR</RESULT>
<RESULT_CODE>10</RESULT_CODE>
<CARD_ENTRY_METHOD>TAPPED</CARD_ENTRY_METHOD>
</RESPONSE>
Redo With CTLS
<RESPONSE>
<RESPONSE_TEXT>REDO WITH CTLS</RESPONSE_TEXT>
<RESULT>ERROR</RESULT>
<RESULT_CODE>11</RESULT_CODE>
<CARD_ENTRY_METHOD>TAPPED</CARD_ENTRY_METHOD>
</RESPONSE>
CTLS Use One Card
<RESPONSE>
<RESPONSE_TEXT>PRESENT ONE CARD</RESPONSE_TEXT>
<RESULT>ERROR</RESULT>
<RESULT_CODE>12</RESULT_CODE>
<CARD_ENTRY_METHOD>TAPPED</CARD_ENTRY_METHOD>
</RESPONSE>
App Not Available
<RESPONSE>
<RESPONSE_TEXT>APPLICATION NOT AVAILABLE</RESPONSE_TEXT>
<RESULT>ERROR</RESULT>
<RESULT_CODE>13</RESULT_CODE>
</RESPONSE>
Consumer Options
Consumer options button selection should be notified to POS via unsolicited message, if POS has shared POS_IP and POS_PORT details in the Start session command.
Based on pre-configured parameters CONSUMEROPTION1, CONSUMEROPTION2, CONSUMEROPTION3 and CONSUMEROPTION4, unsolicited response should be set and send back to POS in the below response:
<RESPONSE>
<RESPONSE_TEXT>CONSUMER OPTION SELECTION</RESPONSE_TEXT>
<RESULT>OK</RESULT>
<RESULT_CODE>-1</RESULT_CODE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<GIFT_RECEIPT>1</GIFT_RECEIPT>
</RESPONSE>
Here, GIFT_RECEIPT is the value of the CONSUMEROPTION1 that corresponds to the consumer selection on the Left Panel.
Klarna ID Check Notification
Klarna CP application supports the validation of the customer ID via Notification in the transaction Flow.
Field | Rule | Type | Minimum | Maximum | Value(s) | Description |
---|---|---|---|---|---|---|
RESULT_CODE | Required | Numeric |
|
This indicates the result code. | ||
PROMPT | Optional | Character | Contains the Text to be displayed on POS |
POS Input Notification: Based on configuration, a notification is sent to POS soliciting a secondary port confirmation of the ID check completion.
<RESPONSE>
<RESPONSE_TEXT>User Identity Confirmation Required</RESPONSE_TEXT>
<RESULT>OK</RESULT>
<RESULT_CODE>3</RESULT_CODE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<PAYMENT_TYPE>KLARNA</PAYMENT_TYPE>
<PROMPT>Validation of Identity Check - Verification Code: </PROMPT>
</RESPONSE>
Display Notification: Based on configuration, a notification is sent to the POS when the Klarna CP application does an implicit ID check.
<RESPONSE>
<RESPONSE_TEXT>CP POS Display Notification</RESPONSE_TEXT>
<RESULT>OK</RESULT>
<RESULT_CODE>4</RESULT_CODE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<PAYMENT_TYPE>KLARNA</PAYMENT_TYPE>
<PROMPT>Validation of Identity Check - Verification Code: </PROMPT>
</RESPONSE>
Barcode Scan Response
Following unsolicited notification response messages are sent to the POS based on barcode commands.
Unsolicited response on Multi scan after scanning an item:
<RESPONSE>
<RESPONSE_TEXT>Command response 0</RESPONSE_TEXT>
<RESULT>SUCCESS</RESULT>
<RESULT_CODE>-1</RESULT_CODE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<BARCODE_DATA>AAAAAEhFTldUU0hUNDQ4MjMxMjQ=</BARCODE_DATA>
</RESPONSE>
Timeout / Cancelled by pressing Device hard key:
<RESPONSE>
<RESPONSE_TEXT>Transaction Cancelled</RESPONSE_TEXT>
<RESULT>BCERROR</RESULT>
<RESULT_CODE>59001</RESULT_CODE>
<TERMINATION_STATUS>FAILURE</TERMINATION_STATUS>
</RESPONSE>