RemitPlus Transaction XML

It is the responsibility of the exporting software to deliver the file in an accessible location (network drive, etc.) for to RemitPlus FileImporter Service to retrieve. Any field marked as empty-skip is considered optional and can be populated empty or omitted entirely (it is recommended that full child nodes be omitted rather than left empty if population will never occur).

Every XML document has a root node which contains all the child nodes underneath it. The root level node for an XML RemitPlus Import File document is a node called batches. The batches node can contain a sequence of batch nodes underneath it or a single batch node for all items. The file supports only one run date per file.

XML File Sample

<?xml version="1.0" encoding="utf-8"?>
<Batches version="1.4" source="Your name here" destination="RemitPlus" created="YYYY-MM-DD
HH:MM:SS" project="RemitPlus Project Name or Id or empty" rundate="YYYY-MM-DD HH:MM:SS or empty"
imageAutoCreate="false/true" box="box value or empty-skip">
	<Batch batchType="RemitPlus Batch Type or empty" batchNumber="Your Batch Number">
		<HeaderFields>
			<HeaderField name="RemitPlus custom field name">field value</HeaderField>
		</HeaderFields>
		<Items>
			<Transaction>
				<Item>
					<Type>Document/Form/Check/Header/Image/DepositTicket/empty-skip</Type>
					<SequenceNumber>your sequence number or empty-skip></SequenceNumber>
					<MICR format="TOAD ?">RAW check MICR or empty-skip></MICR>
					<RoutingNumber>Check Routing number if known or empty-skip</RoutingNumber>
					<AccountNumber>Checking Account number if known or empty-skip</AccountNumber>
					<CheckNumber>Check Number if known or empty-skip</CheckNumber>
					<CheckAmount>Check Amount if known or empty-skip</CheckAmount>
					<OCR>Document OCR if known or empty-skip</OCR>
					<CustomFields>
						<CustomField name="RemitPlus custom field name">field value</CustomField>
					</CustomFields>
					<Splits>
						<Split sequenceNumber="1..n" page="1..n" side="Front/Rear">
							<Field name="RemitPlus split field name">field value</Field>
						</Split>
					</Splits>
					<Pages>
						<Page page="1..n">
							<Image type="Base64/Path" side="Front/Rear" offset="" length=""></Image>
							<Create minHeight="mm value or empty-skip" wifth="mm value, or empty-skip">
								<MICR format="TOAD ?">RAW check MICR or empty-skip></MICR>
								<FrontImage title="Title on top of image or empty-skip">
									<Body>
										<Text>Line of text for image or empty-skip</Text>
									</Body>
								</FrontImage>
								<RearImage>
									<Body>
										<Text>Line of text for image or empty-skip</Text>
									</Body>
								</RearImage>
							</Create>
						</Page>
					</Pages>
				</Item>
			</Transaction>
		</Items>
	</Batch>
</Batches>

XML Elements Explained

BATCHES

Sample: <Batches version="1.4" source="kiosk 2" destination="RemitPlus" created="2008-11-04 14:22:07" project=" " rundate="2008-11-04 "imageAutoCreate="false" box="90210" >

RemitPlus Project Name is an optional field, if supplied needs to exactly match the RemitPlus installed project name (not the display name) or project id, both can be verified through the RemitPlus Project Builder or technical support.
rundate if given will import the file into the corresponding RemitPlus Run Date, if omitted will be imported into current date.
imageAutoCreate is an optional field, I supplied as true (default false) RemitPlus will auto generate images based on the field level data during import.
box: Delimitation for client or merchant. Option attribute.

<Batch batchType="RemitPlus Batch Type or empty" batchNumber="Your Batch Number or empty">

Sample: <Batch batchType="BalancedChecks" batchNumber="151627"> or <Batch batchType="" batchNumber="" >

batchType is an optional field, if supplied needs to exactly match the RemitPlus installed batch type description and can be verified through the RemitPlus Project Builder or technical support.
batchNumber is an optional field reference for the scanning software’s internal batch number, and while stored for reference will not coincide with the RemitPlus batch number. If included needs to be numeric 1-9 digits non-repeating for a given file.

HEADERS

<HeaderField name="RemitPlus custom field name">field value</HeaderField>

Sample: <HeaderField name="Bank Name">First National Bank</HeaderField>

RemitPlus supports processing custom header fields for batches based on project type (such as customer account number, name, etc) and these fields may be passed by the scanning software to the RemitPlus Server processing. The RemitPlus custom header name must exactly match the RemitPlus installed field name (not the display name) and can be verified through the RemitPlus Project Builder or technical support. The HeaderFields node and corresponding child nodes are optional and should be omitted entirely if not used.

TRANSACTION

<Transaction><Item>…</Item><Item>…</Item></Transaction>

Sample: <Transaction><Item>…</Item></Transaction>

Transactions are items that are interrelated, such as a Document and Check that are from the same envelope and can be optionally grouped together in a transaction element. For mixed batch type work (singles, check only, image only, etc, this element is required.

ITEMS

<Type>Document/Form/Check/Header/Image/DepositTicket/empty-skip</Type>

Sample: <Type>Check</Type>

Provide the corresponding RemitPlus supported item type when known (Document, Form, Check, Header, Image, or DepositTicket). If item type is not known, this node may be left blank or omitted entirely, however is required if additional processing against the import is desired (i.e. electronic deposit, extract, etc.). If node is blank or omitted all item types will be stored as “Forms" (allowing custom field research, however no extract or electronic deposit).

<SequenceNumber>your sequence number or empty-skip</SequenceNumber>

Sample: <SequenceNumber>47</SequenceNumber>

Provide the sequence number for the scanning software’s internal sequence number, and while stored for reference may not coincide with the RemitPlus sequence number. If sequence number is not known node may be left blank or omitted entirely. Sequence numbers if given cannot repeat within a given <Batch>.

<MICR format="TOAD ?">Raw Check MICR or empty-skip</MICR>

Sample: <MICR format="TOAD ?">T111412341T000005?77D18408O 1976</MICR>

For scanned checks provide MICR in TOAD ? format for MICR symbology. It is required that <MICR> be present and/or <TYPE> indicate “Check" for RemitPlus to determine transactions where coupon processing is involved whereas:

T = Transit Routing Number (ABA) O = Onus Symbol A = Amount D = - (dash) = (space) ? = Unknown

<RoutingNumber> Check Routing number if known or empty-skip </RoutingNumber>
<AccountNumber> Checking Account number if known or empty-skip </AccountNumber>
<CheckNumber> Check Number if known or empty-skip </CheckNumber>
<CheckAmount> Check Amount if known or empty-skip </CheckAmount>

Samples:

<RoutingNumber>111412341</RoutingNumber>
<AccountNumber>57718408</AccountNumber>
<CheckNumber>1976</CheckNumber>
<CheckAmount>13.24</CheckAmount>

The above nodes are for parsed values based on the raw check MICR when available. All values should be numeric except for <CheckAmount> where a period is required to indicate cents values. If values are not known nodes may be left blank or omitted entirely.

<OCR> Document OCR if known or empty-skip </OCR>

Sample: <OCR>43356008102530600085241</OCR>

This node is for coupons that contain a scanline for (but not limited to) account and amount due information. If this value is not known node may be left blank or omitted entirely.

<CustomFields>
<CustomField name="RemitPlus custom field name">field value</CustomField>
</CustomFields>

Sample: <CustomField name="ResidentID">t1234567</CustomField>

RemitPlus supports processing custom fields based on project type (such as customer account number, name, due date, etc.) and these fields may be passed by the scanning software to the RemitPlus Server processing. The RemitPlus custom field name must exactly match the RemitPlus installed field name (not the display name) and can be verified through the RemitPlus Project Builder or technical support. The CustomFields node and corresponding child nodes are optional and should be omitted entirely if not used.

<Pages>
	<Page page="1..n">
		<Image type="Base64/Path" side="Front/Rear" offset="" length="">G4 Bitonal Tiff in base 64 encoding/Path to G4 Bitonal Tiff</Image>
		<Create minHeight="mm value or empty-skip" width="mm value, or empty-skip">
			<MICR format="TOAD ?">Raw Check MICR or empty-skip</MICR>
			<FrontImage title="Title on top of image or empty-skip">
				<Body>
					<Text>Line of text for image or empty-skip</Text>
				</Body>
			</FrontImage>
			<RearImage>
				<Body>
					<Text>Line of text for image or empty-skip</Text>
				</Body>
			</RearImage>
		</Create>
	</Page>
</Pages>

Sample/Spec:

<Pages>
	<Page page="1">
		<Image type="Path" side="Front">c:\FilePath\image-1-F-1.tif</Image>
		<Create minHeight="95" width="210">
			<MICR format="TOAD ?">T111412341T000005?77D18408O 1976</MICR>
			<RearImage>
				<Body>
					<Text>Endorsed by Janet</Text>
				</Body>
			</RearImage>
		</Create>
	</Page>
</Pages>

IMAGES

All images are required to be scanned and exported as G4 Bitonal (black & white) TIFF between 200-240 dpi either as a file reference or embedded as base 64 bit encoding. It is recommended that rear images are present for all items, however, are optional for non-check items. *** Check items presented without rear images can cause them to be rejected by the financial institution and a delay in customer payment and credit to depositor. ***

For file paths direct to TIFF image files parameters offset & length can be omitted or blank. For files with embedded / packed TIFF files (such as NCR or custom format) offset and length must be present along with file path to pull image information. RemitPlus supports creating front and rear images during the import of the XML file. minHeight attribute for CreateImage should be set to 95mm or more depending on the minimum height of the document. The height will only grow if more lines are added to be body so that they can be visible. The size of 69mm is set as default if not specified. width is defaulted to 150mm and can be changed. If too wide, the image won’t be printed properly and may be shrunken or go off the printed page.

MICR information is optional and will be displayed in an OCR 13b font at the bottom of the front image. The MICR element is optional and should be omitted entirely if not used. Custom text can be provided in the Body collection elements to be included as a printed line on the FrontImage or RearImage independently. Body and its corresponding children (Text) elements are optional and can be omitted entirely. A tab can be placed in the text by using “\tab" in the text. The Text values can contain variables that might not be available to the file creator. These variables are listed below. The CreateImage node and corresponding child nodes are optional and should be omitted entirely if not used. CreateImage is not included in an exported XML file.

File Name Variables:

Variable	Description
%FILENAME%	Filename of source XML file with full path. Path is shortened if the entire filename is more than 70 characters.
%FILEDATE%	Last modified date/time for source XML file.
%SCANNERUSER%	Operator name for logged in user that imported file
%PROJECTDISPLAYNAME%	Project Display Name setup in project
%PROJECTNAME%	Project Name setup in project at initial project install
%BATCHDESC%	Name of BatchType setup in project