Check21 Class

Properties Methods Events Config Settings Errors

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

Class Name

InPay_Check21

Procedural Interface

 inpay_check21_open();
 inpay_check21_close($res);
 inpay_check21_register_callback($res, $id, $function);
 inpay_check21_get_last_error($res);
 inpay_check21_get_last_error_code($res);
 inpay_check21_set($res, $id, $index, $value);
 inpay_check21_get($res, $id, $index);
 inpay_check21_do_buildanduploadfile($res);
 inpay_check21_do_buildfile($res);
 inpay_check21_do_config($res, $configurationstring);
 inpay_check21_do_doevents($res);
 inpay_check21_do_interrupt($res);
 inpay_check21_do_reset($res);

Remarks

An X9.37 file created by this class 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 class 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 class 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 CheckBOFDConversionIndicator 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 CheckFrontImageFilename and CheckBackImageFilename properties to point to image files on disk, or you may set the binary data directly in CheckFrontImageData and CheckBackImageData. 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 class with short descriptions. Click on the links for further details.


BusinessDate	The year, month, and day that designates the business date at the Bank of First Deposit.
CashLetterId	A code used to uniquely identify the cash letter inside the file.
CheckCount	The number of records in the Check arrays.
CheckAmount	The US dollar value of the check.
CheckBackImageCreationDate	Date assigned by the image creator for the image contained in BackImageData .
CheckBackImageData	This property contains the scanned image of the back of the physical check, in the format specified by ImageFormat and compressed using the designated ImageCompression .
CheckBackImageFilename	This property 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 .
CheckBackImageReferenceKey	A designator assigned by the ECE institution that uniquely identifies the BackImageData .
CheckBOFDAccountNumber	A number that identifies the depository account at the Bank of First Deposit.
CheckBOFDBranch	A code that identifies the branch at the Bank of First Deposit.
CheckBOFDConversionIndicator	A code that indicates the conversion within the processing institution between original paper check, image, and IRD.
CheckBOFDRoutingNumber	A number that identifies the Bank of First Deposit.
CheckBOFDTruncator	Identifies if this BOFD is the truncator of the original check.
CheckCanRecreateImages	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.
CheckFrontImageCreationDate	Date assigned by the image creator for the image contained in FrontImageData .
CheckFrontImageData	This property contains the scanned image of the front of the physical check, in the format specified by ImageFormat and compressed using the designated ImageCompression .
CheckFrontImageFilename	This property 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 .
CheckFrontImageReferenceKey	A designator assigned by the ECE institution that uniquely identifies the FrontImageData .
CheckImageCompression	A code that identifies the algorithm or method used to compress the images stored in the FrontImageData and BackImageData properties.
CheckImageCreatorRoutingNumber	A number that identifies the financial institution that created the image (if different from BOFDRoutingNumber ).
CheckImageFormat	A code that identifies the type of image format used for the images contained in the FrontImageData and BackImageData properties.
CheckMICRAuxOnUs	A code used on commercial checks at the discretion of the payor bank, read off of the MICR line on a check.
CheckMICROnUs	Account number data specified by the payor bank and read from the MICR line on a check.
CheckMICRProcessingCode	The external processing code from the MICR line of a check, if present.
CheckMICRRoutingNumber	Payor bank routing number, read from the MICR line of a check.
CheckPayeeName	The name of the payee from the check.
CheckSequenceNumber	ECE Institution Item Sequence Number, assigned by the institution that creates the file.
CollectionType	A code that indicates the type of cash letter and bundle contained in the file.
CycleNumber	Denotes the cycle under which the file is created.
DestinationName	The short name that identifies the institution that receives the file.
DestinationRoutingNumber	This number identifies the institution that receives the file.
DocumentationType	A code that indicates the type of documentation that supports all Checks records in the file.
FileData	Contains the binary contents of the X9.37 file created by the BuildFile method.
Filename	Path and name of the file to be written to disk by the BuildFile method.
FTPPassword	The password to login with.
FTPRemoteFile	The name of the file as it will appear on the server after upload.
FTPRemoteHost	The domain name or IP address of the FTP server the file is to be uploaded to.
FTPRemotePath	The current path on the FTP server.
FTPRemotePort	The port for the FTP service (default is 21).
FTPTimeout	A timeout to use when uploading via FTP.
FTPUser	The user id to login as.
OriginContactName	A contact at the institution that creates the file.
OriginContactPhone	The phone number of the ContactName at the institution that created the file.
OriginName	The short name of the ECE institution that created the file.
OriginRoutingNumber	A number that identifies the ECE institution that originates the file.
RecordType	A code that indicates the type of records contained in this file.
ReturnRoutingNumber	A routing number indicating the location to which returns and return notifications should be sent.
SettlementDate	The date that the institution that created the file expects settlement.
SSLAcceptServerCertEncoded	This is the certificate (PEM/base64 encoded).
SSLCertEncoded	This is the certificate (PEM/base64 encoded).
SSLCertStore	This is the name of the certificate store for the client certificate.
SSLCertStorePassword	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreType	This is the type of certificate store for this certificate.
SSLCertSubject	This is the subject of the certificate used for client authentication.
SSLProvider	This specifies the SSL/TLS implementation to use.
SSLServerCertEncoded	This is the certificate (PEM/base64 encoded).
SSLStartMode	Determines how the class starts the SSL negotiation.

Method List

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


BuildAndUploadFile	Builds an X9.37 file and uploads it to an FTP server.
BuildFile	Builds an X9.37 file.
Config	Sets or retrieves a configuration setting.
DoEvents	Processes events from the internal message queue.
Interrupt	Interrupt the current method.
Reset	Reset the internal state of the class and all properties to their default values.

Event List

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


Error	Information about non-fatal errors encountered during file construction.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.
Status	Traces the commands sent to the server, and the respective replies.

Config Settings

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


AllowAllBOFDIndicators	Allows for any value to be specified within the BOFDIndicator field.
ArchiveType	Indicates the type of archive that supports each Check in this file.
ASCIIOutput	Indicates whether to output ASCII or EBCDIC.
BOFDIndicator	Indicates whether the origin is also the bank of first deposit.
BundleCount	Total number of bundles in the file.
BundleCreationDate	The date the bundle is created.
BundleId	Unique identifier for the bundle inside the Cash Letter.
BundleIndex	Index of the current bundle.
CashLetterCreationDate	The date the cash letter is created.
CashLetterCreationTime	The time the cash letter is created.
CheckIsCredit[i]	Indicates whether a Check is to be sent as a Credit (61) Record.
CountryCode	A code that identifies the country in which the payor bank is located.
DetailAddendumRecordNumber	The Check Detail Addendum A Record Number.
FedWorkType	Federal Reserve work type.
FileCreationDate	The date the file is created.
FileCreationTime	The time the file is created.
FileId	A code used to uniquely identify this file.
FileUserField	A User Field.
IncludeAddendA	Whether to include Detail Addendum A Record.
Overwrite	Indicates whether local files can be overwritten.
OverwriteRemoteFile	Indicates whether remote files can be overwritten on the FTP server.
ResendIndicator	Indicates whether the file being built has been previously transmitted in its entirety.
ReservedField	A field reserved for future use.
ReturnAcceptance	A code that indicates whether the institution that creates this file will or will not support electronic return processing.
TestFile	Indicates whether the file being built is a test file or a production file.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitive	Whether sensitive data is masked in log messages.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Tells the class whether or not to use the system security libraries or an internal implementation.

BusinessDate Property (InPay_Check21 Class)

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

Object Oriented Interface


public function getBusinessDate();


public function setBusinessDate($value);

Procedural Interface


inpay_check21_get($res, 1 );


inpay_check21_set($res, 1, $value );

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).

Data Type

String

CashLetterId Property (InPay_Check21 Class)

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

Object Oriented Interface


public function getCashLetterId();


public function setCashLetterId($value);

Procedural Interface


inpay_check21_get($res, 2 );


inpay_check21_set($res, 2, $value );

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".

Data Type

String

CheckCount Property (InPay_Check21 Class)

The number of records in the Check arrays.

Object Oriented Interface


public function getCheckCount();


public function setCheckCount($value);

Procedural Interface


inpay_check21_get($res, 3 );


inpay_check21_set($res, 3, $value );

Default Value

Remarks

This property controls the size of the following arrays:

CheckAmount
CheckBackImageCreationDate
CheckBackImageData
CheckBackImageFilename
CheckBackImageReferenceKey
CheckBOFDAccountNumber
CheckBOFDBranch
CheckBOFDConversionIndicator
CheckBOFDRoutingNumber
CheckBOFDTruncator
CheckCanRecreateImages
CheckFrontImageCreationDate
CheckFrontImageData
CheckFrontImageFilename
CheckFrontImageReferenceKey
CheckImageCompression
CheckImageCreatorRoutingNumber
CheckImageFormat
CheckMICRAuxOnUs
CheckMICROnUs
CheckMICRProcessingCode
CheckMICRRoutingNumber
CheckPayeeName
CheckSequenceNumber

The array indices start at 0 and end at CheckCount - 1.

This property is not available at design time.

Data Type

Integer

CheckAmount Property (InPay_Check21 Class)

The US dollar value of the check.

Object Oriented Interface


public function getCheckAmount($checkindex);


public function setCheckAmount($checkindex, $value);

Procedural Interface


inpay_check21_get($res, 4 , $checkindex);


inpay_check21_set($res, 4, $value , $checkindex);

Default Value

Remarks

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

The $checkindex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckBackImageCreationDate Property (InPay_Check21 Class)

Date assigned by the image creator for the image contained in BackImageData .

Object Oriented Interface


public function getCheckBackImageCreationDate($checkindex);


public function setCheckBackImageCreationDate($checkindex, $value);

Procedural Interface


inpay_check21_get($res, 5 , $checkindex);


inpay_check21_set($res, 5, $value , $checkindex);

Default Value

Remarks

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

The $checkindex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckBackImageData Property (InPay_Check21 Class)

This property contains the scanned image of the back of the physical check, in the format specified by ImageFormat and compressed using the designated ImageCompression .

Object Oriented Interface


public function getCheckBackImageData($checkindex);


public function setCheckBackImageData($checkindex, $value);

Procedural Interface


inpay_check21_get($res, 6 , $checkindex);


inpay_check21_set($res, 6, $value , $checkindex);

Default Value

Remarks

This property contains the scanned image of the back of the physical check, in the format specified by CheckImageFormat and compressed using the designated CheckImageCompression. You may either specify the raw binary image data in this property, or specify the path and filename of an image on disk in the CheckBackImageFilename property. If both are specified CheckBackImageData will be used. If both properties are left empty, no records referencing the back image of the check will be added to the file.

The $checkindex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

Binary String

CheckBackImageFilename Property (InPay_Check21 Class)

This property 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 .

Object Oriented Interface


public function getCheckBackImageFilename($checkindex);


public function setCheckBackImageFilename($checkindex, $value);

Procedural Interface


inpay_check21_get($res, 7 , $checkindex);


inpay_check21_set($res, 7, $value , $checkindex);

Default Value

Remarks

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

The $checkindex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckBackImageReferenceKey Property (InPay_Check21 Class)

A designator assigned by the ECE institution that uniquely identifies the BackImageData .

Object Oriented Interface


public function getCheckBackImageReferenceKey($checkindex);


public function setCheckBackImageReferenceKey($checkindex, $value);

Procedural Interface


inpay_check21_get($res, 8 , $checkindex);


inpay_check21_set($res, 8, $value , $checkindex);

Default Value

Remarks

A designator assigned by the ECE institution that uniquely identifies the CheckBackImageData. 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.

The $checkindex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckBOFDAccountNumber Property (InPay_Check21 Class)

A number that identifies the depository account at the Bank of First Deposit.

Object Oriented Interface


public function getCheckBOFDAccountNumber($checkindex);


public function setCheckBOFDAccountNumber($checkindex, $value);

Procedural Interface


inpay_check21_get($res, 9 , $checkindex);


inpay_check21_set($res, 9, $value , $checkindex);

Default Value

Remarks

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

The $checkindex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckBOFDBranch Property (InPay_Check21 Class)

A code that identifies the branch at the Bank of First Deposit.

Object Oriented Interface


public function getCheckBOFDBranch($checkindex);


public function setCheckBOFDBranch($checkindex, $value);

Procedural Interface


inpay_check21_get($res, 10 , $checkindex);


inpay_check21_set($res, 10, $value , $checkindex);

Default Value

Remarks

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

The $checkindex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckBOFDConversionIndicator Property (InPay_Check21 Class)

A code that indicates the conversion within the processing institution between original paper check, image, and IRD.

Object Oriented Interface


public function getCheckBOFDConversionIndicator($checkindex);


public function setCheckBOFDConversionIndicator($checkindex, $value);

Procedural Interface


inpay_check21_get($res, 11 , $checkindex);


inpay_check21_set($res, 11, $value , $checkindex);

Default Value

Remarks

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 property is part of the Check Detail Addendum A record (type 26), and may be set to one of the following values:


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

The $checkindex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckBOFDRoutingNumber Property (InPay_Check21 Class)

A number that identifies the Bank of First Deposit.

Object Oriented Interface


public function getCheckBOFDRoutingNumber($checkindex);


public function setCheckBOFDRoutingNumber($checkindex, $value);

Procedural Interface


inpay_check21_get($res, 12 , $checkindex);


inpay_check21_set($res, 12, $value , $checkindex);

Default Value

Remarks

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

The $checkindex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckBOFDTruncator Property (InPay_Check21 Class)

Identifies if this BOFD is the truncator of the original check.

Object Oriented Interface


public function getCheckBOFDTruncator($checkindex);


public function setCheckBOFDTruncator($checkindex, $value);

Procedural Interface


inpay_check21_get($res, 13 , $checkindex);


inpay_check21_set($res, 13, $value , $checkindex);

Default Value

true

Remarks

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

The $checkindex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

Boolean

CheckCanRecreateImages Property (InPay_Check21 Class)

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.

Object Oriented Interface


public function getCheckCanRecreateImages($checkindex);


public function setCheckCanRecreateImages($checkindex, $value);

Procedural Interface


inpay_check21_get($res, 14 , $checkindex);


inpay_check21_set($res, 14, $value , $checkindex);

Default Value

true

Remarks

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.

The $checkindex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

Boolean

CheckFrontImageCreationDate Property (InPay_Check21 Class)

Date assigned by the image creator for the image contained in FrontImageData .

Object Oriented Interface


public function getCheckFrontImageCreationDate($checkindex);


public function setCheckFrontImageCreationDate($checkindex, $value);

Procedural Interface


inpay_check21_get($res, 15 , $checkindex);


inpay_check21_set($res, 15, $value , $checkindex);

Default Value

Remarks

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

The $checkindex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckFrontImageData Property (InPay_Check21 Class)

This property contains the scanned image of the front of the physical check, in the format specified by ImageFormat and compressed using the designated ImageCompression .

Object Oriented Interface


public function getCheckFrontImageData($checkindex);


public function setCheckFrontImageData($checkindex, $value);

Procedural Interface


inpay_check21_get($res, 16 , $checkindex);


inpay_check21_set($res, 16, $value , $checkindex);

Default Value

Remarks

This property contains the scanned image of the front of the physical check, in the format specified by CheckImageFormat and compressed using the designated CheckImageCompression. You may either specify the raw binary image data in this property, or specify the path and filename of an image on disk in the CheckFrontImageFilename property. If both are specified CheckFrontImageData will be used. If both properties are left empty, no records referencing the front image of the check will be added to the file.

The $checkindex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

Binary String

CheckFrontImageFilename Property (InPay_Check21 Class)

This property 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 .

Object Oriented Interface


public function getCheckFrontImageFilename($checkindex);


public function setCheckFrontImageFilename($checkindex, $value);

Procedural Interface


inpay_check21_get($res, 17 , $checkindex);


inpay_check21_set($res, 17, $value , $checkindex);

Default Value

Remarks

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

The $checkindex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckFrontImageReferenceKey Property (InPay_Check21 Class)

A designator assigned by the ECE institution that uniquely identifies the FrontImageData .

Object Oriented Interface


public function getCheckFrontImageReferenceKey($checkindex);


public function setCheckFrontImageReferenceKey($checkindex, $value);

Procedural Interface


inpay_check21_get($res, 18 , $checkindex);


inpay_check21_set($res, 18, $value , $checkindex);

Default Value

Remarks

A designator assigned by the ECE institution that uniquely identifies the CheckFrontImageData. 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.

The $checkindex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckImageCompression Property (InPay_Check21 Class)

A code that identifies the algorithm or method used to compress the images stored in the FrontImageData and BackImageData properties.

Object Oriented Interface


public function getCheckImageCompression($checkindex);


public function setCheckImageCompression($checkindex, $value);

Procedural Interface


inpay_check21_get($res, 19 , $checkindex);


inpay_check21_set($res, 19, $value , $checkindex);

Default Value

Remarks

A code that identifies the algorithm or method used to compress the images stored in the CheckFrontImageData and CheckBackImageData properties. 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 property 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-20	Reserved (agreement is not required)
icPNG (21)	PNG
icJBIG (22)	JBIG
icJPEG2000 (23)	JPEG 2000
24-99	Reserved for emerging image compression technologies as defined on the X9 web site. Only supported under agreement.

The $checkindex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

Integer

CheckImageCreatorRoutingNumber Property (InPay_Check21 Class)

A number that identifies the financial institution that created the image (if different from BOFDRoutingNumber ).

Object Oriented Interface


public function getCheckImageCreatorRoutingNumber($checkindex);


public function setCheckImageCreatorRoutingNumber($checkindex, $value);

Procedural Interface


inpay_check21_get($res, 20 , $checkindex);


inpay_check21_set($res, 20, $value , $checkindex);

Default Value

Remarks

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

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

The $checkindex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckImageFormat Property (InPay_Check21 Class)

A code that identifies the type of image format used for the images contained in the FrontImageData and BackImageData properties.

Object Oriented Interface


public function getCheckImageFormat($checkindex);


public function setCheckImageFormat($checkindex, $value);

Procedural Interface


inpay_check21_get($res, 21 , $checkindex);


inpay_check21_set($res, 21, $value , $checkindex);

Default Value

Remarks

A code that identifies the type of image format used for the images contained in the CheckFrontImageData and CheckBackImageData properties. 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 CheckFrontImageData or CheckBackImageData 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-19	Reserved (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-99	Reserved for image format and encapsulation technologies as defined on the X9 web site. Only supported under agreement.

The $checkindex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

Integer

CheckMICRAuxOnUs Property (InPay_Check21 Class)

A code used on commercial checks at the discretion of the payor bank, read off of the MICR line on a check.

Object Oriented Interface


public function getCheckMICRAuxOnUs($checkindex);


public function setCheckMICRAuxOnUs($checkindex, $value);

Procedural Interface


inpay_check21_get($res, 22 , $checkindex);


inpay_check21_set($res, 22, $value , $checkindex);

Default Value

Remarks

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

The $checkindex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckMICROnUs Property (InPay_Check21 Class)

Account number data specified by the payor bank and read from the MICR line on a check.

Object Oriented Interface


public function getCheckMICROnUs($checkindex);


public function setCheckMICROnUs($checkindex, $value);

Procedural Interface


inpay_check21_get($res, 23 , $checkindex);


inpay_check21_set($res, 23, $value , $checkindex);

Default Value

Remarks

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 property is part of the Check detail record (type 25), and is 20 characters in length.

The $checkindex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckMICRProcessingCode Property (InPay_Check21 Class)

The external processing code from the MICR line of a check, if present.

Object Oriented Interface


public function getCheckMICRProcessingCode($checkindex);


public function setCheckMICRProcessingCode($checkindex, $value);

Procedural Interface


inpay_check21_get($res, 24 , $checkindex);


inpay_check21_set($res, 24, $value , $checkindex);

Default Value

Remarks

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 property is part of the Check detail record (type 25), and is 1 character in length.

The $checkindex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckMICRRoutingNumber Property (InPay_Check21 Class)

Payor bank routing number, read from the MICR line of a check.

Object Oriented Interface


public function getCheckMICRRoutingNumber($checkindex);


public function setCheckMICRRoutingNumber($checkindex, $value);

Procedural Interface


inpay_check21_get($res, 25 , $checkindex);


inpay_check21_set($res, 25, $value , $checkindex);

Default Value

Remarks

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 property is part of the Check detail record (type 25), and is exactly 9 characters long, including the check digit.

The $checkindex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckPayeeName Property (InPay_Check21 Class)

The name of the payee from the check.

Object Oriented Interface


public function getCheckPayeeName($checkindex);


public function setCheckPayeeName($checkindex, $value);

Procedural Interface


inpay_check21_get($res, 26 , $checkindex);


inpay_check21_set($res, 26, $value , $checkindex);

Default Value

Remarks

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

The $checkindex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckSequenceNumber Property (InPay_Check21 Class)

ECE Institution Item Sequence Number, assigned by the institution that creates the file.

Object Oriented Interface


public function getCheckSequenceNumber($checkindex);


public function setCheckSequenceNumber($checkindex, $value);

Procedural Interface


inpay_check21_get($res, 27 , $checkindex);


inpay_check21_set($res, 27, $value , $checkindex);

Default Value

Remarks

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 OriginRoutingNumber, BusinessDate, and CycleNumber. This property is part of the Check detail record (type 25) and Image View Data Record (type 52), and is 15 characters in length.

The $checkindex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CollectionType Property (InPay_Check21 Class)

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

Object Oriented Interface


public function getCollectionType();


public function setCollectionType($value);

Procedural Interface


inpay_check21_get($res, 28 );


inpay_check21_set($res, 28, $value );

Default Value

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.


ctForwardInfo (1)	Preliminary Forward Information - Used when information may change and the information is treated as not final.
ctForwardPresentment (2)	Forward Presentment - For the collection and settlement of checks (demand instruments). Data is treated as final.
ctForwardSameDay (3)	Forward Presentment, Same-Day Settlement - For the collection and settlement of checks (demand instruments) presented under the Federal Reserve's same day settlement amendments to Regulation CC. Data is treated as final.
ctNoDetail (20)	No Detail - There are no checks contained within the file.

Data Type

Integer

CycleNumber Property (InPay_Check21 Class)

Denotes the cycle under which the file is created.

Object Oriented Interface


public function getCycleNumber();


public function setCycleNumber($value);

Procedural Interface


inpay_check21_get($res, 29 );


inpay_check21_set($res, 29, $value );

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).

Data Type

String

DestinationName Property (InPay_Check21 Class)

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

Object Oriented Interface


public function getDestinationName();


public function setDestinationName($value);

Procedural Interface


inpay_check21_get($res, 30 );


inpay_check21_set($res, 30, $value );

Default Value

Remarks

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

Data Type

String

DestinationRoutingNumber Property (InPay_Check21 Class)

This number identifies the institution that receives the file.

Object Oriented Interface


public function getDestinationRoutingNumber();


public function setDestinationRoutingNumber($value);

Procedural Interface


inpay_check21_get($res, 31 );


inpay_check21_set($res, 31, $value );

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.

Data Type

String

DocumentationType Property (InPay_Check21 Class)

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

Object Oriented Interface


public function getDocumentationType();


public function setDocumentationType($value);

Procedural Interface


inpay_check21_get($res, 32 );


inpay_check21_set($res, 32, $value );

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:


A	No image provided, paper provided separately.
B	No image provided, paper provided separately, image upon request.
C	Image provided separately, no paper provided.
D	Image provided separately, no paper provided, image upon request.
E	Image and paper provided separately.
F	Image and paper provided separately, image upon request.
G	Image included, no paper provided.
H	Image included, no paper provided, image upon request.
I	Image included, paper provided separately.
J	Image included, paper provided separately, image upon request.
K	No image provided, no paper provided.
L	No image provided, no paper provided, image upon request.
M	No image provided, Electronic Check provided separately.

Data Type

String

FileData Property (InPay_Check21 Class)

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

Object Oriented Interface


public function getFileData();

Procedural Interface


inpay_check21_get($res, 33 );

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.

Data Type

Binary String

Filename Property (InPay_Check21 Class)

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

Object Oriented Interface


public function getFilename();


public function setFilename($value);

Procedural Interface


inpay_check21_get($res, 34 );


inpay_check21_set($res, 34, $value );

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 FTPRemoteHost. If Filename contains only a path (and ends in "/" or "\"), that directory will be used to store temporary files before uploading to the FTPRemoteHost. If Filename is blank the system temp directory will be used. All temporary files are deleted after a successful upload.

Data Type

String

FTPPassword Property (InPay_Check21 Class)

The password to login with.

Object Oriented Interface


public function getFTPPassword();


public function setFTPPassword($value);

Procedural Interface


inpay_check21_get($res, 35 );


inpay_check21_set($res, 35, $value );

Default Value

Remarks

The password to login with. This property must be set before the class begins a file upload.

This property is not available at design time.

Data Type

String

FTPRemoteFile Property (InPay_Check21 Class)

The name of the file as it will appear on the server after upload.

Object Oriented Interface


public function getFTPRemoteFile();


public function setFTPRemoteFile($value);

Procedural Interface


inpay_check21_get($res, 36 );


inpay_check21_set($res, 36, $value );

Default Value

Remarks

The name of the file as it will appear on the server after upload. The FTPRemoteFile can contain only the file name, an absolute path and filename, or a relative path based on FTPRemotePath.

This property is not available at design time.

Data Type

String

FTPRemoteHost Property (InPay_Check21 Class)

The domain name or IP address of the FTP server the file is to be uploaded to.

Object Oriented Interface


public function getFTPRemoteHost();


public function setFTPRemoteHost($value);

Procedural Interface


inpay_check21_get($res, 37 );


inpay_check21_set($res, 37, $value );

Default Value

Remarks

The domain name or IP address of the FTP server the file is to be uploaded to.

The FTPRemoteHost property specifies the IP address (IP number in dotted internet format) or Domain Name of the FTP server. It is set before a connection is attempted and cannot be changed once a connection is in progress.

If the FTPRemoteHost property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the FTPRemoteHost property is set to the corresponding address. If the search is not successful, an error is returned.

If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

This property is not available at design time.

Data Type

String

FTPRemotePath Property (InPay_Check21 Class)

The current path on the FTP server.

Object Oriented Interface


public function getFTPRemotePath();


public function setFTPRemotePath($value);

Procedural Interface


inpay_check21_get($res, 38 );


inpay_check21_set($res, 38, $value );

Default Value

Remarks

The current path on the FTP server. The FTPRemotePath shows the current working directory on the FTP server. It can also be used to change the working directory by setting it to an absolute directory path, or a relative path with respect to the existing value of FTPRemotePath.

If the first two bytes of the new path are "..", then a change to one level above in the directory tree is performed.

The FTPRemotePath must be set before the class begins a file upload.

This property is not available at design time.

Data Type

String

FTPRemotePort Property (InPay_Check21 Class)

The port for the FTP service (default is 21).

Object Oriented Interface


public function getFTPRemotePort();


public function setFTPRemotePort($value);

Procedural Interface


inpay_check21_get($res, 39 );


inpay_check21_set($res, 39, $value );

Default Value

Remarks

The port for the FTP service (default is 21). A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

This property is not available at design time.

Data Type

Integer

FTPTimeout Property (InPay_Check21 Class)

A timeout to use when uploading via FTP.

Object Oriented Interface


public function getFTPTimeout();


public function setFTPTimeout($value);

Procedural Interface


inpay_check21_get($res, 40 );


inpay_check21_set($res, 40, $value );

Default Value

Remarks

A timeout to use when uploading via FTP.

When uploading the X9.37 file to the FTP FTPRemoteHost, the class will use this property to determine how long to wait for the operation to complete before returning control. The FTPTimeout property cannot be set to 0

The default value for the Timeout property is 60 (seconds).

This property is not available at design time.

Data Type

Integer

FTPUser Property (InPay_Check21 Class)

The user id to login as.

Object Oriented Interface


public function getFTPUser();


public function setFTPUser($value);

Procedural Interface


inpay_check21_get($res, 41 );


inpay_check21_set($res, 41, $value );

Default Value

Remarks

The user id to login as. This property must be set before the class begins a file upload.

This property is not available at design time.

Data Type

String

OriginContactName Property (InPay_Check21 Class)

A contact at the institution that creates the file.

Object Oriented Interface


public function getOriginContactName();


public function setOriginContactName($value);

Procedural Interface


inpay_check21_get($res, 42 );


inpay_check21_set($res, 42, $value );

Default Value

Remarks

A contact at the institution that creates the file. This property is part of the File Control record (type 99), and is 14 characters in length.

This property is not available at design time.

Data Type

String

OriginContactPhone Property (InPay_Check21 Class)

The phone number of the ContactName at the institution that created the file.

Object Oriented Interface


public function getOriginContactPhone();


public function setOriginContactPhone($value);

Procedural Interface


inpay_check21_get($res, 43 );


inpay_check21_set($res, 43, $value );

Default Value

Remarks

The phone number of the OriginContactName at the institution that created the file. This property is part of the Cash Letter Header record (type 10) and File Control record (type 99), and is 10 characters in length.

This property is not available at design time.

Data Type

String

OriginName Property (InPay_Check21 Class)

The short name of the ECE institution that created the file.

Object Oriented Interface


public function getOriginName();


public function setOriginName($value);

Procedural Interface


inpay_check21_get($res, 44 );


inpay_check21_set($res, 44, $value );

Default Value

Remarks

The short name of the ECE institution that created the file. This property is part of the Cash Letter Header record (type 10) and Cash Letter Control record (type 90), and is 14 characters in length.

This property is not available at design time.

Data Type

String

OriginRoutingNumber Property (InPay_Check21 Class)

A number that identifies the ECE institution that originates the file.

Object Oriented Interface


public function getOriginRoutingNumber();


public function setOriginRoutingNumber($value);

Procedural Interface


inpay_check21_get($res, 45 );


inpay_check21_set($res, 45, $value );

Default Value

Remarks

A number that identifies the ECE institution that originates the file. This property is part of the File Header record (type 01) and Cash Letter Header record (type 10), and Bundle Header record (type 20), and is exactly 9 characters long including the check digit.

This property is not available at design time.

Data Type

String

RecordType Property (InPay_Check21 Class)

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

Object Oriented Interface


public function getRecordType();


public function setRecordType($value);

Procedural Interface


inpay_check21_get($res, 46 );


inpay_check21_set($res, 46, $value );

Default Value

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:


rtNoChecks	No electronic check records or image records. (only applicable for an empty cash letter with no Checks.)
rtChecksNoImages	File contains electronic check records with no images.
rtChecksAndImages	File contains electronic check records with images.
rtImagesForCashLetter	File contains electronic check records and images that correspond to a previously sent file (ie, a file sent with a RecordType of rtChecksNoImages). The Checks in this file that contain posting data shall not be changed from the previously sent file with CollectionType 1 or 2.

Data Type

Integer

ReturnRoutingNumber Property (InPay_Check21 Class)

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

Object Oriented Interface


public function getReturnRoutingNumber();


public function setReturnRoutingNumber($value);

Procedural Interface


inpay_check21_get($res, 47 );


inpay_check21_set($res, 47, $value );

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.

Data Type

String

SettlementDate Property (InPay_Check21 Class)

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

Object Oriented Interface


public function getSettlementDate();


public function setSettlementDate($value);

Procedural Interface


inpay_check21_get($res, 48 );


inpay_check21_set($res, 48, $value );

Default Value

Remarks

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

Data Type

String

SSLAcceptServerCertEncoded Property (InPay_Check21 Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface


public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface


inpay_check21_get($res, 50 );


inpay_check21_set($res, 50, $value );

Default Value

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (InPay_Check21 Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface


public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface


inpay_check21_get($res, 78 );


inpay_check21_set($res, 78, $value );

Default Value

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (InPay_Check21 Class)

This is the name of the certificate store for the client certificate.

Object Oriented Interface


public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface


inpay_check21_get($res, 94 );


inpay_check21_set($res, 94, $value );

Default Value

'MY'

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (InPay_Check21 Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface


public function getSSLCertStorePassword();


public function setSSLCertStorePassword($value);

Procedural Interface


inpay_check21_get($res, 95 );


inpay_check21_set($res, 95, $value );

Default Value

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (InPay_Check21 Class)

This is the type of certificate store for this certificate.

Object Oriented Interface


public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface


inpay_check21_get($res, 96 );


inpay_check21_set($res, 96, $value );

Default Value

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS11 interface. To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example: SSH Authentication with Security Key `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

Integer

SSLCertSubject Property (InPay_Check21 Class)

This is the subject of the certificate used for client authentication.

Object Oriented Interface


public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface


inpay_check21_get($res, 97 );


inpay_check21_set($res, 97, $value );

Default Value

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.


Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma it must be quoted.

Data Type

String

SSLProvider Property (InPay_Check21 Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface


public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface


inpay_check21_get($res, 105 );


inpay_check21_set($res, 105, $value );

Default Value

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 class 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:


0 (sslpAutomatic - default)	Automatically selects the appropriate implementation.
1 (sslpPlatform)	Uses the platform/system implementation.
2 (sslpInternal)	Uses the internal implementation.

Additional Notes

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

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

Data Type

Integer

SSLServerCertEncoded Property (InPay_Check21 Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface


public function getSSLServerCertEncoded();

Procedural Interface


inpay_check21_get($res, 107 );

Default Value

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Binary String

SSLStartMode Property (InPay_Check21 Class)

Determines how the class starts the SSL negotiation.

Object Oriented Interface


public function getSSLStartMode();


public function setSSLStartMode($value);

Procedural Interface


inpay_check21_get($res, 134 );


inpay_check21_set($res, 134, $value );

Default Value

Remarks

The SSLStartMode property may have one of the following values:


0 (sslAutomatic)	If the remote port is set to the standard plaintext port of the protocol (where applicable), the class will behave the same as if SSLStartMode is set to sslExplicit. In all other cases, SSL negotiation will be implicit (sslImplicit).
1 (sslImplicit)	The SSL negotiation will start immediately after the connection is established.
2 (sslExplicit)	The class will first connect in plaintext, and then explicitly start SSL negotiation through a protocol command such as STARTTLS.
3 (sslNone - default)	No SSL negotiation, no SSL security. All communication will be in plaintext mode.

Data Type

Integer

BuildAndUploadFile Method (InPay_Check21 Class)

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

Object Oriented Interface

public function doBuildAndUploadFile();

Procedural Interface

inpay_check21_do_buildanduploadfile($res);

Remarks

This method builds a complete X9.37 file and uploads it to the server specified in the FTPRemoteHost 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 class 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 (InPay_Check21 Class)

Builds an X9.37 file.

Object Oriented Interface

public function doBuildFile();

Procedural Interface

inpay_check21_do_buildfile($res);

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 class 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 (InPay_Check21 Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

inpay_check21_do_config($res, $configurationstring);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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 (InPay_Check21 Class)

Processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

inpay_check21_do_doevents($res);

Remarks

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

Interrupt Method (InPay_Check21 Class)

Interrupt the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

inpay_check21_do_interrupt($res);

Remarks

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

Reset Method (InPay_Check21 Class)

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

Object Oriented Interface

public function doReset();

Procedural Interface

inpay_check21_do_reset($res);

Remarks

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

Error Event (InPay_Check21 Class)

Information about non-fatal errors encountered during file construction.

Object Oriented Interface

public function fireError($param);

Procedural Interface

inpay_check21_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

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 class 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 (InPay_Check21 Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

inpay_check21_register_callback($res, 2, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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 (InPay_Check21 Class)

Shows the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

inpay_check21_register_callback($res, 3, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Status Event (InPay_Check21 Class)

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

Object Oriented Interface

public function fireStatus($param);

Procedural Interface

inpay_check21_register_callback($res, 4, array($this, 'fireStatus'));

Parameter List

 'message'

Remarks

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

Config Settings (Check21 Class)

The class 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 class, access to these internal properties is provided through the Config method.

Check21 Config Settings

AllowAllBOFDIndicators: Allows for any value to be specified within the BOFDIndicator field.

The default value is False, indicating that the BOFDIndicator is limited to the allowable values listed.

ArchiveType: Indicates the type of archive that supports each Check in this file.

This code indicates the way the Checks are archived. Access method, availability, and timeframes shall be defined by clearing arrangements. Valid values for this field include:


" " (space)	Default value (not specified)
A	Microfilm.
B	Image.
C	Paper.
D	Microfilm and image.
E	Microfilm and paper.
F	Image and paper.
G	Microfilm, image, and paper.
H	Electronic Check Instrument.
I	None.

ASCIIOutput: Indicates whether to output ASCII or EBCDIC.

If set to True, the class will create check21 files using the ASCII character set instead of the default EBCDIC character set.

BOFDIndicator: Indicates whether the origin is also the bank of first deposit.

This code indicates whether the ECE institution specified in the Origin properties is the Bank of First Deposit (BOFD). Allowable values include:


Y	Indicates ECE institution is BOFD. (default)
N	Indicates ECE institution is not BOFD.
U	Indicates ECE institution relationship to BOFD is undetermined.

This setting is global for all checks.

BundleCount: Total number of bundles in the file.

By default, each cash letter contains one bundle. If you wish to specify multiple bundles, increase the BundleCount and then set the BundleIndex to the bundle you wish to operate on. The CycleNumber, ReturnRoutingNumber, and Checks properties should be set for each bundle contained in the file.

BundleCreationDate: The date the bundle is created.

The class normally uses the current system date when building the bundle inside a file. You can override this functionality by setting the BundleCreationDate manually through Config.

BundleId: Unique identifier for the bundle inside the Cash Letter.

The class normally uses the same CashLetterId as the BundleId when constructing a bundle header record. You can override this functionality by setting the BundleId manually through Config.

BundleIndex: Index of the current bundle.

CashLetterCreationDate: The date the cash letter is created.

The class normally uses the current system date when building the cash letter inside a file. You can override this functionality by setting the CashLetterCreationDate manually through Config.

CashLetterCreationTime: The time the cash letter is created.

The class normally uses the current system time when building a the cash letter inside a file. You can override this functionality by setting the CashLetterCreationTime manually through Config.

CheckIsCredit[i]: Indicates whether a Check is to be sent as a Credit (61) Record.

Valid array indices are from 0 to Checks.Count - 1.

When set to True, the Check at the specified index 'i' will be sent as a Credit Record (61) within the X9.37 file. The DocumentationType is used in the creation of this record as are the following Checks fields: MICRAuxOnUs, MICRProcessingCode, MICRRoutingNumber, MICROnUs, Amount, and SequenceNumber. The default value is False.

CountryCode: A code that identifies the country in which the payor bank is located.

The default is "US".

DetailAddendumRecordNumber: The Check Detail Addendum A Record Number.

This field is used to specify the record number within the Check Detail Addendum A Record. The default value used is '0' but can be changed with this field.

FedWorkType: Federal Reserve work type.

A code that specifies the Federal Reserve work type. Valid values include:


1	City.
2	City Group.
3	City Fine Sort.
4	RCPC.
5	RCPC Group.
6	RCPC Fine Sort.
7	High Dollar Group Sort.
8	Country.
9	Country Group Sort.
0	Country Fine Sort.
A	Other District.
B	Other District Group Sort.
C	Mixed.
D	City/RCPC Mixed.
E	Payor Group Sort.

FileCreationDate: The date the file is created.

The class normally uses the current system date when building a file. You can override this functionality by setting the FileCreationDate manually through Config.

FileCreationTime: The time the file is created.

The class normally uses the current system time when building a file. You can override this functionality by setting the FileCreationTime manually through Config.

FileId: A code used to uniquely identify this file.

This 1-character code permits multiple files, created on the same date, same time, and between the same institutions to be distinguished from one another. This property is part of the File Header record (type 01), and has a default value of "0".

FileUserField: A User Field.

A field used at the discretion of users.

IncludeAddendA: Whether to include Detail Addendum A Record.

Whether to include Detail Addendum A Record (Record 26) in the file. Default value is True. If set to False the Detail Addendum A Record will not be included in the file.

Overwrite: Indicates whether local files can be overwritten.

If the file specified by Filename exists and Overwrite is False, BuildFile and BuildAndUploadFile will fail with an error indicating the file exists. Overwrite is true by default.

OverwriteRemoteFile: Indicates whether remote files can be overwritten on the FTP server.

If the file specified by FTPRemoteFile exists and OverwriteRemoteFile is False, BuildAndUploadFile will fail with an error indicating the file exists. OverwriteRemoteFile is true by default.

ResendIndicator: Indicates whether the file being built has been previously transmitted in its entirety.

The default value for this setting is False.

ReservedField: A field reserved for future use.

A field reserved for future use by the Accredited Standards Committee X9.

ReturnAcceptance: A code that indicates whether the institution that creates this file will or will not support electronic return processing.

Valid values include:


0	Will not accept any electronic information (default).
1	Will accept preliminary return notifications, returns, and final return notifications.
2	Will accept preliminary return notifications and returns.
3	Will accept preliminary return notifications and final return notifications.
4	Will accept returns and final return notifications.
5	Will accept preliminary return notifications only.
6	Will accept returns only.
7	Will accept final return notifications only.
8	Will accept preliminary return notifications, returns, final return notifications, and image returns.
9	Will accept preliminary return notifications, returns, and image returns.
A	Will accept preliminary return notifications, final return notifications, and image returns.
B	Will accept returns, final return notifications, and image returns.
C	Will accept preliminary return notifications and image returns.
D	Will accept returns and image returns.
E	Will accept final return notifications and image returns.
F	Will accept image returns only.

TestFile: Indicates whether the file being built is a test file or a production file.

The default value for TestFile is False, indicating that production files are being construction.

Base Config Settings

BuildInfo: Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage: The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:


Identifier	Name
037	IBM EBCDIC - U.S./Canada
437	OEM - United States
500	IBM EBCDIC - International
708	Arabic - ASMO 708
709	Arabic - ASMO 449+, BCON V4
710	Arabic - Transparent Arabic
720	Arabic - Transparent ASMO
737	OEM - Greek (formerly 437G)
775	OEM - Baltic
850	OEM - Multilingual Latin I
852	OEM - Latin II
855	OEM - Cyrillic (primarily Russian)
857	OEM - Turkish
858	OEM - Multilingual Latin I + Euro symbol
860	OEM - Portuguese
861	OEM - Icelandic
862	OEM - Hebrew
863	OEM - Canadian-French
864	OEM - Arabic
865	OEM - Nordic
866	OEM - Russian
869	OEM - Modern Greek
870	IBM EBCDIC - Multilingual/ROECE (Latin-2)
874	ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875	IBM EBCDIC - Modern Greek
932	ANSI/OEM - Japanese, Shift-JIS
936	ANSI/OEM - Simplified Chinese (PRC, Singapore)
949	ANSI/OEM - Korean (Unified Hangul Code)
950	ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026	IBM EBCDIC - Turkish (Latin-5)
1047	IBM EBCDIC - Latin 1/Open System
1140	IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141	IBM EBCDIC - Germany (20273 + Euro symbol)
1142	IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143	IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144	IBM EBCDIC - Italy (20280 + Euro symbol)
1145	IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146	IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147	IBM EBCDIC - France (20297 + Euro symbol)
1148	IBM EBCDIC - International (500 + Euro symbol)
1149	IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200	Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201	Unicode UCS-2 Big-Endian
1250	ANSI - Central European
1251	ANSI - Cyrillic
1252	ANSI - Latin I
1253	ANSI - Greek
1254	ANSI - Turkish
1255	ANSI - Hebrew
1256	ANSI - Arabic
1257	ANSI - Baltic
1258	ANSI/OEM - Vietnamese
1361	Korean (Johab)
10000	MAC - Roman
10001	MAC - Japanese
10002	MAC - Traditional Chinese (Big5)
10003	MAC - Korean
10004	MAC - Arabic
10005	MAC - Hebrew
10006	MAC - Greek I
10007	MAC - Cyrillic
10008	MAC - Simplified Chinese (GB 2312)
10010	MAC - Romania
10017	MAC - Ukraine
10021	MAC - Thai
10029	MAC - Latin II
10079	MAC - Icelandic
10081	MAC - Turkish
10082	MAC - Croatia
12000	Unicode UCS-4 Little-Endian
12001	Unicode UCS-4 Big-Endian
20000	CNS - Taiwan
20001	TCA - Taiwan
20002	Eten - Taiwan
20003	IBM5550 - Taiwan
20004	TeleText - Taiwan
20005	Wang - Taiwan
20105	IA5 IRV International Alphabet No. 5 (7-bit)
20106	IA5 German (7-bit)
20107	IA5 Swedish (7-bit)
20108	IA5 Norwegian (7-bit)
20127	US-ASCII (7-bit)
20261	T.61
20269	ISO 6937 Non-Spacing Accent
20273	IBM EBCDIC - Germany
20277	IBM EBCDIC - Denmark/Norway
20278	IBM EBCDIC - Finland/Sweden
20280	IBM EBCDIC - Italy
20284	IBM EBCDIC - Latin America/Spain
20285	IBM EBCDIC - United Kingdom
20290	IBM EBCDIC - Japanese Katakana Extended
20297	IBM EBCDIC - France
20420	IBM EBCDIC - Arabic
20423	IBM EBCDIC - Greek
20424	IBM EBCDIC - Hebrew
20833	IBM EBCDIC - Korean Extended
20838	IBM EBCDIC - Thai
20866	Russian - KOI8-R
20871	IBM EBCDIC - Icelandic
20880	IBM EBCDIC - Cyrillic (Russian)
20905	IBM EBCDIC - Turkish
20924	IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932	JIS X 0208-1990 & 0121-1990
20936	Simplified Chinese (GB2312)
21025	IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027	Extended Alpha Lowercase
21866	Ukrainian (KOI8-U)
28591	ISO 8859-1 Latin I
28592	ISO 8859-2 Central Europe
28593	ISO 8859-3 Latin 3
28594	ISO 8859-4 Baltic
28595	ISO 8859-5 Cyrillic
28596	ISO 8859-6 Arabic
28597	ISO 8859-7 Greek
28598	ISO 8859-8 Hebrew
28599	ISO 8859-9 Latin 5
28605	ISO 8859-15 Latin 9
29001	Europa 3
38598	ISO 8859-8 Hebrew
50220	ISO 2022 Japanese with no halfwidth Katakana
50221	ISO 2022 Japanese with halfwidth Katakana
50222	ISO 2022 Japanese JIS X 0201-1989
50225	ISO 2022 Korean
50227	ISO 2022 Simplified Chinese
50229	ISO 2022 Traditional Chinese
50930	Japanese (Katakana) Extended
50931	US/Canada and Japanese
50933	Korean Extended and Korean
50935	Simplified Chinese Extended and Simplified Chinese
50936	Simplified Chinese
50937	US/Canada and Traditional Chinese
50939	Japanese (Latin) Extended and Japanese
51932	EUC - Japanese
51936	EUC - Simplified Chinese
51949	EUC - Korean
51950	EUC - Traditional Chinese
52936	HZ-GB2312 Simplified Chinese
54936	Windows XP: GB18030 Simplified Chinese (4 Byte)
57002	ISCII Devanagari
57003	ISCII Bengali
57004	ISCII Tamil
57005	ISCII Telugu
57006	ISCII Assamese
57007	ISCII Oriya
57008	ISCII Kannada
57009	ISCII Malayalam
57010	ISCII Gujarati
57011	ISCII Punjabi
65000	Unicode UTF-7
65001	Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:


Identifier	Name
1	ASCII
2	NEXTSTEP
3	JapaneseEUC
4	UTF8
5	ISOLatin1
6	Symbol
7	NonLossyASCII
8	ShiftJIS
9	ISOLatin2
10	Unicode
11	WindowsCP1251
12	WindowsCP1252
13	WindowsCP1253
14	WindowsCP1254
15	WindowsCP1250
21	ISO2022JP
30	MacOSRoman
10	UTF16String
0x90000100	UTF16BigEndian
0x94000100	UTF16LittleEndian
0x8c000100	UTF32String
0x98000100	UTF32BigEndian
0x9c000100	UTF32LittleEndian
65536	Proprietary

LicenseInfo: Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

Product: The product the license is for.
Product Key: The key the license was generated from.
License Source: Where the license was found (e.g., RuntimeLicense, License File).
License Type: The type of license installed (e.g., Royalty Free, Single Server).
Last Valid Build: The last valid build number for which the license will work.

MaskSensitive: Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI: Tells the class whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this setting to true tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

Trappable Errors (Check21 Class)

Check21 Errors

143 Busy performing current action

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