Outbound routing file XML format

All routing information is contained in the overall XML document. The destinations XML tag is the root element that contains all the outbound routing information. The following example shows the high-level structure for the routing file XML.

<destinations>
   <destRouting>
      <icpcsRouting>
         <outgoing>
            
            . . .
            
         </outgoing>
      </icpcsRouting>
   </destRouting>
</destinations>

The following table describes the XML elements that can be in the outbound routing file.

Table 1. Outbound routing file XML format
Node name	Parent elements	Node type	Description
`<destinations>`	None, this element is the root element	ELEMENT	Routing file XML root element
`<destRouting>`	`<destinations>`	ELEMENT	Contains the receiving point routing definitions. This element is only specified once.
`<icpcsRouting>`	`<destRouting>`	ELEMENT	The Common Services routing definitions. This element is only specified once.
`<outgoing>`	`<icpcsRouting>`	ELEMENT	The routing used for outgoing work. This element is only specified once.
`<batchCount>`	`<outgoing>`	TEXT	The total number of batch (ICL) header records in the transmission.
`<customDescriptor>`	`<outgoing>`	TEXT	The custom descriptor that is defined in the transmission definition that is used for this transmission.
`<destinationBankCode>`	`<outgoing>`	TEXT	A nine-digit number that identifies the receiving point or immediate destination for the transmission.
`<immediateOrigin>`	`<outgoing>`	TEXT	A nine-digit number that identifies the organization or company that originated the transmission. It is one of the numbers that are described in the following list. The originator routing transit number that was defined in the transmission definition that was used for the outbound transmission. The bank routing number from the outbound transmission.
`<receivingPointBankCode>`	`<outgoing>`	TEXT	The nine-digit routing transit number for the receiving point.
`<releaseTrigger>`	`<outgoing>`	TEXT	This node indicates what caused the transmission to be released. Values for this node are shown in the following list. `manual` `threshold` `scheduled` `replica` `unload` `fileToFile`
`<testIndicator>`	`<outgoing>`	TEXT	A single character that indicates whether the transmission is a test transmission or not. It is set to the test file indicator that is defined in the transmission definition that is used for this transmission.
`<transmissionCreateDate>`	`<outgoing>`	TEXT	The date that the outbound transmission was created. It is not necessarily the business day. The format of the date depends on the message standard. For check transmissions, it is `YYYYMMDD`.
`<transmissionCreateTime>`	`<outgoing>`	TEXT	The time that the outbound transmission was created. It is in the format `HHMM`.
`<transmissionIdModifier>`	`<outgoing>`	TEXT	A single character that modifies the transmission ID. For transmissions that are sent to the same receiving point for a specific processing day, the transmission ID modifier is set to A for the first transmission sent. Then, it is incremented for each subsequent transmission that is sent. The modifier is incremented from A-Z and then from 0-9. After 9 is used, the value begins incrementing from A-Z again. This behavior is similar to how the NACHA specification increments the file ID modifier field in the file record header.

The XML elements of an inbound routing file, or route file, are defined in the Gateway XML schema file routingfileschema.xsd. The files that you need are provided in the FTM artifacts pod and must be downloaded from the pod. For more information about getting files from the artifacts container for your offering, see Getting the files from the artifacts container for your FTM offering.