SCA Functional Specification

SETTLEMENT SUMMARY

Last updated: 07-Apr-2025
Download as PDF

This command runs the Settlement Summary report.

  

Note

Settlement Summary is not valid for host processors.

Device UI Required: No

Request Packet
Field Rule Type Minimum Maximum Value(s) Description
FUNCTION_TYPE Required Static value N/A N/A REPORT Type of function
COMMAND Required Static value N/A N/A SETTLESUMMARY Command name
MAX_NUM_RECORDS_RETURNED Required Numeric 1 4 8000 Maximum number of records returned.
RESPONSEFIELDS Required List     BATCH_SEQ_NUM, ERR_TRANS_IN_BATCH, SETTLE_DATE, SETTLE_CODE, CRDT_SALE_AMT, CRDT_SALE_CNT, CRDT_CRDT_AMT, CRDT_CRDT_CNT, CRDT_VOID_AMT, CRDT_VOID_CNT. Choose from list, minimum one field.
COL_3, COL_4, COL_5, COL_6, COL_7, COL_8, COL_9, COL_10 Optional Character 1 255   These fields represent Column 3 to Column 10. These fields are expected for the Merchants internal POS System, which will record any additional data and link those to the PWC CLIENT_ID and CTROUTD. When a value for COL_n is passed in, that same value will be returned in the response. These COL_n values are not indexed, or searchable in any command report. These fields are not sent to any payment processor. Example: Merchant defined data
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 sed to authenticate the POS. Example: 100
MAC Required Base64 Encoded Data 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

SEARCHFIELDS Child Elements

Field Rule Type Minimum Maximum Value(s) Description
START_SETTLE_DATE Required Date       Settlement start amount. Example: 2016.03.23
END_SETTLE_DATE Required Date       Settlement end amount. Example: 2016.03.24
Example

Following is an example of request packet

<TRANSACTION>
    <COUNTER>1</COUNTER>
    <MAC> … </MAC>
    <MAC_LABEL>REG2</MAC_LABEL>
    <FUNCTION_TYPE>REPORT</FUNCTION_TYPE>
    <COMMAND>SETTLESUMMARY</COMMAND>
    <MAX_NUM_RECORDS_RETURNED>800</MAX_NUM_RECORDS_RETURNED>
    <RESPONSEFIELDS>
            <SETTLE_DATE/>
            <SETTLE_CODE/>
            <CRDT_SALE_AMT/>
            <CRDT_SALE_CNT/>
            <CRDT_CRDT_AMT/>
            <CRDT_CRDT_CNT/>
            <CRDT_VOID_AMT/>
            <CRDT_VOID_CNT/>
            <BATCH_SEQ_NUM/>
            <ERR_TRANS_IN_BATCH/>
    </RESPONSEFIELDS>
    <SEARCHFIELDS>
            <START_SETTLE_DATE>2016.01.01</START_SETTLE_DATE>
            <END_SETTLE_DATE>2016.05.31</END_SETTLE_DATE>
    </SEARCHFIELDS>
    </TRANSACTION>
Response Packet
Field Type Value Description
CLIENT_ID Numeric   CLIENT_ID is the combination an ACCOUNT number, a SITE number, and a TERMINAL number in that order. Example: 100010001
RETURN_FLD_HDRS Numeric   Returns field headers. Example: 0
FORMAT Conditional xml Format of the command.
SERIAL_NUM Character   Serial number. Example: 123456789
COMMAND Static Value SETTLESUMMARY Command name.
MAX_NUM_RECORDS_RETURNED Numeric   Maximum number of records returned. Example: 800
DEVICEKEY Character   Device key.
DELIMITER Static Value , Delimiter to enter multiple entry in a field.
FUNCTION_TYPE Static Value REPORT Function type.
DEVTYPE Character   Device type.
NUM_RECORDS_FOUND Numeric   Number of records found. Example: 2
START_SETTLE_DATE Date   Settlement start amount. Example: 2016.03.23
END_SETTLE_DATE Date   Settlement end amount. Example: 2016.03.24
BATCH_SEQ_NUM, ERR_TRANS_IN_BATCH, SETTLE_DATE, SETTLE_CODE, CRDT_SALE_AMT, CRDT_SALE_CNT, CRDT_CRDT_AMT, CRDT_CRDT_CNT, CRDT_VOID_AMT, CRDT_VOID_CNT     These fields will return for each record if they are specified in the RESPONSEFIELDS parameter of the request.
COL_3, COL_4, COL_5, COL_6, COL_7, COL_8, COL_9, COL_10 Character   Column 3 to Column 10 fields value will be echoed in POS response. These fields are not sent to any payment processor.
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>
<RETURN_FLD_HDRS>0</RETURN_FLD_HDRS>
<ACCOUNT>1</ACCOUNT>
<SITE>0001</SITE>
<TERM>0001</TERM>
<FORMAT>xml</FORMAT>
<SERIAL_NUM>1234565789</SERIAL_NUM>
<DEVICEKEY>*************************</DEVICEKEY>
<COMMAND>SETTLESUMMARY</COMMAND>
<MAX_NUM_RECORDS_RETURNED>800</MAX_NUM_RECORDS_RETURNED>
<DELIMITER>|</DELIMITER>
<FUNCTION_TYPE>REPORT</FUNCTION_TYPE>
<DEVTYPE>VX805P</DEVTYPE>
<NUM_RECORDS_FOUND>0</NUM_RECORDS_FOUND>
<SEARCHFIELDS>
            <START_SETTLE_DATE>2016.01.01</START_SETTLE_DATE>
    <END_SETTLE_DATE>2016.05.31</END_SETTLE_DATE>
</SEARCHFIELDS>
    <RECORDS>
            <RECORD>
                    <BATCH_SEQ_NUM>2</BATCH_SEQ_NUM>
                    <ACCOUNT>93092</ACCOUNT>
                    <SITE>0001</SITE>
                    <TERM>0001</TERM>
                    <ERR_TRANS_IN_BATCH>0</ERR_TRANS_IN_BATCH>
                    <SETTLE_DATE>2016.04.17</SETTLE_DATE>
                    <SETTLE_CODE>02 LOCAL_SETTLE</SETTLE_CODE>
                    <CRDT_SALE_AMT>40.00</CRDT_SALE_AMT>
                    <CRDT_SALE_CNT>2</CRDT_SALE_CNT>
                    <CRDT_CRDT_AMT>0.00</CRDT_CRDT_AMT>
                    <CRDT_CRDT_CNT>0</CRDT_CRDT_CNT>
                    <CRDT_VOID_AMT>0.00</CRDT_VOID_AMT>
                    <CRDT_VOID_CNT>1</CRDT_VOID_CNT>
            </RECORD>
    </RECORDS>
    </RESPONSE>
Rate this article:

Need help?

Do you have a question? If you didn’t find the answer you are looking for in our documentation, you can contact our Support teams for more information. If you have a technical issue or question, please contact us. We are happy to help.

Get in touch

Not yet a Verifone customer?

We’ll help you choose the right payment solution for your business, wherever you want to sell, in-person or online. Our team of experts will happily discuss your needs.

Contact sales Get Started
Verifone logo