ECheck Class

Properties   Methods   Events   Config Settings   Errors  

The ECheck class is used to process Electronic Check (ACH) transactions through Internet Payment services such as the Authorize.Net eCheck.Net service.

Syntax

ECheck

Remarks

The ECheck class allows you to use multiple Internet Payment Gateways through one interface and one class. This allows for easy migration from one gateway to another, as well as quick integration into applications or web services.

The ECheck class allows your website to securely process electronic checks without the need to redirect to a third-party site. All transactions are accomplished through a secure HTTPS Post to any supported gateway. The secure response is received and then stored in the class's response properties. Any web site on a standard HTTP server or any stand-alone application can process transactions without the need for a secure server or third-party intervention.

The first thing you must do is select one of the gateways supported by the ECheck class, and set up an account with that gateway vendor. Once you have an account set up with a valid (or test) login Id and password, you can use the ECheck class.

To begin, set the Gateway property to the gateway you wish to use. If this gateway supports an alternate URL to send test transactions to, set the GatewayURL at this time.

Next, set the MerchantLogin (and for some gateways the MerchantPassword). These are supplied by your gateway vendor when you set up an account.

Now you are ready to process transactions. Not all gateways process ACH or eCheck transactions the same way. While all gateways require a bank routing and account number, some require additional information such as a driver's license number, bank name, or the account type (checking or savings). The gateways and their required properties are listed in the Gateway property.

Once all your properties are set, simply call the Authorize method. If your gateway supports it, you may also credit bank accounts with the Credit method.

The following gateways are supported by the ECheck class:

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.

BankAccountClass Property (ECheck Class)

Indicates whether a personal or business account is used for this transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBankAccountClass();
int SetBankAccountClass(int iBankAccountClass);

Unicode (Windows)
INT GetBankAccountClass();
INT SetBankAccountClass(INT iBankAccountClass);

AC_PERSONAL(0), 
AC_BUSINESS(1)

int inpay_echeck_getbankaccountclass(void* lpObj);
int inpay_echeck_setbankaccountclass(void* lpObj, int iBankAccountClass);

int GetBankAccountClass();
int SetBankAccountClass(int iBankAccountClass);

Default Value

0

Remarks

Indicates whether a personal or business account is used for this transaction.

Available values:

This property is not available at design time.

Data Type

Integer

BankAccountHolderName Property (ECheck Class)

Account holder's name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBankAccountHolderName();
int SetBankAccountHolderName(const char* lpszBankAccountHolderName);

Unicode (Windows)
LPWSTR GetBankAccountHolderName();
INT SetBankAccountHolderName(LPCWSTR lpszBankAccountHolderName);

char* inpay_echeck_getbankaccountholdername(void* lpObj);
int inpay_echeck_setbankaccountholdername(void* lpObj, const char* lpszBankAccountHolderName);

QString GetBankAccountHolderName();
int SetBankAccountHolderName(QString qsBankAccountHolderName);

Default Value

""

Remarks

Account holder's name. This property contains the customer's name as it appears on their account. Many gateways use this property in addition to, or instead of, the Customer Firsts and Last name properties. Note that if this property is not specified, the FullName property from the EPCustomer type will be used instead.

This property is not available at design time.

Data Type

String

BankAccountNumber Property (ECheck Class)

Bank account number for ACH transactions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBankAccountNumber();
int SetBankAccountNumber(const char* lpszBankAccountNumber);

Unicode (Windows)
LPWSTR GetBankAccountNumber();
INT SetBankAccountNumber(LPCWSTR lpszBankAccountNumber);

char* inpay_echeck_getbankaccountnumber(void* lpObj);
int inpay_echeck_setbankaccountnumber(void* lpObj, const char* lpszBankAccountNumber);

QString GetBankAccountNumber();
int SetBankAccountNumber(QString qsBankAccountNumber);

Default Value

""

Remarks

Bank account number for ACH transactions. This property contains the customer's bank account number, which along with the BankRoutingNumber identify the location of the account where funds are to be drawn from for ACH transactions. This property is required for all ACH transactions.

This property is not available at design time.

Data Type

String

BankAccountType Property (ECheck Class)

Indicates whether a checking or savings account is used for this transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBankAccountType();
int SetBankAccountType(int iBankAccountType);

Unicode (Windows)
INT GetBankAccountType();
INT SetBankAccountType(INT iBankAccountType);

AT_CHECKING(0), 
AT_SAVINGS(1)

int inpay_echeck_getbankaccounttype(void* lpObj);
int inpay_echeck_setbankaccounttype(void* lpObj, int iBankAccountType);

int GetBankAccountType();
int SetBankAccountType(int iBankAccountType);

Default Value

0

Remarks

Indicates whether a checking or savings account is used for this transaction. For gateways that support it, this property allows funds to be withdrawn (or added in the case of a Credit) from either the customer's Checking or Savings account.

Available values:

This property is not available at design time.

Data Type

Integer

BankName Property (ECheck Class)

Name of the account holder's bank.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBankName();
int SetBankName(const char* lpszBankName);

Unicode (Windows)
LPWSTR GetBankName();
INT SetBankName(LPCWSTR lpszBankName);

char* inpay_echeck_getbankname(void* lpObj);
int inpay_echeck_setbankname(void* lpObj, const char* lpszBankName);

QString GetBankName();
int SetBankName(QString qsBankName);

Default Value

""

Remarks

Name of the account holder's bank. For example, Citibank, Wells-Fargo, Wachovia, etc. This property contains the name of the bank associated with the BankRoutingNumber.

This property is not available at design time.

Data Type

String

BankRoutingNumber Property (ECheck Class)

Routing number for ACH transactions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBankRoutingNumber();
int SetBankRoutingNumber(const char* lpszBankRoutingNumber);

Unicode (Windows)
LPWSTR GetBankRoutingNumber();
INT SetBankRoutingNumber(LPCWSTR lpszBankRoutingNumber);

char* inpay_echeck_getbankroutingnumber(void* lpObj);
int inpay_echeck_setbankroutingnumber(void* lpObj, const char* lpszBankRoutingNumber);

QString GetBankRoutingNumber();
int SetBankRoutingNumber(QString qsBankRoutingNumber);

Default Value

""

Remarks

Routing number for ACH transactions. This property contains the routing number to the customer's bank (Also known as an ABA code). This number indicates at which bank the BankAccountNumber is located, and is used to identify the location of the account where funds are to be drawn from for ACH transactions. This property is required for all ACH transactions.

Note: When using ACHPayments gateway, a leading zero must be added for Canadian bank accounts.

This property is not available at design time.

Data Type

String

CheckNumber Property (ECheck Class)

Indicates the check number to use for a transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCheckNumber();
int SetCheckNumber(const char* lpszCheckNumber);

Unicode (Windows)
LPWSTR GetCheckNumber();
INT SetCheckNumber(LPCWSTR lpszCheckNumber);

char* inpay_echeck_getchecknumber(void* lpObj);
int inpay_echeck_setchecknumber(void* lpObj, const char* lpszCheckNumber);

QString GetCheckNumber();
int SetCheckNumber(QString qsCheckNumber);

Default Value

""

Remarks

This optional property allows the customer to select a check number to use for this ACH transaction. This property is only supported by the iTransact and NetBilling gateways.

Data Type

String

CompanyName Property (ECheck Class)

The Company Name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCompanyName();
int SetCompanyName(const char* lpszCompanyName);

Unicode (Windows)
LPWSTR GetCompanyName();
INT SetCompanyName(LPCWSTR lpszCompanyName);

char* inpay_echeck_getcompanyname(void* lpObj);
int inpay_echeck_setcompanyname(void* lpObj, const char* lpszCompanyName);

QString GetCompanyName();
int SetCompanyName(QString qsCompanyName);

Default Value

""

Remarks

This property contains the Company Name associated with the billing address.

Data Type

String

CustomerAddress Property (ECheck Class)

Customer's street address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerAddress();
int SetCustomerAddress(const char* lpszCustomerAddress);

Unicode (Windows)
LPWSTR GetCustomerAddress();
INT SetCustomerAddress(LPCWSTR lpszCustomerAddress);

char* inpay_echeck_getcustomeraddress(void* lpObj);
int inpay_echeck_setcustomeraddress(void* lpObj, const char* lpszCustomerAddress);

QString GetCustomerAddress();
int SetCustomerAddress(QString qsCustomerAddress);

Default Value

""

Remarks

Customer's street address. This property is used as part of the Address Verification Service (AVS) and contains the customer's street address as it appears on their monthly statement. Only the street number, street name, and apartment number are required in This property. City, state, and zip code are set in the CustomerCity, CustomerState, and CustomerZip properties.

The length of this property varies by gateway. If the customer's address is very long, it is admissible to include only the street number in This property.

NOTE: For the Moneris gateway, this property should contain only the customer's street number. The street name should be added via the AddSpecialField method. For example:

class.CustomerAddress = "123" class.AddSpecialField("avs_street_name", "Nowhere Ln")

This property is not available at design time.

Data Type

String

CustomerAddress2 Property (ECheck Class)

A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerAddress2();
int SetCustomerAddress2(const char* lpszCustomerAddress2);

Unicode (Windows)
LPWSTR GetCustomerAddress2();
INT SetCustomerAddress2(LPCWSTR lpszCustomerAddress2);

char* inpay_echeck_getcustomeraddress2(void* lpObj);
int inpay_echeck_setcustomeraddress2(void* lpObj, const char* lpszCustomerAddress2);

QString GetCustomerAddress2();
int SetCustomerAddress2(QString qsCustomerAddress2);

Default Value

""

Remarks

A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.).

This property is not available at design time.

Data Type

String

CustomerAggregate Property (ECheck Class)

This property allows you to get or set an XML aggregate built from all of the Customer properties.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerAggregate();
int SetCustomerAggregate(const char* lpszCustomerAggregate);

Unicode (Windows)
LPWSTR GetCustomerAggregate();
INT SetCustomerAggregate(LPCWSTR lpszCustomerAggregate);

char* inpay_echeck_getcustomeraggregate(void* lpObj);
int inpay_echeck_setcustomeraggregate(void* lpObj, const char* lpszCustomerAggregate);

QString GetCustomerAggregate();
int SetCustomerAggregate(QString qsCustomerAggregate);

Default Value

""

Remarks

This property allows you to get or set an XML aggregate built from all of the Customer properties. "EPCustomer" is the root element. The Customer properties make up the tags under the root, but without the beginning "Customer". For instance: <EPCustomer> <Address>123 Nowhere Ln.</Address> <Address2>Apt 3B.</Address2> <City>Beverly Hills</City> ... </EPCustomer>

This property is not available at design time.

Data Type

String

CustomerCity Property (ECheck Class)

Customer's city.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerCity();
int SetCustomerCity(const char* lpszCustomerCity);

Unicode (Windows)
LPWSTR GetCustomerCity();
INT SetCustomerCity(LPCWSTR lpszCustomerCity);

char* inpay_echeck_getcustomercity(void* lpObj);
int inpay_echeck_setcustomercity(void* lpObj, const char* lpszCustomerCity);

QString GetCustomerCity();
int SetCustomerCity(QString qsCustomerCity);

Default Value

""

Remarks

Customer's city. This property is used as part of the Address Verification Service (AVS) and contains the customer's city as it appears on their monthly statement. Other AVS properties include CustomerAddress, CustomerState, and CustomerZip.

This property is not available at design time.

Data Type

String

CustomerCountry Property (ECheck Class)

Customer's country.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerCountry();
int SetCustomerCountry(const char* lpszCustomerCountry);

Unicode (Windows)
LPWSTR GetCustomerCountry();
INT SetCustomerCountry(LPCWSTR lpszCustomerCountry);

char* inpay_echeck_getcustomercountry(void* lpObj);
int inpay_echeck_setcustomercountry(void* lpObj, const char* lpszCustomerCountry);

QString GetCustomerCountry();
int SetCustomerCountry(QString qsCustomerCountry);

Default Value

""

Remarks

Customer's country. This property contains the country in which the customer is located. Most gateways use a two-letter country code, specified in ISO-3166.

Note: If using this property with the PayFuse gateway, this property should contain the ISO-3166 numeric code instead of the standard two-letter code. For example, the ISO code for the US is "840".

This property is not available at design time.

Data Type

String

CustomerEmail Property (ECheck Class)

Customer's email address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerEmail();
int SetCustomerEmail(const char* lpszCustomerEmail);

Unicode (Windows)
LPWSTR GetCustomerEmail();
INT SetCustomerEmail(LPCWSTR lpszCustomerEmail);

char* inpay_echeck_getcustomeremail(void* lpObj);
int inpay_echeck_setcustomeremail(void* lpObj, const char* lpszCustomerEmail);

QString GetCustomerEmail();
int SetCustomerEmail(QString qsCustomerEmail);

Default Value

""

Remarks

Customer's email address. This optional property contains the customer's email address.

This property is not available at design time.

Data Type

String

CustomerFax Property (ECheck Class)

Customer's fax number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerFax();
int SetCustomerFax(const char* lpszCustomerFax);

Unicode (Windows)
LPWSTR GetCustomerFax();
INT SetCustomerFax(LPCWSTR lpszCustomerFax);

char* inpay_echeck_getcustomerfax(void* lpObj);
int inpay_echeck_setcustomerfax(void* lpObj, const char* lpszCustomerFax);

QString GetCustomerFax();
int SetCustomerFax(QString qsCustomerFax);

Default Value

""

Remarks

Customer's fax number. This optional property contains the customer's fax number.

This property is not available at design time.

Data Type

String

CustomerFirstName Property (ECheck Class)

Customer's first name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerFirstName();
int SetCustomerFirstName(const char* lpszCustomerFirstName);

Unicode (Windows)
LPWSTR GetCustomerFirstName();
INT SetCustomerFirstName(LPCWSTR lpszCustomerFirstName);

char* inpay_echeck_getcustomerfirstname(void* lpObj);
int inpay_echeck_setcustomerfirstname(void* lpObj, const char* lpszCustomerFirstName);

QString GetCustomerFirstName();
int SetCustomerFirstName(QString qsCustomerFirstName);

Default Value

""

Remarks

Customer's first name. This property contains the customer's first name.

This property is not available at design time.

Data Type

String

CustomerFullName Property (ECheck Class)

Customer's full name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerFullName();
int SetCustomerFullName(const char* lpszCustomerFullName);

Unicode (Windows)
LPWSTR GetCustomerFullName();
INT SetCustomerFullName(LPCWSTR lpszCustomerFullName);

char* inpay_echeck_getcustomerfullname(void* lpObj);
int inpay_echeck_setcustomerfullname(void* lpObj, const char* lpszCustomerFullName);

QString GetCustomerFullName();
int SetCustomerFullName(QString qsCustomerFullName);

Default Value

""

Remarks

Customer's full name. This property contains the customer's full name as it appears on the credit card or bank account. Many gateways use this property in addition to, or instead of, the CustomerFirstName and CustomerLastName properties. If a gateway requires a CustomerFullName and the property is empty, CustomerFullName will be constructed using the contents of CustomerFirstName and CustomerLastName.

This property is not available at design time.

Data Type

String

CustomerId Property (ECheck Class)

Merchant-generated customer Id.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerId();
int SetCustomerId(const char* lpszCustomerId);

Unicode (Windows)
LPWSTR GetCustomerId();
INT SetCustomerId(LPCWSTR lpszCustomerId);

char* inpay_echeck_getcustomerid(void* lpObj);
int inpay_echeck_setcustomerid(void* lpObj, const char* lpszCustomerId);

QString GetCustomerId();
int SetCustomerId(QString qsCustomerId);

Default Value

""

Remarks

Merchant-generated customer Id. This property contains a merchant-generated customer identification number. This number should be unique for each different customer that places an order with the merchant.

This property is not available at design time.

Data Type

String

CustomerLastName Property (ECheck Class)

Customer's last name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerLastName();
int SetCustomerLastName(const char* lpszCustomerLastName);

Unicode (Windows)
LPWSTR GetCustomerLastName();
INT SetCustomerLastName(LPCWSTR lpszCustomerLastName);

char* inpay_echeck_getcustomerlastname(void* lpObj);
int inpay_echeck_setcustomerlastname(void* lpObj, const char* lpszCustomerLastName);

QString GetCustomerLastName();
int SetCustomerLastName(QString qsCustomerLastName);

Default Value

""

Remarks

Customer's last name. This property contains the customer's last name as it appears on their credit card.

This property is not available at design time.

Data Type

String

CustomerPhone Property (ECheck Class)

Customer's phone number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerPhone();
int SetCustomerPhone(const char* lpszCustomerPhone);

Unicode (Windows)
LPWSTR GetCustomerPhone();
INT SetCustomerPhone(LPCWSTR lpszCustomerPhone);

char* inpay_echeck_getcustomerphone(void* lpObj);
int inpay_echeck_setcustomerphone(void* lpObj, const char* lpszCustomerPhone);

QString GetCustomerPhone();
int SetCustomerPhone(QString qsCustomerPhone);

Default Value

""

Remarks

Customer's phone number. This optional property contains the customer's phone number.

This property is not available at design time.

Data Type

String

CustomerState Property (ECheck Class)

Customer's state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerState();
int SetCustomerState(const char* lpszCustomerState);

Unicode (Windows)
LPWSTR GetCustomerState();
INT SetCustomerState(LPCWSTR lpszCustomerState);

char* inpay_echeck_getcustomerstate(void* lpObj);
int inpay_echeck_setcustomerstate(void* lpObj, const char* lpszCustomerState);

QString GetCustomerState();
int SetCustomerState(QString qsCustomerState);

Default Value

""

Remarks

Customer's state. This property is used as part of the Address Verification Service (AVS) and contains the two character postal abbreviation of the customer's state as it appears on their monthly statement. Other AVS properties include CustomerAddress, CustomerCity, and CustomerZip.

This property is not available at design time.

Data Type

String

CustomerZip Property (ECheck Class)

Customer's zip code (or postal code if outside of the USA).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerZip();
int SetCustomerZip(const char* lpszCustomerZip);

Unicode (Windows)
LPWSTR GetCustomerZip();
INT SetCustomerZip(LPCWSTR lpszCustomerZip);

char* inpay_echeck_getcustomerzip(void* lpObj);
int inpay_echeck_setcustomerzip(void* lpObj, const char* lpszCustomerZip);

QString GetCustomerZip();
int SetCustomerZip(QString qsCustomerZip);

Default Value

""

Remarks

Customer's zip code (or postal code if outside of the USA). This property is used as part of the Address Verification Service (AVS), and contains the customer's zip code as it appears on their monthly statement. Other AVS properties include CustomerAddress, CustomerCity, and CustomerState.

This property is not available at design time.

Data Type

String

Gateway Property (ECheck Class)

Gateway to process transactions with.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetGateway();
int SetGateway(int iGateway);

Unicode (Windows)
INT GetGateway();
INT SetGateway(INT iGateway);

ECGW_NO_GATEWAY(0), 
ECGW_AUTHORIZE_NET(1), 
ECGW_EPROCESSING(2), 
ECGW_ITRANSACT(4), 
ECGW_NET_BILLING(5), 
ECGW_PAY_FLOW_PRO(6), 
ECGW_USAE_PAY(7), 
ECGW_PLUG_NPAY(8), 
ECGW_PLANET_PAYMENT(9), 
ECGW_MPCS(10), 
ECGW_RTWARE(11), 
ECGW_ECX(12), 
ECGW_MERCHANT_ANYWHERE(15), 
ECGW_TRUST_COMMERCE(19), 
ECGW_PAY_FUSE(21), 
ECGW_PAY_FLOW_LINK(22), 
ECGW_ORBITAL(23), 
ECGW_LINK_POINT(24), 
ECGW_FAST_TRANSACT(27), 
ECGW_NETWORK_MERCHANTS(28), 
ECGW_PRIGATE(30), 
ECGW_MERCHANT_PARTNERS(31), 
ECGW_CYBER_CASH(32), 
ECGW_FIRST_DATA(33), 
ECGW_YOUR_PAY(34), 
ECGW_ACHPAYMENTS(35), 
ECGW_FORTE(36), 
ECGW_CYBER_SOURCE(37), 
ECGW_GO_EMERCHANT(39), 
ECGW_TRANS_FIRST(40), 
ECGW_CHASE(41), 
ECGW_NEX_COMMERCE(42), 
ECGW_TRANSACTION_CENTRAL(44), 
ECGW_STERLING(45), 
ECGW_SAGE_PAYMENTS(50), 
ECGW_VERIFI(54), 
ECGW_QBMS(61), 
ECGW_HEARTLAND(62), 
ECGW_LITLE(63), 
ECGW_BRAIN_TREE(64), 
ECGW_JET_PAY(65), 
ECGW_HSBC(66), 
ECGW_BLUE_PAY(67), 
ECGW_ADYEN(68), 
ECGW_PAY_TRACE(70), 
ECGW_OMNI_FUND(73), 
ECGW_TRANS_NATIONAL_BANKCARD(74), 
ECGW_NETBANX(75), 
ECGW_ACHFEDERAL(78), 
ECGW_BLUEFIN(82), 
ECGW_PAYSCAPE(83), 
ECGW_PAY_DIRECT(84), 
ECGW_5TH_DIMENSION(86), 
ECGW_WORLD_PAY_LINK(87), 
ECGW_FIRST_DATA_PAY_POINT(90), 
ECGW_AUTHORIZE_NET_XML(96), 
ECGW_PHOENI_XGATE(97), 
ECGW_REPAY(98), 
ECGW_BLUE_SNAP(104), 
ECGW_BASYS(106), 
ECGW_QBPAYMENTS(113), 
ECGW_HEARTLAND_PORTICO(116)

int inpay_echeck_getgateway(void* lpObj);
int inpay_echeck_setgateway(void* lpObj, int iGateway);

int GetGateway();
int SetGateway(int iGateway);

Default Value

0

Remarks

This property is used to select the gateway with which transactions will be processed. Setting the Gateway property will also fill the GatewayURL with the URL to the gateway's processing server, and will also fill the SpecialFieldName and SpecialFieldValue properties with default names and values for the selected gateway. These are special configuration values that should usually not be changed. The following table shows the currently supported gateways, as well as the corporate home page for each.

Data Type

Integer

GatewayURL Property (ECheck Class)

Default URL for a specific Gateway .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetGatewayURL();
int SetGatewayURL(const char* lpszGatewayURL);

Unicode (Windows)
LPWSTR GetGatewayURL();
INT SetGatewayURL(LPCWSTR lpszGatewayURL);

char* inpay_echeck_getgatewayurl(void* lpObj);
int inpay_echeck_setgatewayurl(void* lpObj, const char* lpszGatewayURL);

QString GetGatewayURL();
int SetGatewayURL(QString qsGatewayURL);

Default Value

""

Remarks

This property is used to change the default URL for a specific Gateway. This is useful for specifying a different URL for testing purposes, or to support additional gateway processors that share a protocol format (such as additional Authorize.net compatible gateways). Please note that the proper "http://" or "https://" formatting must be observed. Some alternate testing URLs are listed below:

URLs for submitting test transactions: (not supported by all gateways)

Data Type

String

InvoiceNumber Property (ECheck Class)

Merchant-generated invoice number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInvoiceNumber();
int SetInvoiceNumber(const char* lpszInvoiceNumber);

Unicode (Windows)
LPWSTR GetInvoiceNumber();
INT SetInvoiceNumber(LPCWSTR lpszInvoiceNumber);

char* inpay_echeck_getinvoicenumber(void* lpObj);
int inpay_echeck_setinvoicenumber(void* lpObj, const char* lpszInvoiceNumber);

QString GetInvoiceNumber();
int SetInvoiceNumber(QString qsInvoiceNumber);

Default Value

""

Remarks

This field contains a merchant-generated invoice number. This number should be unique for each transaction. This property is optional for most gateways, but it is recommended that the merchant use an invoice number to keep track of transactions. See the Gateway property to determine if this is a required or optional field for the gateway you are using.

Data Type

String

LicenseDOB Property (ECheck Class)

Customer's Date of Birth as indicated on his driver's license.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLicenseDOB();
int SetLicenseDOB(const char* lpszLicenseDOB);

Unicode (Windows)
LPWSTR GetLicenseDOB();
INT SetLicenseDOB(LPCWSTR lpszLicenseDOB);

char* inpay_echeck_getlicensedob(void* lpObj);
int inpay_echeck_setlicensedob(void* lpObj, const char* lpszLicenseDOB);

QString GetLicenseDOB();
int SetLicenseDOB(QString qsLicenseDOB);

Default Value

""

Remarks

This property contains the customer's date of birth as it appears on his driver's license. The format varies between gateways, so please see the specifications for correct formatting. This property may be used by the gateway for fraud screening.

Data Type

String

LicenseNumber Property (ECheck Class)

Customer's drivers license number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLicenseNumber();
int SetLicenseNumber(const char* lpszLicenseNumber);

Unicode (Windows)
LPWSTR GetLicenseNumber();
INT SetLicenseNumber(LPCWSTR lpszLicenseNumber);

char* inpay_echeck_getlicensenumber(void* lpObj);
int inpay_echeck_setlicensenumber(void* lpObj, const char* lpszLicenseNumber);

QString GetLicenseNumber();
int SetLicenseNumber(QString qsLicenseNumber);

Default Value

""

Remarks

This property contains the customer's drivers license number. This property may be used by the gateway for fraud screening.

Data Type

String

LicenseState Property (ECheck Class)

State in which customer's drivers license was issued.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLicenseState();
int SetLicenseState(const char* lpszLicenseState);

Unicode (Windows)
LPWSTR GetLicenseState();
INT SetLicenseState(LPCWSTR lpszLicenseState);

char* inpay_echeck_getlicensestate(void* lpObj);
int inpay_echeck_setlicensestate(void* lpObj, const char* lpszLicenseState);

QString GetLicenseState();
int SetLicenseState(QString qsLicenseState);

Default Value

""

Remarks

This property contains the two-digit abbreviated postal code indicating the state in which the customer's drivers license was issued. This property may be used by the gateway for fraud screening.

Data Type

String

MerchantLogin Property (ECheck Class)

Merchant's Gateway login.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantLogin();
int SetMerchantLogin(const char* lpszMerchantLogin);

Unicode (Windows)
LPWSTR GetMerchantLogin();
INT SetMerchantLogin(LPCWSTR lpszMerchantLogin);

char* inpay_echeck_getmerchantlogin(void* lpObj);
int inpay_echeck_setmerchantlogin(void* lpObj, const char* lpszMerchantLogin);

QString GetMerchantLogin();
int SetMerchantLogin(QString qsMerchantLogin);

Default Value

""

Remarks

This is the login Id supplied by the Gateway you signed up with to process credit card transactions.

Data Type

String

MerchantPassword Property (ECheck Class)

Merchant's Gateway password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantPassword();
int SetMerchantPassword(const char* lpszMerchantPassword);

Unicode (Windows)
LPWSTR GetMerchantPassword();
INT SetMerchantPassword(LPCWSTR lpszMerchantPassword);

char* inpay_echeck_getmerchantpassword(void* lpObj);
int inpay_echeck_setmerchantpassword(void* lpObj, const char* lpszMerchantPassword);

QString GetMerchantPassword();
int SetMerchantPassword(QString qsMerchantPassword);

Default Value

""

Remarks

This is the password supplied by the Gateway you signed up with to process credit card transactions. Some gateways require passwords only for Credit or Void transactions, some require it for all transactions, and some do not require this field at all.

Data Type

String

PaymentType Property (ECheck Class)

The type of check payment request (commonly referred to as SEC Code).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPaymentType();
int SetPaymentType(int iPaymentType);

Unicode (Windows)
INT GetPaymentType();
INT SetPaymentType(INT iPaymentType);

PT_WEB(0), 
PT_PPD(1), 
PT_TEL(2), 
PT_CCD(3), 
PT_ARC(4), 
PT_BOC(5), 
PT_POP(6), 
PT_RCK(7)

int inpay_echeck_getpaymenttype(void* lpObj);
int inpay_echeck_setpaymenttype(void* lpObj, int iPaymentType);

int GetPaymentType();
int SetPaymentType(int iPaymentType);

Default Value

0

Remarks

This property is used to specify the payment type of the check transaction.

Available values:

Data Type

Integer

ProxyAuthScheme Property (ECheck Class)

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Unicode (Windows)
INT GetProxyAuthScheme();
INT SetProxyAuthScheme(INT iProxyAuthScheme);

AUTH_BASIC(0), 
AUTH_DIGEST(1), 
AUTH_PROPRIETARY(2), 
AUTH_NONE(3), 
AUTH_NTLM(4), 
AUTH_NEGOTIATE(5)

int inpay_echeck_getproxyauthscheme(void* lpObj);
int inpay_echeck_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (ECheck Class)

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect);

Unicode (Windows)
BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);

int inpay_echeck_getproxyautodetect(void* lpObj);
int inpay_echeck_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (ECheck Class)

This property contains a password if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword);

Unicode (Windows)
LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);

char* inpay_echeck_getproxypassword(void* lpObj);
int inpay_echeck_setproxypassword(void* lpObj, const char* lpszProxyPassword);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (ECheck Class)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Unicode (Windows)
INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);

int inpay_echeck_getproxyport(void* lpObj);
int inpay_echeck_setproxyport(void* lpObj, int iProxyPort);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (ECheck Class)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer);

Unicode (Windows)
LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);

char* inpay_echeck_getproxyserver(void* lpObj);
int inpay_echeck_setproxyserver(void* lpObj, const char* lpszProxyServer);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (ECheck Class)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxySSL();
int SetProxySSL(int iProxySSL);

Unicode (Windows)
INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);

PS_AUTOMATIC(0), 
PS_ALWAYS(1), 
PS_NEVER(2), 
PS_TUNNEL(3)

int inpay_echeck_getproxyssl(void* lpObj);
int inpay_echeck_setproxyssl(void* lpObj, int iProxySSL);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (ECheck Class)

This property contains a user name, if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser);

Unicode (Windows)
LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);

char* inpay_echeck_getproxyuser(void* lpObj);
int inpay_echeck_setproxyuser(void* lpObj, const char* lpszProxyUser);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Default Value

""

Remarks

This property contains a user name, if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ResponseApprovalCode Property (ECheck Class)

Contains an authorization code when a transaction has been approved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseApprovalCode();

Unicode (Windows)
LPWSTR GetResponseApprovalCode();

char* inpay_echeck_getresponseapprovalcode(void* lpObj);

QString GetResponseApprovalCode();

Default Value

""

Remarks

Contains an authorization code when a transaction has been approved. This property contains an authorization code when a transaction has been approved. If the ResponseCode returned indicates that the transaction is not approved, then the contents of this property should be ignored.

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

Data Type

String

ResponseApproved Property (ECheck Class)

Indicates the status of the last transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetResponseApproved();

Unicode (Windows)
BOOL GetResponseApproved();

int inpay_echeck_getresponseapproved(void* lpObj);

bool GetResponseApproved();

Default Value

FALSE

Remarks

Indicates the status of the last transaction. This property will be True if the last transaction was approved. However, you should not rely solely on the value contained in this property. After every transaction, the ResponseCode should be inspected and evaluated according to the specifications of the Gateway in use. A list of response codes for each gateway is listed in the table of contents. However, it is recommended that the developer acquire the current list from the Gateway which is being used.

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

Data Type

Boolean

ResponseApprovedAmount Property (ECheck Class)

The amount approved for the transaction, this is the amount actually charged to the credit card.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseApprovedAmount();

Unicode (Windows)
LPWSTR GetResponseApprovedAmount();

char* inpay_echeck_getresponseapprovedamount(void* lpObj);

QString GetResponseApprovedAmount();

Default Value

""

Remarks

The amount approved for the transaction, this is the amount actually charged to the credit card.

This property is primarily used when gateways allow partial authorizations and AllowPartialAuths is 'True'. Thus this property is not used by all gateways and should not alone be used to determine if a transaction was successful (such as in the case that this property is not populated).

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

Data Type

String

ResponseAVSResult Property (ECheck Class)

Contains the Address Verification System result code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseAVSResult();

Unicode (Windows)
LPWSTR GetResponseAVSResult();

char* inpay_echeck_getresponseavsresult(void* lpObj);

QString GetResponseAVSResult();

Default Value

""

Remarks

Contains the Address Verification System result code. This one character property contains the Address Verification Service (AVS) result code. An AVS result code can provide additional information concerning the authentication of a particular transaction for which cardholder address verification was requested. An AVS result code of "0" will be returned in the response message when no address verification has been requested. The value returned should be stored for later retrieval, as it may be required when voiding or refunding a transaction. Valid AVS response codes are listed below, and are identical across all Gateway (note that some gateways do not return an AVS response).

Note: Some gateways use their own response codes instead of those in the above table; those response codes are detailed below for such gateways.

Adyen

For Adyen, this property will contain the following possible values:

American Payment Solutions

For American Payment Solutions, this property will contain the following possible values:

Barclay

For Barclay, the property will contain the following possible values:

BlueSnap

For BlueSnap, the property will contain a 3-character string (if AVS checks were done), which contains the AVS checks for the following properties:

The possible values for each result character are:

HSBC

For HSBC, the property will contain the following possible values:

PayTrace / PayTraceJSON

For PayTrace / PayTraceJSON, the property will contain the following possible values:

QBMS

For the QBMS gateway, the ResponseAVSResult property will contain the result for the street address, a comma, and then the result for the zip code. The values returned are "Pass", "Fail", and "NotAvailable". Therefore, an ResponseAVSResult of "Fail,Pass" means that the street address failed validation, but the zip code passed.

DataCash

For DataCash, the property will contain the following possible values (of which correspond to both AVS and CVV checks):

Stripe

For Stripe, the property will contain the following possible values:

Worldpay

For Worldpay, the property will contain a 4-character string, which contains the AVS checks for the following properties:

The possible values for each result character are:

Worldpay Online

For Worldpay Online, the property will contain one of the following:

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

Data Type

String

ResponseCode Property (ECheck Class)

Indicates the status of the authorization request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseCode();

Unicode (Windows)
LPWSTR GetResponseCode();

char* inpay_echeck_getresponsecode(void* lpObj);

QString GetResponseCode();

Default Value

""

Remarks

Indicates the status of the authorization request. This property contains the actual response code as returned by the Gateway. Unlike the ResponseApproved property, this ResponseCode property may provide more details about why a transaction was declined. Therefore, it is recommended that developers check the ResponseCode as well as the ResponseApproved property. The Point of Sale system should evaluate this response code and NOT the ResponseText to determine nature of a response message. The current (at the time of this release) response codes for the supported Gateways are listed in the table of contents to your left.

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

Data Type

String

ResponseCVVResult Property (ECheck Class)

Contains the returned CVV2 result code if it was requested.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseCVVResult();

Unicode (Windows)
LPWSTR GetResponseCVVResult();

char* inpay_echeck_getresponsecvvresult(void* lpObj);

QString GetResponseCVVResult();

Default Value

""

Remarks

Contains the returned CVV2 result code if it was requested. This property contains the host returned CVV2 result code (if CVV data was sent in the request). The following is a list of current result codes:

A gateway may also support custom codes or human-readable response messages in this property. Please consult your gateway documentation to determine if CVV2 codes are supported.

Note: Some gateways use their own response codes instead of those in the above table; those response codes are detailed below for such gateways.

HSBC

For HSBC, the property will contain:

Adyen

For Adyen, the property will contain:

Barclay

For Barclay, the property will contain:

BlueSnap

For BlueSnap, the property will contain:

(Note: There are some scenarios in which the property will be empty instead, refer to BlueSnap's documentation for more details.)

DataCash

For DataCash, the property will contain the following possible values (of which correspond to both AVS and CVV checks):

Stripe

For Stripe, the property will contain the following possible values:

Worldpay Online

For Worldpay Online, the property will contain one of the following:

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

Data Type

String

ResponseData Property (ECheck Class)

The entire response returned from the gateway processor.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseData();

Unicode (Windows)
LPWSTR GetResponseData();

char* inpay_echeck_getresponsedata(void* lpObj);

QString GetResponseData();

Default Value

""

Remarks

The entire response returned from the gateway processor. This property contains the entire response returned from the gateway processor. You may use this to parse additional information that is not returned in the standard response properties.

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

Data Type

String

ResponseErrorCode Property (ECheck Class)

Additional error code returned by some gateways.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseErrorCode();

Unicode (Windows)
LPWSTR GetResponseErrorCode();

char* inpay_echeck_getresponseerrorcode(void* lpObj);

QString GetResponseErrorCode();

Default Value

""

Remarks

Additional error code returned by some gateways. If a gateway returns it, this property will contain an additional code that may explain why the transaction was declined. You may also wish to inspect ResponseErrorText for a human-readable description of this ResponseErrorCode.

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

Data Type

String

ResponseErrorText Property (ECheck Class)

Additional error description returned by some gateways.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseErrorText();

Unicode (Windows)
LPWSTR GetResponseErrorText();

char* inpay_echeck_getresponseerrortext(void* lpObj);

QString GetResponseErrorText();

Default Value

""

Remarks

Additional error description returned by some gateways. If a gateway returns it, this property will contain a human-readable description of the error which occurred (if any). You may also wish to inspect ResponseErrorCode for an accompanying code which may be parsed and used by your application.

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

Data Type

String

ResponseInvoiceNumber Property (ECheck Class)

Invoice number submitted in authorization request (if applicable).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseInvoiceNumber();

Unicode (Windows)
LPWSTR GetResponseInvoiceNumber();

char* inpay_echeck_getresponseinvoicenumber(void* lpObj);

QString GetResponseInvoiceNumber();

Default Value

""

Remarks

Invoice number submitted in authorization request (if applicable). This property contains the Invoice Number submitted in the original transaction, echoed back by the Gateway host.

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

Data Type

String

ResponseProcessorCode Property (ECheck Class)

Response code from the underlying processor.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseProcessorCode();

Unicode (Windows)
LPWSTR GetResponseProcessorCode();

char* inpay_echeck_getresponseprocessorcode(void* lpObj);

QString GetResponseProcessorCode();

Default Value

""

Remarks

Response code from the underlying processor. Often times a Gateway will return a ResponseCode that indicates only whether the transaction is approved or declined. Many of these also include a secondary code that provides more details as to why the transaction was declined.

Note, for the PayFlowPro Gateway this property will contain a "1" if the transaction was a duplicate, a "-1" if duplicate checking service is unavailable, and will be blank for a successfully authorized transaction.

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

Data Type

String

ResponseText Property (ECheck Class)

Text information that describes each response code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseText();

Unicode (Windows)
LPWSTR GetResponseText();

char* inpay_echeck_getresponsetext(void* lpObj);

QString GetResponseText();

Default Value

""

Remarks

Text information that describes each response code. This property contains a response or display text message. This message can be used by the terminal to display the authorization result. The display text must not be used to determine the nature of a response message. A Gateway may translate the response according to the language indicated in the merchant account setup (if applicable).

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

Data Type

String

ResponseTransactionId Property (ECheck Class)

Contains the Visa Transaction Identifier or MasterCard Reference Number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseTransactionId();

Unicode (Windows)
LPWSTR GetResponseTransactionId();

char* inpay_echeck_getresponsetransactionid(void* lpObj);

QString GetResponseTransactionId();

Default Value

""

Remarks

Contains the Visa Transaction Identifier or MasterCard Reference Number. This property contains a transaction identifier or reference number. The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this property. Data returned in this property (if any) should be recorded and used to submit a modification of this transaction at a later time (such as voiding the transaction or capturing an authorization-only transaction, if applicable).

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

Data Type

String

SpecialFieldCount Property (ECheck Class)

The number of records in the SpecialField arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSpecialFieldCount();
int SetSpecialFieldCount(int iSpecialFieldCount);

Unicode (Windows)
INT GetSpecialFieldCount();
INT SetSpecialFieldCount(INT iSpecialFieldCount);

int inpay_echeck_getspecialfieldcount(void* lpObj);
int inpay_echeck_setspecialfieldcount(void* lpObj, int iSpecialFieldCount);

int GetSpecialFieldCount();
int SetSpecialFieldCount(int iSpecialFieldCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• SpecialFieldName
• SpecialFieldValue

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

This property is not available at design time.

Data Type

Integer

SpecialFieldName Property (ECheck Class)

Name of special configuration property to submit in this transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSpecialFieldName(int iFieldIndex);
int SetSpecialFieldName(int iFieldIndex, const char* lpszSpecialFieldName);

Unicode (Windows)
LPWSTR GetSpecialFieldName(INT iFieldIndex);
INT SetSpecialFieldName(INT iFieldIndex, LPCWSTR lpszSpecialFieldName);

char* inpay_echeck_getspecialfieldname(void* lpObj, int fieldindex);
int inpay_echeck_setspecialfieldname(void* lpObj, int fieldindex, const char* lpszSpecialFieldName);

QString GetSpecialFieldName(int iFieldIndex);
int SetSpecialFieldName(int iFieldIndex, QString qsSpecialFieldName);

Default Value

""

Remarks

Name of special configuration field to submit in this transaction. The SpecialFieldName and SpecialFieldValue properties can be used to send special gateway configuration and transaction properties for each transaction. These properties can also be used to extend the functionality of this class by submitting additional information to the gateway.

This property is not applicable for the LinkPoint, FirstData, YourPay, PayFuse, or Orbital gateways.

The FieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SpecialFieldCount property.

This property is not available at design time.

Data Type

String

SpecialFieldValue Property (ECheck Class)

Value of special configuration property to submit in this transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSpecialFieldValue(int iFieldIndex);
int SetSpecialFieldValue(int iFieldIndex, const char* lpszSpecialFieldValue);

Unicode (Windows)
LPWSTR GetSpecialFieldValue(INT iFieldIndex);
INT SetSpecialFieldValue(INT iFieldIndex, LPCWSTR lpszSpecialFieldValue);

char* inpay_echeck_getspecialfieldvalue(void* lpObj, int fieldindex);
int inpay_echeck_setspecialfieldvalue(void* lpObj, int fieldindex, const char* lpszSpecialFieldValue);

QString GetSpecialFieldValue(int iFieldIndex);
int SetSpecialFieldValue(int iFieldIndex, QString qsSpecialFieldValue);

Default Value

""

Remarks

Value of special configuration field to submit in this transaction. The SpecialFieldName and SpecialFieldValue properties can be used to send special gateway configuration and transaction properties for each transaction. These properties can also be used to extend the functionality of this class by submitting additional information to the gateway.

Note: This property is not applicable for the LinkPoint, FirstData, YourPay, PayFuse, or Orbital gateways.

The FieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SpecialFieldCount property.

This property is not available at design time.

Data Type

String

SSLAcceptServerCertEncoded Property (ECheck 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_echeck_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int inpay_echeck_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 (ECheck 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_echeck_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int inpay_echeck_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 (ECheck 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_echeck_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int inpay_echeck_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 (ECheck 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_echeck_getsslcertstorepassword(void* lpObj);
int inpay_echeck_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 (ECheck 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_echeck_getsslcertstoretype(void* lpObj);
int inpay_echeck_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 (ECheck 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_echeck_getsslcertsubject(void* lpObj);
int inpay_echeck_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 (ECheck 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_echeck_getsslprovider(void* lpObj);
int inpay_echeck_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 (ECheck 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_echeck_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

TaxId Property (ECheck Class)

Company's Tax Id or a Customer's Social Security Number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTaxId();
int SetTaxId(const char* lpszTaxId);

Unicode (Windows)
LPWSTR GetTaxId();
INT SetTaxId(LPCWSTR lpszTaxId);

char* inpay_echeck_gettaxid(void* lpObj);
int inpay_echeck_settaxid(void* lpObj, const char* lpszTaxId);

QString GetTaxId();
int SetTaxId(QString qsTaxId);

Default Value

""

Remarks

This property contains a Company's Tax Id or a Customer's Social Security Number. In the absence of driver's license information, this property may be used by the gateway for fraud screening.

Data Type

String

TestMode Property (ECheck Class)

Turns test mode on and off for transactions sent to the current Gateway .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTestMode();
int SetTestMode(int bTestMode);

Unicode (Windows)
BOOL GetTestMode();
INT SetTestMode(BOOL bTestMode);

int inpay_echeck_gettestmode(void* lpObj);
int inpay_echeck_settestmode(void* lpObj, int bTestMode);

bool GetTestMode();
int SetTestMode(bool bTestMode);

Default Value

FALSE

Remarks

You can use this property to set a test mode flag that will be sent in an authorization request. Not all Gateways support test modes. If you set the TestMode property to True and the current Gateway does not support it, the class will fails with an error.

Data Type

Boolean

Timeout Property (ECheck Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int inpay_echeck_gettimeout(void* lpObj);
int inpay_echeck_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

30

Remarks

If Timeout is set to a positive value, and an operation cannot be completed immediately, the class will retry the operation for a maximum of Timeout seconds.

The default value for Timeout is 30 (seconds).

Data Type

Integer

TransactionAmount Property (ECheck Class)

Purchase amount for an authorization or retry transaction. Not used for reversals.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTransactionAmount();
int SetTransactionAmount(const char* lpszTransactionAmount);

Unicode (Windows)
LPWSTR GetTransactionAmount();
INT SetTransactionAmount(LPCWSTR lpszTransactionAmount);

char* inpay_echeck_gettransactionamount(void* lpObj);
int inpay_echeck_settransactionamount(void* lpObj, const char* lpszTransactionAmount);

QString GetTransactionAmount();
int SetTransactionAmount(QString qsTransactionAmount);

Default Value

""

Remarks

This field contains the transaction amount to be authorized. Gateways may have differing requirements for how the TransactionAmount should be formatted, so refer to the ECheck Gateway Setup page for details on the gateway you are using.

Data Type

String

TransactionDesc Property (ECheck Class)

Description of goods purchased.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTransactionDesc();
int SetTransactionDesc(const char* lpszTransactionDesc);

Unicode (Windows)
LPWSTR GetTransactionDesc();
INT SetTransactionDesc(LPCWSTR lpszTransactionDesc);

char* inpay_echeck_gettransactiondesc(void* lpObj);
int inpay_echeck_settransactiondesc(void* lpObj, const char* lpszTransactionDesc);

QString GetTransactionDesc();
int SetTransactionDesc(QString qsTransactionDesc);

Default Value

""

Remarks

This field contains a description of the goods or services being purchased. Please see the "ICharge Gateway Setup and Required Properties" page to determine if this is a required or optional field for the gateway you are using.

Data Type

String

TransactionId Property (ECheck Class)

Merchant-generated transaction Id used for all transactions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTransactionId();
int SetTransactionId(const char* lpszTransactionId);

Unicode (Windows)
LPWSTR GetTransactionId();
INT SetTransactionId(LPCWSTR lpszTransactionId);

char* inpay_echeck_gettransactionid(void* lpObj);
int inpay_echeck_settransactionid(void* lpObj, const char* lpszTransactionId);

QString GetTransactionId();
int SetTransactionId(QString qsTransactionId);

Default Value

""

Remarks

This property is used to send a merchant-generated transaction id to the Gateway, if the gateway supports that feature.

Data Type

String

AddSpecialField Method (ECheck Class)