Check21 Module
Properties Methods Events Config Settings Errors
The Check21 module is used to construct a file containing scanned images of paper checks, and optionally upload it to an FTPS server.
Syntax
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 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 ChecksBOFDConversionIndicator 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 ChecksFrontImageFileName and ChecksBackImageFileName properties to
point to image files on disk, or you may set the binary data directly in ChecksFrontImageData and
ChecksBackImageData. 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 module 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. |
| Checks | Collection of checks to be written to 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. |
| FTP | Information about the FTP or FTPS server you're uploading to. |
| Origin | Contains information about the originator of this file and the checks contained within. |
| 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. |
| SSLAcceptServerCert | Instructs the module to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLCert | The certificate to be used during Secure Sockets Layer (SSL) negotiation. |
| SSLProvider | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
| SSLServerCert | The server certificate for the last established connection. |
| SSLStartMode | This property determines how the module starts the Secure Sockets Layer (SSL) negotiation. |
Method List
The following is the full list of the methods of the module 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 | This method processes events from the internal message queue. |
| Interrupt | This method interrupts the current method. |
| Reset | Reset the internal state of the module and all properties to their default values. |
Event List
The following is the full list of the events fired by the module 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 | Fired when secure connection progress messages are available. |
| Status | Traces the commands sent to the server, and the respective replies. |
Config Settings
The following is a list of config settings for the module 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. |
| MaskSensitiveData | Whether sensitive data is masked in log messages. |
| UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
BusinessDate Property (Check21 Module)
The year, month, and day that designates the business date at the Bank of First Deposit.
Syntax
public var businessDate: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=businessDate,setter=setBusinessDate:) NSString* businessDate; - (NSString*)businessDate; - (void)setBusinessDate :(NSString*)newBusinessDate;
Default Value
""
Remarks
This property is 8 characters in length and in the format "YYYYMMDD". If no value is supplied in this property the current system date will be used.
This property is part of the Cash Letter Header record (type 10), Bundle Header record (type 20), Check Detail Addendum A record (type 26), and Image View Data record (type 52).
CashLetterId Property (Check21 Module)
A code used to uniquely identify the cash letter inside the file.
Syntax
public var cashLetterId: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=cashLetterId,setter=setCashLetterId:) NSString* cashLetterId; - (NSString*)cashLetterId; - (void)setCashLetterId :(NSString*)newCashLetterId;
Default Value
""
Remarks
This code identifies the cash letter, and is assigned by the institution that creates the file. This property is part of the Cash Letter Header record (type 10), and is 8 characters in length. The same value will also be used in the Bundle Header Record (type 20) for the "Bundle Id".
Checks Property (Check21 Module)
Collection of checks to be written to the file.
Syntax
public var checks: Array<CheckDetail> { get {...} }
@property (nonatomic,readwrite,assign,getter=checkCount,setter=setCheckCount:) int checkCount; - (int)checkCount; - (void)setCheckCount :(int)newCheckCount; - (NSString*)checkAmount:(int)checkIndex; - (void)setCheckAmount:(int)checkIndex :(NSString*)newCheckAmount; - (NSString*)checkBackImageCreationDate:(int)checkIndex; - (void)setCheckBackImageCreationDate:(int)checkIndex :(NSString*)newCheckBackImageCreationDate; - (NSString*)checkBackImageData:(int)checkIndex; - (void)setCheckBackImageData:(int)checkIndex :(NSString*)newCheckBackImageData; - (NSData*)checkBackImageDataB:(int)checkIndex; - (void)setCheckBackImageDataB:(int)checkIndex :(NSData*)newCheckBackImageData; - (NSString*)checkBackImageFileName:(int)checkIndex; - (void)setCheckBackImageFileName:(int)checkIndex :(NSString*)newCheckBackImageFileName; - (NSString*)checkBackImageReferenceKey:(int)checkIndex; - (void)setCheckBackImageReferenceKey:(int)checkIndex :(NSString*)newCheckBackImageReferenceKey; - (NSString*)checkBOFDAccountNumber:(int)checkIndex; - (void)setCheckBOFDAccountNumber:(int)checkIndex :(NSString*)newCheckBOFDAccountNumber; - (NSString*)checkBOFDBranch:(int)checkIndex; - (void)setCheckBOFDBranch:(int)checkIndex :(NSString*)newCheckBOFDBranch; - (NSString*)checkBOFDConversionIndicator:(int)checkIndex; - (void)setCheckBOFDConversionIndicator:(int)checkIndex :(NSString*)newCheckBOFDConversionIndicator; - (NSString*)checkBOFDRoutingNumber:(int)checkIndex; - (void)setCheckBOFDRoutingNumber:(int)checkIndex :(NSString*)newCheckBOFDRoutingNumber; - (BOOL)checkBOFDTruncator:(int)checkIndex; - (void)setCheckBOFDTruncator:(int)checkIndex :(BOOL)newCheckBOFDTruncator; - (BOOL)checkCanRecreateImages:(int)checkIndex; - (void)setCheckCanRecreateImages:(int)checkIndex :(BOOL)newCheckCanRecreateImages; - (NSString*)checkFrontImageCreationDate:(int)checkIndex; - (void)setCheckFrontImageCreationDate:(int)checkIndex :(NSString*)newCheckFrontImageCreationDate; - (NSString*)checkFrontImageData:(int)checkIndex; - (void)setCheckFrontImageData:(int)checkIndex :(NSString*)newCheckFrontImageData; - (NSData*)checkFrontImageDataB:(int)checkIndex; - (void)setCheckFrontImageDataB:(int)checkIndex :(NSData*)newCheckFrontImageData; - (NSString*)checkFrontImageFileName:(int)checkIndex; - (void)setCheckFrontImageFileName:(int)checkIndex :(NSString*)newCheckFrontImageFileName; - (NSString*)checkFrontImageReferenceKey:(int)checkIndex; - (void)setCheckFrontImageReferenceKey:(int)checkIndex :(NSString*)newCheckFrontImageReferenceKey; - (int)checkImageCompression:(int)checkIndex; - (void)setCheckImageCompression:(int)checkIndex :(int)newCheckImageCompression; - (NSString*)checkImageCreatorRoutingNumber:(int)checkIndex; - (void)setCheckImageCreatorRoutingNumber:(int)checkIndex :(NSString*)newCheckImageCreatorRoutingNumber; - (int)checkImageFormat:(int)checkIndex; - (void)setCheckImageFormat:(int)checkIndex :(int)newCheckImageFormat; - (NSString*)checkMICRAuxOnUs:(int)checkIndex; - (void)setCheckMICRAuxOnUs:(int)checkIndex :(NSString*)newCheckMICRAuxOnUs; - (NSString*)checkMICROnUs:(int)checkIndex; - (void)setCheckMICROnUs:(int)checkIndex :(NSString*)newCheckMICROnUs; - (NSString*)checkMICRProcessingCode:(int)checkIndex; - (void)setCheckMICRProcessingCode:(int)checkIndex :(NSString*)newCheckMICRProcessingCode; - (NSString*)checkMICRRoutingNumber:(int)checkIndex; - (void)setCheckMICRRoutingNumber:(int)checkIndex :(NSString*)newCheckMICRRoutingNumber; - (NSString*)checkPayeeName:(int)checkIndex; - (void)setCheckPayeeName:(int)checkIndex :(NSString*)newCheckPayeeName; - (NSString*)checkSequenceNumber:(int)checkIndex; - (void)setCheckSequenceNumber:(int)checkIndex :(NSString*)newCheckSequenceNumber;
Default Value
3
Remarks
This property contains a collection of CheckDetail objects. Each of those objects must include MICR information read off of a physical check, as well as the Bank of First Deposit's routing number and the name of the payee. Each check object may also optionally contain a scan of the front and back of the paper check.
CollectionType Property (Check21 Module)
A code that indicates the type of cash letter and bundle contained in the file.
Syntax
public var collectionType: Check21CollectionTypes { get {...} set {...} }
public enum Check21CollectionTypes: Int32 { case ctForwardInfo = 1 case ctFowardPresentment = 2 case ctForwardSameDay = 3 case ctNoDetail = 20 }
@property (nonatomic,readwrite,assign,getter=collectionType,setter=setCollectionType:) int collectionType; - (int)collectionType; - (void)setCollectionType :(int)newCollectionType;
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. |
CycleNumber Property (Check21 Module)
Denotes the cycle under which the file is created.
Syntax
public var cycleNumber: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=cycleNumber,setter=setCycleNumber:) NSString* cycleNumber; - (NSString*)cycleNumber; - (void)setCycleNumber :(NSString*)newCycleNumber;
Default Value
""
Remarks
This code is assigned by the institution that creates the file. This property is part of the Bundle Header record (type 20) and Image View Data record (type 52).
DestinationName Property (Check21 Module)
The short name that identifies the institution that receives the file.
Syntax
public var destinationName: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=destinationName,setter=setDestinationName:) NSString* destinationName; - (NSString*)destinationName; - (void)setDestinationName :(NSString*)newDestinationName;
Default Value
""
Remarks
This property is part of the File Header record (type 01), and is exactly 9 characters long, including the check digit.
DestinationRoutingNumber Property (Check21 Module)
This number identifies the institution that receives the file.
Syntax
public var destinationRoutingNumber: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=destinationRoutingNumber,setter=setDestinationRoutingNumber:) NSString* destinationRoutingNumber; - (NSString*)destinationRoutingNumber; - (void)setDestinationRoutingNumber :(NSString*)newDestinationRoutingNumber;
Default Value
""
Remarks
This property is part of the File Header record (type 01), Cash Letter Header Record (type 10), and Bundle Header Record (type 20), and is exactly 9 characters long including the check digit.
DocumentationType Property (Check21 Module)
A code that indicates the type of documentation that supports all Checks records in the file.
Syntax
public var documentationType: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=documentationType,setter=setDocumentationType:) NSString* documentationType; - (NSString*)documentationType; - (void)setDocumentationType :(NSString*)newDocumentationType;
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. |
FileData Property (Check21 Module)
Contains the binary contents of the X9.37 file created by the BuildFile method.
Syntax
@property (nonatomic,readonly,assign,getter=fileData) NSString* fileData; - (NSString*)fileData; @property (nonatomic,readonly,assign,getter=fileDataB) NSData* fileDataB; - (NSData*)fileDataB;
Default Value
""
Remarks
If FileName is specified BuildFile will save to disk, and FileData will remain empty. However if FileName is blank, the file will be created in-memory and stored in this property.
This property is read-only.
FileName Property (Check21 Module)
Path and name of the file to be written to disk by the BuildFile method.
Syntax
public var fileName: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=fileName,setter=setFileName:) NSString* fileName; - (NSString*)fileName; - (void)setFileName :(NSString*)newFileName;
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.
FTP Property (Check21 Module)
Information about the FTP or FTPS server you're uploading to.
Syntax
public var ftp: FTPSettings { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=FTPPassword,setter=setFTPPassword:) NSString* FTPPassword; - (NSString*)FTPPassword; - (void)setFTPPassword :(NSString*)newFTPPassword; @property (nonatomic,readwrite,assign,getter=FTPRemoteFile,setter=setFTPRemoteFile:) NSString* FTPRemoteFile; - (NSString*)FTPRemoteFile; - (void)setFTPRemoteFile :(NSString*)newFTPRemoteFile; @property (nonatomic,readwrite,assign,getter=FTPRemoteHost,setter=setFTPRemoteHost:) NSString* FTPRemoteHost; - (NSString*)FTPRemoteHost; - (void)setFTPRemoteHost :(NSString*)newFTPRemoteHost; @property (nonatomic,readwrite,assign,getter=FTPRemotePath,setter=setFTPRemotePath:) NSString* FTPRemotePath; - (NSString*)FTPRemotePath; - (void)setFTPRemotePath :(NSString*)newFTPRemotePath; @property (nonatomic,readwrite,assign,getter=FTPRemotePort,setter=setFTPRemotePort:) int FTPRemotePort; - (int)FTPRemotePort; - (void)setFTPRemotePort :(int)newFTPRemotePort; @property (nonatomic,readwrite,assign,getter=FTPTimeout,setter=setFTPTimeout:) int FTPTimeout; - (int)FTPTimeout; - (void)setFTPTimeout :(int)newFTPTimeout; @property (nonatomic,readwrite,assign,getter=FTPUser,setter=setFTPUser:) NSString* FTPUser; - (NSString*)FTPUser; - (void)setFTPUser :(NSString*)newFTPUser;
Default Value
3
Remarks
These ftp fields are only necessary when using the BuildAndUploadFile method to upload an X9.37 file to an FTP or FTPS server. The and fields specify the server you wish to connect to. contains the path at which you wish to save the file, and indicates the filename that will be saved on the FTP server after upload. (It does not have to match the property). and contain your logon credentials for the FTP server.
Origin Property (Check21 Module)
Contains information about the originator of this file and the checks contained within.
Syntax
public var origin: Origin { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=originContactName,setter=setOriginContactName:) NSString* originContactName; - (NSString*)originContactName; - (void)setOriginContactName :(NSString*)newOriginContactName; @property (nonatomic,readwrite,assign,getter=originContactPhone,setter=setOriginContactPhone:) NSString* originContactPhone; - (NSString*)originContactPhone; - (void)setOriginContactPhone :(NSString*)newOriginContactPhone; @property (nonatomic,readwrite,assign,getter=originName,setter=setOriginName:) NSString* originName; - (NSString*)originName; - (void)setOriginName :(NSString*)newOriginName; @property (nonatomic,readwrite,assign,getter=originRoutingNumber,setter=setOriginRoutingNumber:) NSString* originRoutingNumber; - (NSString*)originRoutingNumber; - (void)setOriginRoutingNumber :(NSString*)newOriginRoutingNumber;
Default Value
3
Remarks
These fields are used in many places in the different records that make up an X9.37 file.
RecordType Property (Check21 Module)
A code that indicates the type of records contained in this file.
Syntax
public var recordType: Check21RecordTypes { get {...} set {...} }
public enum Check21RecordTypes: Int32 { case rtNoChecks = 0 case rtChecksNoImages = 1 case rtChecksAndImages = 2 case rtImagesForCashLetter = 3 }
@property (nonatomic,readwrite,assign,getter=recordType,setter=setRecordType:) int recordType; - (int)recordType; - (void)setRecordType :(int)newRecordType;
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 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. |
ReturnRoutingNumber Property (Check21 Module)
A routing number indicating the location to which returns and return notifications should be sent.
Syntax
public var returnRoutingNumber: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=returnRoutingNumber,setter=setReturnRoutingNumber:) NSString* returnRoutingNumber; - (NSString*)returnRoutingNumber; - (void)setReturnRoutingNumber :(NSString*)newReturnRoutingNumber;
Default Value
""
Remarks
This routing number is specified by the institution that creates the file, and specifies the location to which returns, return notifications, and preliminary return notifications should be sent. This property is part of the Bundle Header record (type 20), and is exactly 9 characters long including the check digit.
SettlementDate Property (Check21 Module)
The date that the institution that created the file expects settlement.
Syntax
public var settlementDate: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=settlementDate,setter=setSettlementDate:) NSString* settlementDate; - (NSString*)settlementDate; - (void)setSettlementDate :(NSString*)newSettlementDate;
Default Value
""
Remarks
This property is part of the Cash Letter Control record (type 90), and is in the format YYYYMMDD.
SSLAcceptServerCert Property (Check21 Module)
Instructs the module to unconditionally accept the server certificate that matches the supplied certificate.
Syntax
public var sslAcceptServerCert: Certificate { get {...} set {...} }
@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertEffectiveDate) NSString* SSLAcceptServerCertEffectiveDate; - (NSString*)SSLAcceptServerCertEffectiveDate; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertExpirationDate) NSString* SSLAcceptServerCertExpirationDate; - (NSString*)SSLAcceptServerCertExpirationDate; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertExtendedKeyUsage) NSString* SSLAcceptServerCertExtendedKeyUsage; - (NSString*)SSLAcceptServerCertExtendedKeyUsage; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertFingerprint) NSString* SSLAcceptServerCertFingerprint; - (NSString*)SSLAcceptServerCertFingerprint; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertFingerprintSHA1) NSString* SSLAcceptServerCertFingerprintSHA1; - (NSString*)SSLAcceptServerCertFingerprintSHA1; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertFingerprintSHA256) NSString* SSLAcceptServerCertFingerprintSHA256; - (NSString*)SSLAcceptServerCertFingerprintSHA256; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertIssuer) NSString* SSLAcceptServerCertIssuer; - (NSString*)SSLAcceptServerCertIssuer; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPrivateKey) NSString* SSLAcceptServerCertPrivateKey; - (NSString*)SSLAcceptServerCertPrivateKey; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPrivateKeyAvailable) BOOL SSLAcceptServerCertPrivateKeyAvailable; - (BOOL)SSLAcceptServerCertPrivateKeyAvailable; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPrivateKeyContainer) NSString* SSLAcceptServerCertPrivateKeyContainer; - (NSString*)SSLAcceptServerCertPrivateKeyContainer; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPublicKey) NSString* SSLAcceptServerCertPublicKey; - (NSString*)SSLAcceptServerCertPublicKey; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPublicKeyAlgorithm) NSString* SSLAcceptServerCertPublicKeyAlgorithm; - (NSString*)SSLAcceptServerCertPublicKeyAlgorithm; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPublicKeyLength) int SSLAcceptServerCertPublicKeyLength; - (int)SSLAcceptServerCertPublicKeyLength; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertSerialNumber) NSString* SSLAcceptServerCertSerialNumber; - (NSString*)SSLAcceptServerCertSerialNumber; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertSignatureAlgorithm) NSString* SSLAcceptServerCertSignatureAlgorithm; - (NSString*)SSLAcceptServerCertSignatureAlgorithm; @property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStore,setter=setSSLAcceptServerCertStore:) NSString* SSLAcceptServerCertStore; - (NSString*)SSLAcceptServerCertStore; - (void)setSSLAcceptServerCertStore :(NSString*)newSSLAcceptServerCertStore; @property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStoreB,setter=setSSLAcceptServerCertStoreB:) NSData* SSLAcceptServerCertStoreB; - (NSData*)SSLAcceptServerCertStoreB; - (void)setSSLAcceptServerCertStoreB :(NSData*)newSSLAcceptServerCertStore; @property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStorePassword,setter=setSSLAcceptServerCertStorePassword:) NSString* SSLAcceptServerCertStorePassword; - (NSString*)SSLAcceptServerCertStorePassword; - (void)setSSLAcceptServerCertStorePassword :(NSString*)newSSLAcceptServerCertStorePassword; @property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStoreType,setter=setSSLAcceptServerCertStoreType:) int SSLAcceptServerCertStoreType; - (int)SSLAcceptServerCertStoreType; - (void)setSSLAcceptServerCertStoreType :(int)newSSLAcceptServerCertStoreType; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertSubjectAltNames) NSString* SSLAcceptServerCertSubjectAltNames; - (NSString*)SSLAcceptServerCertSubjectAltNames; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertThumbprintMD5) NSString* SSLAcceptServerCertThumbprintMD5; - (NSString*)SSLAcceptServerCertThumbprintMD5; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertThumbprintSHA1) NSString* SSLAcceptServerCertThumbprintSHA1; - (NSString*)SSLAcceptServerCertThumbprintSHA1; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertThumbprintSHA256) NSString* SSLAcceptServerCertThumbprintSHA256; - (NSString*)SSLAcceptServerCertThumbprintSHA256; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertUsage) NSString* SSLAcceptServerCertUsage; - (NSString*)SSLAcceptServerCertUsage; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertUsageFlags) int SSLAcceptServerCertUsageFlags; - (int)SSLAcceptServerCertUsageFlags; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertVersion) NSString* SSLAcceptServerCertVersion; - (NSString*)SSLAcceptServerCertVersion; @property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertSubject,setter=setSSLAcceptServerCertSubject:) NSString* SSLAcceptServerCertSubject; - (NSString*)SSLAcceptServerCertSubject; - (void)setSSLAcceptServerCertSubject :(NSString*)newSSLAcceptServerCertSubject; @property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncoded,setter=setSSLAcceptServerCertEncoded:) NSString* SSLAcceptServerCertEncoded; - (NSString*)SSLAcceptServerCertEncoded; - (void)setSSLAcceptServerCertEncoded :(NSString*)newSSLAcceptServerCertEncoded; @property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncodedB,setter=setSSLAcceptServerCertEncodedB:) NSData* SSLAcceptServerCertEncodedB; - (NSData*)SSLAcceptServerCertEncodedB; - (void)setSSLAcceptServerCertEncodedB :(NSData*)newSSLAcceptServerCertEncoded;
Default Value
3
Remarks
If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.
You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.
Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.
SSLCert Property (Check21 Module)
The certificate to be used during Secure Sockets Layer (SSL) negotiation.
Syntax
public var sslCert: Certificate { get {...} set {...} }
@property (nonatomic,readonly,assign,getter=SSLCertEffectiveDate) NSString* SSLCertEffectiveDate; - (NSString*)SSLCertEffectiveDate; @property (nonatomic,readonly,assign,getter=SSLCertExpirationDate) NSString* SSLCertExpirationDate; - (NSString*)SSLCertExpirationDate; @property (nonatomic,readonly,assign,getter=SSLCertExtendedKeyUsage) NSString* SSLCertExtendedKeyUsage; - (NSString*)SSLCertExtendedKeyUsage; @property (nonatomic,readonly,assign,getter=SSLCertFingerprint) NSString* SSLCertFingerprint; - (NSString*)SSLCertFingerprint; @property (nonatomic,readonly,assign,getter=SSLCertFingerprintSHA1) NSString* SSLCertFingerprintSHA1; - (NSString*)SSLCertFingerprintSHA1; @property (nonatomic,readonly,assign,getter=SSLCertFingerprintSHA256) NSString* SSLCertFingerprintSHA256; - (NSString*)SSLCertFingerprintSHA256; @property (nonatomic,readonly,assign,getter=SSLCertIssuer) NSString* SSLCertIssuer; - (NSString*)SSLCertIssuer; @property (nonatomic,readonly,assign,getter=SSLCertPrivateKey) NSString* SSLCertPrivateKey; - (NSString*)SSLCertPrivateKey; @property (nonatomic,readonly,assign,getter=SSLCertPrivateKeyAvailable) BOOL SSLCertPrivateKeyAvailable; - (BOOL)SSLCertPrivateKeyAvailable; @property (nonatomic,readonly,assign,getter=SSLCertPrivateKeyContainer) NSString* SSLCertPrivateKeyContainer; - (NSString*)SSLCertPrivateKeyContainer; @property (nonatomic,readonly,assign,getter=SSLCertPublicKey) NSString* SSLCertPublicKey; - (NSString*)SSLCertPublicKey; @property (nonatomic,readonly,assign,getter=SSLCertPublicKeyAlgorithm) NSString* SSLCertPublicKeyAlgorithm; - (NSString*)SSLCertPublicKeyAlgorithm; @property (nonatomic,readonly,assign,getter=SSLCertPublicKeyLength) int SSLCertPublicKeyLength; - (int)SSLCertPublicKeyLength; @property (nonatomic,readonly,assign,getter=SSLCertSerialNumber) NSString* SSLCertSerialNumber; - (NSString*)SSLCertSerialNumber; @property (nonatomic,readonly,assign,getter=SSLCertSignatureAlgorithm) NSString* SSLCertSignatureAlgorithm; - (NSString*)SSLCertSignatureAlgorithm; @property (nonatomic,readwrite,assign,getter=SSLCertStore,setter=setSSLCertStore:) NSString* SSLCertStore; - (NSString*)SSLCertStore; - (void)setSSLCertStore :(NSString*)newSSLCertStore; @property (nonatomic,readwrite,assign,getter=SSLCertStoreB,setter=setSSLCertStoreB:) NSData* SSLCertStoreB; - (NSData*)SSLCertStoreB; - (void)setSSLCertStoreB :(NSData*)newSSLCertStore; @property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword; - (NSString*)SSLCertStorePassword; - (void)setSSLCertStorePassword :(NSString*)newSSLCertStorePassword; @property (nonatomic,readwrite,assign,getter=SSLCertStoreType,setter=setSSLCertStoreType:) int SSLCertStoreType; - (int)SSLCertStoreType; - (void)setSSLCertStoreType :(int)newSSLCertStoreType; @property (nonatomic,readonly,assign,getter=SSLCertSubjectAltNames) NSString* SSLCertSubjectAltNames; - (NSString*)SSLCertSubjectAltNames; @property (nonatomic,readonly,assign,getter=SSLCertThumbprintMD5) NSString* SSLCertThumbprintMD5; - (NSString*)SSLCertThumbprintMD5; @property (nonatomic,readonly,assign,getter=SSLCertThumbprintSHA1) NSString* SSLCertThumbprintSHA1; - (NSString*)SSLCertThumbprintSHA1; @property (nonatomic,readonly,assign,getter=SSLCertThumbprintSHA256) NSString* SSLCertThumbprintSHA256; - (NSString*)SSLCertThumbprintSHA256; @property (nonatomic,readonly,assign,getter=SSLCertUsage) NSString* SSLCertUsage; - (NSString*)SSLCertUsage; @property (nonatomic,readonly,assign,getter=SSLCertUsageFlags) int SSLCertUsageFlags; - (int)SSLCertUsageFlags; @property (nonatomic,readonly,assign,getter=SSLCertVersion) NSString* SSLCertVersion; - (NSString*)SSLCertVersion; @property (nonatomic,readwrite,assign,getter=SSLCertSubject,setter=setSSLCertSubject:) NSString* SSLCertSubject; - (NSString*)SSLCertSubject; - (void)setSSLCertSubject :(NSString*)newSSLCertSubject; @property (nonatomic,readwrite,assign,getter=SSLCertEncoded,setter=setSSLCertEncoded:) NSString* SSLCertEncoded; - (NSString*)SSLCertEncoded; - (void)setSSLCertEncoded :(NSString*)newSSLCertEncoded; @property (nonatomic,readwrite,assign,getter=SSLCertEncodedB,setter=setSSLCertEncodedB:) NSData* SSLCertEncodedB; - (NSData*)SSLCertEncodedB; - (void)setSSLCertEncodedB :(NSData*)newSSLCertEncoded;
Default Value
3
Remarks
This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the field to the encoded certificate. To select a certificate, use the store and subject fields.
SSLProvider Property (Check21 Module)
The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Syntax
public var sslProvider: Check21SSLProviders { get {...} set {...} }
public enum Check21SSLProviders: Int32 { case sslpAutomatic = 0 case sslpPlatform = 1 case sslpInternal = 2 }
@property (nonatomic,readwrite,assign,getter=SSLProvider,setter=setSSLProvider:) int SSLProvider; - (int)SSLProvider; - (void)setSSLProvider :(int)newSSLProvider;
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 as follows:
| 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
| 1 (sslpPlatform) | Uses the platform/system implementation. |
| 2 (sslpInternal) | Uses the internal implementation. |
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, the platform implementation will be used by default in all cases in the macOS edition.
SSLServerCert Property (Check21 Module)
The server certificate for the last established connection.
Syntax
public var sslServerCert: Certificate { get {...} }
@property (nonatomic,readonly,assign,getter=SSLServerCertEffectiveDate) NSString* SSLServerCertEffectiveDate; - (NSString*)SSLServerCertEffectiveDate; @property (nonatomic,readonly,assign,getter=SSLServerCertExpirationDate) NSString* SSLServerCertExpirationDate; - (NSString*)SSLServerCertExpirationDate; @property (nonatomic,readonly,assign,getter=SSLServerCertExtendedKeyUsage) NSString* SSLServerCertExtendedKeyUsage; - (NSString*)SSLServerCertExtendedKeyUsage; @property (nonatomic,readonly,assign,getter=SSLServerCertFingerprint) NSString* SSLServerCertFingerprint; - (NSString*)SSLServerCertFingerprint; @property (nonatomic,readonly,assign,getter=SSLServerCertFingerprintSHA1) NSString* SSLServerCertFingerprintSHA1; - (NSString*)SSLServerCertFingerprintSHA1; @property (nonatomic,readonly,assign,getter=SSLServerCertFingerprintSHA256) NSString* SSLServerCertFingerprintSHA256; - (NSString*)SSLServerCertFingerprintSHA256; @property (nonatomic,readonly,assign,getter=SSLServerCertIssuer) NSString* SSLServerCertIssuer; - (NSString*)SSLServerCertIssuer; @property (nonatomic,readonly,assign,getter=SSLServerCertPrivateKey) NSString* SSLServerCertPrivateKey; - (NSString*)SSLServerCertPrivateKey; @property (nonatomic,readonly,assign,getter=SSLServerCertPrivateKeyAvailable) BOOL SSLServerCertPrivateKeyAvailable; - (BOOL)SSLServerCertPrivateKeyAvailable; @property (nonatomic,readonly,assign,getter=SSLServerCertPrivateKeyContainer) NSString* SSLServerCertPrivateKeyContainer; - (NSString*)SSLServerCertPrivateKeyContainer; @property (nonatomic,readonly,assign,getter=SSLServerCertPublicKey) NSString* SSLServerCertPublicKey; - (NSString*)SSLServerCertPublicKey; @property (nonatomic,readonly,assign,getter=SSLServerCertPublicKeyAlgorithm) NSString* SSLServerCertPublicKeyAlgorithm; - (NSString*)SSLServerCertPublicKeyAlgorithm; @property (nonatomic,readonly,assign,getter=SSLServerCertPublicKeyLength) int SSLServerCertPublicKeyLength; - (int)SSLServerCertPublicKeyLength; @property (nonatomic,readonly,assign,getter=SSLServerCertSerialNumber) NSString* SSLServerCertSerialNumber; - (NSString*)SSLServerCertSerialNumber; @property (nonatomic,readonly,assign,getter=SSLServerCertSignatureAlgorithm) NSString* SSLServerCertSignatureAlgorithm; - (NSString*)SSLServerCertSignatureAlgorithm; @property (nonatomic,readonly,assign,getter=SSLServerCertStore) NSString* SSLServerCertStore; - (NSString*)SSLServerCertStore; @property (nonatomic,readonly,assign,getter=SSLServerCertStoreB) NSData* SSLServerCertStoreB; - (NSData*)SSLServerCertStoreB; @property (nonatomic,readonly,assign,getter=SSLServerCertStorePassword) NSString* SSLServerCertStorePassword; - (NSString*)SSLServerCertStorePassword; @property (nonatomic,readonly,assign,getter=SSLServerCertStoreType) int SSLServerCertStoreType; - (int)SSLServerCertStoreType; @property (nonatomic,readonly,assign,getter=SSLServerCertSubjectAltNames) NSString* SSLServerCertSubjectAltNames; - (NSString*)SSLServerCertSubjectAltNames; @property (nonatomic,readonly,assign,getter=SSLServerCertThumbprintMD5) NSString* SSLServerCertThumbprintMD5; - (NSString*)SSLServerCertThumbprintMD5; @property (nonatomic,readonly,assign,getter=SSLServerCertThumbprintSHA1) NSString* SSLServerCertThumbprintSHA1; - (NSString*)SSLServerCertThumbprintSHA1; @property (nonatomic,readonly,assign,getter=SSLServerCertThumbprintSHA256) NSString* SSLServerCertThumbprintSHA256; - (NSString*)SSLServerCertThumbprintSHA256; @property (nonatomic,readonly,assign,getter=SSLServerCertUsage) NSString* SSLServerCertUsage; - (NSString*)SSLServerCertUsage; @property (nonatomic,readonly,assign,getter=SSLServerCertUsageFlags) int SSLServerCertUsageFlags; - (int)SSLServerCertUsageFlags; @property (nonatomic,readonly,assign,getter=SSLServerCertVersion) NSString* SSLServerCertVersion; - (NSString*)SSLServerCertVersion; @property (nonatomic,readonly,assign,getter=SSLServerCertSubject) NSString* SSLServerCertSubject; - (NSString*)SSLServerCertSubject; @property (nonatomic,readonly,assign,getter=SSLServerCertEncoded) NSString* SSLServerCertEncoded; - (NSString*)SSLServerCertEncoded; @property (nonatomic,readonly,assign,getter=SSLServerCertEncodedB) NSData* SSLServerCertEncodedB; - (NSData*)SSLServerCertEncodedB;
Default Value
3
Remarks
This property contains the server certificate for the last established connection.
SSLServerCert is reset every time a new connection is attempted.
SSLStartMode Property (Check21 Module)
This property determines how the module starts the Secure Sockets Layer (SSL) negotiation.
Syntax
public var sslStartMode: Check21SSLStartModes { get {...} set {...} }
public enum Check21SSLStartModes: Int32 { case sslAutomatic = 0 case sslImplicit = 1 case sslExplicit = 2 case sslNone = 3 }
@property (nonatomic,readwrite,assign,getter=SSLStartMode,setter=setSSLStartMode:) int SSLStartMode; - (int)SSLStartMode; - (void)setSSLStartMode :(int)newSSLStartMode;
Default Value
3
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 will 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. |
BuildAndUploadFile Method (Check21 Module)
Builds an X9.37 file and uploads it to an FTP server.
Syntax
public func buildAndUploadFile() throws -> Void
- (void)buildAndUploadFile;
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 (Check21 Module)
Builds an X9.37 file.
Syntax
public func buildFile() throws -> Void
- (void)buildFile;
Remarks
This method builds a complete X9.37 file. If the FileName is specified, the file will be saved to the path and filename indicated there. If no FileName is given, the resultant file will be stored in memory, and can be accessed in the FileData property.
An X9.37 file created by this 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 (Check21 Module)
Sets or retrieves a configuration setting.
Syntax
- (NSString*)config:(NSString*)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 (Check21 Module)
This method processes events from the internal message queue.
Syntax
public func doEvents() throws -> Void
- (void)doEvents;
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 (Check21 Module)
This method interrupts the current method.
Syntax
public func interrupt() throws -> Void
- (void)interrupt;
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
Reset Method (Check21 Module)
Reset the internal state of the component and all properties to their default values.
Syntax
public func reset() throws -> Void
- (void)reset;
Remarks
The Reset method doesn't have any parameters and doesn't return any value.
Error Event (Check21 Module)
Information about non-fatal errors encountered during file construction.
Syntax
- (void)onError:(int)errorCode :(NSString*)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 (Check21 Module)
Fired after the server presents its certificate to the client.
Syntax
func onSSLServerAuthentication(certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)
- (void)onSSLServerAuthentication:(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)accept;
Remarks
During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (Check21 Module)
Fired when secure connection progress messages are available.
Syntax
func onSSLStatus(message: String)
- (void)onSSLStatus:(NSString*)message;
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
Status Event (Check21 Module)
Traces the commands sent to the server, and the respective replies.
Syntax
func onStatus(message: String)
- (void)onStatus:(NSString*)message;
Remarks
The Status event is useful for debugging purposes. It shows all the interaction between the client and the server, line by line.
Certificate Type
This is the digital certificate being used.
Remarks
This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.
- EffectiveDate
- ExpirationDate
- ExtendedKeyUsage
- Fingerprint
- FingerprintSHA1
- FingerprintSHA256
- Issuer
- PrivateKey
- PrivateKeyAvailable
- PrivateKeyContainer
- PublicKey
- PublicKeyAlgorithm
- PublicKeyLength
- SerialNumber
- SignatureAlgorithm
- Store
- StorePassword
- StoreType
- SubjectAltNames
- ThumbprintMD5
- ThumbprintSHA1
- ThumbprintSHA256
- Usage
- UsageFlags
- Version
- Subject
- Encoded
Fields
effectiveDate
String (read-only)
Default Value: ""
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
expirationDate
String (read-only)
Default Value: ""
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
extendedKeyUsage
String (read-only)
Default Value: ""
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
fingerprint
String (read-only)
Default Value: ""
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
fingerprintSHA1
String (read-only)
Default Value: ""
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
fingerprintSHA256
String (read-only)
Default Value: ""
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
issuer
String (read-only)
Default Value: ""
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
privateKey
String (read-only)
Default Value: ""
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The may be available but not exportable. In this case, returns an empty string.
privateKeyAvailable
Bool (read-only)
Default Value: False
Whether a is available for the selected certificate. If is True, the certificate may be used for authentication purposes (e.g., server authentication).
privateKeyContainer
String (read-only)
Default Value: ""
The name of the container for the certificate (if available). This functionality is available only on Windows platforms.
publicKey
String (read-only)
Default Value: ""
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
publicKeyAlgorithm
String (read-only)
Default Value: ""
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
publicKeyLength
Int32 (read-only)
Default Value: 0
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
serialNumber
String (read-only)
Default Value: ""
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
signatureAlgorithm
String (read-only)
Default Value: ""
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
storeB
Data
Default Value: "MY"
The name of the certificate store for the client certificate.
The property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in .
is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details.
Designations of certificate stores are platform dependent.
The following designations are 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
store
String
Default Value: "MY"
The name of the certificate store for the client certificate.
The property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in .
is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details.
Designations of certificate stores are platform dependent.
The following designations are 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
storePassword
String
Default Value: ""
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
storeType
CertStoreTypes
Default Value: 0
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 (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) 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 PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 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 PKCS#11 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 PKCS#11 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 and set to the PIN. Code Example. SSH Authentication with Security Key:
|
| 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. |
subjectAltNames
String (read-only)
Default Value: ""
Comma-separated lists of alternative subject names for the certificate.
thumbprintMD5
String (read-only)
Default Value: ""
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
thumbprintSHA1
String (read-only)
Default Value: ""
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
thumbprintSHA256
String (read-only)
Default Value: ""
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
usage
String (read-only)
Default Value: ""
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
usageFlags
Int32 (read-only)
Default Value: 0
The flags that show intended use for the certificate. The value of is a combination of the following flags:
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |
Please see the property for a text representation of .
This functionality currently is not available when the provider is OpenSSL.
version
String (read-only)
Default Value: ""
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
subject
String
Default Value: ""
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a 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 as follows:
| Field | Meaning |
| CN | Common Name. This is commonly a hostname 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.
encodedB
Data
Default Value: ""
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate.
When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string.
encoded
String
Default Value: ""
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate.
When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string.
Constructors
public init()
Creates a instance whose properties can be set. This is useful for use with when generating new certificates.
public init(encoded: )
Parses Encoded as an X.509 public key.
public init(storeType: , store: , storePassword: , subject: )
StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store.
After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public init(storeType: , store: , storePassword: , subject: )
StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.
After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
CheckDetail Type
Contains information about a check to be written to file.
Remarks
A CheckDetail type contains MICR information read off of a physical check, as well as the Bank of First Deposit's routing number and the name of the payee. A check may also optionally contain a scan of the front and back of the paper check.
- Amount
- BackImageCreationDate
- BackImageData
- BackImageFileName
- BackImageReferenceKey
- BOFDAccountNumber
- BOFDBranch
- BOFDConversionIndicator
- BOFDRoutingNumber
- BOFDTruncator
- CanRecreateImages
- FrontImageCreationDate
- FrontImageData
- FrontImageFileName
- FrontImageReferenceKey
- ImageCompression
- ImageCreatorRoutingNumber
- ImageFormat
- MICRAuxOnUs
- MICROnUs
- MICRProcessingCode
- MICRRoutingNumber
- PayeeName
- SequenceNumber
Fields
amount
String
Default Value: ""
The US dollar value of the check. This property is part of the Check detail record (type 25), and is 10 characters in length.
backImageCreationDate
String
Default Value: ""
Date assigned by the image creator for the image contained in . This property is part of the Image View Detail record (type 50), and is in the format "YYYYMMDD".
backImageDataB
Data
Default Value: ""
This property contains the scanned image of the back of the physical check, in the format specified by and compressed using the designated . 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 property. If both are specified will be used. If both properties are left empty, no records referencing the back image of the check will be added to the file.
backImageData
String
Default Value: ""
This property contains the scanned image of the back of the physical check, in the format specified by and compressed using the designated . 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 property. If both are specified will be used. If both properties are left empty, no records referencing the back image of the check will be added to the file.
backImageFileName
String
Default Value: ""
This property contains location of a scanned image of the back of the physical check, in the format specified by and compressed using the designated . 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 property. If both properties are specified will be used and will be ignored. If both properties are left empty, no records referencing the back image of the check will be added to the file.
backImageReferenceKey
String
Default Value: ""
A designator assigned by the ECE institution that uniquely identifies the . This designator could be a key that would be used by the creating institution to located the unique associated image, or it could provide a full access path and name that would allow direct external look up and access of the image. For example, this could be a URL.
bofdAccountNumber
String
Default Value: ""
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.
bofdBranch
String
Default Value: ""
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.
bofdConversionIndicator
String
Default Value: ""
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. |
bofdRoutingNumber
String
Default Value: ""
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.
bofdTruncator
Bool
Default Value: True
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.
canRecreateImages
Bool
Default Value: True
A code that indicates whether the sender has the ability to recreate the check images (from the original source) for the duration of the agreed to retention time frame.
frontImageCreationDate
String
Default Value: ""
Date assigned by the image creator for the image contained in . This property is part of the Image View Detail record (type 50), and is in the format "YYYYMMDD".
frontImageDataB
Data
Default Value: ""
This property contains the scanned image of the front of the physical check, in the format specified by and compressed using the designated . 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 property. If both are specified will be used. If both properties are left empty, no records referencing the front image of the check will be added to the file.
frontImageData
String
Default Value: ""
This property contains the scanned image of the front of the physical check, in the format specified by and compressed using the designated . 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 property. If both are specified will be used. If both properties are left empty, no records referencing the front image of the check will be added to the file.
frontImageFileName
String
Default Value: ""
This property contains location of a scanned image of the front of the physical check, in the format specified by and compressed using the designated . 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 property. If both properties are specified will be used and will be ignored. If both properties are left empty, no records referencing the front image of the check will be added to the file.
frontImageReferenceKey
String
Default Value: ""
A designator assigned by the ECE institution that uniquely identifies the . This designator could be a key that would be used by the creating institution to located the unique associated image, or it could provide a full access path and name that would allow direct external look up and access of the image. For example, this could be a URL.
imageCompression
CompressionTypes
Default Value: 1
A code that identifies the algorithm or method used to compress the images stored in the and 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. |
imageCreatorRoutingNumber
String
Default Value: ""
A number that identifies the financial institution that created the image (if different from ). 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.
imageFormat
ImageFormats
Default Value: 0
A code that identifies the type of image format used for the images contained in the and 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 or 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. |
micrAuxOnUs
String
Default Value: ""
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.
micrOnUs
String
Default Value: ""
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.
micrProcessingCode
String
Default Value: ""
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.
micrRoutingNumber
String
Default Value: ""
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.
payeeName
String
Default Value: ""
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.
sequenceNumber
String
Default Value: ""
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.
Constructors
public init()
FTPSettings Type
Used to connect to an FTP or FTPS server for uploading X9.37 files.
Remarks
These ftp fields are only necessary when uploading an X9.37 file to an FTP or FTPS server. The and fields specify the server you wish to connect to. contains the path at which you wish to save the file, and indicates the filename that will be saved on the FTP server after upload. (It does not have to match the property). and contain your logon credentials for the FTP server.
Fields
password
String
Default Value: ""
The password to login with. This property must be set before the class begins a file upload.
remoteFile
String
Default Value: ""
The name of the file as it will appear on the server after upload. The can contain only the file name, an absolute path and filename, or a relative path based on .
remoteHost
String
Default Value: ""
The domain name or IP address of the FTP server the file is to be uploaded to.
The 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 property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the 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.
remotePath
String
Default Value: ""
The current path on the FTP server. The 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 .
If the first two bytes of the new path are "..", then a change to one level above in the directory tree is performed.
remotePort
Int32
Default Value: 21
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.
timeout
Int32
Default Value: 60
A timeout to use when uploading via FTP.
When uploading the X9.37 file to the FTP , the class will use this property to determine how long to wait for the operation to complete before returning control. The property cannot be set to 0
The default value for the Timeout property is 60 (seconds).
user
String
Default Value: ""
The user id to login as. This property must be set before the class begins a file upload.
Constructors
public init()
Origin Type
Specifies the originator of a file and the checks contained within.
Remarks
These fields are used in many places in the different records that make up an X9.37 file.
Fields
contactName
String
Default Value: ""
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.
contactPhone
String
Default Value: ""
The phone number of the 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.
originName
String
Default Value: ""
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.
routingNumber
String
Default Value: ""
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.
Constructors
public init()
public init(originName: , routingNumber: , contactName: , contactPhone: )
Config Settings (Check21 Module)
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
| " " (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. |
| Y | Indicates ECE institution is BOFD. (default) |
| N | Indicates ECE institution is not BOFD. |
| U | Indicates ECE institution relationship to BOFD is undetermined. |
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.
| 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. |
| 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. |
Base Config Settings
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 |
| 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 |
- 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.
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.
Setting this configuration setting to tells the class to use the internal implementation instead of using the system security libraries.
This setting is set to by default on all platforms.
Trappable Errors (Check21 Module)
Check21 Errors
| 143 | Busy performing current action |