Item Message

An item message contains item data information: amount, account and image data. The Gateway Server supports the following types of items according to the usage:
  • Credit item (7)
  • Debit item (9)
  • Balance exclude item (E)
  • Cash in item (I)
  • Cash out item (O)
The balance exclude item does not count in the total. The valid image view formats are:
  • tiffG4
  • jfif
  • png
  • tiffJpeg6
  • tiffJpeg7
  • jpeg2000
  • ioca
Table 1. Item Message Values
Parameter Name Value Description
type check, return, credit, batch, cashIn, cashOut Item type
userField   User field of the item message
auxOnUs   Auxiliary on-us (serial number). MICR field 7 from the codeline of the item
extProcCode   External processing code. MICR field 6 from the codeline of the item
extProcCode→valid True, false The 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 codeline of the item
routingNumber→valid True, false 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 codeline of the item; separated by forward slashes in place of the on us symbols.
onUs→validOpt4 True, false Flag is true if the on us optional field 4 is valid
onUs→validAccount True, false Flag is true if the on us account number field 3 is valid
onUs→validPc True, false Flag is true if the on us process control field 2 is valid
amount   Item amount. MICR field 1 from the item’s codeline
Amount→valid True, false Flag is true if the item amount field 1 is valid
originating BankISN   A number assigned by the ECE institution that creates the item used for identification
documentationType   Code used to indicated the type of documentation supporting the item
returnReason   Return reason code used to indicated the reason for nonpayment. It is only present in returned items.
returnItemForwardDate   Designates the business date of the forward bundle for electronic check exchange items. It is only present in returned items.
usage
  • 7 - credit item
  • 9 - debit item (if the item is credit and the usage is 0, the item is used as a debit item)
  • E- balance exclude item
  • I - cash in item
  • O - cash out item
 Item usage indicator
originalRecordData   Original record data of the item message. The format attribute is IR.
imageView→side front, back Side of the image view
imageView→type blackWhite, grayscale, color Type of the image view
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)
 Format of the image view
imageLength   Length of the image data
image   Image data
The payload portion of a sample item message in XML is shown: 
<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>