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.

Method List

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

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.

Config Settings

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

BusinessDate Property (Check21 Module)

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

Syntax

• Swift
• Objective-C

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

• Swift
• Objective-C

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

• Swift
• Objective-C

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

The SSLStartMode property may have one of the following values:

CollectionType Property (Check21 Module)

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

Syntax

• Swift
• Objective-C

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.

CycleNumber Property (Check21 Module)

Denotes the cycle under which the file is created.

Syntax

• Swift
• Objective-C

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

• Swift
• Objective-C

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

• Swift
• Objective-C

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

• Swift
• Objective-C

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:

FileData Property (Check21 Module)

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

Syntax

• Swift
• Objective-C

public var fileData: String {
  get {...}
}

public var fileDataB: Data {
  get {...}
}

@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

• Swift
• Objective-C

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

• Swift
• Objective-C

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

The SSLStartMode property may have one of the following values:

Origin Property (Check21 Module)

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

Syntax

• Swift
• Objective-C

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

The SSLStartMode property may have one of the following values:

RecordType Property (Check21 Module)

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

Syntax

• Swift
• Objective-C

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:

ReturnRoutingNumber Property (Check21 Module)

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

Syntax

• Swift
• Objective-C

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

• Swift
• Objective-C

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.

SSLAcceptServerCertEncoded Property (Check21 Module)

This is the certificate (PEM/base64 encoded).

Syntax

• Swift
• Objective-C

public var sslAcceptServerCertEncoded: String {
  get {...}
  set {...}
}

public var sslAcceptServerCertEncodedB: Data {
  get {...}
  set {...}
}

@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

""

Remarks

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

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

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLAcceptServerCertEncodedB(sslAcceptServerCertEncoded: Data) throws
public func setSSLAcceptServerCertEncoded(sslAcceptServerCertEncoded: String) throws

SSLCertEncoded Property (Check21 Module)

This is the certificate (PEM/base64 encoded).

Syntax

• Swift
• Objective-C

public var sslCertEncoded: String {
  get {...}
  set {...}
}

public var sslCertEncodedB: Data {
  get {...}
  set {...}
}

@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

""

Remarks

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

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

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertEncodedB(sslCertEncoded: Data) throws
public func setSSLCertEncoded(sslCertEncoded: String) throws

SSLCertStore Property (Check21 Module)

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

Syntax

• Swift
• Objective-C

public var sslCertStore: String {
  get {...}
  set {...}
}

public var sslCertStoreB: Data {
  get {...}
  set {...}
}

@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;

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform-dependent.

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

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

SSLCertStorePassword Property (Check21 Module)

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

Syntax

• Swift
• Objective-C

public var sslCertStorePassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword;

- (NSString*)SSLCertStorePassword;
- (void)setSSLCertStorePassword :(NSString*)newSSLCertStorePassword;

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.

SSLCertStoreType Property (Check21 Module)

This is the type of certificate store for this certificate.

Syntax

• Swift
• Objective-C

public var sslCertStoreType: Check21SSLCertStoreTypes {
  get {...}
  set {...}
}

public enum Check21SSLCertStoreTypes: Int32 {
  case cstUser = 0
  case cstMachine = 1
  case cstPFXFile = 2
  case cstPFXBlob = 3
  case cstJKSFile = 4
  case cstJKSBlob = 5
  case cstPEMKeyFile = 6
  case cstPEMKeyBlob = 7
  case cstPublicKeyFile = 8
  case cstPublicKeyBlob = 9
  case cstSSHPublicKeyBlob = 10
  case cstP7BFile = 11
  case cstP7BBlob = 12
  case cstSSHPublicKeyFile = 13
  case cstPPKFile = 14
  case cstPPKBlob = 15
  case cstXMLFile = 16
  case cstXMLBlob = 17
  case cstJWKFile = 18
  case cstJWKBlob = 19
  case cstSecurityKey = 20
  case cstBCFKSFile = 21
  case cstBCFKSBlob = 22
  case cstPKCS11 = 23
  case cstAuto = 99
}

@property (nonatomic,readwrite,assign,getter=SSLCertStoreType,setter=setSSLCertStoreType:) int SSLCertStoreType;

- (int)SSLCertStoreType;
- (void)setSSLCertStoreType :(int)newSSLCertStoreType;

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:

SSLCertSubject Property (Check21 Module)

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

Syntax

• Swift
• Objective-C

public var sslCertSubject: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertSubject,setter=setSSLCertSubject:) NSString* SSLCertSubject;

- (NSString*)SSLCertSubject;
- (void)setSSLCertSubject :(NSString*)newSSLCertSubject;

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.

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

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertSubject(sslCertSubject: String) throws

SSLProvider Property (Check21 Module)

This specifies the SSL/TLS implementation to use.

Syntax

• Swift
• Objective-C

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:

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 the platform implementation will be used by default in all cases in the macOS edition.

SSLServerCertEncoded Property (Check21 Module)

This is the certificate (PEM/base64 encoded).

Syntax

• Swift
• Objective-C

public var sslServerCertEncoded: String {
  get {...}
}

public var sslServerCertEncodedB: Data {
  get {...}
}

@property (nonatomic,readonly,assign,getter=SSLServerCertEncoded) NSString* SSLServerCertEncoded;

- (NSString*)SSLServerCertEncoded;

@property (nonatomic,readonly,assign,getter=SSLServerCertEncodedB) NSData* SSLServerCertEncodedB;

- (NSData*)SSLServerCertEncodedB;

Default Value

""

Remarks

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

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

This property is read-only.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLServerCertEncodedB(sslServerCertEncoded: Data) throws
public func setSSLServerCertEncoded(sslServerCertEncoded: String) throws

SSLStartMode Property (Check21 Module)

Determines how the module starts the SSL negotiation.

Syntax

• Swift
• Objective-C

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:

BuildAndUploadFile Method (Check21 Module)

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

Syntax

• Swift
• Objective-C

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

• Swift
• Objective-C

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

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

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

Processes events from the internal message queue.

Syntax

• Swift
• Objective-C

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)

Interrupt the current method.

Syntax

• Swift
• Objective-C

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

• Swift
• Objective-C

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

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

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

• Swift
• Objective-C

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

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

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

SSLStatus Event (Check21 Module)

Shows the progress of the secure connection.

Syntax

• Swift
• Objective-C

func onSSLStatus(message: String)

- (void)onSSLStatus:(NSString*)message;

Remarks

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

Status Event (Check21 Module)

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

Syntax

• Swift
• Objective-C

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.

CheckDetail Type

Contains information about a check to be written to file.

Remarks

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

Fields

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

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

Constructors

public init()

public init(originName: , routingNumber: , contactName: , contactPhone: )

Config Settings (Check21 Module)

Trappable Errors (Check21 Module)

Check21 Errors

	143   Busy performing current action