E-Payment Integrator V6 - Online Help
E-Payment Integrator V6
Questions / Feedback?

CheckDetail Type

Contains information about a check to be written to file.

Remarks

A CheckDetail type contains MICR information read off of a physical check, as well as the Bank of First Deposit's routing number and the name of the payee. A check may also optionally contain a scan of the front and back of the paper check.

Fields

Amount
String

The US dollar value of the check. This field is part of the Check detail record (type 25), and is 10 characters in length.

BackImageCreationDate
String

Date assigned by the image creator for the image contained in BackImageData. This field is part of the Image View Detail record (type 50), and is in the format "YYYYMMDD".

BackImageData
String

This field contains the scanned image of the back of the physical check, in the format specified by ImageFormat and compressed using the designated ImageCompression. You may either specify the raw binary image data in this field, or specify the path and filename of an image on disk in the BackImageFilename field. If both are specified BackImageData will be used. If both fields are left empty, no records referencing the back image of the check will be added to the file.

BackImageDataB
Byte[]

This field contains the scanned image of the back of the physical check, in the format specified by ImageFormat and compressed using the designated ImageCompression. You may either specify the raw binary image data in this field, or specify the path and filename of an image on disk in the BackImageFilename field. If both are specified BackImageData will be used. If both fields are left empty, no records referencing the back image of the check will be added to the file.

BackImageFilename
String

This field contains location of a scanned image of the back of the physical check, in the format specified by ImageFormat and compressed using the designated ImageCompression. You may either specify the path and filename of an image on disk in this field, or you may set the raw binary image data in the BackImageData field. If both fields are specified BackImageData will be used and BackImageFilename will be ignored. If both fields are left empty, no records referencing the back image of the check will be added to the file.

BackImageReferenceKey
String

A designator assigned by the ECE institution that uniquely identifies the BackImageData. This designator could be a key that would be used by the creating institution to located the unique associated image, or it could provide a full access path and name that would allow direct external look up and access of the image. For example, this could be a URL.

BOFDAccountNumber
String

A number that identifies the depository account at the Bank of First Deposit. This field is part of the Check Detail Addendum A record (type 26), and is 18 characters in length.

BOFDBranch
String

A code that identifies the branch at the Bank of First Deposit. This field is part of the Check Detail Addendum A record (type 26), and is 5 characters in length.

BOFDConversionIndicator
String

A code that indicates the conversion within the processing institution between original paper check, image, and IRD. The indicator is specific to the action of this BOFD endorser. This field is part of the Check Detail Addendum A record (type 26), and may be set to one of the following values:

0Did not convert physical document.
1Original paper converted to IRD.
2Original paper converted to image.
3IRD converted to another IRD.
4Ird converted to image of IRD.
5Image converted to an IRD.
6Image converted to another image (ie: transcoded).
7Did not convert image (ie: same as source).
8Undetermined.

BOFDRoutingNumber
String

A number that identifies the Bank of First Deposit. This field is part of the Check Detail Addendum A record (type 26), and is exactly 9 characters long, including the check digit.

BOFDTruncator
Boolean

Identifies if this BOFD is the truncator of the original check. This field is part of the Check Detail Addendum A record (type 26), and is True by default.

CanRecreateImages
Boolean

A code that indicates whether the sender has the ability to recreate the check images (from the original source) for the duration of the agreed to retention time frame.

FrontImageCreationDate
String

Date assigned by the image creator for the image contained in FrontImageData. This field is part of the Image View Detail record (type 50), and is in the format "YYYYMMDD".

FrontImageData
String

This field contains the scanned image of the front of the physical check, in the format specified by ImageFormat and compressed using the designated ImageCompression. You may either specify the raw binary image data in this field, or specify the path and filename of an image on disk in the FrontImageFilename field. If both are specified FrontImageData will be used. If both fields are left empty, no records referencing the front image of the check will be added to the file.

FrontImageDataB
Byte[]

This field contains the scanned image of the front of the physical check, in the format specified by ImageFormat and compressed using the designated ImageCompression. You may either specify the raw binary image data in this field, or specify the path and filename of an image on disk in the FrontImageFilename field. If both are specified FrontImageData will be used. If both fields are left empty, no records referencing the front image of the check will be added to the file.

FrontImageFilename
String

This field contains location of a scanned image of the front of the physical check, in the format specified by ImageFormat and compressed using the designated ImageCompression. You may either specify the path and filename of an image on disk in this field, or you may set the raw binary image data in the FrontImageData field. If both fields are specified FrontImageData will be used and FrontImageFilename will be ignored. If both fields are left empty, no records referencing the front image of the check will be added to the file.

FrontImageReferenceKey
String

A designator assigned by the ECE institution that uniquely identifies the FrontImageData. This designator could be a key that would be used by the creating institution to located the unique associated image, or it could provide a full access path and name that would allow direct external look up and access of the image. For example, this could be a URL.

ImageCompression
CompressionTypes

A code that identifies the algorithm or method used to compress the images stored in the FrontImageData and BackImageData fields. Values 0-20 may be used without a pre-existing agreement. Values 21-99 shall only be used when an agreement exists indicating that sender and receiver both support the specified image compression method and the method is specified below or on the X9 web site. This field is part of the Image View Detail record (type 50), and may be any of the values below:

icFacsimile (0)Group 4 facsimile compression
icJPEG (1)JPEG Baseline
icABIC (2)ABIC
3-20Reserved (agreement is not required)
icPNG (21)PNG
icJBIG (22)JBIG
icJPEG2000 (23)JPEG 2000
24-99Reserved for emerging image compression technologies as defined on the X9 web site. Only supported under agreement.

ImageCreatorRoutingNumber
String

A number that identifies the financial institution that created the image (if different from BOFDRoutingNumber). This field is part of the Image View Detail record (type 50), and is exactly 9 characters long, including the check digit.

If this field is not specified the Originator routing number will be used.

ImageFormat
ImageFormats

A code that identifies the type of image format used for the images contained in the FrontImageData and BackImageData fields. Values 0-19 may e used without a pre-existing agreement. Values 20-99 shall only be used when an agreement exists indicating that the sender and receiver both support the specified image format type and the type is specified below or on the X9 web site. The image format type is also commonly specified by reference to the file extension used when the FrontImageData or BackImageData is saved as an image file. The file extension for each image format is included below for reference.

ifTIFF (0)TIFF 6, extension: TIF.
ifIOCA (1)IOCA FS11, extension: ICA.
2-19Reserved (agreement is not required)
ifPNG (20)Portable Network Graphics, extension: PNG.
ifJFIF (21)JPEG File Interchange Format, extension: JPG.
ifSPIFF (22)Still Picture Interchange File Format, extension: SPF.
ifJBIG (23) JBIG data stream, extension: JBG.
ifJPEG2000 (24)JPEG 2000, extension: JP2.
25-99Reserved for image format and encapsulation technologies as defined on the X9 web site. Only supported under agreement.

MICRAuxOnUs
String

A code used on commercial checks at the discretion of the payor bank, read off of the MICR line on a check. This field is part of the Check detail record (type 25), and is 15 characters in length.

MICROnUs
String

Account number data specified by the payor bank and read from the MICR line on a check. On-Us data usually consists of the payor's account number, a serial number or transaction code, or both.

ANS X9.37 requires the collecting bank to capture the entire On-Us field from the physical check. Blanks are to be suppressed, dashes are optional, and each On-Us symbol must be translated to a forward slash ('/'). This field is part of the Check detail record (type 25), and is 20 characters in length.

MICRProcessingCode
String

The external processing code from the MICR line of a check, if present. This is also known as "Position 44",. and is used for special purposes as authorized by the Accredited Standards Committee X9. This field is part of the Check detail record (type 25), and is 1 character in length.

MICRRoutingNumber
String

Payor bank routing number, read from the MICR line of a check. This number identifies the institution by or through which the item is payable. This field is part of the Check detail record (type 25), and is exactly 9 characters long, including the check digit.

PayeeName
String

The name of the payee from the check. This field is part of the Check Detail Addendum A record (type 26), and is 15 characters in length.

SequenceNumber
String

ECE Institution Item Sequence Number, assigned by the institution that creates the file. The ECE institution must construct the sequence number to guarantee uniqueness for a given RoutingNumber, BusinessDate, and CycleNumber. This field is part of the Check detail record (type 25) and Image View Data Record (type 52), and is 15 characters in length.

Constructors

[VB.NET]
Public CheckDetail()

[C#]
public CheckDetail();



 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 6.0.6240.0