BillPayment Class

Properties Methods Events Config Settings Errors

The BillPayment control is a single class that supports the SignOn and Payment functions of Open Financial Exchange, as described by OFX Specification 1.x and 2.x.

Syntax

BillPayment

Remarks

Payment requests can be used to schedule individual payments and to modify or delete payments if necessary.

To use the BillPayment class, first provide OFXAppId, and OFXAppVersion properties, your FI information (by setting the FIOrganization, FIId and FIUrl properties), your login information (OFXUser, OFXPassword).

set Payment (FromBankId, FromAccountId, and FromAccountType fields to the values corresponding to the account from which you wish to pay the bill, Amount to the desired amount, DateDue to the date payment has to be processed);
set Payee (by providing either Id or: payee full information (via Aggregate or by setting each payee field such as Name, Addr1, Phone, ListId (if assigned by the server) and Account to your account id with that biller;

Finally, call the PayBill method. If the biller does not exist in the payee list, the payment request will also set up that payee adding it to your payee list.

Upon successful response, the Id, Status and DateProcessed fields will be populated indicating the status of your payment. If the payee didn't exist in your payee list, and if your FI supports assigning id to payees, the Id and ListId assigned to that payer might also be returned in the server response.

Between the time a payment is scheduled and the time the server processes the payment, the user can request changes to the parameters of that payment. For example, the Amount or DateDue of the payment can be modified. To modify a scheduled payment identified by PaymentId, the ModifyPayment method can be called where the PaymentId identifies the targeted payment. When this method is called, the full contents of the payment request must be specified, including both modified and unmodified data. All data can be modified except Name and Id. Depending on the server, the response might include the date on which server actually processed this payment, or if it failed due to insufficient funds.

To cancel a scheduled payment identified by PaymentId, the CancelPayment method must be called.

Obtaining the status for a payment identified by PaymentId can be done by calling the GetStatus method.

Bill payments are subject to synchronization which can be done by calling the SynchronizePayments method.

Property List

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


FIId	Financial institution identifier.
FIOrganization	Financial institution organization name.
Firewall	A set of properties related to firewall access.
FIUrl	Financial institution URL.
LostSync	Whether the token in the synchronization request is older.
OFXAccessKey	Access key value received after a MFA authentication in a previous signon.
OFXAppId	OFX application identifier.
OFXAppVersion	OFX application version.
OFXPassword	User's password.
OFXRequest	The current OFX request aggregate.
OFXResponse	The current OFX response aggregate.
OFXUser	User's id.
OFXVersion	OFX API version.
Payee	Identifies the payee to be added, modified or paid to.
Payment	Identifies the payment to be scheduled or modified.
SSLAcceptServerCert	Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during Secure Sockets Layer (SSL) negotiation.
SSLProvider	The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
SSLServerCert	The server certificate for the last established connection.
SyncPayees	A list of payees being synchronized.
SyncPayments	A list of bill payments being synchronized.
Timeout	The timeout for the class.

Method List

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


AddPayee	Add a payee to server's payee list.
CancelPayment	Cancels a scheduled bill payment.
Config	Sets or retrieves a configuration setting.
DeletePayee	Deletes a payee identified by ListId from the server payee list.
GetStatus	Obtains the current processing status of a payment.
ModifyPayee	Modifies a payee identified by ListId that already exists in the payee list.
ModifyPayment	Modifies a scheduled payment.
PayBill	Pays a bill to a given payee.
Reset	Reset the internal state of the class and all properties to their default values.
SynchronizePayees	Synchronizes payees on the client side with payees on record on the server side.
SynchronizePayments	Synchronizes bills paid on the client side with paid bills on record on the server side.

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.


ConnectionStatus	Fired to indicate changes in the connection state.
Error	Fired when information is available about errors during data delivery.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Fired when secure connection progress messages are available.
SyncPayees	Fired for each payee included in the synchronization response.
SyncPayments	Fired for each payment transaction included in the synchronization response.

Config Settings

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


AuthToken	Authentication token required for this signon session only.
ClientUId	Unique ID identifying OFX Client.
CorrectAction[i]	The action taken to a previously sent transaction corrected by the current one.
CorrectFITID[i]	The FITID of a previously sent transaction corrected by the current one.
CurrencyFormat	The format to be used for returning currency values.
DateFormat	The format to be used for input and output dates.
GetResponseVar	Parses additional information out of the response.
NewPassword	New password for the current OFX user.
OFXDateFormat	The date format as required by OFX FI server.
OFXLog	Log file for the OFX transaction.
ServerMessage	Server message if a warning or other information returned.
UserCred1A	Additional user credential required by server.
UserCred2A	Additional user credential required by server.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowHTTPFallback	Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.
Append	Whether to append data to LocalFile.
Authorization	The Authorization string to be sent to the server.
BytesTransferred	Contains the number of bytes transferred in the response data.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequest	Set to true to compress the body of a PUT or POST request.
EncodeURL	If set to True the URL will be encoded by the class.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to True the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexing	HTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersion	The version of HTTP used by the class.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
LogLevel	The level of detail that is logged.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
NegotiatedHTTPVersion	The negotiated HTTP version.
OtherHeaders	Other headers as determined by the user (optional).
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
SentHeaders	The full set of headers as sent by the client.
StatusCode	The status code of the last response from the server.
StatusLine	The first line of the last response from the server.
TransferredData	The contents of the last response from the server.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the class.
TransferredHeaders	The full set of headers as received from the server.
TransferredRequest	The full request as sent by the client.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
UseIDNs	Whether to encode hostnames to internationalized domain names.
UsePlatformHTTPClient	Whether or not to use the platform HTTP client.
UseProxyAutoConfigURL	Whether to use a Proxy auto-config file when attempting a connection.
UserAgent	Information about the user agent (browser).
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveRetryCount	The number of keep-alive packets to be sent before the remotehost is considered disconnected.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the class binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACertFilePaths	The paths to CA certificate files on Unix/Linux.
SSLCACerts	A newline separated list of CA certificates to be included when performing an SSL handshake.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLClientCACerts	A newline separated list of CA certificates to use during SSL client certificate validation.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFile	The location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipher	Returns the negotiated cipher suite.
SSLNegotiatedCipherStrength	Returns the negotiated cipher suite strength.
SSLNegotiatedCipherSuite	Returns the negotiated cipher suite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificates to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitiveData	Whether sensitive data is masked in log messages.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

FIId Property (BillPayment Class)

Financial institution identifier.

Syntax

ANSI (Cross Platform)
char* GetFIId();
int SetFIId(const char* lpszFIId);

Unicode (Windows)
LPWSTR GetFIId();
INT SetFIId(LPCWSTR lpszFIId);

char* inebank_billpayment_getfiid(void* lpObj);
int inebank_billpayment_setfiid(void* lpObj, const char* lpszFIId);

QString GetFIId();
int SetFIId(QString qsFIId);

Default Value

Remarks

FIId holds the identifier of the OFX Financial Institution and is used during signon. This value is unique for each organization name.

Data Type

String

FIOrganization Property (BillPayment Class)

Financial institution organization name.

Syntax

ANSI (Cross Platform)
char* GetFIOrganization();
int SetFIOrganization(const char* lpszFIOrganization);

Unicode (Windows)
LPWSTR GetFIOrganization();
INT SetFIOrganization(LPCWSTR lpszFIOrganization);

char* inebank_billpayment_getfiorganization(void* lpObj);
int inebank_billpayment_setfiorganization(void* lpObj, const char* lpszFIOrganization);

QString GetFIOrganization();
int SetFIOrganization(QString qsFIOrganization);

Default Value

Remarks

This is the name of the OFX Financial Institution and is used during signon. Each organization has a unique FIId that must also be used at signon.

Data Type

String

Firewall Property (BillPayment Class)

A set of properties related to firewall access.

Syntax

InEBankFirewall* GetFirewall();
int SetFirewall(InEBankFirewall* val);

int inebank_billpayment_getfirewallautodetect(void* lpObj);
int inebank_billpayment_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int inebank_billpayment_getfirewalltype(void* lpObj);
int inebank_billpayment_setfirewalltype(void* lpObj, int iFirewallType);

char* inebank_billpayment_getfirewallhost(void* lpObj);
int inebank_billpayment_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* inebank_billpayment_getfirewallpassword(void* lpObj);
int inebank_billpayment_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int inebank_billpayment_getfirewallport(void* lpObj);
int inebank_billpayment_setfirewallport(void* lpObj, int iFirewallPort);

char* inebank_billpayment_getfirewalluser(void* lpObj);
int inebank_billpayment_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

Data Type

InEBankFirewall

FIUrl Property (BillPayment Class)

Financial institution URL.

Syntax

ANSI (Cross Platform)
char* GetFIUrl();
int SetFIUrl(const char* lpszFIUrl);

Unicode (Windows)
LPWSTR GetFIUrl();
INT SetFIUrl(LPCWSTR lpszFIUrl);

char* inebank_billpayment_getfiurl(void* lpObj);
int inebank_billpayment_setfiurl(void* lpObj, const char* lpszFIUrl);

QString GetFIUrl();
int SetFIUrl(QString qsFIUrl);

Default Value

Remarks

This is the URL of the OFX Financial Institution to which the class will signon and fetch data.

Data Type

String

LostSync Property (BillPayment Class)

Whether the token in the synchronization request is older.

Syntax

ANSI (Cross Platform)
int GetLostSync();

Unicode (Windows)
BOOL GetLostSync();

int inebank_billpayment_getlostsync(void* lpObj);

bool GetLostSync();

Default Value

FALSE

Remarks

The LostSync will be returned in the server response after a synchronization request has been sent (when the Synchronize method was called). This indicates whether the Token in the synchronization request is older than the earliest entry in the server's history table. If True, some responses have been lost. Otherwise, the token in the synchronization request is newer than or matches a token in the server's history table.

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

Data Type

Boolean

OFXAccessKey Property (BillPayment Class)

Access key value received after a MFA authentication in a previous signon.

Syntax

ANSI (Cross Platform)
char* GetOFXAccessKey();
int SetOFXAccessKey(const char* lpszOFXAccessKey);

Unicode (Windows)
LPWSTR GetOFXAccessKey();
INT SetOFXAccessKey(LPCWSTR lpszOFXAccessKey);

char* inebank_billpayment_getofxaccesskey(void* lpObj);
int inebank_billpayment_setofxaccesskey(void* lpObj, const char* lpszOFXAccessKey);

QString GetOFXAccessKey();
int SetOFXAccessKey(QString qsOFXAccessKey);

Default Value

Remarks

This might be returned in the server response after a MFA authentication (i.e. MFA challenge question/answer pairs were validated by the server when the SendChallengeAnswers method in FIProfile class was called).

To prevent servers from needing to authenticate the user in each OFX request, the server may respond to a correct set of challenge answers with a OFXAccessKey on the signon response (when the SendChallengeAnswers method in FIProfile class was called).

The server determines the contents of this optional element. On each subsequent signon request, the client will send the last value of the OFXAccessKey it has received, even after the end of the current session. The server has the option to respond to any subsequent request with a 3000 error code, requiring the client to send the MFA challenge questions request again (by calling the RequestChallengeQuestions method in FIProfile class). This allows the server to determine the lifetime of the OFXAccessKey.

Data Type

String

OFXAppId Property (BillPayment Class)

OFX application identifier.

Syntax

ANSI (Cross Platform)
char* GetOFXAppId();
int SetOFXAppId(const char* lpszOFXAppId);

Unicode (Windows)
LPWSTR GetOFXAppId();
INT SetOFXAppId(LPCWSTR lpszOFXAppId);

char* inebank_billpayment_getofxappid(void* lpObj);
int inebank_billpayment_setofxappid(void* lpObj, const char* lpszOFXAppId);

QString GetOFXAppId();
int SetOFXAppId(QString qsOFXAppId);

Default Value

Remarks

This is the unique identifier of the user's OFX application.

Data Type

String

OFXAppVersion Property (BillPayment Class)

OFX application version.

Syntax

ANSI (Cross Platform)
char* GetOFXAppVersion();
int SetOFXAppVersion(const char* lpszOFXAppVersion);

Unicode (Windows)
LPWSTR GetOFXAppVersion();
INT SetOFXAppVersion(LPCWSTR lpszOFXAppVersion);

char* inebank_billpayment_getofxappversion(void* lpObj);
int inebank_billpayment_setofxappversion(void* lpObj, const char* lpszOFXAppVersion);

QString GetOFXAppVersion();
int SetOFXAppVersion(QString qsOFXAppVersion);

Default Value

Remarks

This is the version of the user's OFX application.

Data Type

String

OFXPassword Property (BillPayment Class)

User's password.

Syntax

ANSI (Cross Platform)
char* GetOFXPassword();
int SetOFXPassword(const char* lpszOFXPassword);

Unicode (Windows)
LPWSTR GetOFXPassword();
INT SetOFXPassword(LPCWSTR lpszOFXPassword);

char* inebank_billpayment_getofxpassword(void* lpObj);
int inebank_billpayment_setofxpassword(void* lpObj, const char* lpszOFXPassword);

QString GetOFXPassword();
int SetOFXPassword(QString qsOFXPassword);

Default Value

Remarks

This is the password used when signing on to the OFX Financial Institution's service.

Data Type

String

OFXRequest Property (BillPayment Class)

The current OFX request aggregate.

Syntax

ANSI (Cross Platform)
char* GetOFXRequest();

Unicode (Windows)
LPWSTR GetOFXRequest();

char* inebank_billpayment_getofxrequest(void* lpObj);

QString GetOFXRequest();

Default Value

Remarks

Polling OFXRequest will cause the class to generate and return an OFX request aggregate.

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

Data Type

String

OFXResponse Property (BillPayment Class)

The current OFX response aggregate.

Syntax

ANSI (Cross Platform)
char* GetOFXResponse();
int SetOFXResponse(const char* lpszOFXResponse);

Unicode (Windows)
LPWSTR GetOFXResponse();
INT SetOFXResponse(LPCWSTR lpszOFXResponse);

char* inebank_billpayment_getofxresponse(void* lpObj);
int inebank_billpayment_setofxresponse(void* lpObj, const char* lpszOFXResponse);

QString GetOFXResponse();
int SetOFXResponse(QString qsOFXResponse);

Default Value

Remarks

This can be used especially for debugging purposes. This can also be used to parse an OFX Response. To do so, you can set the OFX Response data (in string format) to OFXResponse. Once set, the supplied OFX data will be parsed and will populate the same read-only properties that ReadOFXDataFile does.

This property is not available at design time.

Data Type

String

OFXUser Property (BillPayment Class)

User's id.

Syntax

ANSI (Cross Platform)
char* GetOFXUser();
int SetOFXUser(const char* lpszOFXUser);

Unicode (Windows)
LPWSTR GetOFXUser();
INT SetOFXUser(LPCWSTR lpszOFXUser);

char* inebank_billpayment_getofxuser(void* lpObj);
int inebank_billpayment_setofxuser(void* lpObj, const char* lpszOFXUser);

QString GetOFXUser();
int SetOFXUser(QString qsOFXUser);

Default Value

Remarks

This is the UserID used when signing on to the OFX Financial Institution's service.

Data Type

String

OFXVersion Property (BillPayment Class)

OFX API version.

Syntax

ANSI (Cross Platform)
char* GetOFXVersion();
int SetOFXVersion(const char* lpszOFXVersion);

Unicode (Windows)
LPWSTR GetOFXVersion();
INT SetOFXVersion(LPCWSTR lpszOFXVersion);

char* inebank_billpayment_getofxversion(void* lpObj);
int inebank_billpayment_setofxversion(void* lpObj, const char* lpszOFXVersion);

QString GetOFXVersion();
int SetOFXVersion(QString qsOFXVersion);

Default Value

"102"

Remarks

This is the OFX API version used in all requests sent to your FI server (such as 1.0.2, 2.0.1, 2.1.1, etc.). Valid values: 102, 103, 200, 201, 203, 210, 211. Note that not all OFX Versions are supported by FIs.

Note: If the OFXVersion is set to 1x, the request and the response are going to be in SGML format. If set to 2x, the request will be in XML format (the response format depends on the FI's server capabilities). Note that if the OFX FI server does not support version 2x, the server will return an error (such as 'Bad Request').

Certain services are available only for a specific OFX version. For example, image download, is available only in OFX version 2.1.1.

Data Type

String

Payee Property (BillPayment Class)

Identifies the payee to be added, modified or paid to.

Syntax

InEBankPayeeDetail* GetPayee();
int SetPayee(InEBankPayeeDetail* val);

char* inebank_billpayment_getpayeeaccount(void* lpObj);
int inebank_billpayment_setpayeeaccount(void* lpObj, const char* lpszPayeeAccount);

char* inebank_billpayment_getpayeeaddr1(void* lpObj);
int inebank_billpayment_setpayeeaddr1(void* lpObj, const char* lpszPayeeAddr1);

char* inebank_billpayment_getpayeeaddr2(void* lpObj);
int inebank_billpayment_setpayeeaddr2(void* lpObj, const char* lpszPayeeAddr2);

char* inebank_billpayment_getpayeeaddr3(void* lpObj);
int inebank_billpayment_setpayeeaddr3(void* lpObj, const char* lpszPayeeAddr3);

char* inebank_billpayment_getpayeeaggregate(void* lpObj);
int inebank_billpayment_setpayeeaggregate(void* lpObj, const char* lpszPayeeAggregate);

char* inebank_billpayment_getpayeecity(void* lpObj);
int inebank_billpayment_setpayeecity(void* lpObj, const char* lpszPayeeCity);

char* inebank_billpayment_getpayeecountry(void* lpObj);
int inebank_billpayment_setpayeecountry(void* lpObj, const char* lpszPayeeCountry);

char* inebank_billpayment_getpayeedaystopay(void* lpObj);

char* inebank_billpayment_getpayeeid(void* lpObj);
int inebank_billpayment_setpayeeid(void* lpObj, const char* lpszPayeeId);

char* inebank_billpayment_getpayeeidscope(void* lpObj);

char* inebank_billpayment_getpayeelistid(void* lpObj);
int inebank_billpayment_setpayeelistid(void* lpObj, const char* lpszPayeeListId);

char* inebank_billpayment_getpayeename(void* lpObj);
int inebank_billpayment_setpayeename(void* lpObj, const char* lpszPayeeName);

char* inebank_billpayment_getpayeephone(void* lpObj);
int inebank_billpayment_setpayeephone(void* lpObj, const char* lpszPayeePhone);

char* inebank_billpayment_getpayeepostalcode(void* lpObj);
int inebank_billpayment_setpayeepostalcode(void* lpObj, const char* lpszPayeePostalCode);

char* inebank_billpayment_getpayeestate(void* lpObj);
int inebank_billpayment_setpayeestate(void* lpObj, const char* lpszPayeeState);

QString GetPayeeAccount();
int SetPayeeAccount(QString qsPayeeAccount);

QString GetPayeeAddr1();
int SetPayeeAddr1(QString qsPayeeAddr1);

QString GetPayeeAddr2();
int SetPayeeAddr2(QString qsPayeeAddr2);

QString GetPayeeAddr3();
int SetPayeeAddr3(QString qsPayeeAddr3);

QString GetPayeeAggregate();
int SetPayeeAggregate(QString qsPayeeAggregate);

QString GetPayeeCity();
int SetPayeeCity(QString qsPayeeCity);

QString GetPayeeCountry();
int SetPayeeCountry(QString qsPayeeCountry);

QString GetPayeeDaysToPay();

QString GetPayeeId();
int SetPayeeId(QString qsPayeeId);

QString GetPayeeIdScope();

QString GetPayeeListId();
int SetPayeeListId(QString qsPayeeListId);

QString GetPayeeName();
int SetPayeeName(QString qsPayeeName);

QString GetPayeePhone();
int SetPayeePhone(QString qsPayeePhone);

QString GetPayeePostalCode();
int SetPayeePostalCode(QString qsPayeePostalCode);

QString GetPayeeState();
int SetPayeeState(QString qsPayeeState);

Remarks

This property is required to be provided in a payee add, payee modify or bill payment request.

Either Id or the rest of the payee fields are required to be provided in the request.

In a bill payment request (when the PayBill method is called), the following can be set:


Id	(conditional - either this or payee information (name, address, phone, etc.) should be provided in the request)
Name	(conditional - required if Id and Aggregate are not provided)
Addr1	(conditional - required if Id and Aggregate are not provided)
Addr2	(conditional - optional and applicable only if Id and Aggregate are not set)
Addr3	(conditional - optional and applicable only if Id and Aggregate are not set)
City	(conditional - required if Id and Aggregate are not set)
State	(conditional - required if Id and Aggregate are not set)
PostalCode	(conditional - required if Id and Aggregate are not set)
Country	(conditional - optional and applicable only if Id and Aggregate are not set)
Phone	(conditional - required if Id and Aggregate are not set)
ListId	(conditional - required if Id and Aggregate is not set)
Account	(conditional - required if Aggregate is not set)

This must be set to an instance of the PayeeDetail type. See the PayeeDetail type for more information.

Data Type

InEBankPayeeDetail

Payment Property (BillPayment Class)

Identifies the payment to be scheduled or modified.

Syntax

InEBankPaymentDetail* GetPayment();
int SetPayment(InEBankPaymentDetail* val);

char* inebank_billpayment_getpaymentaggregate(void* lpObj);

char* inebank_billpayment_getpaymentamount(void* lpObj);
int inebank_billpayment_setpaymentamount(void* lpObj, const char* lpszPaymentAmount);

char* inebank_billpayment_getpaymentbillref(void* lpObj);
int inebank_billpayment_setpaymentbillref(void* lpObj, const char* lpszPaymentBillRef);

char* inebank_billpayment_getpaymentchecknumber(void* lpObj);

char* inebank_billpayment_getpaymentcurrencycode(void* lpObj);

char* inebank_billpayment_getpaymentdatedue(void* lpObj);
int inebank_billpayment_setpaymentdatedue(void* lpObj, const char* lpszPaymentDateDue);

char* inebank_billpayment_getpaymentdateprocessed(void* lpObj);

char* inebank_billpayment_getpaymentfromaccountid(void* lpObj);
int inebank_billpayment_setpaymentfromaccountid(void* lpObj, const char* lpszPaymentFromAccountId);

int inebank_billpayment_getpaymentfromaccounttype(void* lpObj);
int inebank_billpayment_setpaymentfromaccounttype(void* lpObj, int iPaymentFromAccountType);

char* inebank_billpayment_getpaymentfrombankid(void* lpObj);
int inebank_billpayment_setpaymentfrombankid(void* lpObj, const char* lpszPaymentFromBankId);

char* inebank_billpayment_getpaymentid(void* lpObj);
int inebank_billpayment_setpaymentid(void* lpObj, const char* lpszPaymentId);

char* inebank_billpayment_getpaymentmemo(void* lpObj);
int inebank_billpayment_setpaymentmemo(void* lpObj, const char* lpszPaymentMemo);

char* inebank_billpayment_getpaymentpayeeaccount(void* lpObj);

char* inebank_billpayment_getpaymentpayeeaggregate(void* lpObj);

char* inebank_billpayment_getpaymentpayeeid(void* lpObj);

char* inebank_billpayment_getpaymentpayeelistid(void* lpObj);

char* inebank_billpayment_getpaymentstatus(void* lpObj);

char* inebank_billpayment_getpaymenttoaccountid(void* lpObj);
int inebank_billpayment_setpaymenttoaccountid(void* lpObj, const char* lpszPaymentToAccountId);

int inebank_billpayment_getpaymenttoaccounttype(void* lpObj);
int inebank_billpayment_setpaymenttoaccounttype(void* lpObj, int iPaymentToAccountType);

char* inebank_billpayment_getpaymenttobankid(void* lpObj);
int inebank_billpayment_setpaymenttobankid(void* lpObj, const char* lpszPaymentToBankId);

char* inebank_billpayment_getpaymenttxtype(void* lpObj);

QString GetPaymentAggregate();

QString GetPaymentAmount();
int SetPaymentAmount(QString qsPaymentAmount);

QString GetPaymentBillRef();
int SetPaymentBillRef(QString qsPaymentBillRef);

QString GetPaymentCheckNumber();

QString GetPaymentCurrencyCode();

QString GetPaymentDateDue();
int SetPaymentDateDue(QString qsPaymentDateDue);

QString GetPaymentDateProcessed();

QString GetPaymentFromAccountId();
int SetPaymentFromAccountId(QString qsPaymentFromAccountId);

int GetPaymentFromAccountType();
int SetPaymentFromAccountType(int iPaymentFromAccountType);

QString GetPaymentFromBankId();
int SetPaymentFromBankId(QString qsPaymentFromBankId);

QString GetPaymentId();
int SetPaymentId(QString qsPaymentId);

QString GetPaymentMemo();
int SetPaymentMemo(QString qsPaymentMemo);

QString GetPaymentPayeeAccount();

QString GetPaymentPayeeAggregate();

QString GetPaymentPayeeId();

QString GetPaymentPayeeListId();

QString GetPaymentStatus();

QString GetPaymentToAccountId();
int SetPaymentToAccountId(QString qsPaymentToAccountId);

int GetPaymentToAccountType();
int SetPaymentToAccountType(int iPaymentToAccountType);

QString GetPaymentToBankId();
int SetPaymentToBankId(QString qsPaymentToBankId);

QString GetPaymentTxType();

Remarks

This property is required to be provided in a bill payment or modify payment request.

The following fields can be set:


FromBankId	(required)
FromAccountId	(required)
FromAccountType	(required)
ToBankId	(optional, but if ToBank information is provided, payee information is required as well)
ToAccountId	(optional)
ToAccountType	(optional)
Amount	(required)
DateDue	(required)
Memo	(optional)
BillRef	(optional)

This must be set to an instance of the PaymentDetail type. See the PaymentDetail type for more information.

This property is not available at design time.

Data Type

InEBankPaymentDetail

SSLAcceptServerCert Property (BillPayment Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

InEBankCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(InEBankCertificate* val);

char* inebank_billpayment_getsslacceptservercerteffectivedate(void* lpObj);

char* inebank_billpayment_getsslacceptservercertexpirationdate(void* lpObj);

char* inebank_billpayment_getsslacceptservercertextendedkeyusage(void* lpObj);

char* inebank_billpayment_getsslacceptservercertfingerprint(void* lpObj);

char* inebank_billpayment_getsslacceptservercertfingerprintsha1(void* lpObj);

char* inebank_billpayment_getsslacceptservercertfingerprintsha256(void* lpObj);

char* inebank_billpayment_getsslacceptservercertissuer(void* lpObj);

char* inebank_billpayment_getsslacceptservercertprivatekey(void* lpObj);

int inebank_billpayment_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* inebank_billpayment_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* inebank_billpayment_getsslacceptservercertpublickey(void* lpObj);

char* inebank_billpayment_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int inebank_billpayment_getsslacceptservercertpublickeylength(void* lpObj);

char* inebank_billpayment_getsslacceptservercertserialnumber(void* lpObj);

char* inebank_billpayment_getsslacceptservercertsignaturealgorithm(void* lpObj);

int inebank_billpayment_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int inebank_billpayment_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* inebank_billpayment_getsslacceptservercertstorepassword(void* lpObj);
int inebank_billpayment_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int inebank_billpayment_getsslacceptservercertstoretype(void* lpObj);
int inebank_billpayment_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* inebank_billpayment_getsslacceptservercertsubjectaltnames(void* lpObj);

char* inebank_billpayment_getsslacceptservercertthumbprintmd5(void* lpObj);

char* inebank_billpayment_getsslacceptservercertthumbprintsha1(void* lpObj);

char* inebank_billpayment_getsslacceptservercertthumbprintsha256(void* lpObj);

char* inebank_billpayment_getsslacceptservercertusage(void* lpObj);

int inebank_billpayment_getsslacceptservercertusageflags(void* lpObj);

char* inebank_billpayment_getsslacceptservercertversion(void* lpObj);

char* inebank_billpayment_getsslacceptservercertsubject(void* lpObj);
int inebank_billpayment_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int inebank_billpayment_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int inebank_billpayment_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

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

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Data Type

InEBankCertificate

SSLCert Property (BillPayment Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

InEBankCertificate* GetSSLCert();
int SetSSLCert(InEBankCertificate* val);

char* inebank_billpayment_getsslcerteffectivedate(void* lpObj);

char* inebank_billpayment_getsslcertexpirationdate(void* lpObj);

char* inebank_billpayment_getsslcertextendedkeyusage(void* lpObj);

char* inebank_billpayment_getsslcertfingerprint(void* lpObj);

char* inebank_billpayment_getsslcertfingerprintsha1(void* lpObj);

char* inebank_billpayment_getsslcertfingerprintsha256(void* lpObj);

char* inebank_billpayment_getsslcertissuer(void* lpObj);

char* inebank_billpayment_getsslcertprivatekey(void* lpObj);

int inebank_billpayment_getsslcertprivatekeyavailable(void* lpObj);

char* inebank_billpayment_getsslcertprivatekeycontainer(void* lpObj);

char* inebank_billpayment_getsslcertpublickey(void* lpObj);

char* inebank_billpayment_getsslcertpublickeyalgorithm(void* lpObj);

int inebank_billpayment_getsslcertpublickeylength(void* lpObj);

char* inebank_billpayment_getsslcertserialnumber(void* lpObj);

char* inebank_billpayment_getsslcertsignaturealgorithm(void* lpObj);

int inebank_billpayment_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int inebank_billpayment_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* inebank_billpayment_getsslcertstorepassword(void* lpObj);
int inebank_billpayment_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int inebank_billpayment_getsslcertstoretype(void* lpObj);
int inebank_billpayment_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* inebank_billpayment_getsslcertsubjectaltnames(void* lpObj);

char* inebank_billpayment_getsslcertthumbprintmd5(void* lpObj);

char* inebank_billpayment_getsslcertthumbprintsha1(void* lpObj);

char* inebank_billpayment_getsslcertthumbprintsha256(void* lpObj);

char* inebank_billpayment_getsslcertusage(void* lpObj);

int inebank_billpayment_getsslcertusageflags(void* lpObj);

char* inebank_billpayment_getsslcertversion(void* lpObj);

char* inebank_billpayment_getsslcertsubject(void* lpObj);
int inebank_billpayment_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int inebank_billpayment_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int inebank_billpayment_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

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

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

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

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

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

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

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Data Type

InEBankCertificate

SSLProvider Property (BillPayment Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

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

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

Possible Values

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

int inebank_billpayment_getsslprovider(void* lpObj);
int inebank_billpayment_setsslprovider(void* lpObj, int iSSLProvider);

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

Default Value

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:


0 (sslpAutomatic - default)	Automatically selects the appropriate implementation.
1 (sslpPlatform)	Uses the platform/system implementation.
2 (sslpInternal)	Uses the internal implementation.

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

SSLServerCert Property (BillPayment Class)

The server certificate for the last established connection.

Syntax

InEBankCertificate* GetSSLServerCert();

char* inebank_billpayment_getsslservercerteffectivedate(void* lpObj);

char* inebank_billpayment_getsslservercertexpirationdate(void* lpObj);

char* inebank_billpayment_getsslservercertextendedkeyusage(void* lpObj);

char* inebank_billpayment_getsslservercertfingerprint(void* lpObj);

char* inebank_billpayment_getsslservercertfingerprintsha1(void* lpObj);

char* inebank_billpayment_getsslservercertfingerprintsha256(void* lpObj);

char* inebank_billpayment_getsslservercertissuer(void* lpObj);

char* inebank_billpayment_getsslservercertprivatekey(void* lpObj);

int inebank_billpayment_getsslservercertprivatekeyavailable(void* lpObj);

char* inebank_billpayment_getsslservercertprivatekeycontainer(void* lpObj);

char* inebank_billpayment_getsslservercertpublickey(void* lpObj);

char* inebank_billpayment_getsslservercertpublickeyalgorithm(void* lpObj);

int inebank_billpayment_getsslservercertpublickeylength(void* lpObj);

char* inebank_billpayment_getsslservercertserialnumber(void* lpObj);

char* inebank_billpayment_getsslservercertsignaturealgorithm(void* lpObj);

int inebank_billpayment_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* inebank_billpayment_getsslservercertstorepassword(void* lpObj);

int inebank_billpayment_getsslservercertstoretype(void* lpObj);

char* inebank_billpayment_getsslservercertsubjectaltnames(void* lpObj);

char* inebank_billpayment_getsslservercertthumbprintmd5(void* lpObj);

char* inebank_billpayment_getsslservercertthumbprintsha1(void* lpObj);

char* inebank_billpayment_getsslservercertthumbprintsha256(void* lpObj);

char* inebank_billpayment_getsslservercertusage(void* lpObj);

int inebank_billpayment_getsslservercertusageflags(void* lpObj);

char* inebank_billpayment_getsslservercertversion(void* lpObj);

char* inebank_billpayment_getsslservercertsubject(void* lpObj);

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

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

InEBankCertificate

SyncPayees Property (BillPayment Class)

A list of payees being synchronized.

Syntax

InEBankList<InEBankPayeeDetail>* GetSyncPayees();

int inebank_billpayment_getsyncpayeecount(void* lpObj);

char* inebank_billpayment_getsyncpayeeaccount(void* lpObj, int syncpayeeindex);

char* inebank_billpayment_getsyncpayeeaddr1(void* lpObj, int syncpayeeindex);

char* inebank_billpayment_getsyncpayeeaddr2(void* lpObj, int syncpayeeindex);

char* inebank_billpayment_getsyncpayeeaddr3(void* lpObj, int syncpayeeindex);

char* inebank_billpayment_getsyncpayeeaggregate(void* lpObj, int syncpayeeindex);

char* inebank_billpayment_getsyncpayeecity(void* lpObj, int syncpayeeindex);

char* inebank_billpayment_getsyncpayeecountry(void* lpObj, int syncpayeeindex);

char* inebank_billpayment_getsyncpayeedaystopay(void* lpObj, int syncpayeeindex);

char* inebank_billpayment_getsyncpayeeid(void* lpObj, int syncpayeeindex);

char* inebank_billpayment_getsyncpayeeidscope(void* lpObj, int syncpayeeindex);

char* inebank_billpayment_getsyncpayeelistid(void* lpObj, int syncpayeeindex);

char* inebank_billpayment_getsyncpayeename(void* lpObj, int syncpayeeindex);

char* inebank_billpayment_getsyncpayeephone(void* lpObj, int syncpayeeindex);

char* inebank_billpayment_getsyncpayeepostalcode(void* lpObj, int syncpayeeindex);

char* inebank_billpayment_getsyncpayeestate(void* lpObj, int syncpayeeindex);

char* inebank_billpayment_getsyncpayeetxtype(void* lpObj, int syncpayeeindex);

int GetSyncPayeeCount();

QString GetSyncPayeeAccount(int iSyncPayeeIndex);

QString GetSyncPayeeAddr1(int iSyncPayeeIndex);

QString GetSyncPayeeAddr2(int iSyncPayeeIndex);

QString GetSyncPayeeAddr3(int iSyncPayeeIndex);

QString GetSyncPayeeAggregate(int iSyncPayeeIndex);

QString GetSyncPayeeCity(int iSyncPayeeIndex);

QString GetSyncPayeeCountry(int iSyncPayeeIndex);

QString GetSyncPayeeDaysToPay(int iSyncPayeeIndex);

QString GetSyncPayeeId(int iSyncPayeeIndex);

QString GetSyncPayeeIdScope(int iSyncPayeeIndex);

QString GetSyncPayeeListId(int iSyncPayeeIndex);

QString GetSyncPayeeName(int iSyncPayeeIndex);

QString GetSyncPayeePhone(int iSyncPayeeIndex);

QString GetSyncPayeePostalCode(int iSyncPayeeIndex);

QString GetSyncPayeeState(int iSyncPayeeIndex);

QString GetSyncPayeeTxType(int iSyncPayeeIndex);

Remarks

This is populated when the SynchronizePayees method has been called. It should be inspected for each SyncPayeeIndex = 0 to SyncPayeeCount - 1.

Each synchronized payee has a Aggregate, TxType, Id, IdScope, ListId, Account, Name, Phone, Addr1, Addr2, Addr3, City, State, Country, PostalCode, and DaysToPay tied to it.

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

Data Type

InEBankPayeeDetail

SyncPayments Property (BillPayment Class)

A list of bill payments being synchronized.

Syntax

InEBankList<InEBankPaymentDetail>* GetSyncPayments();

int inebank_billpayment_getsyncpaymentcount(void* lpObj);

char* inebank_billpayment_getsyncpaymentaggregate(void* lpObj, int syncpaymentindex);

char* inebank_billpayment_getsyncpaymentamount(void* lpObj, int syncpaymentindex);

char* inebank_billpayment_getsyncpaymentbillref(void* lpObj, int syncpaymentindex);

char* inebank_billpayment_getsyncpaymentchecknumber(void* lpObj, int syncpaymentindex);

char* inebank_billpayment_getsyncpaymentcurrencycode(void* lpObj, int syncpaymentindex);

char* inebank_billpayment_getsyncpaymentdatedue(void* lpObj, int syncpaymentindex);

char* inebank_billpayment_getsyncpaymentdateprocessed(void* lpObj, int syncpaymentindex);

char* inebank_billpayment_getsyncpaymentid(void* lpObj, int syncpaymentindex);

char* inebank_billpayment_getsyncpaymentmemo(void* lpObj, int syncpaymentindex);

char* inebank_billpayment_getsyncpaymentpayeeaccount(void* lpObj, int syncpaymentindex);

char* inebank_billpayment_getsyncpaymentpayeeaggregate(void* lpObj, int syncpaymentindex);

char* inebank_billpayment_getsyncpaymentpayeeid(void* lpObj, int syncpaymentindex);

char* inebank_billpayment_getsyncpaymentpayeelistid(void* lpObj, int syncpaymentindex);

char* inebank_billpayment_getsyncpaymentstatus(void* lpObj, int syncpaymentindex);

char* inebank_billpayment_getsyncpaymenttxtype(void* lpObj, int syncpaymentindex);

int GetSyncPaymentCount();

QString GetSyncPaymentAggregate(int iSyncPaymentIndex);

QString GetSyncPaymentAmount(int iSyncPaymentIndex);

QString GetSyncPaymentBillRef(int iSyncPaymentIndex);

QString GetSyncPaymentCheckNumber(int iSyncPaymentIndex);

QString GetSyncPaymentCurrencyCode(int iSyncPaymentIndex);

QString GetSyncPaymentDateDue(int iSyncPaymentIndex);

QString GetSyncPaymentDateProcessed(int iSyncPaymentIndex);

QString GetSyncPaymentId(int iSyncPaymentIndex);

QString GetSyncPaymentMemo(int iSyncPaymentIndex);

QString GetSyncPaymentPayeeAccount(int iSyncPaymentIndex);

QString GetSyncPaymentPayeeAggregate(int iSyncPaymentIndex);

QString GetSyncPaymentPayeeId(int iSyncPaymentIndex);

QString GetSyncPaymentPayeeListId(int iSyncPaymentIndex);

QString GetSyncPaymentStatus(int iSyncPaymentIndex);

QString GetSyncPaymentTxType(int iSyncPaymentIndex);

Remarks

This is populated when the SynchronizePayments method has been called. It should be inspected for each SyncPaymentIndex = 0 to SyncPaymentCount - 1.

Each synchronized bill payment has a Aggregate, TxType, Id, Amount, CurrencyCode, CheckNumber, PayeeAccount, PayeeId, PayeeListId, PayeeAggregate, Memo, BillRef, Status, DateDue, and DateProcessed tied to it.

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

Data Type

InEBankPaymentDetail

Timeout Property (BillPayment Class)

The timeout for the class.

Syntax

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

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

int inebank_billpayment_gettimeout(void* lpObj);
int inebank_billpayment_settimeout(void* lpObj, int iTimeout);

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

Default Value

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

AddPayee Method (BillPayment Class)

Add a payee to server's payee list.

Syntax

ANSI (Cross Platform)
int AddPayee();

Unicode (Windows)
INT AddPayee();

int inebank_billpayment_addpayee(void* lpObj);

int AddPayee();

Remarks

This function generates the Signon and Add Payee request, submits it to the financial institution via HTTP, receives the response, and parses it.

The following properties can be set when this method is called:


FIUrl	(required)
FIId	(required)
FIOrganization	(required)
OFXAppId	(required)
OFXAppVersion	(required)
OFXUser	(required)
OFXPassword	(required)
Payee	(required)
ToBankId	(optional)
ToAccountId	(optional)
ToAccountType	(optional)

Upon a successful reply, the following read-only fields are populated as a result of parsing the server response:


Id	(optional)
ListId	(always returned)
DaysToPay	(always returned)
IdScope	(optional)
all input values for payee (name, address, phone, account) and destination bank account are echoed in the response

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

CancelPayment Method (BillPayment Class)

Cancels a scheduled bill payment.

Syntax

ANSI (Cross Platform)
int CancelPayment(const char* lpszPaymentId);

Unicode (Windows)
INT CancelPayment(LPCWSTR lpszPaymentId);

int inebank_billpayment_cancelpayment(void* lpObj, const char* lpszPaymentId);

int CancelPayment(const QString& qsPaymentId);

Remarks

This function generates the Signon and Payment Cancellation request page, submits it to the financial institution via secure HTTP Post, receives the response, and parses it.

The PaymentId parameter identifies the payment to be canceled. This is the id assigned and returned by the server at the time the payment was scheduled (that was stored in Id).

The following properties should be set when this method is called:


FIUrl	(required)
FIId	(required)
FIOrganization	(required)
OFXAppId	(required)
OFXAppVersion	(required)
OFXUser	(required)
OFXPassword	(required)

Upon successful response, the server will return the Id which echoes the PaymentId.

Error Handling (C++)

Config Method (BillPayment Class)

Sets or retrieves a configuration setting.

Syntax

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* inebank_billpayment_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.

DeletePayee Method (BillPayment Class)

Deletes a payee identified by ListId from the server payee list.

Syntax

ANSI (Cross Platform)
int DeletePayee(const char* lpszListId);

Unicode (Windows)
INT DeletePayee(LPCWSTR lpszListId);

int inebank_billpayment_deletepayee(void* lpObj, const char* lpszListId);

int DeletePayee(const QString& qsListId);

Remarks

This function generates the Signon and Delete Payee request page, submits it to the financial institution via secure HTTP Post, receives the response, and parses it.

The ListId parameter identifies the payee to be deleted. This is the id returned by the server at the time the payee was added to the payee list (that was stored in ListId).

The following properties should be set when this method is called:


FIUrl	(required)
FIId	(required)
FIOrganization	(required)
OFXAppId	(required)
OFXAppVersion	(required)
OFXUser	(required)
OFXPassword	(required)

Upon successful response, the server will return the ListId that echoes the ListId input parameter.

Error Handling (C++)

GetStatus Method (BillPayment Class)

Obtains the current processing status of a payment.

Syntax

ANSI (Cross Platform)
int GetStatus(const char* lpszPaymentId);

Unicode (Windows)
INT GetStatus(LPCWSTR lpszPaymentId);

int inebank_billpayment_getstatus(void* lpObj, const char* lpszPaymentId);

int GetStatus(const QString& qsPaymentId);

Remarks

The PaymentId parameter identifies the payment you want to obtain the status for. This is the id returned by the server at the time the payment was scheduled (that was stored in Id).

The following properties should be set when this method is called:


FIUrl	(required)
FIId	(required)
FIOrganization	(required)
OFXAppId	(required)
OFXAppVersion	(required)
OFXUser	(required)
OFXPassword	(required)

Upon successful response, the server will return the following:


Status
DateProcessed
CheckNumber	(optional)

Error Handling (C++)

ModifyPayee Method (BillPayment Class)

Modifies a payee identified by ListId that already exists in the payee list.

Syntax

ANSI (Cross Platform)
int ModifyPayee(const char* lpszPayeeListId);

Unicode (Windows)
INT ModifyPayee(LPCWSTR lpszPayeeListId);

int inebank_billpayment_modifypayee(void* lpObj, const char* lpszPayeeListId);

int ModifyPayee(const QString& qsPayeeListId);

Remarks

This function generates the Signon and Payee Modification request, submits it to the financial institution via secure HTTP Post, receives the response, and parses it.

When modifying a payee by calling the ModifyPayee method, the user must specify the changed and unchanged payee information (i.e., all the fields that were specified when the payee was first added to the server list).

The ListId parameter identifies the payee to be modified. This is the id returned by the server at the time the payee was added to the payee list.

The response normally just echoes the values passed in the request. However, when a change had already occurred in the server to the payee information (for example a change in the payee's lead time, indicated by DaysToPay), the response will include this information as well.

If the response indicates either that a payee now has a payee ID (a non-empty Id is returned in the response) or no longer has one (an empty Id is returned), then the user now becomes aware that this ID cannot be used as an appropriate form of designating the payee in any future payment requests to that payee.

Error Handling (C++)

ModifyPayment Method (BillPayment Class)

Modifies a scheduled payment.

Syntax

ANSI (Cross Platform)
int ModifyPayment(const char* lpszPaymentId);

Unicode (Windows)
INT ModifyPayment(LPCWSTR lpszPaymentId);

int inebank_billpayment_modifypayment(void* lpObj, const char* lpszPaymentId);

int ModifyPayment(const QString& qsPaymentId);

Remarks

This function generates the Signon and Payment Modification request page, submits it to the financial institution via secure HTTP Post, receives the response, and parses it.

The PaymentId parameter identifies the targeted payment to be modified. This is the id assigned and returned by the server at the time the payment was scheduled (that was stored in Id).

Between the time the client schedules a payment and the time the server processes the payment, the client may request changes (if the server allows it) to certain parameters of that payment. For example, the Amount or DateDue of the payment can be modified. This can be done by calling the ModifyPayment method. The request must specify the full contents of the payment request, including both modified and unmodified data.

The user should provide all the fields that were specified when the payment to be modified was created (when the PayBill method was called) and the ListId if this was assigned. All data can be modified except the Name and Id.

The response normally just echoes the values passed in the request. However, if the status of a scheduled payment changes in any way, the user should expect to receive modification responses when synchronizing with the server by calling Synchronize method. For example, when a server completes a payment, the status of the payment goes from pending to posted. This status change will be included in the server response.

Please check your FI profile to see if they provide this service (bill payment modification).

Error Handling (C++)

PayBill Method (BillPayment Class)

Pays a bill to a given payee.

Syntax

ANSI (Cross Platform)
int PayBill();

Unicode (Windows)
INT PayBill();

int inebank_billpayment_paybill(void* lpObj);

int PayBill();

Remarks

This function generates the Signon and Bill Payment request page, submits it to the financial institution via HTTP, receives the response, and parses it.

The following properties can be set when this method is called:


FIUrl	(required)
FIId	(required)
FIOrganization	(required)
OFXAppId	(required)
OFXAppVersion	(required)
OFXUser	(required)
OFXPassword	(required)
Payment	(required)
Payee	(required)

Payee information can be provided in the request by either setting each Payee field, or by setting the Aggregate field, the value of which can be retrieved after submitting a payee synchronization request (by calling the SynchronizePayees method).

Even when Aggregate property has been set, the user can still set any payee field to values different from the ones that are populated via Aggregate. When this happens, the server will consider this payment request as payee modification request as well. As result, that payee will be modified in the payment system accordingly.

Upon a successful reply, the following read-only properties are populated as a result of parsing the server response:


CurrencyCode
Id
Status
DateProcessed
CheckNumber
DaysToPay
IdScope
all input values for amount, bank account information, and payee information are echoed in the response

Error Handling (C++)

Reset Method (BillPayment Class)

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

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int inebank_billpayment_reset(void* lpObj);

int Reset();

Remarks

The Reset method does not have any parameters and does not return any value.

Error Handling (C++)

SynchronizePayees Method (BillPayment Class)

Synchronizes payees on the client side with payees on record on the server side.

Syntax

ANSI (Cross Platform)
char* SynchronizePayees(const char* lpszToken);

Unicode (Windows)
LPWSTR SynchronizePayees(LPCWSTR lpszToken);

char* inebank_billpayment_synchronizepayees(void* lpObj, const char* lpszToken);

QString SynchronizePayees(const QString& qsToken);

Remarks

Users of OFX Payments need to be able to obtain the current list of payees stored on the server that is configured for use in payments. In a "pay some" system, users are sometimes required to explicitly configure the payees to whom the system will make payments. This can be done by means of a telephone call to the payments provider or through other methods such as AddPayee or PayBill. It is only necessary to enter each payee once. In other systems, the payments provider can elect to store a list of all payees that the user has paid. This is a convenience to the client. It allows payees set up on one client to be accessible from a user's other clients. In this case, payee list synchronization provides a way for the payee to become accessible to the client software when the FI completes the setup.

The list can contain payees with or without payee IDs. An important function of the payee list is to communicate payee changes from the server to the client. This includes changes in processing date parameters and conversion of a payee to a standard payee.

Once added to the list, the payment system makes payments by the payee list ID. This makes it clear to a client when the user is adding to a payee list, and when he or she modifies an existing payee on the list. Although the messages make it clear whether a client is trying to add a new payee, a careful server will check for exact matches on payee adds and not create new payee list entries unnecessarily.

"Pay-any" systems can perform background processing that matches billing addresses with standard payees. When this occurs the server can update the relevant payee lists, and update the clients when they synchronize with the modified list data. Each payee entry in the list can also include a list of the user's accounts with that payee. This further reduces the data entry required by a user to make a payment, and facilitates the implementation of lightweight clients.

In order to accomplish these tasks, the user has to submit a synchronization request by calling SynchronizePayees method to insure that it has an accurate copy of the server data that is relevant to the client application. The intent of this request is to address the following scenarios in which the client might lose synchronization with the server:

Payees relevant to the client's application state have been added, deleted, or modified by a second client. For example, a user might enter or change payees from more than one PC or application.
A communications session between the client and server was interrupted or completed abnormally. As a result, the client does not have responses from the server indicating that all the payees were received and processed.

If this request is submitted for the first time to the server, the Token parameter has to be 0. In this case, servers should send all available history, allowing a new client (for example) to know about work done by other clients. If a user's account has never been used with OFX, the server returns no history.

Unless the synchronization is a refresh request (see below), in all subsequent requests, this has to be the previous value of Token this method returned (i.e., received for this type of synchronization request from the server). This will serve as the user's own endpoint. When the server supplies a response, it supplies a new endpoint (Token) as well. A token needs to be unique only within payments for the specified account.

A brand new client, or a client that lost synchronization, might want to learn about mot recent payee list by submitting a payee synchronization refresh (i.e., wants a set of changes, rather than asking the server to send everything it knows).

A client can request a refresh of current state by calling the SynchronizePayees method, where Token parameter is set to REFRESH (not case sensitive). The response will reflect the current state. For example, if you create a payee and then modify it three times, even if this history would have been available for a regular synchronization, on a synchronization refresh request the servers should only send a single add that reflects the current state.

If the response contains a list of payees, then the SyncPayees property will be populated and SyncPayees event will be fired for each payee. A single payee has a single Id and/or ListId, but it can undergo several state changes over its life and thus might have several entries in the token history.

Error Handling (C++)

SynchronizePayments Method (BillPayment Class)

Synchronizes bills paid on the client side with paid bills on record on the server side.

Syntax

ANSI (Cross Platform)
char* SynchronizePayments(const char* lpszToken);

Unicode (Windows)
LPWSTR SynchronizePayments(LPCWSTR lpszToken);

char* inebank_billpayment_synchronizepayments(void* lpObj, const char* lpszToken);

QString SynchronizePayments(const QString& qsToken);

Remarks

The bill payment synchronization request (as all other bill payment requests: add, modify, cancel) is applicable for bank accounts only and not for the credit card accounts.

Users of OFX Payments need to be able to obtain the current status of transactions previously sent to the server for processing. For example, once the user schedules a payment and the payment date has passed, the user might want to verify that the server made the payment as directed. Additionally, OFX allows for interactions with the server through multiple clients. This means, for example, that the user can perform some transactions from a home PC and others from an office computer with each session incorporating the activities performed on the other. In order to accomplish these tasks, the user has to submit a synchronization request by calling SynchronizePayments method to insure that it has an accurate copy of the server data that is relevant to the client application. The intent of this request is to address three scenarios in which the client might lose synchronization with the server:

A transaction has changed its state based on processing actions on the server. For example, a scheduled payment has passed its due date and has been paid or rejected.
Transactions relevant to the client's application state have been added, deleted, or modified by a second client. For example, a user might enter or change transactions from more than one PC or application.
A communications session between the client and server was interrupted or completed abnormally. As a result the client does not have responses from the server indicating that all the transactions were received and processed.

A brand new client, or a client that lost synchronization, might want to learn about in-progress payments by submitting a synchronization refresh of the payment requests (i.e., wants a set of changes, rather than asking the server to send everything it knows). It would almost certainly want to do a synchronization refresh of the recurring payment models, because these often live for months or years.

A client can request a refresh of current state by calling the SynchronizePayments where Token parameter is set to REFRESH (not case sensitive). The response will reflect the current state. For example, if you create a payment and then modify it three times, even if this history would have been available for a regular synchronization, on a synchronization refresh request the servers should only send a single add that reflects the current state.

The following properties have to be set when this method is called:


FIUrl	(required)
FIId	(required)
FIOrganization	(required)
OFXAppId	(required)
OFXAppVersion	(required)
OFXUser	(required)
OFXPassword	(required)
FromBankId	(required)
FromAccountId	(required)
FromAccountType	(optional)

Upon a successful reply, if the response contains payment aggregates, then the SyncPayments property will be populated and SyncPayments event will be fired for each payment transaction. A single payment has a single Id, but it can undergo several state changes over its life and thus might have several entries in the token history.

Error Handling (C++)

ConnectionStatus Event (BillPayment Class)

Fired to indicate changes in the connection state.

Syntax

ANSI (Cross Platform)
virtual int FireConnectionStatus(BillPaymentConnectionStatusEventParams *e);

typedef struct {
  const char *ConnectionEvent;
  int StatusCode;
  const char *Description;
  int reserved;
} BillPaymentConnectionStatusEventParams;


Unicode (Windows)
virtual INT FireConnectionStatus(BillPaymentConnectionStatusEventParams *e);

typedef struct {
  LPCWSTR ConnectionEvent;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} BillPaymentConnectionStatusEventParams;

#define EID_BILLPAYMENT_CONNECTIONSTATUS 1

virtual INT INEBANK_CALL FireConnectionStatus(LPSTR &lpszConnectionEvent, INT &iStatusCode, LPSTR &lpszDescription);

class BillPaymentConnectionStatusEventParams {
public:
  const QString &ConnectionEvent();

  int StatusCode();

  const QString &Description();

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

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

// Or, subclass BillPayment and override this emitter function.
virtual int FireConnectionStatus(BillPaymentConnectionStatusEventParams *e) {...}

Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:


	Firewall connection complete.
	Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable).
	Remote host connection complete.
	Remote host disconnected.
	SSL or S/Shell connection broken.
	Firewall host disconnected.

StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Error Event (BillPayment Class)

Fired when information is available about errors during data delivery.

Syntax

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

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


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

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

#define EID_BILLPAYMENT_ERROR 2

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

class BillPaymentErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter 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 (BillPayment Class)

Fired after the server presents its certificate to the client.

Syntax

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

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


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

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

#define EID_BILLPAYMENT_SSLSERVERAUTHENTICATION 3

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

class BillPaymentSSLServerAuthenticationEventParams {
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(BillPaymentSSLServerAuthenticationEventParams *e);

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

Remarks

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

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

SSLStatus Event (BillPayment Class)

Fired when secure connection progress messages are available.

Syntax

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

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


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

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

#define EID_BILLPAYMENT_SSLSTATUS 4

virtual INT INEBANK_CALL FireSSLStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

SyncPayees Event (BillPayment Class)

Fired for each payee included in the synchronization response.

Syntax

ANSI (Cross Platform)
virtual int FireSyncPayees(BillPaymentSyncPayeesEventParams *e);

typedef struct {
  const char *PayeeAggregate;
  const char *PayeeTxType;
  const char *PayeeId;
  const char *PayeeIdScope;
  const char *PayeeListId;
  const char *PayeeAccount;
  const char *PayeeName;
  const char *PayeeAddr1;
  const char *PayeeAddr2;
  const char *PayeeAddr3;
  const char *PayeeCity;
  const char *PayeeState;
  const char *PayeePostalCode;
  const char *PayeeCountry;
  const char *PayeePhone;
  int reserved;
} BillPaymentSyncPayeesEventParams;


Unicode (Windows)
virtual INT FireSyncPayees(BillPaymentSyncPayeesEventParams *e);

typedef struct {
  LPCWSTR PayeeAggregate;
  LPCWSTR PayeeTxType;
  LPCWSTR PayeeId;
  LPCWSTR PayeeIdScope;
  LPCWSTR PayeeListId;
  LPCWSTR PayeeAccount;
  LPCWSTR PayeeName;
  LPCWSTR PayeeAddr1;
  LPCWSTR PayeeAddr2;
  LPCWSTR PayeeAddr3;
  LPCWSTR PayeeCity;
  LPCWSTR PayeeState;
  LPCWSTR PayeePostalCode;
  LPCWSTR PayeeCountry;
  LPCWSTR PayeePhone;
  INT reserved;
} BillPaymentSyncPayeesEventParams;

#define EID_BILLPAYMENT_SYNCPAYEES 5

virtual INT INEBANK_CALL FireSyncPayees(LPSTR &lpszPayeeAggregate, LPSTR &lpszPayeeTxType, LPSTR &lpszPayeeId, LPSTR &lpszPayeeIdScope, LPSTR &lpszPayeeListId, LPSTR &lpszPayeeAccount, LPSTR &lpszPayeeName, LPSTR &lpszPayeeAddr1, LPSTR &lpszPayeeAddr2, LPSTR &lpszPayeeAddr3, LPSTR &lpszPayeeCity, LPSTR &lpszPayeeState, LPSTR &lpszPayeePostalCode, LPSTR &lpszPayeeCountry, LPSTR &lpszPayeePhone);

class BillPaymentSyncPayeesEventParams {
public:
  const QString &PayeeAggregate();

  const QString &PayeeTxType();

  const QString &PayeeId();

  const QString &PayeeIdScope();

  const QString &PayeeListId();

  const QString &PayeeAccount();

  const QString &PayeeName();

  const QString &PayeeAddr1();

  const QString &PayeeAddr2();

  const QString &PayeeAddr3();

  const QString &PayeeCity();

  const QString &PayeeState();

  const QString &PayeePostalCode();

  const QString &PayeeCountry();

  const QString &PayeePhone();

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

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

// Or, subclass BillPayment and override this emitter function.
virtual int FireSyncPayees(BillPaymentSyncPayeesEventParams *e) {...}

Remarks

When this event is fired for each payee included in the response (if any), the following are returned for each payee identified by PayeeListId:

PayeeAggregate contains the complete aggregate for a payee.
PayeeTxType indicates the payee transaction type, if this is added, modified or deleted (possible values: ADDED, MODIFIED, DELETED).
PayeeId contains the server-assigned id of a payee.
PayeeIdScope contains Scope of a payee ID in the payee list (GLOBAL, USER), where GLOBAL = payee ID valid across the entire payment system USER = payee ID valid with all FI accounts set up for the user's payments account.
PayeeListId contains the list record id of a payee in the payee list.
PayeeAccount contains the account the user has with a payee in the payee list.
PayeeName contains the name of a payee in the payee list.
PayeeAddr1 contains the street address (line 1) of a payee in the payee list.
PayeeAddr2 contains the address line 2 of a payee in the payee list.
PayeeAddr3 contains the address line 3 of a payee in the payee list.
PayeeCity contains the city name of a payee in the payee list.
PayeeState contains the state name of a payee in the payee list.
PayeePostalCode contains the postal code of a payee in the payee list.
PayeeCountry contains the country name of a payee in the payee list.
PayeePhone contains the phone number of a payee in the payee list.

If what you need is not returned through this event parameters, you can always parse each PayeeAggregate using our OFXAggregate component.

SyncPayments Event (BillPayment Class)

Fired for each payment transaction included in the synchronization response.

Syntax

ANSI (Cross Platform)
virtual int FireSyncPayments(BillPaymentSyncPaymentsEventParams *e);

typedef struct {
  const char *PaymentAggregate;
  const char *PaymentTxType;
  const char *PaymentId;
  const char *PayeeId;
  const char *PayeeListId;
  const char *PayeeAccount;
  const char *PayeeAggregate;
  const char *PaymentAmount;
  const char *FromAccountId;
  const char *PaymentStatus;
  const char *PaymentDate;
  int reserved;
} BillPaymentSyncPaymentsEventParams;


Unicode (Windows)
virtual INT FireSyncPayments(BillPaymentSyncPaymentsEventParams *e);

typedef struct {
  LPCWSTR PaymentAggregate;
  LPCWSTR PaymentTxType;
  LPCWSTR PaymentId;
  LPCWSTR PayeeId;
  LPCWSTR PayeeListId;
  LPCWSTR PayeeAccount;
  LPCWSTR PayeeAggregate;
  LPCWSTR PaymentAmount;
  LPCWSTR FromAccountId;
  LPCWSTR PaymentStatus;
  LPCWSTR PaymentDate;
  INT reserved;
} BillPaymentSyncPaymentsEventParams;

#define EID_BILLPAYMENT_SYNCPAYMENTS 6

virtual INT INEBANK_CALL FireSyncPayments(LPSTR &lpszPaymentAggregate, LPSTR &lpszPaymentTxType, LPSTR &lpszPaymentId, LPSTR &lpszPayeeId, LPSTR &lpszPayeeListId, LPSTR &lpszPayeeAccount, LPSTR &lpszPayeeAggregate, LPSTR &lpszPaymentAmount, LPSTR &lpszFromAccountId, LPSTR &lpszPaymentStatus, LPSTR &lpszPaymentDate);

class BillPaymentSyncPaymentsEventParams {
public:
  const QString &PaymentAggregate();

  const QString &PaymentTxType();

  const QString &PaymentId();

  const QString &PayeeId();

  const QString &PayeeListId();

  const QString &PayeeAccount();

  const QString &PayeeAggregate();

  const QString &PaymentAmount();

  const QString &FromAccountId();

  const QString &PaymentStatus();

  const QString &PaymentDate();

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

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

// Or, subclass BillPayment and override this emitter function.
virtual int FireSyncPayments(BillPaymentSyncPaymentsEventParams *e) {...}

Remarks

When this event is fired for each payment transaction included in the response (if any), the following are returned for each payment transaction identified by PaymentId:

PaymentAggregate contains the aggregate for a payment transaction.
PaymentTxType indicates the payment transaction type, if this is added, modified or canceled (possible values: ADDED, MODIFIED, CANCELLED).
PaymentId contains the server id of a transaction in the list of payment transactions (if any) returned in the synchronization response.
PayeeId contains the id of the payee the payment has been sent to.
PayeeListId contains the list id of the payee the payment has been sent to.
PayeeAccount contains the account the user has with the payee the payment has been sent to.
PayeeAggregate contains the info aggregate (name and address details) of the payee the payment has been sent to.
PaymentAmount contains the amount of a payment transaction.
FromAccountId contains the account number a payment has been sent from.
PaymentStatus contains the status of a payment transaction.
PaymentDate contains the date of a payment transaction.

If what you need is not returned through this event, you can always parse each PaymentAggregate using our OFXAggregate component.

Certificate Type

This is the digital certificate being used.

Syntax

InEBankCertificate (declared in inebank.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

The following fields are available:

Fields

EffectiveDate
char* (read-only)
Default Value: ""

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

ExpirationDate
char* (read-only)
Default Value: ""

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

ExtendedKeyUsage
char* (read-only)
Default Value: ""

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

Fingerprint
char* (read-only)
Default Value: ""

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

FingerprintSHA1
char* (read-only)
Default Value: ""

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

FingerprintSHA256
char* (read-only)
Default Value: ""

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

Issuer
char* (read-only)
Default Value: ""

The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.

PrivateKey
char* (read-only)
Default Value: ""

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.

PrivateKeyAvailable
int (read-only)
Default Value: FALSE

Whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

PrivateKeyContainer
char* (read-only)
Default Value: ""

The name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

PublicKey
char* (read-only)
Default Value: ""

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

PublicKeyAlgorithm
char* (read-only)
Default Value: ""

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

PublicKeyLength
int (read-only)
Default Value: 0

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

SerialNumber
char* (read-only)
Default Value: ""

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

SignatureAlgorithm
char* (read-only)
Default Value: ""

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

Store
char*
Default Value: "MY"

The name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

Designations of certificate stores are platform dependent.

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


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

StorePassword
char*
Default Value: ""

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

StoreType
int
Default Value: 0

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This field can take one of the following values:


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: This store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: This store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: This store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key: `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

SubjectAltNames
char* (read-only)
Default Value: ""

Comma-separated lists of alternative subject names for the certificate.

ThumbprintMD5
char* (read-only)
Default Value: ""

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

ThumbprintSHA1
char* (read-only)
Default Value: ""

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

ThumbprintSHA256
char* (read-only)
Default Value: ""

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

Usage
char* (read-only)
Default Value: ""

The text description of UsageFlags.

This value will be one or more of the following strings and will be separated by commas:

Digital Signature
Non-Repudiation
Key Encipherment
Data Encipherment
Key Agreement
Certificate Signing
CRL Signing
Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

UsageFlags
int (read-only)
Default Value: 0

The flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:


0x80	Digital Signature
0x40	Non-Repudiation
0x20	Key Encipherment
0x10	Data Encipherment
0x08	Key Agreement
0x04	Certificate Signing
0x02	CRL Signing
0x01	Encipher Only

Please see the Usage field for a text representation of UsageFlags.

This functionality currently is not available when the provider is OpenSSL.

Version
char* (read-only)
Default Value: ""

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

Subject
char*
Default Value: ""

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the field is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:


Field	Meaning
CN	Common Name. This is commonly a hostname like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

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

Encoded
char*
Default Value: ""

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

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

Constructors

Certificate()

Creates a instance whose properties can be set. This is useful for use with when generating new certificates.

Certificate(const char* lpEncoded, int lenEncoded)

Parses Encoded as an X.509 public key.

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

Firewall Type

The firewall the component will connect through.

Syntax

InEBankFirewall (declared in inebank.h)

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

The following fields are available:

AutoDetect
FirewallType
Host
Password
Port
User

Fields

AutoDetect
int
Default Value: FALSE

Whether to automatically detect and use firewall system settings, if available.

FirewallType
int
Default Value: 0

The type of firewall to connect through. The applicable values are as follows:


fwNone (0)	No firewall (default setting).
fwTunnel (1)	Connect through a tunneling proxy. Port is set to 80.
fwSOCKS4 (2)	Connect through a SOCKS4 Proxy. Port is set to 1080.
fwSOCKS5 (3)	Connect through a SOCKS5 Proxy. Port is set to 1080.
fwSOCKS4A (10)	Connect through a SOCKS4A Proxy. Port is set to 1080.

Host
char*
Default Value: ""

The name or IP address of the firewall (optional). If a Host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the class fails with an error.

Password
char*
Default Value: ""

A password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Port
int
Default Value: 0

The Transmission Control Protocol (TCP) port for the firewall Host. See the description of the Host field for details.

Note: This field is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details.

User
char*
Default Value: ""

A username if authentication is to be used when connecting through a firewall. If Host is specified, this field and the Password field are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Constructors

Firewall()

PayeeDetail Type

This type corresponds to a single payee.

Syntax

InEBankPayeeDetail (declared in inebank.h)

Remarks

PayeeDetail objects are used when adding, modifying, or paying a payee, or synchronizing the payees (when the corresponding methods: AddPayee, ModifyPayee, PayBill, and SynchronizePayees are called).

The following fields are available:

Account
Addr1
Addr2
Addr3
Aggregate
City
Country
DaysToPay
Id
IdScope
ListId
Name
Phone
PostalCode
State
TxType

Fields

Account
char*
Default Value: ""

User's account number with the payee. This string uniquely identifies the customer in the payee (biller) system.

This is optional and applicable only when the Id is not provided in the request. In this case, the payee detailed information is used to identify the payee in a payment request, or when adding or modifying a payee.

Addr1
char*
Default Value: ""

Payee's address line 1.

This is required to be provided in :

a payment request if payee detailed information is used to identify the payee (i.e., when Id is not provided in the request when either PayBill or ModifyPayment methods are called);
adding or modifying a payee (when the AddPayee or ModifyPayee methods are called).

Addr2
char*
Default Value: ""

Payee's address line 2.

Addr3
char*
Default Value: ""

Payee's address line 3.

Aggregate
char*
Default Value: ""

Wrapper for payee details.

This string consists of all the payee's fields Id, Name, Addr1, Addr2, Addr3, City, State, PostalCode, Country, Phone, IdScope, DaysToPay, ListId, Account of the payee.

When the SynchronizePayees is called, the SyncPayees event is fired for each payee in the payee list. Among other payee data returned through this event's parameters, there is also a PayeeAggregate parameter.

When sending a payment request (by calling PayBill) to an existing payee in the list returned via the payee synchronization request, and when the Id is unknown or not assigned, instead of setting all payee's fields, the user can set the Aggregate to the value of PayeeAggregate returned for that payee from the SyncPayees event. When the Aggregate is set to this value, all payee's fields are populated with the corresponding values in the aggregate.

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the class's fields. However, some of these elements, and/or their potential values, may not be supported by the class. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate class or any other means.

Note: The original data from the server is returned as SGML or XML (depending on the value of OFXVersion that FI supports. If the original data is returned in SGML format, the class internally manipulates these responses into the equivalent XML format by inserting close element tags (e.g., "</ACCTID>") into the data as it comes from the server.

City
char*
Default Value: ""

Payee's city.

This is required to be provided in :

a payment request if payee detailed information is used to identify the payee (i.e., when Id is not provided in the request when either PayBill or ModifyPayment methods are called);
adding or modifying a payee (when the AddPayee or ModifyPayee methods are called).

Country
char*
Default Value: "USA"

Payee's country. This is a 3 letter country code as representation of a country name (ISO/DIS-3166 3-letter country code standard).

DaysToPay
char* (read-only)
Default Value: ""

Minimum number of business days required to complete the payment transaction to this payee.

Id
char*
Default Value: ""

Server-assigned payee identifier.

The Id is assigned by the payment system to a payee. There is no requirement though that all or any payees are assigned an identifier. This string uniquely identifies the payee in the list of payees.

Either Id or payee full information should be provided in a payment request, but not both.

Payee full information can be provided in the request by setting either the Aggregate or payee details represented by required fields: Name, Addr1, City, State, PostalCode, Phone, and optional fields: Addr2, Addr3, Country, Account.

The Id might be populated when: either a payment request (PayBill method is called) or an add payee request (AddPayee method is called) has been sent to the payment server, or when the Aggregate has been set.

IdScope
char* (read-only)
Default Value: ""

Scope of the payee Id.

Possible values are:


Value	Meaning
GLOBAL	Payee Id is valid across the entire payee system
USER	Payee Id is valid across all FI accounts for this user

ListId
char*
Default Value: ""

Server-assigned payee list record ID for this payee.

This is uniquely assigned by the server to each entry in a payee list. In systems that do not assign a Id, the ListId is another identifier that can be used to reference every payee making sure that the user can correctly link payments to their payees. This identifier is valid as long as the user's payee list includes the payee it identifies, even if the server assigns a Id to this payee.

It is assigned by the server to that payee when an add payee request (via AddPayee method) or bill payment request (via PayBill method) has been sent.

The value of ListId is used as parameter when the ModifyPayee or DeletePayee methods are called (when modifying or deleting a payee). In all other payment requests is optional.

Name
char*
Default Value: ""

Name of the payee to whom the given Id or ListId corresponds. This is required to be provided in :

a payment request if payee detailed information is used to identify the payee (i.e., when Id is not provided in the request when either PayBill or ModifyPayment methods are called);
adding or modifying a payee (when the AddPayee or ModifyPayee methods are called).

After sending payment or add/modify payee requests, if the returned IdScope is GLOBAL, the Name will contain the standard payee name returned by the server.

Phone
char*
Default Value: ""

Payee's phone.

This is required to be provided in :

a payment request if payee detailed information is used to identify the payee (i.e., when Id is not provided in the request when either PayBill or ModifyPayment methods are called);
adding or modifying a payee (when the AddPayee or ModifyPayee methods are called).

PostalCode
char*
Default Value: ""

Payee's postal code.

This is required to be provided in :

a payment request if payee detailed information is used to identify the payee (i.e., when Id is not provided in the request when either PayBill or ModifyPayment methods are called);
adding or modifying a payee (when the AddPayee or ModifyPayee methods are called).

State
char*
Default Value: ""

Payee's state

This is required to be provided in :

a payment request if payee detailed information is used to identify the payee (i.e., when Id is not provided in the request when either PayBill or ModifyPayment methods are called);
adding or modifying a payee (when the AddPayee or ModifyPayee methods are called).

TxType
char* (read-only)
Default Value: ""

Transaction type performed on the payee being synchronized.

This is applicable to payee synchronization requests only. Possible values and their meanings are as follows:


ADDED	If the payee being synchronized was added in the payee list.
MODIFIED	If the payee being synchronized was modified.
DELETED	If the payee being synchronized was deleted from the payee list.

Constructors

PayeeDetail()

PayeeDetail(const char* lpszId)

PayeeDetail(const char* lpszName, const char* lpszAddr1, const char* lpszCity, const char* lpszState, const char* lpszPostalCode, const char* lpszPhone)

PayeeDetail(const char* lpszName, const char* lpszAddr1, const char* lpszAddr2, const char* lpszAddr3, const char* lpszCity, const char* lpszState, const char* lpszPostalCode, const char* lpszCountry, const char* lpszPhone, const char* lpszAccount)

PaymentDetail Type

This type corresponds to a single bill payment.

Syntax

InEBankPaymentDetail (declared in inebank.h)

Remarks

PaymentDetail objects are used when paying or modifying a bill, or synchronizing the bill payments (when the corresponding methods: PayBill, ModifyPayment, and SynchronizePayments are called).

The following fields are available:

Fields

Aggregate
char* (read-only)
Default Value: ""

Wrapper for a payment details.

This string consists of all the payment's fields Id, Status, Amount, FromBankId, FromAccountId, FromAccountType, Memo, CheckNumber, etc..

Amount
char*
Default Value: ""

Payment amount. This is to be provided when sending a bill payment request.

Note: the financial institution usually returns amounts as a string that includes the sign (+/-) of the amount. However, the server may sometimes leave out a particular field if it is not required by the OFX specification. To avoid confusion that can be caused by returning integers, the class will return all amount types as a string, with the empty string ("") for fields not returned by the server.

Where there is a value returned by the server, the class will attempt to convert the string into a format that can be easily parsed into an integer value. This behavior can be controlled by the CurrencyFormat config setting.

BillRef
char*
Default Value: ""

Biller-supplied reference information when paying a bill, if available.

This is optional when submitting a payment request.

CheckNumber
char* (read-only)
Default Value: ""

Check number assigned by the server to this payment.

This will be returned in the server response (if available) when the request succeeds.

CurrencyCode
char* (read-only)
Default Value: ""

Default currency code for this transaction.

This indicates the currency in which the payment will be carried out.

DateDue
char*
Default Value: ""

Processing date requested by user for the payment to be sent.

This is required to be provided in any bill payment or payment modification requests.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

DateProcessed
char* (read-only)
Default Value: ""

Payment processing date.

This indicates the date when the event described by Status occurs.

This format specifies also how the returned dates are going to get parsed.

FromAccountId
char*
Default Value: ""

Account number from which the money for this payment is drawn.

This is an account number for a typical bank, such as one that might appear on a check, a bank card, or a credit card with that bank.

It is required to be provided when a bill payment or payment modification request is sent to the server (i.e., when PayBill or ModifyPayment methods are called).

If FromAccountType is set to CreditCard, the FromAccountId should be a credit card account number.

FromAccountType
int
Default Value: 0

Indicates the type of account from which the money for this payment is drawn.

This is required to be provided when a bill payment or payment modification request is sent to the server (i.e., when PayBill or ModifyPayment methods are called).

This property uses the following four values:

atChecking (0)
atSavings (1)
atMoneyMarket (2)
atLineOfCredit (3)

FromBankId
char*
Default Value: ""

Number that identifies the bank where the money is to be withdrawn.

This is required to be provided when a bill payment request has been made.

Id
char*
Default Value: ""

Transaction Id assigned by the server to the payment.

The Id is returned after a bill payment request (when calling the PayBill method, which can be either a single payment or a recurring payment model).

This identifier value can be used as reference to this payment or model in any modification or cancellation request (as parameter when the ModifyPayment or CancelPayment methods are called).

Memo
char*
Default Value: ""

Memo attached to this payment from the customer to payee.

This is optional when submitting a payment request.

PayeeAccount
char* (read-only)
Default Value: ""

User's account number with the payee this payment was sent to.

This string uniquely identifies the customer in the payee (biller) system.

PayeeAggregate
char* (read-only)
Default Value: ""

Wrapper for the payee details this payment was sent to.

This string consists of these payee's data: name, address, city, state, country, postal code, country and phone.

When the SynchronizePayments is called, the SyncPayments event is fired for each payment in the payment list. Among other payment data returned through this event's parameters, there is also a PayeeAggregate parameter.

PayeeId
char* (read-only)
Default Value: ""

Server-assigned identifier to the payee this payment was sent to.

The PayeeId is assigned by the payment system to a payee. There is no requirement though that all or any payees are assigned an identifier. This string uniquely identifies the payee in the list of payees.

Either PayeeAggregate or PayeeId can be returned in the response, but not both.

PayeeListId
char* (read-only)
Default Value: ""

Server-assigned payee list record ID for the payee this payment was sent to.

This is uniquely assigned by the server to each entry in a payee list. In systems that do not assign a PayeeId, the PayeeListId is another identifier that can be used to reference every payee making sure that the user can correctly link payments to their payees. This identifier is valid as long as the user's payee list includes the payee it identifies, even if the server assigns a PayeeId to this payee.

This is assigned by the server to that payee when an add payee request (via AddPayee method) or bill payment request (via PayBill method) has been sent.

Status
char* (read-only)
Default Value: ""

Payment processing status.

The possible values of this property are as follows:


Value	Meaning
WILLPROCESSON	Will be processed on Date
PROCESSEDON	Was processed on Date
NOFUNDSON	There were insufficient funds to pay this bill as of Date
FAILEDON	The attempt to make a payment failed on Date for unspecified reasons
CANCELEDON	the request to make a payment was canceled by the user on Date

ToAccountId
char*
Default Value: ""

Account number to which the money for this payment is sent.

This is an account number for a typical bank, such as one that might appear on a check, a bank card, or a credit card with this bank.

It is optional to be provided when a bill payment or payment modification request is sent to the server (i.e., when PayBill or ModifyPayment methods are called).

If ToAccountType is set to CreditCard, the ToAccountId should be a credit card account number.

This is optional, but if it is provided in the request, Payee detailed information is required to be provided as well (by providing payee details, such as name, address, phone, etc.) and not via Id.

ToAccountType
int
Default Value: 0

Indicates the type of account to which this payment is sent.

This is required to be provided when a bill payment or payment modification request is sent to the server (i.e., when PayBill or ModifyPayment methods are called).

This property uses the following four values:

atChecking (0)
atSavings (1)
atMoneyMarket (2)
atLineOfCredit (3)

ToBankId
char*
Default Value: ""

Number that identifies the bank where the money is to be deposited.

TxType
char* (read-only)
Default Value: ""

Transaction type performed on the payment being synchronized.

This is applicable to payment synchronization requests only. Possible values and their meanings are as follows:


ADDED	If the payment being synchronized was new bill payment.
MODIFIED	If the payment being synchronized was modified.
CANCELLED	If the payment being synchronized was cancelled.

Constructors

PaymentDetail()

PaymentDetail(const char* lpszId, const char* lpszFromBankId, const char* lpszFromAccountId, int iFromAccountType, const char* lpszToBankId, const char* lpszToAccountId, int iToAccountType, const char* lpszAmount, const char* lpszDateDue, const char* lpszMemo)

PaymentDetail(const char* lpszFromBankId, const char* lpszFromAccountId, int iFromAccountType, const char* lpszToBankId, const char* lpszToAccountId, int iToAccountType, const char* lpszAmount, const char* lpszDateDue, const char* lpszMemo)

PaymentDetail(const char* lpszFromBankId, const char* lpszFromAccountId, int iFromAccountType, const char* lpszAmount, const char* lpszDateDue, const char* lpszMemo)

PaymentDetail(const char* lpszFromBankId, const char* lpszFromAccountId, int iFromAccountType, const char* lpszAmount, const char* lpszDateDue)

PaymentDetail(const char* lpszId, const char* lpszFromBankId, const char* lpszFromAccountId, int iFromAccountType)

PaymentDetail(const char* lpszFromBankId, const char* lpszFromAccountId, int iFromAccountType)

PaymentDetail(const char* lpszId)

InEBankList Type

Syntax

InEBankList<T> (declared in inebank.h)

Remarks

InEBankList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the BillPayment class.

Methods

GetCount	This method returns the current size of the collection. int GetCount() {}
SetCount	This method sets the size of the collection. This method returns `0` if setting the size was successful; or `-1` if the collection is `ReadOnly`. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection. int SetCount(int count) {}
Get	This method gets the item at the specified position. The `index` parameter specifies the index of the item in the collection. This method returns `NULL` if an invalid `index` is specified. T* Get(int index) {}
Set	This method sets the item at the specified position. The `index` parameter specifies the index of the item in the collection that is being set. This method returns `-1` if an invalid `index` is specified. Note: Objects created using the `new` operator must be freed using the `delete` operator; they will not be automatically freed by the class. T* Set(int index, T* value) {}

Config Settings (BillPayment Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

OFX Config Settings

AuthToken: Authentication token required for this signon session only.

This credential is provided to the user out of band.

In the profile response, if AuthTokenFirst is True, then AuthToken should be sent in the very first signon.

ClientUId: Unique ID identifying OFX Client.

In the profile response, if ClientUIdReq is True, then ClientUId should be set and included in all future requests.

CorrectAction[i]: The action taken to a previously sent transaction corrected by the current one.

If present in the list of transactions response, this represents the action taken to a previously sent transaction that is corrected by this record. Possible values are: REPLACE or DELETE. REPLACE replaces the transaction that it corrects referenced by CorrectFITID[i];. DELETE deletes it. This is applicable to statement download components only.

CorrectFITID[i]: The FITID of a previously sent transaction corrected by the current one.

If present in the list of transactions response, this represents the FITID of a previously sent transaction that is corrected by this record. Based on the value of CorrectAction[i];, this transaction replaces or deletes the transaction that it corrects. This is applicable to statement download components only.

CurrencyFormat: The format to be used for returning currency values.

If this is set to a non-empty string, the class will attempt to use the value as a pattern to format all currency strings returned from the server. You may use any of the system's default number formatting strings.

DateFormat: The format to be used for input and output dates.

This format is used for input and output dates. You may use any of the system's default date formatting strings.

When submitting the request: all your input dates should be entered in a format specified by DateFormat and the class will convert those to OFXDateFormat right before sending the request.

For example, if you set a date to '2000.01.01' (by first setting the DateFormat to 'yyyy.MM.dd'), for a EST timezone, the class will convert it to '20000101000000.000[-5:EST]' (format specified by OFXDateFormat).

When parsing the response: if DateFormat is set to a non-empty string, the class will attempt to use the value as a pattern to format all date strings as they are returned. Otherwise, the system's default value will be used for formatting.

If the DateFormat is set to the special value "OFXDATE": During input:, any values you supply to date properties are passed to the server directly with no changes; During output: all dates will be returned in the OFX format as it was provided by the server without performing any modifications.

GetResponseVar: Parses additional information out of the response.

Any additional response information contained within the OFX response that is not available via the Response fields, may be retrieved with this GetResponseVar config.

To obtain a response value, pass the XPath to the value you wish to receive. For instance, if the OFX response contains: "<OFX><SIGNONMSGSRSV1><SONRS><STATUS><CODE>0<SEVERITY>INFO</STATUS><DTSERVER>20120104223836.575<LANGUAGE>ENG"

Then calling GetResponseVar("/OFX/SIGNONMSGSRVSV1/LANGUAGE") will return "ENG".

NewPassword: New password for the current OFX user.

Setting NewPassword to a non-empty value will cause the class to issue a password change request during sign-on along with the regular current OFX request. After the request is sent, this value will be cleared.

The correct current password is needed as well during signon request and must be supplied through the OFXPassword. Upon successful reply from the server, the NewPassword used becomes the new password.

OFXDateFormat: The date format as required by OFX FI server.

Most of OFX FI servers, accept the default format, where the offset (G) and timezone (Z) are specified. However, there might still be some servers that do not accept that part. In such cases, you will have to set the OFXDateFormat to "YYYYMMddHHmmss.xxx" and GMT will be assumed as the default value.

Your input dates should be entered in a format specified by DateFormat and the class will convert those to OFXDateFormat (format that OFX FI server recognizes) right before sending the request.

OFXLog: Log file for the OFX transaction.

This setting records the OFX communication, but without including HTTP headers, to a file.

Please note that ReadOFXDataFile will not be able to parse this file because of the OFX request content present. If only the response of the server is required, please look at the WriteOFXDataFile method instead.

ServerMessage: Server message if a warning or other information returned.

When sending a transaction request to a FI, their server with return either a successful reply or an error. However, even when a transaction is successful, a warning or other server messages might still be returned and are to be treated as informational notes only.

UserCred1A: Additional user credential required by server.

In the profile response, if UserCred1Q is present, then UserCred1A should be set (as the answer to question identified by UserCred1Q) and it should be included in all future requests as part of the signon.

UserCred2A: Additional user credential required by server.

In the profile response, if UserCred2Q is present, then UserCred2A should be set (as the answer to question identified by UserCred2Q) and it should be included in all future requests as part of the signon.

HTTP Config Settings

AcceptEncoding: Used to tell the server which types of content encodings the client supports.

When AllowHTTPCompression is True, the class adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The class only supports gzip and deflate decompression algorithms.

AllowHTTPCompression: This property enables HTTP compression for receiving data.

This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.

When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".

The default value is True.

AllowHTTPFallback: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.

This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".

If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2.

The default value is True.

Append: Whether to append data to LocalFile.

This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False.

Authorization: The Authorization string to be sent to the server.

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

BytesTransferred: Contains the number of bytes transferred in the response data.

This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the Transfer event, by BytesTransferred.

ChunkSize: Specifies the chunk size in bytes when using chunked encoding.

This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

CompressHTTPRequest: Set to true to compress the body of a PUT or POST request.

If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

EncodeURL: If set to True the URL will be encoded by the class.

If set to True, the URL passed to the class will be URL encoded. The default value is False.

FollowRedirects: Determines what happens when the server issues a redirect.

This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the class fails with an error.

Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is 0 (Never). In this case, redirects are never followed, and the class fails with an error instead.

Following are the valid options:

0 - Never
1 - Always
2 - Same Scheme

GetOn302Redirect: If set to True the class will perform a GET on the new location.

The default value is False. If set to True, the class will perform a GET on the new location. Otherwise, it will use the same HTTP method again.

HTTP2HeadersWithoutIndexing: HTTP2 headers that should not update the dynamic header table with incremental indexing.

HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

HTTPVersion: The version of HTTP used by the class.

This property specifies the HTTP version used by the class. Possible values are as follows:

"1.0"
"1.1" (default)
"2.0"
"3.0"

When using HTTP/2 ("2.0") or HTTP/3 ("3.0"), additional restrictions apply. Please see the following notes for details.

HTTP/2 Notes

When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.

HTTP/3 Notes

HTTP/3 is supported only in .NET and Java.

When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.

IfModifiedSince: A date determining the maximum age of the desired document.

If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: Sat, 29 Oct 2017 19:43:31 GMT.

KeepAlive: Determines whether the HTTP connection is closed after completion of the request.

If true, the component will not send the Connection: Close header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note: Not all servers support persistent connections. If false, the connection will be closed immediately after the server response is received.

The default value for KeepAlive is false.

KerberosSPN: The Service Principal Name for the Kerberos Domain Controller.

If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

LogLevel: The level of detail that is logged.

This configuration setting controls the level of detail that is logged through the Log event. Possible values are as follows:


0 (None)	No events are logged.
1 (Info - default)	Informational events are logged.
2 (Verbose)	Detailed data are logged.
3 (Debug)	Debug data are logged.

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

MaxRedirectAttempts: Limits the number of redirects that are followed in a request.

When FollowRedirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

NegotiatedHTTPVersion: The negotiated HTTP version.

This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used.

OtherHeaders: Other headers as determined by the user (optional).

This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.

This configuration setting is useful for extending the functionality of the class beyond what is provided.

ProxyAuthorization: The authorization string to be sent to the proxy server.

This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If User and Password are specified, this value is calculated using the algorithm specified by AuthScheme.

ProxyAuthScheme: The authorization scheme to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyPassword: A password if authentication is to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyPort: Port for the proxy server (default 80).

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyServer: Name or IP address of a proxy server (optional).

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyUser: A user name if authentication is to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

SentHeaders: The full set of headers as sent by the client.

This configuration setting returns the complete set of raw headers as sent by the client.

StatusCode: The status code of the last response from the server.

This configuration setting contains the result code of the last response from the server.

StatusLine: The first line of the last response from the server.

This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description].

TransferredData: The contents of the last response from the server.

This configuration setting contains the contents of the last response from the server.

TransferredDataLimit: The maximum number of incoming bytes to be stored by the class.

If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class.

TransferredHeaders: The full set of headers as received from the server.

This configuration setting returns the complete set of raw headers as received from the server.

TransferredRequest: The full request as sent by the client.

This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

.NET Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); C++ HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest"));

UseChunkedEncoding: Enables or Disables HTTP chunked encoding for transfers.

If UseChunkedEncoding is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False.

Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

UseIDNs: Whether to encode hostnames to internationalized domain names.

This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).

The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW.

UsePlatformHTTPClient: Whether or not to use the platform HTTP client.

When using this configuration setting, if True, the component will use the default HTTP client for the platform (URLConnection in Java, WebRequest in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine).

Note: This setting is applicable only to Mac/iOS editions.

UseProxyAutoConfigURL: Whether to use a Proxy auto-config file when attempting a connection.

This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and AutoDetect is set to True.

When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.

UserAgent: Information about the user agent (browser).

This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

Override the default with the name and version of your software.

TCPClient Config Settings

ConnectionTimeout: Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect: Tells the class whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallHost: Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPassword: Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort: The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType: Determines the type of firewall to connect through.

Possible values are as follows:


0	No firewall (default setting).
1	Connect through a tunneling proxy. FirewallPort is set to 80.
2	Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3	Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10	Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallUser: A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

KeepAliveInterval: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveRetryCount: The number of keep-alive packets to be sent before the remotehost is considered disconnected.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the number of times that the keep-alive packets will be sent before the remote host is considered disconnected. The system default if this value is not specified here is 9.

Note: This configuration setting is only available in the Unix platform. It is not supported in masOS or FreeBSD.

KeepAliveTime: The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger: When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime: Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost: The name of the local host through which connections are initiated or accepted.

The LocalHost setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

LocalPort: The port in the local host where the class binds.

This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength: The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate: The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList: A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive: Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay: Whether or not to delay when sending packets.

When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

UseIPv6: Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are as follows:


0	IPv4 only
1	IPv6 only
2	IPv6 with IPv4 fallback

SSL Config Settings

LogSSLPackets: Controls whether SSL packets are logged when using the internal security API.

When SSLProvider is set to Internal, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is False, as it is useful only for debugging purposes.

When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if SSLProvider is set to Platform.

OpenSSLCADir: The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile: Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:

-----BEGIN CERTIFICATE-----

... (CA certificate in base64 encoding) ...

-----END CERTIFICATE-----

Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList: A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData: The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession: Determines if the SSL session is reused.

If set to True, the class will reuse the context if and only if the following criteria are met:

The target host name is the same.
The system cache entry has not expired (default timeout is 10 hours).
The application process that calls the function is the same.
The logon session is the same.
The instance of the class is the same.

SSLCACertFilePaths: The paths to CA certificate files on Unix/Linux.

This configuration setting specifies the paths on disk to CA certificate files on Unix/Linux.

The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.

The default value is as follows:

/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem

SSLCACerts: A newline separated list of CA certificates to be included when performing an SSL handshake.

When SSLProvider is set to Internal, this configuration setting specifies one or more CA certificates to be included with the SSLCert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

SSLCipherStrength: The minimum cipher strength used for bulk encryption.

This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.

Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.

SSLClientCACerts: A newline separated list of CA certificates to use during SSL client certificate validation.

This configuration setting is only applicable to server components (e.g., TCPServer) see SSLServerCACerts for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

SSLEnabledCipherSuites: The cipher suite to be used in an SSL negotiation.

This configuration setting enables the cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when SSLProvider is set to Platform include the following: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider is set to Platform include the following:

CALG_3DES
CALG_3DES_112
CALG_AES
CALG_AES_128
CALG_AES_192
CALG_AES_256
CALG_AGREEDKEY_ANY
CALG_CYLINK_MEK
CALG_DES
CALG_DESX
CALG_DH_EPHEM
CALG_DH_SF
CALG_DSS_SIGN
CALG_ECDH
CALG_ECDH_EPHEM
CALG_ECDSA
CALG_ECMQV
CALG_HASH_REPLACE_OWF
CALG_HUGHES_MD5
CALG_HMAC
CALG_KEA_KEYX
CALG_MAC
CALG_MD2
CALG_MD4
CALG_MD5
CALG_NO_SIGN
CALG_OID_INFO_CNG_ONLY
CALG_OID_INFO_PARAMETERS
CALG_PCT1_MASTER
CALG_RC2
CALG_RC4
CALG_RC5
CALG_RSA_KEYX
CALG_RSA_SIGN
CALG_SCHANNEL_ENC_KEY
CALG_SCHANNEL_MAC_KEY
CALG_SCHANNEL_MASTER_HASH
CALG_SEAL
CALG_SHA
CALG_SHA1
CALG_SHA_256
CALG_SHA_384
CALG_SHA_512
CALG_SKIPJACK
CALG_SSL2_MASTER
CALG_SSL3_MASTER
CALG_SSL3_SHAMD5
CALG_TEK
CALG_TLS1_MASTER
CALG_TLS1PRF

Example values when SSLProvider is set to Internalinclude the following:

obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");

Possible values when SSLProvider is set to Internal include the following:

TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
TLS_DHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
TLS_DHE_DSS_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_DES_CBC_SHA
TLS_DHE_RSA_WITH_DES_CBC_SHA
TLS_DHE_DSS_WITH_DES_CBC_SHA
TLS_RSA_WITH_RC4_128_MD5
TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:

TLS_AES_256_GCM_SHA384
TLS_CHACHA20_POLY1305_SHA256
TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols: Used to enable/disable the supported security protocols.

This configuration setting is used to enable or disable the supported security protocols.

Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:


TLS1.3	12288 (Hex 3000)
TLS1.2	3072 (Hex C00) (Default - Client and Server)
TLS1.1	768 (Hex 300) (Default - Client)
TLS1	192 (Hex C0) (Default - Client)
SSL3	48 (Hex 30)
SSL2	12 (Hex 0C)

Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.

SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:

By default when TLS 1.3 is enabled, the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.

In editions that are designed to run on Windows, SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider), please be aware of the following notes:

The platform provider is available only on Windows 11/Windows Server 2022 and up.
SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

SSLEnabledProtocols: SSL2 and SSL3 Notes:

SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.

SSLEnableRenegotiation: Whether the renegotiation_info SSL extension is supported.

This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is false by default, but it can be set to true to enable the extension.

This configuration setting is applicable only when SSLProvider is set to Internal.

SSLIncludeCertChain: Whether the entire certificate chain is included in the SSLServerAuthentication event.

This configuration setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

SSLKeyLogFile: The location of a file where per-session secrets are written for debugging purposes.

This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.

Note: This configuration setting is applicable only when SSLProvider is set to Internal.

SSLNegotiatedCipher: Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength: Returns the negotiated cipher suite strength.

This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite: Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.

SSLNegotiatedKeyExchange: Returns the negotiated key exchange algorithm.

This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.

SSLNegotiatedKeyExchangeStrength: Returns the negotiated key exchange algorithm strength.

This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.

SSLNegotiatedVersion: Returns the negotiated protocol version.

This configuration setting returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags: Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:


0x00000001	Ignore time validity status of certificate.
0x00000002	Ignore time validity status of CTL.
0x00000004	Ignore non-nested certificate times.
0x00000010	Allow unknown certificate authority.
0x00000020	Ignore wrong certificate usage.
0x00000100	Ignore unknown certificate revocation status.
0x00000200	Ignore unknown CTL signer revocation status.
0x00000400	Ignore unknown certificate authority revocation status.
0x00000800	Ignore unknown root revocation status.
0x00008000	Allow test root certificate.
0x00004000	Trust test root certificate.
0x80000000	Ignore non-matching CN (certificate CN non-matching server name).

This functionality is currently not available when the provider is OpenSSL.

SSLServerCACerts: A newline separated list of CA certificates to use during SSL server certificate validation.

This configuration setting is only used by client components (e.g., TCPClient) see SSLClientCACerts for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

TLS12SignatureAlgorithms: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This configuration setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class fails with an error.

The format of this value is a comma-separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups: The supported groups for ECC.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:

"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)

TLS13KeyShareGroups: The groups for which to pregenerate key shares.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.

In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448"
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1"
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096"
"ffdhe_6144"
"ffdhe_8192"

TLS13SignatureAlgorithms: The allowed certificate signature algorithms.

This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:

"ed25519" (default)
"ed448" (default)
"ecdsa_secp256r1_sha256" (default)
"ecdsa_secp384r1_sha384" (default)
"ecdsa_secp521r1_sha512" (default)
"rsa_pkcs1_sha256" (default)
"rsa_pkcs1_sha384" (default)
"rsa_pkcs1_sha512" (default)
"rsa_pss_sha256" (default)
"rsa_pss_sha384" (default)
"rsa_pss_sha512" (default)

The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This configuration setting is applicable only when SSLEnabledProtocols includes TLS 1.3.

TLS13SupportedGroups: The supported groups for (EC)DHE key exchange.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448" (default)
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096" (default)
"ffdhe_6144" (default)
"ffdhe_8192" (default)

Socket Config Settings

AbsoluteTimeout: Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method that does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for User Datagram Protocol (UDP) ports.

FirewallData: Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).

InBufferSize: The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the InBufferSize setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize: The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the OutBufferSize setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

BuildInfo: Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage: The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:


Identifier	Name
037	IBM EBCDIC - U.S./Canada
437	OEM - United States
500	IBM EBCDIC - International
708	Arabic - ASMO 708
709	Arabic - ASMO 449+, BCON V4
710	Arabic - Transparent Arabic
720	Arabic - Transparent ASMO
737	OEM - Greek (formerly 437G)
775	OEM - Baltic
850	OEM - Multilingual Latin I
852	OEM - Latin II
855	OEM - Cyrillic (primarily Russian)
857	OEM - Turkish
858	OEM - Multilingual Latin I + Euro symbol
860	OEM - Portuguese
861	OEM - Icelandic
862	OEM - Hebrew
863	OEM - Canadian-French
864	OEM - Arabic
865	OEM - Nordic
866	OEM - Russian
869	OEM - Modern Greek
870	IBM EBCDIC - Multilingual/ROECE (Latin-2)
874	ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875	IBM EBCDIC - Modern Greek
932	ANSI/OEM - Japanese, Shift-JIS
936	ANSI/OEM - Simplified Chinese (PRC, Singapore)
949	ANSI/OEM - Korean (Unified Hangul Code)
950	ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026	IBM EBCDIC - Turkish (Latin-5)
1047	IBM EBCDIC - Latin 1/Open System
1140	IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141	IBM EBCDIC - Germany (20273 + Euro symbol)
1142	IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143	IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144	IBM EBCDIC - Italy (20280 + Euro symbol)
1145	IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146	IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147	IBM EBCDIC - France (20297 + Euro symbol)
1148	IBM EBCDIC - International (500 + Euro symbol)
1149	IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200	Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201	Unicode UCS-2 Big-Endian
1250	ANSI - Central European
1251	ANSI - Cyrillic
1252	ANSI - Latin I
1253	ANSI - Greek
1254	ANSI - Turkish
1255	ANSI - Hebrew
1256	ANSI - Arabic
1257	ANSI - Baltic
1258	ANSI/OEM - Vietnamese
1361	Korean (Johab)
10000	MAC - Roman
10001	MAC - Japanese
10002	MAC - Traditional Chinese (Big5)
10003	MAC - Korean
10004	MAC - Arabic
10005	MAC - Hebrew
10006	MAC - Greek I
10007	MAC - Cyrillic
10008	MAC - Simplified Chinese (GB 2312)
10010	MAC - Romania
10017	MAC - Ukraine
10021	MAC - Thai
10029	MAC - Latin II
10079	MAC - Icelandic
10081	MAC - Turkish
10082	MAC - Croatia
12000	Unicode UCS-4 Little-Endian
12001	Unicode UCS-4 Big-Endian
20000	CNS - Taiwan
20001	TCA - Taiwan
20002	Eten - Taiwan
20003	IBM5550 - Taiwan
20004	TeleText - Taiwan
20005	Wang - Taiwan
20105	IA5 IRV International Alphabet No. 5 (7-bit)
20106	IA5 German (7-bit)
20107	IA5 Swedish (7-bit)
20108	IA5 Norwegian (7-bit)
20127	US-ASCII (7-bit)
20261	T.61
20269	ISO 6937 Non-Spacing Accent
20273	IBM EBCDIC - Germany
20277	IBM EBCDIC - Denmark/Norway
20278	IBM EBCDIC - Finland/Sweden
20280	IBM EBCDIC - Italy
20284	IBM EBCDIC - Latin America/Spain
20285	IBM EBCDIC - United Kingdom
20290	IBM EBCDIC - Japanese Katakana Extended
20297	IBM EBCDIC - France
20420	IBM EBCDIC - Arabic
20423	IBM EBCDIC - Greek
20424	IBM EBCDIC - Hebrew
20833	IBM EBCDIC - Korean Extended
20838	IBM EBCDIC - Thai
20866	Russian - KOI8-R
20871	IBM EBCDIC - Icelandic
20880	IBM EBCDIC - Cyrillic (Russian)
20905	IBM EBCDIC - Turkish
20924	IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932	JIS X 0208-1990 & 0121-1990
20936	Simplified Chinese (GB2312)
21025	IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027	Extended Alpha Lowercase
21866	Ukrainian (KOI8-U)
28591	ISO 8859-1 Latin I
28592	ISO 8859-2 Central Europe
28593	ISO 8859-3 Latin 3
28594	ISO 8859-4 Baltic
28595	ISO 8859-5 Cyrillic
28596	ISO 8859-6 Arabic
28597	ISO 8859-7 Greek
28598	ISO 8859-8 Hebrew
28599	ISO 8859-9 Latin 5
28605	ISO 8859-15 Latin 9
29001	Europa 3
38598	ISO 8859-8 Hebrew
50220	ISO 2022 Japanese with no halfwidth Katakana
50221	ISO 2022 Japanese with halfwidth Katakana
50222	ISO 2022 Japanese JIS X 0201-1989
50225	ISO 2022 Korean
50227	ISO 2022 Simplified Chinese
50229	ISO 2022 Traditional Chinese
50930	Japanese (Katakana) Extended
50931	US/Canada and Japanese
50933	Korean Extended and Korean
50935	Simplified Chinese Extended and Simplified Chinese
50936	Simplified Chinese
50937	US/Canada and Traditional Chinese
50939	Japanese (Latin) Extended and Japanese
51932	EUC - Japanese
51936	EUC - Simplified Chinese
51949	EUC - Korean
51950	EUC - Traditional Chinese
52936	HZ-GB2312 Simplified Chinese
54936	Windows XP: GB18030 Simplified Chinese (4 Byte)
57002	ISCII Devanagari
57003	ISCII Bengali
57004	ISCII Tamil
57005	ISCII Telugu
57006	ISCII Assamese
57007	ISCII Oriya
57008	ISCII Kannada
57009	ISCII Malayalam
57010	ISCII Gujarati
57011	ISCII Punjabi
65000	Unicode UTF-7
65001	Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:


Identifier	Name
1	ASCII
2	NEXTSTEP
3	JapaneseEUC
4	UTF8
5	ISOLatin1
6	Symbol
7	NonLossyASCII
8	ShiftJIS
9	ISOLatin2
10	Unicode
11	WindowsCP1251
12	WindowsCP1252
13	WindowsCP1253
14	WindowsCP1254
15	WindowsCP1250
21	ISO2022JP
30	MacOSRoman
10	UTF16String
0x90000100	UTF16BigEndian
0x94000100	UTF16LittleEndian
0x8c000100	UTF32String
0x98000100	UTF32BigEndian
0x9c000100	UTF32LittleEndian
65536	Proprietary

LicenseInfo: Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

Product: The product the license is for.
Product Key: The key the license was generated from.
License Source: Where the license was found (e.g., RuntimeLicense, License File).
License Type: The type of license installed (e.g., Royalty Free, Single Server).
Last Valid Build: The last valid build number for which the license will work.

MaskSensitiveData: Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI: Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

Trappable Errors (BillPayment 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.

OFX Errors

2000	Required field missing from server response.
2001	OFX server error. Description follows.
2002	Invalid OFX response.
2003	OFX response contains unknown element tags.

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

XML Errors

101	Invalid attribute index.
102	No attributes available.
103	Invalid namespace index.
104	No namespaces available.
105	Invalid element index.
106	No elements available.
107	Attribute does not exist.
201	Unbalanced element tag.
202	Unknown element prefix (cannot find namespace).
203	Unknown attribute prefix (cannot find namespace).
204	Invalid XML markup.
205	Invalid end state for parser.
206	Document contains unbalanced elements.
207	Invalid XPath.
208	No such child.
209	Top element does not match start of path.
210	DOM tree unavailable (set BuildDOM to True and reparse).
302	Cannot open file.
401	Invalid XML would be generated.
402	An invalid XML name has been specified.

HTTP Errors

118	Firewall error. The error description contains the detailed message.
143	Busy executing current method.
151	HTTP protocol error. The error message has the server response.
152	No server specified in URL.
153	Specified URLScheme is invalid.
155	Range operation is not supported by server.
156	Invalid cookie index (out of range).
301	Interrupted.
302	Cannot open AttachedFile.

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

TCPClient Errors

100	You cannot change the RemotePort at this time. A connection is in progress.
101	You cannot change the RemoteHost (Server) at this time. A connection is in progress.
102	The RemoteHost address is invalid (0.0.0.0).
104	Already connected. If you want to reconnect, close the current connection first.
106	You cannot change the LocalPort at this time. A connection is in progress.
107	You cannot change the LocalHost at this time. A connection is in progress.
112	You cannot change MaxLineLength at this time. A connection is in progress.
116	RemotePort cannot be zero. Please specify a valid service port number.
117	You cannot change the UseConnection option while the class is active.
135	Operation would block.
201	Timeout.
211	Action impossible in control's present state.
212	Action impossible while not connected.
213	Action impossible while listening.
301	Timeout.
302	Could not open file.
434	Unable to convert string to selected CodePage.
1105	Already connecting. If you want to reconnect, close the current connection first.
1117	You need to connect first.
1119	You cannot change the LocalHost at this time. A connection is in progress.
1120	Connection dropped by remote host.

SSL Errors

270	Cannot load specified security library.
271	Cannot open certificate store.
272	Cannot find specified certificate.
273	Cannot acquire security credentials.
274	Cannot find certificate chain.
275	Cannot verify certificate chain.
276	Error during handshake.
280	Error verifying certificate.
281	Could not find client certificate.
282	Could not find server certificate.
283	Error encrypting data.
284	Error decrypting data.

TCP/IP Errors

10004	[10004] Interrupted system call.
10009	[10009] Bad file number.
10013	[10013] Access denied.
10014	[10014] Bad address.
10022	[10022] Invalid argument.
10024	[10024] Too many open files.
10035	[10035] Operation would block.
10036	[10036] Operation now in progress.
10037	[10037] Operation already in progress.
10038	[10038] Socket operation on nonsocket.
10039	[10039] Destination address required.
10040	[10040] Message is too long.
10041	[10041] Protocol wrong type for socket.
10042	[10042] Bad protocol option.
10043	[10043] Protocol is not supported.
10044	[10044] Socket type is not supported.
10045	[10045] Operation is not supported on socket.
10046	[10046] Protocol family is not supported.
10047	[10047] Address family is not supported by protocol family.
10048	[10048] Address already in use.
10049	[10049] Cannot assign requested address.
10050	[10050] Network is down.
10051	[10051] Network is unreachable.
10052	[10052] Net dropped connection or reset.
10053	[10053] Software caused connection abort.
10054	[10054] Connection reset by peer.
10055	[10055] No buffer space available.
10056	[10056] Socket is already connected.
10057	[10057] Socket is not connected.
10058	[10058] Cannot send after socket shutdown.
10059	[10059] Too many references, cannot splice.
10060	[10060] Connection timed out.
10061	[10061] Connection refused.
10062	[10062] Too many levels of symbolic links.
10063	[10063] File name is too long.
10064	[10064] Host is down.
10065	[10065] No route to host.
10066	[10066] Directory is not empty
10067	[10067] Too many processes.
10068	[10068] Too many users.
10069	[10069] Disc Quota Exceeded.
10070	[10070] Stale NFS file handle.
10071	[10071] Too many levels of remote in path.
10091	[10091] Network subsystem is unavailable.
10092	[10092] WINSOCK DLL Version out of range.
10093	[10093] Winsock is not loaded yet.
11001	[11001] Host not found.
11002	[11002] Nonauthoritative 'Host not found' (try again or check DNS setup).
11003	[11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP.
11004	[11004] Valid name, no data record (check DNS setup).