Item Message

Table 1 provides parameter information for item messages.
Table 1. Item Message Values
Parameter Name Values Description
type check, return, credit, batch, cashIn, cashOut Item type.
userField   User field of the batch message.
auxOnUs   Auxiliary on-us (serial number). MICR field 7 from the item’s code line.
extProcCode   External processing code. MICR field 6 from the item’s code line.
extProcCode->valid True, false This flag is true if the external processing code field (6) is valid; otherwise it is false.
routingNumber True, false Payor bank routing number. MICR field 5 from the item’s code line.
routingNumber->valid True, false This flag is true if the payor bank routing number field (5) is valid; otherwise it is false. onUs MICR fields 4, 3, and 2 from the item’s code line, separated by forward slashes (/) instead of the on-us symbols.
onUs-> validOpt4 True, false This flag is true if the on-us optional field (4) is valid; otherwise it is false.
onUs-> validAccount True, false This flag is true if the on-us account number field (3) is valid; otherwise it is false.
onUs->validPc True, false This flag is true if the on-us process control field (2) is valid; otherwise it is false.
amount   Item amount. MICR field 1 from the item’s code line.
Amount->valid True, false This flag is true if the item amount field (1) is valid; otherwise it is false.
originatingBankISN   A number assigned by the ECE institution that creates the item used to identify the item.
documentationType   A code that indicates the type of documentation that supports the item.
returnReason   A code that indicates the reason for non-payment. This is present only in return items.
Amount->valid True, false This flag is true if the item amount field (1) is valid; otherwise it is false.
originatingBankISN   A number assigned by the ECE institution that creates the item used to identify the item.
documentationType   A code that indicates the type of documentation that supports the item.
returnReason   A code that indicates the reason for nonpayment. This is present only in return items.
returnItemForwardDate   A code for electronic check exchange items. Designates the business date of the forward bundle. This is present only in return items.
returnReason   A code that indicates the reason for nonpayment. This is present only in return items.
returnItemForwardDate   A code for electronic check exchange items. Designates the business date of the forward bundle. This is present only in return items.
usage
  • 7: credit item
  • 9: debit item (if item type is credit and the usage is set to 9, the item is used as debit item.)
  • E: balance exclude item
  • I: cash in item
  • O: cash
Item usage indicator
originalRecordData   The original record data of the item message. The format attribute is IR.
imageView->side front, back The side of the image view in the item
imageView->type blackWhite, grayscale, color The type of the image view in the item
imageView->format
  • tiffG4 – TIFF 6 (only compression Group 4 Black and White allowed)
  • jfif – JPEG(JFIF)
  • png – PNG(Portable Network Graphics)
  • tiffJpeg6 – TIFF 6 (compression scheme 6 for Grayscale)
  • tiffJpeg7 - TIFF 6 (compression scheme 7 for Grayscale)
  • jpeg2000 – JPEG2000
  • ioca – IOCA FS 11 (Image Object Content Architecture Function Set 11)
 The format of the image view in the item
imageLength   The length of the image data
image   The image data
The following is an XML sample for an item message: 
<cap:itemRecord type="return"  xmlns:cap="http://www.ibm.com/PayDirCapture"
     xmlns:xsi="http://www.w3.org/2001/xmlSchema-instance">
  <userField>sample item user data</userField>
  <auxOnUs>1000202</auxOnUs>
  <extProcCode valid="true">0</extProcCode>
  <routingNumber valid="false">55555-333</routingNumber>
  <onUs validOpt4="false" validAccount="true" validPc="true">3569002150/1234</onUs>
  <amount valid="true">0000000100</amount>
  <originatingBankISN>012345678912</originatingBankISN>
  <documentationType>M</documentationType>
  <returnReason>41</returnReason>
  <returnItemForwardDate>2008-09-18</returnItemForwardDate>
  <usage>9</usage>
  <originalRecordData format="IR">
    <otherType1>
      <micrFields>1000202,0,55555-333,3569002150/1234,0000000100</micrFields>
    </otherType1>
  </originalRecordData>
  <imageViews>
    <imageView side="front" type="blackWhite" format="tiffG4" compression="g4">
      <imageLength>9999999</imageLength>
      <image>9H80fdsd59s89s9W</image>
    </imageView>
    <imageView side="back" type="grayscale" format="jfif" compression="jpeg">
      <imageLength>12</imageLength>
      <image>9H80fdsd59s89s9W</image>
      <originalRecordData format="IR">
        5200124541221 11 2121 22255522 5 2 222 0001120
      </originalRecordData>
    </imageView>
  </imageViews>
</cap:itemRecord>