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.

Syntax

class inpay.Check21

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 return_routing_number. 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 cash_letter_id and cycle_number 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 file_data property).

Check21.CashLetterId = "123456" Check21.CycleNumber = "01" Check21.Filename = "sample_output.dat" This file is going to contain scanned images of paper checks, so record_type should be set to rtChecksAndImages and make sure the documentation_type is set to a compatible value ("G" through "J" are valid when record_type 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 check_bofd_conversion_indicator 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 check_front_image_filename and check_back_image_filename properties to point to image files on disk, or you may set the binary data directly in check_front_image_data and check_back_image_data. 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 build_file 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 build_and_upload_file 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.

business_date	The year, month, and day that designates the business date at the Bank of First Deposit.
cash_letter_id	A code used to uniquely identify the cash letter inside the file.
check_count	The number of records in the Check arrays.
check_amount	The US dollar value of the check.
check_back_image_creation_date	Date assigned by the image creator for the image contained in BackImageData .
check_back_image_data	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 .
check_back_image_filename	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 .
check_back_image_reference_key	A designator assigned by the ECE institution that uniquely identifies the BackImageData .
check_bofd_account_number	A number that identifies the depository account at the Bank of First Deposit.
check_bofd_branch	A code that identifies the branch at the Bank of First Deposit.
check_bofd_conversion_indicator	A code that indicates the conversion within the processing institution between original paper check, image, and IRD.
check_bofd_routing_number	A number that identifies the Bank of First Deposit.
check_bofd_truncator	Identifies if this BOFD is the truncator of the original check.
check_can_recreate_images	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.
check_front_image_creation_date	Date assigned by the image creator for the image contained in FrontImageData .
check_front_image_data	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 .
check_front_image_filename	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 .
check_front_image_reference_key	A designator assigned by the ECE institution that uniquely identifies the FrontImageData .
check_image_compression	A code that identifies the algorithm or method used to compress the images stored in the FrontImageData and BackImageData properties.
check_image_creator_routing_number	A number that identifies the financial institution that created the image (if different from BOFDRoutingNumber ).
check_image_format	A code that identifies the type of image format used for the images contained in the FrontImageData and BackImageData properties.
check_micr_aux_on_us	A code used on commercial checks at the discretion of the payor bank, read off of the MICR line on a check.
check_micr_on_us	Account number data specified by the payor bank and read from the MICR line on a check.
check_micr_processing_code	The external processing code from the MICR line of a check, if present.
check_micr_routing_number	Payor bank routing number, read from the MICR line of a check.
check_payee_name	The name of the payee from the check.
check_sequence_number	ECE Institution Item Sequence Number, assigned by the institution that creates the file.
collection_type	A code that indicates the type of cash letter and bundle contained in the file.
cycle_number	Denotes the cycle under which the file is created.
destination_name	The short name that identifies the institution that receives the file.
destination_routing_number	This number identifies the institution that receives the file.
documentation_type	A code that indicates the type of documentation that supports all Checks records in the file.
file_data	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.
ftp_password	The password to login with.
ftp_remote_file	The name of the file as it will appear on the server after upload.
ftp_remote_host	The domain name or IP address of the FTP server the file is to be uploaded to.
ftp_remote_path	The current path on the FTP server.
ftp_remote_port	The port for the FTP service (default is 21).
ftp_timeout	A timeout to use when uploading via FTP.
ftp_user	The user id to login as.
origin_contact_name	A contact at the institution that creates the file.
origin_contact_phone	The phone number of the ContactName at the institution that created the file.
origin_name	The short name of the ECE institution that created the file.
origin_routing_number	A number that identifies the ECE institution that originates the file.
record_type	A code that indicates the type of records contained in this file.
return_routing_number	A routing number indicating the location to which returns and return notifications should be sent.
settlement_date	The date that the institution that created the file expects settlement.
ssl_accept_server_cert_encoded	This is the certificate (PEM/base64 encoded).
ssl_cert_encoded	This is the certificate (PEM/base64 encoded).
ssl_cert_store	This is the name of the certificate store for the client certificate.
ssl_cert_store_password	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
ssl_cert_store_type	This is the type of certificate store for this certificate.
ssl_cert_subject	This is the subject of the certificate used for client authentication.
ssl_provider	This specifies the SSL/TLS implementation to use.
ssl_server_cert_encoded	This is the certificate (PEM/base64 encoded).
ssl_start_mode	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.

build_and_upload_file	Builds an X9.37 file and uploads it to an FTP server.
build_file	Builds an X9.37 file.
config	Sets or retrieves a configuration setting.
do_events	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.

on_error	Information about non-fatal errors encountered during file construction.
on_ssl_server_authentication	Fired after the server presents its certificate to the client.
on_ssl_status	Shows the progress of the secure connection.
on_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.

business_date Property

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

Syntax

def get_business_date() -> str: ...
def set_business_date(value: str) -> None: ...

business_date = property(get_business_date, set_business_date)

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

cash_letter_id Property

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

Syntax

def get_cash_letter_id() -> str: ...
def set_cash_letter_id(value: str) -> None: ...

cash_letter_id = property(get_cash_letter_id, set_cash_letter_id)

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

check_count Property

The number of records in the Check arrays.

Syntax

def get_check_count() -> int: ...
def set_check_count(value: int) -> None: ...

check_count = property(get_check_count, set_check_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• check_amount
• check_back_image_creation_date
• check_back_image_data
• check_back_image_filename
• check_back_image_reference_key
• check_bofd_account_number
• check_bofd_branch
• check_bofd_conversion_indicator
• check_bofd_routing_number
• check_bofd_truncator
• check_can_recreate_images
• check_front_image_creation_date
• check_front_image_data
• check_front_image_filename
• check_front_image_reference_key
• check_image_compression
• check_image_creator_routing_number
• check_image_format
• check_micr_aux_on_us
• check_micr_on_us
• check_micr_processing_code
• check_micr_routing_number
• check_payee_name
• check_sequence_number

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

check_amount Property

The US dollar value of the check.

Syntax

def get_check_amount(check_index: int) -> str: ...
def set_check_amount(check_index: int, value: str) -> None: ...

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 check_index parameter specifies the index of the item in the array. The size of the array is controlled by the check_count property.

check_back_image_creation_date Property

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

Syntax

def get_check_back_image_creation_date(check_index: int) -> str: ...
def set_check_back_image_creation_date(check_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The check_index parameter specifies the index of the item in the array. The size of the array is controlled by the check_count property.

check_back_image_data Property

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 .

Syntax

def get_check_back_image_data(check_index: int) -> bytes: ...
def set_check_back_image_data(check_index: int, value: bytes) -> None: ...

Default Value

""

Remarks

This property contains the scanned image of the back of the physical check, in the format specified by check_image_format and compressed using the designated check_image_compression. 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 check_back_image_filename property. If both are specified check_back_image_data 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 check_index parameter specifies the index of the item in the array. The size of the array is controlled by the check_count property.

check_back_image_filename Property

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 .

Syntax

def get_check_back_image_filename(check_index: int) -> str: ...
def set_check_back_image_filename(check_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains location of a scanned image of the back of the physical check, in the format specified by check_image_format and compressed using the designated check_image_compression. 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 check_back_image_data property. If both properties are specified check_back_image_data will be used and check_back_image_filename 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 check_index parameter specifies the index of the item in the array. The size of the array is controlled by the check_count property.

check_back_image_reference_key Property

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

Syntax

def get_check_back_image_reference_key(check_index: int) -> str: ...
def set_check_back_image_reference_key(check_index: int, value: str) -> None: ...

Default Value

""

Remarks

A designator assigned by the ECE institution that uniquely identifies the check_back_image_data. 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 check_index parameter specifies the index of the item in the array. The size of the array is controlled by the check_count property.

check_bofd_account_number Property

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

Syntax

def get_check_bofd_account_number(check_index: int) -> str: ...
def set_check_bofd_account_number(check_index: int, value: str) -> None: ...

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 check_index parameter specifies the index of the item in the array. The size of the array is controlled by the check_count property.

check_bofd_branch Property

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

Syntax

def get_check_bofd_branch(check_index: int) -> str: ...
def set_check_bofd_branch(check_index: int, value: str) -> None: ...

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 check_index parameter specifies the index of the item in the array. The size of the array is controlled by the check_count property.

check_bofd_conversion_indicator Property

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

Syntax

def get_check_bofd_conversion_indicator(check_index: int) -> str: ...
def set_check_bofd_conversion_indicator(check_index: int, value: str) -> None: ...

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 check_index parameter specifies the index of the item in the array. The size of the array is controlled by the check_count property.

check_bofd_routing_number Property

A number that identifies the Bank of First Deposit.

Syntax

def get_check_bofd_routing_number(check_index: int) -> str: ...
def set_check_bofd_routing_number(check_index: int, value: str) -> None: ...

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 check_index parameter specifies the index of the item in the array. The size of the array is controlled by the check_count property.

check_bofd_truncator Property

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

Syntax

def get_check_bofd_truncator(check_index: int) -> bool: ...
def set_check_bofd_truncator(check_index: int, value: bool) -> None: ...

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 check_index parameter specifies the index of the item in the array. The size of the array is controlled by the check_count property.

check_can_recreate_images Property

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.

Syntax

def get_check_can_recreate_images(check_index: int) -> bool: ...
def set_check_can_recreate_images(check_index: int, value: bool) -> None: ...

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 check_index parameter specifies the index of the item in the array. The size of the array is controlled by the check_count property.

check_front_image_creation_date Property

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

Syntax

def get_check_front_image_creation_date(check_index: int) -> str: ...
def set_check_front_image_creation_date(check_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The check_index parameter specifies the index of the item in the array. The size of the array is controlled by the check_count property.

check_front_image_data Property

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 .

Syntax

def get_check_front_image_data(check_index: int) -> bytes: ...
def set_check_front_image_data(check_index: int, value: bytes) -> None: ...

Default Value

""

Remarks

This property contains the scanned image of the front of the physical check, in the format specified by check_image_format and compressed using the designated check_image_compression. 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 check_front_image_filename property. If both are specified check_front_image_data 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 check_index parameter specifies the index of the item in the array. The size of the array is controlled by the check_count property.

check_front_image_filename Property

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 .

Syntax

def get_check_front_image_filename(check_index: int) -> str: ...
def set_check_front_image_filename(check_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains location of a scanned image of the front of the physical check, in the format specified by check_image_format and compressed using the designated check_image_compression. 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 check_front_image_data property. If both properties are specified check_front_image_data will be used and check_front_image_filename 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 check_index parameter specifies the index of the item in the array. The size of the array is controlled by the check_count property.

check_front_image_reference_key Property

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

Syntax

def get_check_front_image_reference_key(check_index: int) -> str: ...
def set_check_front_image_reference_key(check_index: int, value: str) -> None: ...

Default Value

""

Remarks

A designator assigned by the ECE institution that uniquely identifies the check_front_image_data. 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 check_index parameter specifies the index of the item in the array. The size of the array is controlled by the check_count property.

check_image_compression Property

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

Syntax

def get_check_image_compression(check_index: int) -> int: ...
def set_check_image_compression(check_index: int, value: int) -> None: ...

Default Value

1

Remarks

A code that identifies the algorithm or method used to compress the images stored in the check_front_image_data and check_back_image_data 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 check_index parameter specifies the index of the item in the array. The size of the array is controlled by the check_count property.

check_image_creator_routing_number Property

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

Syntax

def get_check_image_creator_routing_number(check_index: int) -> str: ...
def set_check_image_creator_routing_number(check_index: int, value: str) -> None: ...

Default Value

""

Remarks

A number that identifies the financial institution that created the image (if different from check_bofd_routing_number). 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 check_index parameter specifies the index of the item in the array. The size of the array is controlled by the check_count property.

check_image_format Property

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

Syntax

def get_check_image_format(check_index: int) -> int: ...
def set_check_image_format(check_index: int, value: int) -> None: ...

Default Value

0

Remarks

A code that identifies the type of image format used for the images contained in the check_front_image_data and check_back_image_data 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 check_front_image_data or check_back_image_data 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 check_index parameter specifies the index of the item in the array. The size of the array is controlled by the check_count property.

check_micr_aux_on_us Property

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

Syntax

def get_check_micr_aux_on_us(check_index: int) -> str: ...
def set_check_micr_aux_on_us(check_index: int, value: str) -> None: ...

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 check_index parameter specifies the index of the item in the array. The size of the array is controlled by the check_count property.

check_micr_on_us Property

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

Syntax

def get_check_micr_on_us(check_index: int) -> str: ...
def set_check_micr_on_us(check_index: int, value: str) -> None: ...

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 check_index parameter specifies the index of the item in the array. The size of the array is controlled by the check_count property.

check_micr_processing_code Property

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

Syntax

def get_check_micr_processing_code(check_index: int) -> str: ...
def set_check_micr_processing_code(check_index: int, value: str) -> None: ...

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 check_index parameter specifies the index of the item in the array. The size of the array is controlled by the check_count property.

check_micr_routing_number Property

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

Syntax

def get_check_micr_routing_number(check_index: int) -> str: ...
def set_check_micr_routing_number(check_index: int, value: str) -> None: ...

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 check_index parameter specifies the index of the item in the array. The size of the array is controlled by the check_count property.

check_payee_name Property

The name of the payee from the check.

Syntax

def get_check_payee_name(check_index: int) -> str: ...
def set_check_payee_name(check_index: int, value: str) -> None: ...

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 check_index parameter specifies the index of the item in the array. The size of the array is controlled by the check_count property.

check_sequence_number Property

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

Syntax

def get_check_sequence_number(check_index: int) -> str: ...
def set_check_sequence_number(check_index: int, value: str) -> None: ...

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 origin_routing_number, business_date, and cycle_number. 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 check_index parameter specifies the index of the item in the array. The size of the array is controlled by the check_count property.

collection_type Property

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

Syntax

def get_collection_type() -> int: ...
def set_collection_type(value: int) -> None: ...

collection_type = property(get_collection_type, set_collection_type)

Default Value

1

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.

cycle_number Property

Denotes the cycle under which the file is created.

Syntax

def get_cycle_number() -> str: ...
def set_cycle_number(value: str) -> None: ...

cycle_number = property(get_cycle_number, set_cycle_number)

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

destination_name Property

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

Syntax

def get_destination_name() -> str: ...
def set_destination_name(value: str) -> None: ...

destination_name = property(get_destination_name, set_destination_name)

Default Value

""

Remarks

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

destination_routing_number Property

This number identifies the institution that receives the file.

Syntax

def get_destination_routing_number() -> str: ...
def set_destination_routing_number(value: str) -> None: ...

destination_routing_number = property(get_destination_routing_number, set_destination_routing_number)

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.

documentation_type Property

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

Syntax

def get_documentation_type() -> str: ...
def set_documentation_type(value: str) -> None: ...

documentation_type = property(get_documentation_type, set_documentation_type)

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.

file_data Property

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

Syntax

def get_file_data() -> bytes: ...

file_data = property(get_file_data, None)

Default Value

""

Remarks

If filename is specified build_file will save to disk, and file_data 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

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

Syntax

def get_filename() -> str: ...
def set_filename(value: str) -> None: ...

filename = property(get_filename, set_filename)

Default Value

""

Remarks

If filename is blank, the build_file method will create the file in-memory and store it in the file_data property.

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

ftp_password Property

The password to login with.

Syntax

def get_ftp_password() -> str: ...
def set_ftp_password(value: str) -> None: ...

ftp_password = property(get_ftp_password, set_ftp_password)

Default Value

""

Remarks

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

ftp_remote_file Property

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

Syntax

def get_ftp_remote_file() -> str: ...
def set_ftp_remote_file(value: str) -> None: ...

ftp_remote_file = property(get_ftp_remote_file, set_ftp_remote_file)

Default Value

""

Remarks

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

ftp_remote_host Property

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

Syntax

def get_ftp_remote_host() -> str: ...
def set_ftp_remote_host(value: str) -> None: ...

ftp_remote_host = property(get_ftp_remote_host, set_ftp_remote_host)

Default Value

""

Remarks

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

The ftp_remote_host 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 ftp_remote_host property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the ftp_remote_host 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.

ftp_remote_path Property

The current path on the FTP server.

Syntax

def get_ftp_remote_path() -> str: ...
def set_ftp_remote_path(value: str) -> None: ...

ftp_remote_path = property(get_ftp_remote_path, set_ftp_remote_path)

Default Value

""

Remarks

The current path on the FTP server. The ftp_remote_path 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 ftp_remote_path.

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

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

ftp_remote_port Property

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

Syntax

def get_ftp_remote_port() -> int: ...
def set_ftp_remote_port(value: int) -> None: ...

ftp_remote_port = property(get_ftp_remote_port, set_ftp_remote_port)

Default Value

21

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.

ftp_timeout Property

A timeout to use when uploading via FTP.

Syntax

def get_ftp_timeout() -> int: ...
def set_ftp_timeout(value: int) -> None: ...

ftp_timeout = property(get_ftp_timeout, set_ftp_timeout)

Default Value

60

Remarks

A timeout to use when uploading via FTP.

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

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

ftp_user Property

The user id to login as.

Syntax

def get_ftp_user() -> str: ...
def set_ftp_user(value: str) -> None: ...

ftp_user = property(get_ftp_user, set_ftp_user)

Default Value

""

Remarks

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

origin_contact_name Property

A contact at the institution that creates the file.

Syntax

def get_origin_contact_name() -> str: ...
def set_origin_contact_name(value: str) -> None: ...

origin_contact_name = property(get_origin_contact_name, set_origin_contact_name)

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.

origin_contact_phone Property

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

Syntax

def get_origin_contact_phone() -> str: ...
def set_origin_contact_phone(value: str) -> None: ...

origin_contact_phone = property(get_origin_contact_phone, set_origin_contact_phone)

Default Value

""

Remarks

The phone number of the origin_contact_name 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.

origin_name Property

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

Syntax

def get_origin_name() -> str: ...
def set_origin_name(value: str) -> None: ...

origin_name = property(get_origin_name, set_origin_name)

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.

origin_routing_number Property

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

Syntax

def get_origin_routing_number() -> str: ...
def set_origin_routing_number(value: str) -> None: ...

origin_routing_number = property(get_origin_routing_number, set_origin_routing_number)

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.

record_type Property

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

Syntax

def get_record_type() -> int: ...
def set_record_type(value: int) -> None: ...

record_type = property(get_record_type, set_record_type)

Default Value

0

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 record_type of rtChecksNoImages). The checks in this file that contain posting data shall not be changed from the previously sent file with collection_type 1 or 2.

return_routing_number Property

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

Syntax

def get_return_routing_number() -> str: ...
def set_return_routing_number(value: str) -> None: ...

return_routing_number = property(get_return_routing_number, set_return_routing_number)

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.

settlement_date Property

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

Syntax

def get_settlement_date() -> str: ...
def set_settlement_date(value: str) -> None: ...

settlement_date = property(get_settlement_date, set_settlement_date)

Default Value

""

Remarks

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

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_store Property

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

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

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

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject 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).

ssl_cert_store_password Property

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

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

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.

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

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 list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS11 dll. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssl_cert_store and set ssl_cert_store_password 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.

ssl_cert_subject Property

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

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

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.

ssl_provider Property

This specifies the SSL/TLS implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

0

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.

ssl_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_start_mode Property

Determines how the class starts the SSL negotiation.

Syntax

def get_ssl_start_mode() -> int: ...
def set_ssl_start_mode(value: int) -> None: ...

ssl_start_mode = property(get_ssl_start_mode, set_ssl_start_mode)

Default Value

3

Remarks

The ssl_start_mode 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 ssl_start_mode 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.

build_and_upload_file Method

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

Syntax

def build_and_upload_file() -> None: ...

Remarks

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

build_file Method

Builds an X9.37 file.

Syntax

def build_file() -> None: ...

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 file_data 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

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

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.

do_events Method

Processes events from the internal message queue.

Syntax

def do_events() -> None: ...

Remarks

When do_events 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

Interrupt the current method.

Syntax

def interrupt() -> None: ...

Remarks

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

reset Method

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

Syntax

def reset() -> None: ...

Remarks

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

on_error Event

Information about non-fatal errors encountered during file construction.

Syntax

class Check21ErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class Check21:
@property
def on_error() -> Callable[[Check21ErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[Check21ErrorEventParams], None]) -> None: ...

Remarks

The on_error event is fired to warn the user that it may be operating differently than the user expects. For instance, if the collection_type 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.

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class Check21SSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class Check21:
@property
def on_ssl_server_authentication() -> Callable[[Check21SSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[Check21SSLServerAuthenticationEventParams], None]) -> None: ...

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.

on_ssl_status Event

Shows the progress of the secure connection.

Syntax

class Check21SSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class Check21:
@property
def on_ssl_status() -> Callable[[Check21SSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[Check21SSLStatusEventParams], None]) -> None: ...

Remarks

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

on_status Event

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

Syntax

class Check21StatusEventParams(object):
  @property
  def message() -> str: ...

# In class Check21:
@property
def on_status() -> Callable[[Check21StatusEventParams], None]: ...
@on_status.setter
def on_status(event_hook: Callable[[Check21StatusEventParams], None]) -> None: ...

Remarks

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

Check21 Config Settings

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 cycle_number, return_routing_number, 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 cash_letter_id 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. 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 cycle_number, return_routing_number, and checks properties should be set for each bundle contained in the file.

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 documentation_type 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, build_file and build_and_upload_file 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 ftp_remote_file exists and OverwriteRemoteFile is False, build_and_upload_file 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 do_events 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.

Check21 Errors

Check21 Errors

	143   Busy performing current action

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