Check21 Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

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 CheckBOFDConversionIndicator should also be set to "2" if this bank converted the original check into the image being included. Check21.CheckBOFDRoutingNumber(0) = "111012822" Check21.CheckBOFDAccountNumber(0) = "181818181818181818" Check21.CheckBOFDBranch(0) = "Asgard" Check21.CheckBOFDConversionIndicator(0) = "2" Finally, you must include images of the front and back of the check, and indicate the format and compression used to create those images. You may use CheckFrontImageFilename and CheckBackImageFilename properties to point to image files on disk, or you may set the binary data directly in CheckFrontImageData and CheckBackImageData. You also need to set a unique identifier that can be used to retrieve the images at a later date. Check21.CheckImageFormat(0) = ifTIFF ' default Check21.CheckImageCompression(0) = icJPEG ' default Check21.CheckCanRecreateImages(0) = True ' default Check21.CheckFrontImageFilename(0) = "front.jpg" Check21.CheckFrontImageReferenceKey(0) = "72234215front" Check21.CheckBackImageFilename(0) = "back.jpg" Check21.CheckBackImageReferenceKey(0) = "72234215back" Now call BuildFile to build the file and save it to the Filename you indicated earlier. If you have an FTPS server (TLS/SSL-secured FTP) to upload the files to, you may set the FTP properties and call BuildAndUploadFile method instead.

Property List

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

Method List

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

Event List

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

Config Settings

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

BusinessDate Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBusinessDate();
int SetBusinessDate(const char* lpszBusinessDate);

Unicode (Windows)
LPWSTR GetBusinessDate();
INT SetBusinessDate(LPCWSTR lpszBusinessDate);

char* inpay_check21_getbusinessdate(void* lpObj);
int inpay_check21_setbusinessdate(void* lpObj, const char* lpszBusinessDate);

QString GetBusinessDate();
int SetBusinessDate(QString qsBusinessDate);

Default Value

""

Remarks

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

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

Data Type

String

CashLetterId Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCashLetterId();
int SetCashLetterId(const char* lpszCashLetterId);

Unicode (Windows)
LPWSTR GetCashLetterId();
INT SetCashLetterId(LPCWSTR lpszCashLetterId);

char* inpay_check21_getcashletterid(void* lpObj);
int inpay_check21_setcashletterid(void* lpObj, const char* lpszCashLetterId);

QString GetCashLetterId();
int SetCashLetterId(QString qsCashLetterId);

Default Value

""

Remarks

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

Data Type

String

CheckCount Property (Check21 Class)

The number of records in the Check arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCheckCount();
int SetCheckCount(int iCheckCount);

Unicode (Windows)
INT GetCheckCount();
INT SetCheckCount(INT iCheckCount);

int inpay_check21_getcheckcount(void* lpObj);
int inpay_check21_setcheckcount(void* lpObj, int iCheckCount);

int GetCheckCount();
int SetCheckCount(int iCheckCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

This property is not available at design time.

Data Type

Integer

CheckAmount Property (Check21 Class)

The US dollar value of the check.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCheckAmount(int iCheckIndex);
int SetCheckAmount(int iCheckIndex, const char* lpszCheckAmount);

Unicode (Windows)
LPWSTR GetCheckAmount(INT iCheckIndex);
INT SetCheckAmount(INT iCheckIndex, LPCWSTR lpszCheckAmount);

char* inpay_check21_getcheckamount(void* lpObj, int checkindex);
int inpay_check21_setcheckamount(void* lpObj, int checkindex, const char* lpszCheckAmount);

QString GetCheckAmount(int iCheckIndex);
int SetCheckAmount(int iCheckIndex, QString qsCheckAmount);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

CheckBackImageCreationDate Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCheckBackImageCreationDate(int iCheckIndex);
int SetCheckBackImageCreationDate(int iCheckIndex, const char* lpszCheckBackImageCreationDate);

Unicode (Windows)
LPWSTR GetCheckBackImageCreationDate(INT iCheckIndex);
INT SetCheckBackImageCreationDate(INT iCheckIndex, LPCWSTR lpszCheckBackImageCreationDate);

char* inpay_check21_getcheckbackimagecreationdate(void* lpObj, int checkindex);
int inpay_check21_setcheckbackimagecreationdate(void* lpObj, int checkindex, const char* lpszCheckBackImageCreationDate);

QString GetCheckBackImageCreationDate(int iCheckIndex);
int SetCheckBackImageCreationDate(int iCheckIndex, QString qsCheckBackImageCreationDate);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

CheckBackImageData Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCheckBackImageData(int iCheckIndex, char* &lpCheckBackImageData, int &lenCheckBackImageData);
int SetCheckBackImageData(int iCheckIndex, const char* lpCheckBackImageData, int lenCheckBackImageData);

Unicode (Windows)
INT GetCheckBackImageData(INT iCheckIndex, LPSTR &lpCheckBackImageData, INT &lenCheckBackImageData);
INT SetCheckBackImageData(INT iCheckIndex, LPCSTR lpCheckBackImageData, INT lenCheckBackImageData);

int inpay_check21_getcheckbackimagedata(void* lpObj, int checkindex, char** lpCheckBackImageData, int* lenCheckBackImageData);
int inpay_check21_setcheckbackimagedata(void* lpObj, int checkindex, const char* lpCheckBackImageData, int lenCheckBackImageData);

QByteArray GetCheckBackImageData(int iCheckIndex);
int SetCheckBackImageData(int iCheckIndex, QByteArray qbaCheckBackImageData);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

CheckBackImageFilename Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCheckBackImageFilename(int iCheckIndex);
int SetCheckBackImageFilename(int iCheckIndex, const char* lpszCheckBackImageFilename);

Unicode (Windows)
LPWSTR GetCheckBackImageFilename(INT iCheckIndex);
INT SetCheckBackImageFilename(INT iCheckIndex, LPCWSTR lpszCheckBackImageFilename);

char* inpay_check21_getcheckbackimagefilename(void* lpObj, int checkindex);
int inpay_check21_setcheckbackimagefilename(void* lpObj, int checkindex, const char* lpszCheckBackImageFilename);

QString GetCheckBackImageFilename(int iCheckIndex);
int SetCheckBackImageFilename(int iCheckIndex, QString qsCheckBackImageFilename);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

CheckBackImageReferenceKey Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCheckBackImageReferenceKey(int iCheckIndex);
int SetCheckBackImageReferenceKey(int iCheckIndex, const char* lpszCheckBackImageReferenceKey);

Unicode (Windows)
LPWSTR GetCheckBackImageReferenceKey(INT iCheckIndex);
INT SetCheckBackImageReferenceKey(INT iCheckIndex, LPCWSTR lpszCheckBackImageReferenceKey);

char* inpay_check21_getcheckbackimagereferencekey(void* lpObj, int checkindex);
int inpay_check21_setcheckbackimagereferencekey(void* lpObj, int checkindex, const char* lpszCheckBackImageReferenceKey);

QString GetCheckBackImageReferenceKey(int iCheckIndex);
int SetCheckBackImageReferenceKey(int iCheckIndex, QString qsCheckBackImageReferenceKey);

Default Value

""

Remarks

A designator assigned by the ECE institution that uniquely identifies the CheckBackImageData. This designator could be a key that would be used by the creating institution to located the unique associated image, or it could provide a full access path and name that would allow direct external look up and access of the image. For example, this could be a URL.

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

This property is not available at design time.

Data Type

String

CheckBOFDAccountNumber Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCheckBOFDAccountNumber(int iCheckIndex);
int SetCheckBOFDAccountNumber(int iCheckIndex, const char* lpszCheckBOFDAccountNumber);

Unicode (Windows)
LPWSTR GetCheckBOFDAccountNumber(INT iCheckIndex);
INT SetCheckBOFDAccountNumber(INT iCheckIndex, LPCWSTR lpszCheckBOFDAccountNumber);

char* inpay_check21_getcheckbofdaccountnumber(void* lpObj, int checkindex);
int inpay_check21_setcheckbofdaccountnumber(void* lpObj, int checkindex, const char* lpszCheckBOFDAccountNumber);

QString GetCheckBOFDAccountNumber(int iCheckIndex);
int SetCheckBOFDAccountNumber(int iCheckIndex, QString qsCheckBOFDAccountNumber);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

CheckBOFDBranch Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCheckBOFDBranch(int iCheckIndex);
int SetCheckBOFDBranch(int iCheckIndex, const char* lpszCheckBOFDBranch);

Unicode (Windows)
LPWSTR GetCheckBOFDBranch(INT iCheckIndex);
INT SetCheckBOFDBranch(INT iCheckIndex, LPCWSTR lpszCheckBOFDBranch);

char* inpay_check21_getcheckbofdbranch(void* lpObj, int checkindex);
int inpay_check21_setcheckbofdbranch(void* lpObj, int checkindex, const char* lpszCheckBOFDBranch);

QString GetCheckBOFDBranch(int iCheckIndex);
int SetCheckBOFDBranch(int iCheckIndex, QString qsCheckBOFDBranch);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

CheckBOFDConversionIndicator Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCheckBOFDConversionIndicator(int iCheckIndex);
int SetCheckBOFDConversionIndicator(int iCheckIndex, const char* lpszCheckBOFDConversionIndicator);

Unicode (Windows)
LPWSTR GetCheckBOFDConversionIndicator(INT iCheckIndex);
INT SetCheckBOFDConversionIndicator(INT iCheckIndex, LPCWSTR lpszCheckBOFDConversionIndicator);

char* inpay_check21_getcheckbofdconversionindicator(void* lpObj, int checkindex);
int inpay_check21_setcheckbofdconversionindicator(void* lpObj, int checkindex, const char* lpszCheckBOFDConversionIndicator);

QString GetCheckBOFDConversionIndicator(int iCheckIndex);
int SetCheckBOFDConversionIndicator(int iCheckIndex, QString qsCheckBOFDConversionIndicator);

Default Value

""

Remarks

A code that indicates the conversion within the processing institution between original paper check, image, and IRD. The indicator is specific to the action of this BOFD endorser. This property is part of the Check Detail Addendum A record (type 26), and may be set to one of the following values:

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

This property is not available at design time.

Data Type

String

CheckBOFDRoutingNumber Property (Check21 Class)

A number that identifies the Bank of First Deposit.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCheckBOFDRoutingNumber(int iCheckIndex);
int SetCheckBOFDRoutingNumber(int iCheckIndex, const char* lpszCheckBOFDRoutingNumber);

Unicode (Windows)
LPWSTR GetCheckBOFDRoutingNumber(INT iCheckIndex);
INT SetCheckBOFDRoutingNumber(INT iCheckIndex, LPCWSTR lpszCheckBOFDRoutingNumber);

char* inpay_check21_getcheckbofdroutingnumber(void* lpObj, int checkindex);
int inpay_check21_setcheckbofdroutingnumber(void* lpObj, int checkindex, const char* lpszCheckBOFDRoutingNumber);

QString GetCheckBOFDRoutingNumber(int iCheckIndex);
int SetCheckBOFDRoutingNumber(int iCheckIndex, QString qsCheckBOFDRoutingNumber);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

CheckBOFDTruncator Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCheckBOFDTruncator(int iCheckIndex);
int SetCheckBOFDTruncator(int iCheckIndex, int bCheckBOFDTruncator);

Unicode (Windows)
BOOL GetCheckBOFDTruncator(INT iCheckIndex);
INT SetCheckBOFDTruncator(INT iCheckIndex, BOOL bCheckBOFDTruncator);

int inpay_check21_getcheckbofdtruncator(void* lpObj, int checkindex);
int inpay_check21_setcheckbofdtruncator(void* lpObj, int checkindex, int bCheckBOFDTruncator);

bool GetCheckBOFDTruncator(int iCheckIndex);
int SetCheckBOFDTruncator(int iCheckIndex, bool bCheckBOFDTruncator);

Default Value

TRUE

Remarks

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

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

This property is not available at design time.

Data Type

Boolean

CheckCanRecreateImages Property (Check21 Class)

A code that indicates whether the sender has the ability to recreate the check images (from the original source) for the duration of the agreed to retention time frame.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCheckCanRecreateImages(int iCheckIndex);
int SetCheckCanRecreateImages(int iCheckIndex, int bCheckCanRecreateImages);

Unicode (Windows)
BOOL GetCheckCanRecreateImages(INT iCheckIndex);
INT SetCheckCanRecreateImages(INT iCheckIndex, BOOL bCheckCanRecreateImages);

int inpay_check21_getcheckcanrecreateimages(void* lpObj, int checkindex);
int inpay_check21_setcheckcanrecreateimages(void* lpObj, int checkindex, int bCheckCanRecreateImages);

bool GetCheckCanRecreateImages(int iCheckIndex);
int SetCheckCanRecreateImages(int iCheckIndex, bool bCheckCanRecreateImages);

Default Value

TRUE

Remarks

A code that indicates whether the sender has the ability to recreate the check images (from the original source) for the duration of the agreed to retention time frame.

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

This property is not available at design time.

Data Type

Boolean

CheckFrontImageCreationDate Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCheckFrontImageCreationDate(int iCheckIndex);
int SetCheckFrontImageCreationDate(int iCheckIndex, const char* lpszCheckFrontImageCreationDate);

Unicode (Windows)
LPWSTR GetCheckFrontImageCreationDate(INT iCheckIndex);
INT SetCheckFrontImageCreationDate(INT iCheckIndex, LPCWSTR lpszCheckFrontImageCreationDate);

char* inpay_check21_getcheckfrontimagecreationdate(void* lpObj, int checkindex);
int inpay_check21_setcheckfrontimagecreationdate(void* lpObj, int checkindex, const char* lpszCheckFrontImageCreationDate);

QString GetCheckFrontImageCreationDate(int iCheckIndex);
int SetCheckFrontImageCreationDate(int iCheckIndex, QString qsCheckFrontImageCreationDate);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

CheckFrontImageData Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCheckFrontImageData(int iCheckIndex, char* &lpCheckFrontImageData, int &lenCheckFrontImageData);
int SetCheckFrontImageData(int iCheckIndex, const char* lpCheckFrontImageData, int lenCheckFrontImageData);

Unicode (Windows)
INT GetCheckFrontImageData(INT iCheckIndex, LPSTR &lpCheckFrontImageData, INT &lenCheckFrontImageData);
INT SetCheckFrontImageData(INT iCheckIndex, LPCSTR lpCheckFrontImageData, INT lenCheckFrontImageData);

int inpay_check21_getcheckfrontimagedata(void* lpObj, int checkindex, char** lpCheckFrontImageData, int* lenCheckFrontImageData);
int inpay_check21_setcheckfrontimagedata(void* lpObj, int checkindex, const char* lpCheckFrontImageData, int lenCheckFrontImageData);

QByteArray GetCheckFrontImageData(int iCheckIndex);
int SetCheckFrontImageData(int iCheckIndex, QByteArray qbaCheckFrontImageData);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

CheckFrontImageFilename Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCheckFrontImageFilename(int iCheckIndex);
int SetCheckFrontImageFilename(int iCheckIndex, const char* lpszCheckFrontImageFilename);

Unicode (Windows)
LPWSTR GetCheckFrontImageFilename(INT iCheckIndex);
INT SetCheckFrontImageFilename(INT iCheckIndex, LPCWSTR lpszCheckFrontImageFilename);

char* inpay_check21_getcheckfrontimagefilename(void* lpObj, int checkindex);
int inpay_check21_setcheckfrontimagefilename(void* lpObj, int checkindex, const char* lpszCheckFrontImageFilename);

QString GetCheckFrontImageFilename(int iCheckIndex);
int SetCheckFrontImageFilename(int iCheckIndex, QString qsCheckFrontImageFilename);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

CheckFrontImageReferenceKey Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCheckFrontImageReferenceKey(int iCheckIndex);
int SetCheckFrontImageReferenceKey(int iCheckIndex, const char* lpszCheckFrontImageReferenceKey);

Unicode (Windows)
LPWSTR GetCheckFrontImageReferenceKey(INT iCheckIndex);
INT SetCheckFrontImageReferenceKey(INT iCheckIndex, LPCWSTR lpszCheckFrontImageReferenceKey);

char* inpay_check21_getcheckfrontimagereferencekey(void* lpObj, int checkindex);
int inpay_check21_setcheckfrontimagereferencekey(void* lpObj, int checkindex, const char* lpszCheckFrontImageReferenceKey);

QString GetCheckFrontImageReferenceKey(int iCheckIndex);
int SetCheckFrontImageReferenceKey(int iCheckIndex, QString qsCheckFrontImageReferenceKey);

Default Value

""

Remarks

A designator assigned by the ECE institution that uniquely identifies the CheckFrontImageData. This designator could be a key that would be used by the creating institution to located the unique associated image, or it could provide a full access path and name that would allow direct external look up and access of the image. For example, this could be a URL.

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

This property is not available at design time.

Data Type

String

CheckImageCompression Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCheckImageCompression(int iCheckIndex);
int SetCheckImageCompression(int iCheckIndex, int iCheckImageCompression);

Unicode (Windows)
INT GetCheckImageCompression(INT iCheckIndex);
INT SetCheckImageCompression(INT iCheckIndex, INT iCheckImageCompression);

IC_FACSIMILE(0), 
IC_JPEG(1), 
IC_ABIC(2), 
IC_PNG(21), 
IC_JBIG(22), 
IC_JPEG2000(23)

int inpay_check21_getcheckimagecompression(void* lpObj, int checkindex);
int inpay_check21_setcheckimagecompression(void* lpObj, int checkindex, int iCheckImageCompression);

int GetCheckImageCompression(int iCheckIndex);
int SetCheckImageCompression(int iCheckIndex, int iCheckImageCompression);

Default Value

1

Remarks

A code that identifies the algorithm or method used to compress the images stored in the CheckFrontImageData and CheckBackImageData properties. Values 0-20 may be used without a pre-existing agreement. Values 21-99 shall only be used when an agreement exists indicating that sender and receiver both support the specified image compression method and the method is specified below or on the X9 web site. This property is part of the Image View Detail record (type 50), and may be any of the values below:

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

This property is not available at design time.

Data Type

Integer

CheckImageCreatorRoutingNumber Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCheckImageCreatorRoutingNumber(int iCheckIndex);
int SetCheckImageCreatorRoutingNumber(int iCheckIndex, const char* lpszCheckImageCreatorRoutingNumber);

Unicode (Windows)
LPWSTR GetCheckImageCreatorRoutingNumber(INT iCheckIndex);
INT SetCheckImageCreatorRoutingNumber(INT iCheckIndex, LPCWSTR lpszCheckImageCreatorRoutingNumber);

char* inpay_check21_getcheckimagecreatorroutingnumber(void* lpObj, int checkindex);
int inpay_check21_setcheckimagecreatorroutingnumber(void* lpObj, int checkindex, const char* lpszCheckImageCreatorRoutingNumber);

QString GetCheckImageCreatorRoutingNumber(int iCheckIndex);
int SetCheckImageCreatorRoutingNumber(int iCheckIndex, QString qsCheckImageCreatorRoutingNumber);

Default Value

""

Remarks

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

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

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

This property is not available at design time.

Data Type

String

CheckImageFormat Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCheckImageFormat(int iCheckIndex);
int SetCheckImageFormat(int iCheckIndex, int iCheckImageFormat);

Unicode (Windows)
INT GetCheckImageFormat(INT iCheckIndex);
INT SetCheckImageFormat(INT iCheckIndex, INT iCheckImageFormat);

IF_TIFF(0), 
IF_IOCA(1), 
IF_PNG(20), 
IF_JFIF(21), 
IF_SPIFF(22), 
IF_JBIG(23), 
IF_JPEG2000(24)

int inpay_check21_getcheckimageformat(void* lpObj, int checkindex);
int inpay_check21_setcheckimageformat(void* lpObj, int checkindex, int iCheckImageFormat);

int GetCheckImageFormat(int iCheckIndex);
int SetCheckImageFormat(int iCheckIndex, int iCheckImageFormat);

Default Value

0

Remarks

A code that identifies the type of image format used for the images contained in the CheckFrontImageData and CheckBackImageData properties. Values 0-19 may e used without a pre-existing agreement. Values 20-99 shall only be used when an agreement exists indicating that the sender and receiver both support the specified image format type and the type is specified below or on the X9 web site. The image format type is also commonly specified by reference to the file extension used when the CheckFrontImageData or CheckBackImageData is saved as an image file. The file extension for each image format is included below for reference.

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

This property is not available at design time.

Data Type

Integer

CheckMICRAuxOnUs Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCheckMICRAuxOnUs(int iCheckIndex);
int SetCheckMICRAuxOnUs(int iCheckIndex, const char* lpszCheckMICRAuxOnUs);

Unicode (Windows)
LPWSTR GetCheckMICRAuxOnUs(INT iCheckIndex);
INT SetCheckMICRAuxOnUs(INT iCheckIndex, LPCWSTR lpszCheckMICRAuxOnUs);

char* inpay_check21_getcheckmicrauxonus(void* lpObj, int checkindex);
int inpay_check21_setcheckmicrauxonus(void* lpObj, int checkindex, const char* lpszCheckMICRAuxOnUs);

QString GetCheckMICRAuxOnUs(int iCheckIndex);
int SetCheckMICRAuxOnUs(int iCheckIndex, QString qsCheckMICRAuxOnUs);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

CheckMICROnUs Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCheckMICROnUs(int iCheckIndex);
int SetCheckMICROnUs(int iCheckIndex, const char* lpszCheckMICROnUs);

Unicode (Windows)
LPWSTR GetCheckMICROnUs(INT iCheckIndex);
INT SetCheckMICROnUs(INT iCheckIndex, LPCWSTR lpszCheckMICROnUs);

char* inpay_check21_getcheckmicronus(void* lpObj, int checkindex);
int inpay_check21_setcheckmicronus(void* lpObj, int checkindex, const char* lpszCheckMICROnUs);

QString GetCheckMICROnUs(int iCheckIndex);
int SetCheckMICROnUs(int iCheckIndex, QString qsCheckMICROnUs);

Default Value

""

Remarks

Account number data specified by the payor bank and read from the MICR line on a check. On-Us data usually consists of the payor's account number, a serial number or transaction code, or both.

ANS X9.37 requires the collecting bank to capture the entire On-Us field from the physical check. Blanks are to be suppressed, dashes are optional, and each On-Us symbol must be translated to a forward slash ('/'). This property is part of the Check detail record (type 25), and is 20 characters in length.

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

This property is not available at design time.

Data Type

String

CheckMICRProcessingCode Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCheckMICRProcessingCode(int iCheckIndex);
int SetCheckMICRProcessingCode(int iCheckIndex, const char* lpszCheckMICRProcessingCode);

Unicode (Windows)
LPWSTR GetCheckMICRProcessingCode(INT iCheckIndex);
INT SetCheckMICRProcessingCode(INT iCheckIndex, LPCWSTR lpszCheckMICRProcessingCode);

char* inpay_check21_getcheckmicrprocessingcode(void* lpObj, int checkindex);
int inpay_check21_setcheckmicrprocessingcode(void* lpObj, int checkindex, const char* lpszCheckMICRProcessingCode);

QString GetCheckMICRProcessingCode(int iCheckIndex);
int SetCheckMICRProcessingCode(int iCheckIndex, QString qsCheckMICRProcessingCode);

Default Value

""

Remarks

The external processing code from the MICR line of a check, if present. This is also known as "Position 44",. and is used for special purposes as authorized by the Accredited Standards Committee X9. This property is part of the Check detail record (type 25), and is 1 character in length.

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

This property is not available at design time.

Data Type

String

CheckMICRRoutingNumber Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCheckMICRRoutingNumber(int iCheckIndex);
int SetCheckMICRRoutingNumber(int iCheckIndex, const char* lpszCheckMICRRoutingNumber);

Unicode (Windows)
LPWSTR GetCheckMICRRoutingNumber(INT iCheckIndex);
INT SetCheckMICRRoutingNumber(INT iCheckIndex, LPCWSTR lpszCheckMICRRoutingNumber);

char* inpay_check21_getcheckmicrroutingnumber(void* lpObj, int checkindex);
int inpay_check21_setcheckmicrroutingnumber(void* lpObj, int checkindex, const char* lpszCheckMICRRoutingNumber);

QString GetCheckMICRRoutingNumber(int iCheckIndex);
int SetCheckMICRRoutingNumber(int iCheckIndex, QString qsCheckMICRRoutingNumber);

Default Value

""

Remarks

Payor bank routing number, read from the MICR line of a check. This number identifies the institution by or through which the item is payable. This property is part of the Check detail record (type 25), and is exactly 9 characters long, including the check digit.

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

This property is not available at design time.

Data Type

String

CheckPayeeName Property (Check21 Class)

The name of the payee from the check.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCheckPayeeName(int iCheckIndex);
int SetCheckPayeeName(int iCheckIndex, const char* lpszCheckPayeeName);

Unicode (Windows)
LPWSTR GetCheckPayeeName(INT iCheckIndex);
INT SetCheckPayeeName(INT iCheckIndex, LPCWSTR lpszCheckPayeeName);

char* inpay_check21_getcheckpayeename(void* lpObj, int checkindex);
int inpay_check21_setcheckpayeename(void* lpObj, int checkindex, const char* lpszCheckPayeeName);

QString GetCheckPayeeName(int iCheckIndex);
int SetCheckPayeeName(int iCheckIndex, QString qsCheckPayeeName);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

CheckSequenceNumber Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCheckSequenceNumber(int iCheckIndex);
int SetCheckSequenceNumber(int iCheckIndex, const char* lpszCheckSequenceNumber);

Unicode (Windows)
LPWSTR GetCheckSequenceNumber(INT iCheckIndex);
INT SetCheckSequenceNumber(INT iCheckIndex, LPCWSTR lpszCheckSequenceNumber);

char* inpay_check21_getchecksequencenumber(void* lpObj, int checkindex);
int inpay_check21_setchecksequencenumber(void* lpObj, int checkindex, const char* lpszCheckSequenceNumber);

QString GetCheckSequenceNumber(int iCheckIndex);
int SetCheckSequenceNumber(int iCheckIndex, QString qsCheckSequenceNumber);

Default Value

""

Remarks

ECE Institution Item Sequence Number, assigned by the institution that creates the file. The ECE institution must construct the sequence number to guarantee uniqueness for a given OriginRoutingNumber, BusinessDate, and CycleNumber. This property is part of the Check detail record (type 25) and Image View Data Record (type 52), and is 15 characters in length.

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

This property is not available at design time.

Data Type

String

CollectionType Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCollectionType();
int SetCollectionType(int iCollectionType);

Unicode (Windows)
INT GetCollectionType();
INT SetCollectionType(INT iCollectionType);

CT_FORWARD_INFO(1), 
CT_FOWARD_PRESENTMENT(2), 
CT_FORWARD_SAME_DAY(3), 
CT_NO_DETAIL(20)

int inpay_check21_getcollectiontype(void* lpObj);
int inpay_check21_setcollectiontype(void* lpObj, int iCollectionType);

int GetCollectionType();
int SetCollectionType(int iCollectionType);

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.

Data Type

Integer

CycleNumber Property (Check21 Class)

Denotes the cycle under which the file is created.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCycleNumber();
int SetCycleNumber(const char* lpszCycleNumber);

Unicode (Windows)
LPWSTR GetCycleNumber();
INT SetCycleNumber(LPCWSTR lpszCycleNumber);

char* inpay_check21_getcyclenumber(void* lpObj);
int inpay_check21_setcyclenumber(void* lpObj, const char* lpszCycleNumber);

QString GetCycleNumber();
int SetCycleNumber(QString qsCycleNumber);

Default Value

""

Remarks

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

Data Type

String

DestinationName Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDestinationName();
int SetDestinationName(const char* lpszDestinationName);

Unicode (Windows)
LPWSTR GetDestinationName();
INT SetDestinationName(LPCWSTR lpszDestinationName);

char* inpay_check21_getdestinationname(void* lpObj);
int inpay_check21_setdestinationname(void* lpObj, const char* lpszDestinationName);

QString GetDestinationName();
int SetDestinationName(QString qsDestinationName);

Default Value

""

Remarks

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

Data Type

String

DestinationRoutingNumber Property (Check21 Class)

This number identifies the institution that receives the file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDestinationRoutingNumber();
int SetDestinationRoutingNumber(const char* lpszDestinationRoutingNumber);

Unicode (Windows)
LPWSTR GetDestinationRoutingNumber();
INT SetDestinationRoutingNumber(LPCWSTR lpszDestinationRoutingNumber);

char* inpay_check21_getdestinationroutingnumber(void* lpObj);
int inpay_check21_setdestinationroutingnumber(void* lpObj, const char* lpszDestinationRoutingNumber);

QString GetDestinationRoutingNumber();
int SetDestinationRoutingNumber(QString qsDestinationRoutingNumber);

Default Value

""

Remarks

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

Data Type

String

DocumentationType Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDocumentationType();
int SetDocumentationType(const char* lpszDocumentationType);

Unicode (Windows)
LPWSTR GetDocumentationType();
INT SetDocumentationType(LPCWSTR lpszDocumentationType);

char* inpay_check21_getdocumentationtype(void* lpObj);
int inpay_check21_setdocumentationtype(void* lpObj, const char* lpszDocumentationType);

QString GetDocumentationType();
int SetDocumentationType(QString qsDocumentationType);

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:

Data Type

String

FileData Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFileData(char* &lpFileData, int &lenFileData);

Unicode (Windows)
INT GetFileData(LPSTR &lpFileData, INT &lenFileData);

int inpay_check21_getfiledata(void* lpObj, char** lpFileData, int* lenFileData);

QByteArray GetFileData();

Default Value

""

Remarks

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

This property is read-only.

Data Type

Binary String

Filename Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFilename();
int SetFilename(const char* lpszFilename);

Unicode (Windows)
LPWSTR GetFilename();
INT SetFilename(LPCWSTR lpszFilename);

char* inpay_check21_getfilename(void* lpObj);
int inpay_check21_setfilename(void* lpObj, const char* lpszFilename);

QString GetFilename();
int SetFilename(QString qsFilename);

Default Value

""

Remarks

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

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

Data Type

String

FTPPassword Property (Check21 Class)

The password to login with.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFTPPassword();
int SetFTPPassword(const char* lpszFTPPassword);

Unicode (Windows)
LPWSTR GetFTPPassword();
INT SetFTPPassword(LPCWSTR lpszFTPPassword);

char* inpay_check21_getftppassword(void* lpObj);
int inpay_check21_setftppassword(void* lpObj, const char* lpszFTPPassword);

QString GetFTPPassword();
int SetFTPPassword(QString qsFTPPassword);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

FTPRemoteFile Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFTPRemoteFile();
int SetFTPRemoteFile(const char* lpszFTPRemoteFile);

Unicode (Windows)
LPWSTR GetFTPRemoteFile();
INT SetFTPRemoteFile(LPCWSTR lpszFTPRemoteFile);

char* inpay_check21_getftpremotefile(void* lpObj);
int inpay_check21_setftpremotefile(void* lpObj, const char* lpszFTPRemoteFile);

QString GetFTPRemoteFile();
int SetFTPRemoteFile(QString qsFTPRemoteFile);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

FTPRemoteHost Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFTPRemoteHost();
int SetFTPRemoteHost(const char* lpszFTPRemoteHost);

Unicode (Windows)
LPWSTR GetFTPRemoteHost();
INT SetFTPRemoteHost(LPCWSTR lpszFTPRemoteHost);

char* inpay_check21_getftpremotehost(void* lpObj);
int inpay_check21_setftpremotehost(void* lpObj, const char* lpszFTPRemoteHost);

QString GetFTPRemoteHost();
int SetFTPRemoteHost(QString qsFTPRemoteHost);

Default Value

""

Remarks

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

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

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

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

This property is not available at design time.

Data Type

String

FTPRemotePath Property (Check21 Class)

The current path on the FTP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFTPRemotePath();
int SetFTPRemotePath(const char* lpszFTPRemotePath);

Unicode (Windows)
LPWSTR GetFTPRemotePath();
INT SetFTPRemotePath(LPCWSTR lpszFTPRemotePath);

char* inpay_check21_getftpremotepath(void* lpObj);
int inpay_check21_setftpremotepath(void* lpObj, const char* lpszFTPRemotePath);

QString GetFTPRemotePath();
int SetFTPRemotePath(QString qsFTPRemotePath);

Default Value

""

Remarks

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

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

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

This property is not available at design time.

Data Type

String

FTPRemotePort Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFTPRemotePort();
int SetFTPRemotePort(int iFTPRemotePort);

Unicode (Windows)
INT GetFTPRemotePort();
INT SetFTPRemotePort(INT iFTPRemotePort);

int inpay_check21_getftpremoteport(void* lpObj);
int inpay_check21_setftpremoteport(void* lpObj, int iFTPRemotePort);

int GetFTPRemotePort();
int SetFTPRemotePort(int iFTPRemotePort);

Default Value

21

Remarks

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

This property is not available at design time.

Data Type

Integer

FTPTimeout Property (Check21 Class)

A timeout to use when uploading via FTP.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFTPTimeout();
int SetFTPTimeout(int iFTPTimeout);

Unicode (Windows)
INT GetFTPTimeout();
INT SetFTPTimeout(INT iFTPTimeout);

int inpay_check21_getftptimeout(void* lpObj);
int inpay_check21_setftptimeout(void* lpObj, int iFTPTimeout);

int GetFTPTimeout();
int SetFTPTimeout(int iFTPTimeout);

Default Value

60

Remarks

A timeout to use when uploading via FTP.

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

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

This property is not available at design time.

Data Type

Integer

FTPUser Property (Check21 Class)

The user id to login as.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFTPUser();
int SetFTPUser(const char* lpszFTPUser);

Unicode (Windows)
LPWSTR GetFTPUser();
INT SetFTPUser(LPCWSTR lpszFTPUser);

char* inpay_check21_getftpuser(void* lpObj);
int inpay_check21_setftpuser(void* lpObj, const char* lpszFTPUser);

QString GetFTPUser();
int SetFTPUser(QString qsFTPUser);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

OriginContactName Property (Check21 Class)

A contact at the institution that creates the file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOriginContactName();
int SetOriginContactName(const char* lpszOriginContactName);

Unicode (Windows)
LPWSTR GetOriginContactName();
INT SetOriginContactName(LPCWSTR lpszOriginContactName);

char* inpay_check21_getorigincontactname(void* lpObj);
int inpay_check21_setorigincontactname(void* lpObj, const char* lpszOriginContactName);

QString GetOriginContactName();
int SetOriginContactName(QString qsOriginContactName);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

OriginContactPhone Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOriginContactPhone();
int SetOriginContactPhone(const char* lpszOriginContactPhone);

Unicode (Windows)
LPWSTR GetOriginContactPhone();
INT SetOriginContactPhone(LPCWSTR lpszOriginContactPhone);

char* inpay_check21_getorigincontactphone(void* lpObj);
int inpay_check21_setorigincontactphone(void* lpObj, const char* lpszOriginContactPhone);

QString GetOriginContactPhone();
int SetOriginContactPhone(QString qsOriginContactPhone);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

OriginName Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOriginName();
int SetOriginName(const char* lpszOriginName);

Unicode (Windows)
LPWSTR GetOriginName();
INT SetOriginName(LPCWSTR lpszOriginName);

char* inpay_check21_getoriginname(void* lpObj);
int inpay_check21_setoriginname(void* lpObj, const char* lpszOriginName);

QString GetOriginName();
int SetOriginName(QString qsOriginName);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

OriginRoutingNumber Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOriginRoutingNumber();
int SetOriginRoutingNumber(const char* lpszOriginRoutingNumber);

Unicode (Windows)
LPWSTR GetOriginRoutingNumber();
INT SetOriginRoutingNumber(LPCWSTR lpszOriginRoutingNumber);

char* inpay_check21_getoriginroutingnumber(void* lpObj);
int inpay_check21_setoriginroutingnumber(void* lpObj, const char* lpszOriginRoutingNumber);

QString GetOriginRoutingNumber();
int SetOriginRoutingNumber(QString qsOriginRoutingNumber);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

RecordType Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRecordType();
int SetRecordType(int iRecordType);

Unicode (Windows)
INT GetRecordType();
INT SetRecordType(INT iRecordType);

RT_NO_CHECKS(0), 
RT_CHECKS_NO_IMAGES(1), 
RT_CHECKS_AND_IMAGES(2), 
RT_IMAGES_FOR_CASH_LETTER(3)

int inpay_check21_getrecordtype(void* lpObj);
int inpay_check21_setrecordtype(void* lpObj, int iRecordType);

int GetRecordType();
int SetRecordType(int iRecordType);

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:

Data Type

Integer

ReturnRoutingNumber Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReturnRoutingNumber();
int SetReturnRoutingNumber(const char* lpszReturnRoutingNumber);

Unicode (Windows)
LPWSTR GetReturnRoutingNumber();
INT SetReturnRoutingNumber(LPCWSTR lpszReturnRoutingNumber);

char* inpay_check21_getreturnroutingnumber(void* lpObj);
int inpay_check21_setreturnroutingnumber(void* lpObj, const char* lpszReturnRoutingNumber);

QString GetReturnRoutingNumber();
int SetReturnRoutingNumber(QString qsReturnRoutingNumber);

Default Value

""

Remarks

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

Data Type

String

SettlementDate Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSettlementDate();
int SetSettlementDate(const char* lpszSettlementDate);

Unicode (Windows)
LPWSTR GetSettlementDate();
INT SetSettlementDate(LPCWSTR lpszSettlementDate);

char* inpay_check21_getsettlementdate(void* lpObj);
int inpay_check21_setsettlementdate(void* lpObj, const char* lpszSettlementDate);

QString GetSettlementDate();
int SetSettlementDate(QString qsSettlementDate);

Default Value

""

Remarks

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

Data Type

String

SSLAcceptServerCertEncoded Property (Check21 Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int inpay_check21_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int inpay_check21_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (Check21 Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int inpay_check21_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int inpay_check21_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int inpay_check21_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int inpay_check21_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

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

Data Type

Binary String

SSLCertStorePassword Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* inpay_check21_getsslcertstorepassword(void* lpObj);
int inpay_check21_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (Check21 Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int inpay_check21_getsslcertstoretype(void* lpObj);
int inpay_check21_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

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:

Data Type

Integer

SSLCertSubject Property (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* inpay_check21_getsslcertsubject(void* lpObj);
int inpay_check21_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

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.

Data Type

String

SSLProvider Property (Check21 Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int inpay_check21_getsslprovider(void* lpObj);
int inpay_check21_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

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, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (Check21 Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

int inpay_check21_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

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

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

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

Data Type

Binary String

SSLStartMode Property (Check21 Class)

Determines how the class starts the SSL negotiation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLStartMode();
int SetSSLStartMode(int iSSLStartMode);

Unicode (Windows)
INT GetSSLStartMode();
INT SetSSLStartMode(INT iSSLStartMode);

SSL_AUTOMATIC(0), 
SSL_IMPLICIT(1), 
SSL_EXPLICIT(2), 
SSL_NONE(3)

int inpay_check21_getsslstartmode(void* lpObj);
int inpay_check21_setsslstartmode(void* lpObj, int iSSLStartMode);

int GetSSLStartMode();
int SetSSLStartMode(int iSSLStartMode);

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

Data Type

Integer

BuildAndUploadFile Method (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int BuildAndUploadFile();

Unicode (Windows)
INT BuildAndUploadFile();

int inpay_check21_buildanduploadfile(void* lpObj);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

BuildFile Method (Check21 Class)

Builds an X9.37 file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int BuildFile();

Unicode (Windows)
INT BuildFile();

int inpay_check21_buildfile(void* lpObj);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (Check21 Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* inpay_check21_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DoEvents Method (Check21 Class)

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int inpay_check21_doevents(void* lpObj);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Interrupt Method (Check21 Class)

Interrupt the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int inpay_check21_interrupt(void* lpObj);

int Interrupt();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int inpay_check21_reset(void* lpObj);

int Reset();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Error Event (Check21 Class)

Information about non-fatal errors encountered during file construction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(Check21ErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} Check21ErrorEventParams;


Unicode (Windows)
virtual INT FireError(Check21ErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} Check21ErrorEventParams;

#define EID_CHECK21_ERROR 1

virtual INT INPAY_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class Check21ErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(Check21ErrorEventParams *e);

// Or, subclass Check21 and override this emitter function.
virtual int FireError(Check21ErrorEventParams *e) {...}

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

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(Check21SSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} Check21SSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(Check21SSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} Check21SSLServerAuthenticationEventParams;

#define EID_CHECK21_SSLSERVERAUTHENTICATION 2

virtual INT INPAY_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class Check21SSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(Check21SSLServerAuthenticationEventParams *e);

// Or, subclass Check21 and override this emitter function.
virtual int FireSSLServerAuthentication(Check21SSLServerAuthenticationEventParams *e) {...}

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

Shows the progress of the secure connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(Check21SSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} Check21SSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(Check21SSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} Check21SSLStatusEventParams;

#define EID_CHECK21_SSLSTATUS 3

virtual INT INPAY_CALL FireSSLStatus(LPSTR &lpszMessage);

class Check21SSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(Check21SSLStatusEventParams *e);

// Or, subclass Check21 and override this emitter function.
virtual int FireSSLStatus(Check21SSLStatusEventParams *e) {...}

Remarks

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

Status Event (Check21 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStatus(Check21StatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} Check21StatusEventParams;


Unicode (Windows)
virtual INT FireStatus(Check21StatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} Check21StatusEventParams;

#define EID_CHECK21_STATUS 4

virtual INT INPAY_CALL FireStatus(LPSTR &lpszMessage);

class Check21StatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Status(Check21StatusEventParams *e);

// Or, subclass Check21 and override this emitter function.
virtual int FireStatus(Check21StatusEventParams *e) {...}

Remarks

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

Config Settings (Check21 Class)

Trappable Errors (Check21 Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Check21 Errors

	143   Busy performing current action

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