CHARITY_DONATION
Last updated: 07-Apr-2025
This command is used to direct the device to display up to five (5) lines of display text and prompt up to five amount values (with currency Symbol).
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 | CHARITY | Command name. |
| DISPLAY_TEXT1 | Optional | Character | 1 | 50 | Displays text line 1. Example: Here is what your donation can achieve? | |
| DISPLAY_TEXT2 | Optional | Character | 1 | 50 | Displays text line 2. Example: Stop child labor for children by connecting parent | |
| DISPLAY_TEXT3 | Optional | Character | 1 | 50 | Displays text line 3. Example: Ensure 6 school children are enrolled back school | |
| DISPLAY_TEXT4 | Optional | Character | 1 | 50 | Displays text line 4. Example: Protect 9 children from the threat of malnutrition | |
| DISPLAY_TEXT5 | Optional | Character | 1 | 50 | Displays text line 5. Example: Give 15 children healthy life by proper healthcare | |
| AMOUNT1 | Required | Character | 1 | 10 | SCA Application does not format the amount or append any decimals or currency symbols to the amount. The POS should send the values as they appear on the Engage device display. NOTE: A minimum of one of the Amount field is required. In Amount Box up to 10 characters can be displayed including currency symbol and decimal point. Example: $0.20. | |
| AMOUNT2 | Optional | Character | 1 | 10 | Same as AMOUNT1. Example: $10.00 | |
| AMOUNT3 | Optional | Character | 1 | 10 | Same as AMOUNT1. Example: $99.99 | |
| AMOUNT4 | Optional | Character | 1 | 10 | Same as AMOUNT1. Example: $20.00 | |
| AMOUNT5 | Optional | Character | 1 | 10 | Same as AMOUNT1. Example: $7.50 | |
| 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>CHARITY</COMMAND>
<DISPLAY_TEXT1>Here is what your donation can achieve?</DISPLAY_TEXT1>
<DISPLAY_TEXT2>Stop child labor for children by connecting parent.</DISPLAY_TEXT2>
<DISPLAY_TEXT3>Ensure 6 school children are enrolled back school</DISPLAY_TEXT3>
<DISPLAY_TEXT4>Protect 9 children from the threat of malnutrition</DISPLAY_TEXT4>
<DISPLAY_TEXT5>Give 15 children healthy life by proper healthcare</DISPLAY_TEXT5>
<AMOUNT1>$0.20</AMOUNT1>
<AMOUNT2>$99.99</AMOUNT2>
<AMOUNT3>$15.00</AMOUNT3>
<AMOUNT4>$20.00</AMOUNT4>
<AMOUNT5>$7.50</AMOUNT5>
<POS_RECON>GET ECHO FROM TERMINAL</POS_RECON>
</TRANSACTION>
Response Packet
| Field | Type | Value | Description |
|---|---|---|---|
| RESPONSE_TEXT | Character | Processor response text. Example: SUCCESS | |
| RESULT | Character | OK or CANCELLED | This indicates the Result details. |
| RESULT_CODE | Numeric | Expected result code: -1, 59006, 59040, 59043 | 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 | |
| AMOUNT_DATA | Character | 1, 2, 3, 4, 5, 0 (SKIP) | Represents the amount field selected by the user, like <AMOUNT1> or <AMOUNT3>, not the amount in currency. 0 indicates the donation amount option is skipped. |
| POS_RECON | Character | POS reconciliation field echoed back if sent in request. Example: RetailPOS1 |
Transaction Performance Metric
Note
These fields are returned, if SCAPERFMETRIC parameter (Application Parameters) is enabled.
| Field | Type | Value | Description |
|---|---|---|---|
| UI_TIME | Time | This indicates the time duration, for which the device screen is displayed (like error message, prompt screen, remove card screen) till any user action is performed in the command execution flow. This field is not applicable to capture the time for the Processing, Authorizing and transaction status screen. The format of the returned value would be S.sss, where S is seconds (this can be 0 to any positive integer) and sss is milliseconds. In case of any insignificant time or 0.000 value, will not be returned in the response. Example: <UI_TIME>44.028</UI_TIME> |
|
| HOST_TIME | Time | This indicates the time taken for the Connection to the host, sending request and receives data from the host. This field also take the cumulative time for multiple requests which may sent to the host during the transaction including two legged transactions, timeout requests, Auto Last Tran requests, DCC, Credit app proxy. The format of the returned value would be S.sss, where S is seconds (this can be 0 to any positive integer) and sss is milliseconds. In case of any insignificant time or 0.000 value, will not be returned in the response. Example: <HOST_TIME>1.389</HOST_TIME> |
|
| CMD_TIME | Time | This field indicates the total amount of time for a command, which is executed by the application from request received to the response sent. The format of the returned value would be S.sss, where S is seconds (this can be 0 to any positive integer) and sss is milliseconds. In case of any insignificant time or 0.000 value, will not be returned in the response. Example: <CMD_TIME>70.765</CMD_TIME> |
Example
Following is an example of response packet
<RESPONSE>
<RESPONSE_TEXT>Charity Captured</RESPONSE_TEXT>
<RESULT>OK</RESULT>
<RESULT_CODE>-1</RESULT_CODE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<AMOUNT_DATA>0</AMOUNT_DATA>
<POS_RECON>GET ECHO FROM TERMINAL</POS_RECON>
<COUNTER>17</COUNTER>
</RESPONSE>
Rate this article:
