Close Batch Message

A close batch message indicates the close of the batch. The seqNum of this message should be the maximum number in the message group. The message contains the counts and amount of items within the batch (ICL). The Gateway Server closes the whole batch messages as it finds the close batch message is received and other messages are all received.

Table 1. Close Batch Message Values
Parameter Name Value Description
type close Batch message type
userField   User field of the batch message
enterpriseID   Enterprise identifier of the batch (ICL)
bankID   Bank identifier of the batch (ICL)
branchID   Branch identifier of the batch (ICL)
batchID   Batch identifier of the batch (ICL)
businessDate   Business date of the batch (ICL)
sourceType   Source type of the batch (ICL)
closeDateTime   The close time of the batch (ICL) in the form yyyy-mm-ddThh:mm:ss. The T starts the time area.
debitCount   Total number of debit items in the batch (ICL)
debitTotal   Total amount of all debit items in the batch (ICL)
creditCount   Total number of all credit items in the batch (ICL)
creditTotal   Total amount of all credit items in the batch (ICL)
cashInCount   Total number of all cash in items in the batch (ICL)
cashInTotal   Total amount of all cash in items in the batch (ICL)
cashOutCount   Total number of all cash out items in the batch (ICL)
cashOutTotal   Total amount of all cash out items in the batch (ICL)
totalCount   Total number of all kinds of items in the batch (ICL)
originalRecordData   Original record data of the close batch message. The format attribute is IR.
The payload portion of a sample close batch message in XML is shown: 
<cap:batchRecord type="close"  xmlns:cap="http://www.ibm.com/PayDirCapture"
    xmlns:xsi="http://www.w3.org/2001/xmlSchema-instance">
  <userField>sample batch user data</userField>
  <enterpriseID>enterprise0</enterpriseID>
  <bankID>bank0</bankID>
  <branchID>branch0</branchID>
  <batchID>batch0</batchID>
  <businessDate>2004-11-10</businessDate>
  <sourceType>teller</sourceType>
  <closeDateTime>2008-10-24T08:32:03</closeDateTime>
  <debitCount>4</debitCount>
  <debitTotal>5400000</debitTotal>
  <cashInCount>0</cashInCount>
  <cashInTotal>0</cashInTotal>
  <cashOutCount>2</cashOutCount>
  <cashOutTotal>2678600</cashOutTotal>
  <creditCount>1</creditCount>
  <creditTotal>453200</creditTotal>
  <originalRecordData format="IR">
    Test Original Record Data
  </originalRecordData>
</cap:batchRecord>
Note:
  1. All messages saved in the notificationMsgPath/rcap folder are cleaned by running end of day.
  2. Remote capture items with the usage field set to E are not counted in the transaction and batch (ICL) counts and totals.
  3. Remote capture items with type field set to credit and usage field set to 9 (debit) are treated as debit items.
  4. All messages are written into the capture file in sequence based on their sequence number in the batch.