Check21 Component

Properties   Methods   Events   Config Settings   Errors  

The Check21 component is used to construct a file containing scanned images of paper checks, and optionally upload it to an FTPS server.

Syntax

TibpCheck21

Remarks

An X9.37 file created by this component will contain the following records:

• File Header Record (1)
• Cash Letter Header Record (1)
• Bundle Header Record (1)
• Check detail record structure (0 to CheckCount), which contains:
  • Check Detail Record (1)
  • Check Detail Addenda A (1)
  • Front Image View Detail Record (0 or 1)
  • Front Image View Data Record (0 or 1)
  • Back Image View Detail Record (0 or 1)
  • Back Image View Data Record (0 or 1)
• Bundle Control Record (1)
• Cash Letter Control Record (1)
• File Control Record (1)

This component makes creating the above file very easy. First set the Origin properties with information about the institution that is originating this file, and the destination it is to be deposited to. Also set the ReturnRoutingNumber. Check21.OriginName = "First Bank of Thor" Check21.OriginRoutingNumber = "111012822" Check21.OriginContactName = "Jake Olsen" Check21.OriginContactPhone = "800-555-5555" Check21.DestinationRoutingNumber = "051000321" Check21.DestinationName = "First Bank of Loki" Check21.ReturnRoutingNumber = "111012822" This file must be differentiated from other files, so now set the CashLetterId and CycleNumber properties, as well as the FileName. (Alternatively FileName may be left empty, and the component will write the file to memory and store it in the FileData property).

Check21.CashLetterId = "123456" Check21.CycleNumber = "01" Check21.FileName = "sample_output.dat" This file is going to contain scanned images of paper checks, so RecordType should be set to rtChecksAndImages and make sure the DocumentationType is set to a compatible value ("G" through "J" are valid when RecordType is rtChecksAndImages). Check21.RecordType = rtChecksAndImages Check21.DocumentationType = "G" This sample file is to contain only one check, but a real file may contain any number of checks. To add a check, set the CheckCount, and then fill the Check array properties with information read off the check's MICR line, as well as the Payee's name and the amount of the check. Check21.CheckCount = 1 Check21.CheckMICROnUs(0) = "1234567890101" ' Account number on the check Check21.CheckMICRRoutingNumber(0) = "902113700" Check21.CheckAmount(0) = "50000" ' $500.00 Check21.CheckSequenceNumber(0) = "407" Check21.CheckPayeeName = "Bruce Banner" Then set information about the Bank of First Deposit. This may be identical to the Origin. The BOFDConversionIndicator should also be set to "2" if this bank converted the original check into the image being included. Check21.CheckBOFDRoutingNumber(0) = "111012822" Check21.CheckBOFDAccountNumber(0) = "181818181818181818" Check21.CheckBOFDBranch(0) = "Asgard" Check21.CheckBOFDConversionIndicator(0) = "2" Finally, you must include images of the front and back of the check, and indicate the format and compression used to create those images. You may use FrontImageFileName and BackImageFileName properties to point to image files on disk, or you may set the binary data directly in FrontImageData and BackImageData. You also need to set a unique identifier that can be used to retrieve the images at a later date. Check21.CheckImageFormat(0) = ifTIFF ' default Check21.CheckImageCompression(0) = icJPEG ' default Check21.CheckCanRecreateImages(0) = True ' default Check21.CheckFrontImageFileName(0) = "front.jpg" Check21.CheckFrontImageReferenceKey(0) = "72234215front" Check21.CheckBackImageFileName(0) = "back.jpg" Check21.CheckBackImageReferenceKey(0) = "72234215back" Now call BuildFile to build the file and save it to the FileName you indicated earlier. If you have an FTPS server (TLS/SSL-secured FTP) to upload the files to, you may set the FTP properties and call BuildAndUploadFile method instead.

Property List

---

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

BusinessDate Property (Check21 Component)

The year, month, and day that designates the business date at the Bank of First Deposit.

Syntax

property BusinessDate: String read get_BusinessDate write set_BusinessDate;

Default Value

''

Remarks

This property is 8 characters in length and in the format "YYYYMMDD". If no value is supplied in this property the current system date will be used.

This property is part of the Cash Letter Header record (type 10), Bundle Header record (type 20), Check Detail Addendum A record (type 26), and Image View Data record (type 52).

CashLetterId Property (Check21 Component)

A code used to uniquely identify the cash letter inside the file.

Syntax

property CashLetterId: String read get_CashLetterId write set_CashLetterId;

Default Value

''

Remarks

This code identifies the cash letter, and is assigned by the institution that creates the file. This property is part of the Cash Letter Header record (type 10), and is 8 characters in length. The same value will also be used in the Bundle Header Record (type 20) for the "Bundle Id".

Checks Property (Check21 Component)

Collection of checks to be written to the file.

Syntax

property Checks: TibpCheckDetailList read get_Checks write set_Checks;

Remarks

This property contains a collection of CheckDetail objects. Each of those objects must include 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. Each check object may also optionally contain a scan of the front and back of the paper check.

This property is not available at design time.

Please refer to the CheckDetail type for a complete list of fields.

CollectionType Property (Check21 Component)

A code that indicates the type of cash letter and bundle contained in the file.

Syntax

property CollectionType: TibpCollectionTypes read get_CollectionType write set_CollectionType;

TibpCollectionTypes = (
  ctForwardInfo,
  ctFowardPresentment,
  ctForwardSameDay,
  ctNoDetail
);

Default Value

ctForwardInfo

Remarks

This property is part of the Cash Letter Header record (type 10), and is exactly 2 characters in length. Valid values for this property are listed below.

CycleNumber Property (Check21 Component)

Denotes the cycle under which the file is created.

Syntax

property CycleNumber: String read get_CycleNumber write set_CycleNumber;

Default Value

''

Remarks

This code is assigned by the institution that creates the file. This property is part of the Bundle Header record (type 20) and Image View Data record (type 52).

DestinationName Property (Check21 Component)

The short name that identifies the institution that receives the file.

Syntax

property DestinationName: String read get_DestinationName write set_DestinationName;

Default Value

''

Remarks

This property is part of the File Header record (type 01), and is exactly 9 characters long, including the check digit.

DestinationRoutingNumber Property (Check21 Component)

This number identifies the institution that receives the file.

Syntax

property DestinationRoutingNumber: String read get_DestinationRoutingNumber write set_DestinationRoutingNumber;

Default Value

''

Remarks

This property is part of the File Header record (type 01), Cash Letter Header Record (type 10), and Bundle Header Record (type 20), and is exactly 9 characters long including the check digit.

DocumentationType Property (Check21 Component)

A code that indicates the type of documentation that supports all Checks records in the file.

Syntax

property DocumentationType: String read get_DocumentationType write set_DocumentationType;

Default Value

''

Remarks

This property is part of the Cash Letter record (type 10) and Check detail record (type 25), and may be any of the values listed below:

FileData Property (Check21 Component)

Contains the binary contents of the X9.37 file created by the BuildFile method.

Syntax

property FileData: String read get_FileData;
property FileDataB: TBytes read get_FileDataB;

Default Value

''

Remarks

If FileName is specified BuildFile will save to disk, and FileData will remain empty. However if FileName is blank, the file will be created in-memory and stored in this property.

This property is read-only.

FileName Property (Check21 Component)

Path and name of the file to be written to disk by the BuildFile method.

Syntax

property FileName: String read get_FileName write set_FileName;

Default Value

''

Remarks

If FileName is blank, the BuildFile method will create the file in-memory and store it in the FileData property.

When using the BuildAndUploadFile method, FileName is used slightly different. If a path and filename is specified, the file will be written to disk and uploaded to the RemoteHost. If FileName contains only a path (and ends in "/" or "\"), that directory will be used to store temporary files before uploading to the RemoteHost. If FileName is blank the system temp directory will be used. All temporary files are deleted after a successful upload.

FTP Property (Check21 Component)

Information about the FTP or FTPS server you're uploading to.

Syntax

property FTP: TibpFTPSettings read get_FTP write set_FTP;

Remarks

These ftp fields are only necessary when using the BuildAndUploadFile method to upload an X9.37 file to an FTP or FTPS server. The RemoteHost and RemotePath fields specify the server you wish to connect to. RemotePath contains the path at which you wish to save the file, and RemoteFile indicates the filename that will be saved on the FTP server after upload. (It does not have to match the FileName property). User and Password contain your logon credentials for the FTP server.

This property is not available at design time.

Please refer to the FTPSettings type for a complete list of fields.

Origin Property (Check21 Component)

Contains information about the originator of this file and the checks contained within.

Syntax

property Origin: TibpOrigin read get_Origin write set_Origin;

Remarks

These fields are used in many places in the different records that make up an X9.37 file.

This property is not available at design time.

Please refer to the Origin type for a complete list of fields.

RecordType Property (Check21 Component)

A code that indicates the type of records contained in this file.

Syntax

property RecordType: TibpRecordTypes read get_RecordType write set_RecordType;

TibpRecordTypes = (
  rtNoChecks,
  rtChecksNoImages,
  rtChecksAndImages,
  rtImagesForCashLetter
);

Default Value

rtNoChecks

Remarks

If an image is associated with any (even one) CheckDetail detail record, this property must be set to rtChecksAndImages or rtImagesForCashLetter. This property is part of the Cash Letter record (type 10) and may be set to any of the values listed below:

ReturnRoutingNumber Property (Check21 Component)

A routing number indicating the location to which returns and return notifications should be sent.

Syntax

property ReturnRoutingNumber: String read get_ReturnRoutingNumber write set_ReturnRoutingNumber;

Default Value

''

Remarks

This routing number is specified by the institution that creates the file, and specifies the location to which returns, return notifications, and preliminary return notifications should be sent. This property is part of the Bundle Header record (type 20), and is exactly 9 characters long including the check digit.

SettlementDate Property (Check21 Component)

The date that the institution that created the file expects settlement.

Syntax

property SettlementDate: String read get_SettlementDate write set_SettlementDate;

Default Value

''

Remarks

This property is part of the Cash Letter Control record (type 90), and is in the format YYYYMMDD.

SSLAcceptServerCert Property (Check21 Component)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

property SSLAcceptServerCert: TibpCertificate read get_SSLAcceptServerCert write set_SSLAcceptServerCert;

Remarks

If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Please refer to the Certificate type for a complete list of fields.

SSLCert Property (Check21 Component)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

property SSLCert: TibpCertificate read get_SSLCert write set_SSLCert;

Remarks

This property includes the digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Please refer to the Certificate type for a complete list of fields.

SSLProvider Property (Check21 Component)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

property SSLProvider: TibpTSSLProviders read get_SSLProvider write set_SSLProvider;

TibpTSSLProviders = (
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
);

Default Value

sslpAutomatic

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

Additional Notes

In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.

When Automatic is selected, on Windows, the component will use the platform implementation. On Linux/macOS, the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

SSLServerCert Property (Check21 Component)

The server certificate for the last established connection.

Syntax

property SSLServerCert: TibpCertificate read get_SSLServerCert;

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Please refer to the Certificate type for a complete list of fields.

SSLStartMode Property (Check21 Component)

This property determines how the component starts the Secure Sockets Layer (SSL) negotiation.

Syntax

property SSLStartMode: TibpTSSLStartModes read get_SSLStartMode write set_SSLStartMode;

TibpTSSLStartModes = (
  sslAutomatic,
  sslImplicit,
  sslExplicit,
  sslNone
);

Default Value

sslNone

Remarks

The SSLStartMode property may have one of the following values:

BuildAndUploadFile Method (Check21 Component)

Builds an X9.37 file and uploads it to an FTP server.

Syntax

procedure BuildAndUploadFile();

Remarks

This method builds a complete X9.37 file and uploads it to the server specified in the RemoteHost property. If an FileName is specified, it will be saved on the local disc as well. If FileName contains only a path (FileName must terminate in a "/" or "\"), that path will be used to create a temporary file which will be deleted after the upload. If FileName is empty, the system temp directory will be used for creating the temporary file.

An X9.37 file created by this component will contain the following records:

• File Header Record (1)
• Cash Letter Header Record (1)
• Bundle Header Record (1)
• Check detail record structure (0 to CheckCount), which contains:
  • Check Detail Record (1)
  • Check Detail Addenda A (1)
  • Front Image View Detail Record (0 or 1)
  • Front Image View Data Record (0 or 1)
  • Back Image View Detail Record (0 or 1)
  • Back Image View Data Record (0 or 1)
• Bundle Control Record (1)
• Cash Letter Control Record (1)
• File Control Record (1)

BuildFile Method (Check21 Component)

Builds an X9.37 file.

Syntax

procedure BuildFile();

Remarks

This method builds a complete X9.37 file. If the FileName is specified, the file will be saved to the path and filename indicated there. If no FileName is given, the resultant file will be stored in memory, and can be accessed in the FileData property.

An X9.37 file created by this component will contain the following records:

• File Header Record (1)
• Cash Letter Header Record (1)
• Bundle Header Record (1)
• Check detail record structure (0 to CheckCount), which contains:
  • Check Detail Record (1)
  • Check Detail Addenda A (1)
  • Front Image View Detail Record (0 or 1)
  • Front Image View Data Record (0 or 1)
  • Back Image View Detail Record (0 or 1)
  • Back Image View Data Record (0 or 1)
• Bundle Control Record (1)
• Cash Letter Control Record (1)
• File Control Record (1)

Config Method (Check21 Component)

Sets or retrieves a configuration setting.

Syntax

function Config(ConfigurationString: String): String;

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DoEvents Method (Check21 Component)

This method processes events from the internal message queue.

Syntax

procedure DoEvents();

Remarks

When DoEvents is called, the component processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Interrupt Method (Check21 Component)

This method interrupts the current method.

Syntax

procedure Interrupt();

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

Reset Method (Check21 Component)

Reset the internal state of the component and all properties to their default values.

Syntax

procedure Reset();

Remarks

The Reset method doesn't have any parameters and doesn't return any value.

Error Event (Check21 Component)

Information about non-fatal errors encountered during file construction.

Syntax

type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent read FOnError write FOnError;

Remarks

The Error event is fired to warn the user that it may be operating differently than the user expects. For instance, if the CollectionType is set to ctNoDetail, but check detail records are provided in the Checks array properties the component will fire this event indicating that the specified Checks were ignored.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

SSLServerAuthentication Event (Check21 Component)

Fired after the server presents its certificate to the client.

Syntax

type TSSLServerAuthenticationEvent = procedure (
  Sender: TObject;
  const CertEncoded: String;
  const CertEncodedB: TBytes;
  const CertSubject: String;
  const CertIssuer: String;
  const Status: String;
  var Accept: Boolean
) of Object;

property OnSSLServerAuthentication: TSSLServerAuthenticationEvent read FOnSSLServerAuthentication write FOnSSLServerAuthentication;

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (Check21 Component)

Fired when secure connection progress messages are available.

Syntax

type TSSLStatusEvent = procedure (
  Sender: TObject;
  const Message: String
) of Object;

property OnSSLStatus: TSSLStatusEvent read FOnSSLStatus write FOnSSLStatus;

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Status Event (Check21 Component)

Traces the commands sent to the server, and the respective replies.

Syntax

type TStatusEvent = procedure (
  Sender: TObject;
  const Message: String
) of Object;

property OnStatus: TStatusEvent read FOnStatus write FOnStatus;

Remarks

The Status event is useful for debugging purposes. It shows all the interaction between the client and the server, line by line.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

• EffectiveDate
• ExpirationDate
• ExtendedKeyUsage
• Fingerprint
• FingerprintSHA1
• FingerprintSHA256
• Issuer
• PrivateKey
• PrivateKeyAvailable
• PrivateKeyContainer
• PublicKey
• PublicKeyAlgorithm
• PublicKeyLength
• SerialNumber
• SignatureAlgorithm
• Store
• StorePassword
• StoreType
• SubjectAltNames
• ThumbprintMD5
• ThumbprintSHA1
• ThumbprintSHA256
• Usage
• UsageFlags
• Version
• Subject
• Encoded

Fields

Constructors

>

constructor Create();

>

constructor Create(valEncoded: TBytes);

>

constructor Create(valStoreType: TibpCertStoreTypes; valStore: String; valStorePassword: String; valSubject: String);

>

constructor Create(valStoreType: TibpCertStoreTypes; valStore: TBytes; valStorePassword: String; valSubject: String);

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.

• Amount
• BackImageCreationDate
• BackImageData
• BackImageFileName
• BackImageReferenceKey
• BOFDAccountNumber
• BOFDBranch
• BOFDConversionIndicator
• BOFDRoutingNumber
• BOFDTruncator
• CanRecreateImages
• FrontImageCreationDate
• FrontImageData
• FrontImageFileName
• FrontImageReferenceKey
• ImageCompression
• ImageCreatorRoutingNumber
• ImageFormat
• MICRAuxOnUs
• MICROnUs
• MICRProcessingCode
• MICRRoutingNumber
• PayeeName
• SequenceNumber

Fields

Constructors

constructor Create();

FTPSettings Type

Used to connect to an FTP or FTPS server for uploading X9.37 files.

Remarks

These ftp fields are only necessary when uploading an X9.37 file to an FTP or FTPS server. The RemoteHost and RemotePath fields specify the server you wish to connect to. RemotePath contains the path at which you wish to save the file, and RemoteFile indicates the filename that will be saved on the FTP server after upload. (It does not have to match the FileName property). User and Password contain your logon credentials for the FTP server.

• Password
• RemoteFile
• RemoteHost
• RemotePath
• RemotePort
• Timeout
• User

Fields

Constructors

constructor Create();

Origin Type

Specifies the originator of a file and the checks contained within.

Remarks

These fields are used in many places in the different records that make up an X9.37 file.

• ContactName
• ContactPhone
• OriginName
• RoutingNumber

Fields

Constructors

constructor Create();

constructor Create(valOriginName: String; valRoutingNumber: String; valContactName: String; valContactPhone: String);

Config Settings (Check21 Component)

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

Check21 Config Settings

Base Config Settings

Trappable Errors (Check21 Component)

Check21 Errors

The component may also return one of the following error codes, which are inherited from other components.