BankTransfer Class

Properties Methods Events Config Settings Errors

The BankTransfer class is a single class that supports the SignOn and Intrabank/Interbank Funds Transfer functions of Open Financial Exchange, as described by Specification 1.0.2.

Syntax

BankTransfer

Remarks

The BankTransfer class supports immediate or scheduled intrabank (between two accounts at the same financial institution) and interbank (between two accounts at different financial institutions).

The fund transfer request designates source and destination accounts and the amount of the transfer. The FI must be able to authenticate the source account. The user can schedule the transfers for a future date or request an immediate transfer. The user can modify or cancel scheduled transfers, but not immediate transfers.

Interbank funds transfers differ from intrabank funds transfers in the following respects:

the routing and transit number of the destination account differs from the source account;
at the discretion of the FI, the destination account can be subject to pre-notification;
source and destination accounts must be enabled for the Automated Clearing House (ACH);

To make transfer, the TransferFunds method should be called and the following information should be provided in the request.

First, identify the:

OFX user and application by setting the OFXUser, OFXPassword, OFXAppId and OFXAppVersion properties;
financial institution by setting the FIId, FIOrganization, and FIUrl, properties.

Next, specify the:

source account you wish to transfer the funds from, by setting FromBankId, FromAccountId, FromAccountType, and for international banks also FromBranchId and FromAccountKey properties;
destination account where the funds will be deposited to, by setting ToBankId (if requesting interbank transfer), ToAccountId, ToAccountType, and for international banks also ToBranchId and ToAccountKey;
transfer amount by setting Amount to the desired value;
transfer date by setting DateDue (if requesting a scheduled transfer, not an immediate one);

When the response returns, the server cannot provide complete confirmation for the transfer. The server can confirm only that it received the transfer instruction, and possibly, whether it validated the accounts, amount, and date specified in the transfer. When the transfer status is not provided in the server response, then the server should confirm that it accepted the instructions by issuing a Id. In this case, it should also indicate the expected posting date of the transfer stored in DatePosted.

The transfer confirmation can be retrieved at a later time through a synchronization request (by calling SynchronizeTransfers method).

If the request is for an immediate transfer and the server can perform the transfer in real time, the server should indicate whether the transfer succeeded and should return the date of the transfer in DatePosted. In this case, synchronization is not required.

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.
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.
SyncTransfers	A list of bank transfers being synchronized.
Timeout	The timeout for the class.
Transfer	Identifies the bank transfer to be initiated or modified.

Method List

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


CancelTransfer	Cancels a scheduled transfer.
Config	Sets or retrieves a configuration setting.
ModifyTransfer	Modifies a scheduled transfer.
Reset	Reset the internal state of the class and all properties to their default values.
SynchronizeTransfers	Synchronizes transfers on the client side with transfers on record on the server side.
TransferFunds	Transfers money from one account to another within the same or different Financial Institution(s).

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.
SyncTransfers	Fired for each intrabank transfer 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.


BatchTransferType	Transfer request type when an intrabank or interbank transfer is part of a multiple request (batch).
TransferType	Transfer request type for a specified transaction.
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 (BankTransfer 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_banktransfer_getfiid(void* lpObj);
int inebank_banktransfer_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 (BankTransfer 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_banktransfer_getfiorganization(void* lpObj);
int inebank_banktransfer_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 (BankTransfer Class)

A set of properties related to firewall access.

Syntax

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

int inebank_banktransfer_getfirewallautodetect(void* lpObj);
int inebank_banktransfer_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int inebank_banktransfer_getfirewalltype(void* lpObj);
int inebank_banktransfer_setfirewalltype(void* lpObj, int iFirewallType);

char* inebank_banktransfer_getfirewallhost(void* lpObj);
int inebank_banktransfer_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* inebank_banktransfer_getfirewallpassword(void* lpObj);
int inebank_banktransfer_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int inebank_banktransfer_getfirewallport(void* lpObj);
int inebank_banktransfer_setfirewallport(void* lpObj, int iFirewallPort);

char* inebank_banktransfer_getfirewalluser(void* lpObj);
int inebank_banktransfer_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 (BankTransfer 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_banktransfer_getfiurl(void* lpObj);
int inebank_banktransfer_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 (BankTransfer Class)

Whether the token in the synchronization request is older.

Syntax

ANSI (Cross Platform)
int GetLostSync();

Unicode (Windows)
BOOL GetLostSync();

int inebank_banktransfer_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 (BankTransfer 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_banktransfer_getofxaccesskey(void* lpObj);
int inebank_banktransfer_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 (BankTransfer 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_banktransfer_getofxappid(void* lpObj);
int inebank_banktransfer_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 (BankTransfer 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_banktransfer_getofxappversion(void* lpObj);
int inebank_banktransfer_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 (BankTransfer 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_banktransfer_getofxpassword(void* lpObj);
int inebank_banktransfer_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 (BankTransfer Class)

The current OFX request aggregate.

Syntax

ANSI (Cross Platform)
char* GetOFXRequest();

Unicode (Windows)
LPWSTR GetOFXRequest();

char* inebank_banktransfer_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 (BankTransfer 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_banktransfer_getofxresponse(void* lpObj);
int inebank_banktransfer_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 (BankTransfer 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_banktransfer_getofxuser(void* lpObj);
int inebank_banktransfer_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 (BankTransfer 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_banktransfer_getofxversion(void* lpObj);
int inebank_banktransfer_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

SSLAcceptServerCert Property (BankTransfer Class)

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

Syntax

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

char* inebank_banktransfer_getsslacceptservercerteffectivedate(void* lpObj);

char* inebank_banktransfer_getsslacceptservercertexpirationdate(void* lpObj);

char* inebank_banktransfer_getsslacceptservercertextendedkeyusage(void* lpObj);

char* inebank_banktransfer_getsslacceptservercertfingerprint(void* lpObj);

char* inebank_banktransfer_getsslacceptservercertfingerprintsha1(void* lpObj);

char* inebank_banktransfer_getsslacceptservercertfingerprintsha256(void* lpObj);

char* inebank_banktransfer_getsslacceptservercertissuer(void* lpObj);

char* inebank_banktransfer_getsslacceptservercertprivatekey(void* lpObj);

int inebank_banktransfer_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* inebank_banktransfer_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* inebank_banktransfer_getsslacceptservercertpublickey(void* lpObj);

char* inebank_banktransfer_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int inebank_banktransfer_getsslacceptservercertpublickeylength(void* lpObj);

char* inebank_banktransfer_getsslacceptservercertserialnumber(void* lpObj);

char* inebank_banktransfer_getsslacceptservercertsignaturealgorithm(void* lpObj);

int inebank_banktransfer_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int inebank_banktransfer_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* inebank_banktransfer_getsslacceptservercertstorepassword(void* lpObj);
int inebank_banktransfer_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int inebank_banktransfer_getsslacceptservercertstoretype(void* lpObj);
int inebank_banktransfer_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* inebank_banktransfer_getsslacceptservercertsubjectaltnames(void* lpObj);

char* inebank_banktransfer_getsslacceptservercertthumbprintmd5(void* lpObj);

char* inebank_banktransfer_getsslacceptservercertthumbprintsha1(void* lpObj);

char* inebank_banktransfer_getsslacceptservercertthumbprintsha256(void* lpObj);

char* inebank_banktransfer_getsslacceptservercertusage(void* lpObj);

int inebank_banktransfer_getsslacceptservercertusageflags(void* lpObj);

char* inebank_banktransfer_getsslacceptservercertversion(void* lpObj);

char* inebank_banktransfer_getsslacceptservercertsubject(void* lpObj);
int inebank_banktransfer_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int inebank_banktransfer_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int inebank_banktransfer_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 (BankTransfer Class)

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

Syntax

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

char* inebank_banktransfer_getsslcerteffectivedate(void* lpObj);

char* inebank_banktransfer_getsslcertexpirationdate(void* lpObj);

char* inebank_banktransfer_getsslcertextendedkeyusage(void* lpObj);

char* inebank_banktransfer_getsslcertfingerprint(void* lpObj);

char* inebank_banktransfer_getsslcertfingerprintsha1(void* lpObj);

char* inebank_banktransfer_getsslcertfingerprintsha256(void* lpObj);

char* inebank_banktransfer_getsslcertissuer(void* lpObj);

char* inebank_banktransfer_getsslcertprivatekey(void* lpObj);

int inebank_banktransfer_getsslcertprivatekeyavailable(void* lpObj);

char* inebank_banktransfer_getsslcertprivatekeycontainer(void* lpObj);

char* inebank_banktransfer_getsslcertpublickey(void* lpObj);

char* inebank_banktransfer_getsslcertpublickeyalgorithm(void* lpObj);

int inebank_banktransfer_getsslcertpublickeylength(void* lpObj);

char* inebank_banktransfer_getsslcertserialnumber(void* lpObj);

char* inebank_banktransfer_getsslcertsignaturealgorithm(void* lpObj);

int inebank_banktransfer_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int inebank_banktransfer_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* inebank_banktransfer_getsslcertstorepassword(void* lpObj);
int inebank_banktransfer_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int inebank_banktransfer_getsslcertstoretype(void* lpObj);
int inebank_banktransfer_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* inebank_banktransfer_getsslcertsubjectaltnames(void* lpObj);

char* inebank_banktransfer_getsslcertthumbprintmd5(void* lpObj);

char* inebank_banktransfer_getsslcertthumbprintsha1(void* lpObj);

char* inebank_banktransfer_getsslcertthumbprintsha256(void* lpObj);

char* inebank_banktransfer_getsslcertusage(void* lpObj);

int inebank_banktransfer_getsslcertusageflags(void* lpObj);

char* inebank_banktransfer_getsslcertversion(void* lpObj);

char* inebank_banktransfer_getsslcertsubject(void* lpObj);
int inebank_banktransfer_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int inebank_banktransfer_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int inebank_banktransfer_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 (BankTransfer 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_banktransfer_getsslprovider(void* lpObj);
int inebank_banktransfer_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 (BankTransfer Class)

The server certificate for the last established connection.

Syntax

InEBankCertificate* GetSSLServerCert();

char* inebank_banktransfer_getsslservercerteffectivedate(void* lpObj);

char* inebank_banktransfer_getsslservercertexpirationdate(void* lpObj);

char* inebank_banktransfer_getsslservercertextendedkeyusage(void* lpObj);

char* inebank_banktransfer_getsslservercertfingerprint(void* lpObj);

char* inebank_banktransfer_getsslservercertfingerprintsha1(void* lpObj);

char* inebank_banktransfer_getsslservercertfingerprintsha256(void* lpObj);

char* inebank_banktransfer_getsslservercertissuer(void* lpObj);

char* inebank_banktransfer_getsslservercertprivatekey(void* lpObj);

int inebank_banktransfer_getsslservercertprivatekeyavailable(void* lpObj);

char* inebank_banktransfer_getsslservercertprivatekeycontainer(void* lpObj);

char* inebank_banktransfer_getsslservercertpublickey(void* lpObj);

char* inebank_banktransfer_getsslservercertpublickeyalgorithm(void* lpObj);

int inebank_banktransfer_getsslservercertpublickeylength(void* lpObj);

char* inebank_banktransfer_getsslservercertserialnumber(void* lpObj);

char* inebank_banktransfer_getsslservercertsignaturealgorithm(void* lpObj);

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

char* inebank_banktransfer_getsslservercertstorepassword(void* lpObj);

int inebank_banktransfer_getsslservercertstoretype(void* lpObj);

char* inebank_banktransfer_getsslservercertsubjectaltnames(void* lpObj);

char* inebank_banktransfer_getsslservercertthumbprintmd5(void* lpObj);

char* inebank_banktransfer_getsslservercertthumbprintsha1(void* lpObj);

char* inebank_banktransfer_getsslservercertthumbprintsha256(void* lpObj);

char* inebank_banktransfer_getsslservercertusage(void* lpObj);

int inebank_banktransfer_getsslservercertusageflags(void* lpObj);

char* inebank_banktransfer_getsslservercertversion(void* lpObj);

char* inebank_banktransfer_getsslservercertsubject(void* lpObj);

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

SyncTransfers Property (BankTransfer Class)

A list of bank transfers being synchronized.

Syntax

InEBankList<InEBankTransferDetail>* GetSyncTransfers();

int inebank_banktransfer_getsynctransfercount(void* lpObj);

char* inebank_banktransfer_getsynctransferaggregate(void* lpObj, int synctransferindex);

char* inebank_banktransfer_getsynctransferamount(void* lpObj, int synctransferindex);

char* inebank_banktransfer_getsynctransferdatedue(void* lpObj, int synctransferindex);

char* inebank_banktransfer_getsynctransferdateposted(void* lpObj, int synctransferindex);

char* inebank_banktransfer_getsynctransferdateprocessed(void* lpObj, int synctransferindex);

char* inebank_banktransfer_getsynctransferdateprojected(void* lpObj, int synctransferindex);

char* inebank_banktransfer_getsynctransferfromaccountid(void* lpObj, int synctransferindex);

char* inebank_banktransfer_getsynctransferid(void* lpObj, int synctransferindex);

char* inebank_banktransfer_getsynctransferstatus(void* lpObj, int synctransferindex);

char* inebank_banktransfer_getsynctransfertoaccountid(void* lpObj, int synctransferindex);

char* inebank_banktransfer_getsynctransfertxtype(void* lpObj, int synctransferindex);

int GetSyncTransferCount();

QString GetSyncTransferAggregate(int iSyncTransferIndex);

QString GetSyncTransferAmount(int iSyncTransferIndex);

QString GetSyncTransferDateDue(int iSyncTransferIndex);

QString GetSyncTransferDatePosted(int iSyncTransferIndex);

QString GetSyncTransferDateProcessed(int iSyncTransferIndex);

QString GetSyncTransferDateProjected(int iSyncTransferIndex);

QString GetSyncTransferFromAccountId(int iSyncTransferIndex);

QString GetSyncTransferId(int iSyncTransferIndex);

QString GetSyncTransferStatus(int iSyncTransferIndex);

QString GetSyncTransferToAccountId(int iSyncTransferIndex);

QString GetSyncTransferTxType(int iSyncTransferIndex);

Remarks

This is populated when the SynchronizeTransfers method has been called. It should be inspected for each SyncTransferIndex = 0 to SyncTransferCount - 1.

Each synchronized bank transfer has a Aggregate, Amount, Id, Status, FromAccountId, ToAccountId, TxType, DateDue, DatePosted, DateProjected, and DateProcessed tied to it.

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

Data Type

InEBankTransferDetail

Timeout Property (BankTransfer 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_banktransfer_gettimeout(void* lpObj);
int inebank_banktransfer_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

Transfer Property (BankTransfer Class)

Identifies the bank transfer to be initiated or modified.

Syntax

InEBankTransferDetail* GetTransfer();
int SetTransfer(InEBankTransferDetail* val);

char* inebank_banktransfer_gettransferamount(void* lpObj);
int inebank_banktransfer_settransferamount(void* lpObj, const char* lpszTransferAmount);

char* inebank_banktransfer_gettransfercurrencycode(void* lpObj);

char* inebank_banktransfer_gettransferdatedue(void* lpObj);
int inebank_banktransfer_settransferdatedue(void* lpObj, const char* lpszTransferDateDue);

char* inebank_banktransfer_gettransferdateposted(void* lpObj);

char* inebank_banktransfer_gettransferdateprocessed(void* lpObj);

char* inebank_banktransfer_gettransferfromaccountid(void* lpObj);
int inebank_banktransfer_settransferfromaccountid(void* lpObj, const char* lpszTransferFromAccountId);

char* inebank_banktransfer_gettransferfromaccountkey(void* lpObj);
int inebank_banktransfer_settransferfromaccountkey(void* lpObj, const char* lpszTransferFromAccountKey);

int inebank_banktransfer_gettransferfromaccounttype(void* lpObj);
int inebank_banktransfer_settransferfromaccounttype(void* lpObj, int iTransferFromAccountType);

char* inebank_banktransfer_gettransferfrombankid(void* lpObj);
int inebank_banktransfer_settransferfrombankid(void* lpObj, const char* lpszTransferFromBankId);

char* inebank_banktransfer_gettransferfrombranchid(void* lpObj);
int inebank_banktransfer_settransferfrombranchid(void* lpObj, const char* lpszTransferFromBranchId);

char* inebank_banktransfer_gettransferid(void* lpObj);
int inebank_banktransfer_settransferid(void* lpObj, const char* lpszTransferId);

char* inebank_banktransfer_gettransferstatus(void* lpObj);

char* inebank_banktransfer_gettransfertoaccountid(void* lpObj);
int inebank_banktransfer_settransfertoaccountid(void* lpObj, const char* lpszTransferToAccountId);

char* inebank_banktransfer_gettransfertoaccountkey(void* lpObj);
int inebank_banktransfer_settransfertoaccountkey(void* lpObj, const char* lpszTransferToAccountKey);

int inebank_banktransfer_gettransfertoaccounttype(void* lpObj);
int inebank_banktransfer_settransfertoaccounttype(void* lpObj, int iTransferToAccountType);

char* inebank_banktransfer_gettransfertobankid(void* lpObj);
int inebank_banktransfer_settransfertobankid(void* lpObj, const char* lpszTransferToBankId);

char* inebank_banktransfer_gettransfertobranchid(void* lpObj);
int inebank_banktransfer_settransfertobranchid(void* lpObj, const char* lpszTransferToBranchId);

QString GetTransferAmount();
int SetTransferAmount(QString qsTransferAmount);

QString GetTransferCurrencyCode();

QString GetTransferDateDue();
int SetTransferDateDue(QString qsTransferDateDue);

QString GetTransferDatePosted();

QString GetTransferDateProcessed();

QString GetTransferFromAccountId();
int SetTransferFromAccountId(QString qsTransferFromAccountId);

QString GetTransferFromAccountKey();
int SetTransferFromAccountKey(QString qsTransferFromAccountKey);

int GetTransferFromAccountType();
int SetTransferFromAccountType(int iTransferFromAccountType);

QString GetTransferFromBankId();
int SetTransferFromBankId(QString qsTransferFromBankId);

QString GetTransferFromBranchId();
int SetTransferFromBranchId(QString qsTransferFromBranchId);

QString GetTransferId();
int SetTransferId(QString qsTransferId);

QString GetTransferStatus();

QString GetTransferToAccountId();
int SetTransferToAccountId(QString qsTransferToAccountId);

QString GetTransferToAccountKey();
int SetTransferToAccountKey(QString qsTransferToAccountKey);

int GetTransferToAccountType();
int SetTransferToAccountType(int iTransferToAccountType);

QString GetTransferToBankId();
int SetTransferToBankId(QString qsTransferToBankId);

QString GetTransferToBranchId();
int SetTransferToBranchId(QString qsTransferToBranchId);

Remarks

This property is required to be provided when either TransferFunds or ModifyTransfer methods are called.

The following fields can be set:


FromBankId	(required)
FromBranchId	(applicable to international FIs only)
FromAccountId	(required)
FromAccountType	(required)
FromAccountKey	(applicable to international FIs only)
ToBankId	(required for interbank transfers only)
ToBranchId	(applicable to international FIs only)
ToAccountId	(optional)
ToAccountType	(optional)
ToAccountKey	(applicable to international FIs only)
Amount	(required)
DateDue	(applicable to scheduled transfers only)

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

This property is not available at design time.

Data Type

InEBankTransferDetail

CancelTransfer Method (BankTransfer Class)

Cancels a scheduled transfer.

Syntax

ANSI (Cross Platform)
int CancelTransfer(const char* lpszTransferId);

Unicode (Windows)
INT CancelTransfer(LPCWSTR lpszTransferId);

int inebank_banktransfer_canceltransfer(void* lpObj, const char* lpszTransferId);

int CancelTransfer(const QString& qsTransferId);

Remarks

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

The TransferId parameter identifies the transfer to be canceled. This is the id assigned and returned by the server at the time the transfer 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)
OFXVersion	(required if 2.x OFX version is the one supported by your FI)
OFXUser	(required)
OFXPassword	(required)

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

Error Handling (C++)

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

Config Method (BankTransfer Class)

Sets or retrieves a configuration setting.

Syntax

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

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

ModifyTransfer Method (BankTransfer Class)

Modifies a scheduled transfer.

Syntax

ANSI (Cross Platform)
int ModifyTransfer(const char* lpszTransferId);

Unicode (Windows)
INT ModifyTransfer(LPCWSTR lpszTransferId);

int inebank_banktransfer_modifytransfer(void* lpObj, const char* lpszTransferId);

int ModifyTransfer(const QString& qsTransferId);

Remarks

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

Only scheduled transfers can be modified, not the immediate ones.

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

When modifying a scheduled transfer by calling the ModifyTransfer method, the user should provide all the fields for source and destination account that were specified when the transfer was initiated (when the TransferFunds method was called), and not just the fields that are to be modified).

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


FIUrl	(required)
FIId	(required)
FIOrganization	(required)
OFXAppId	(required)
OFXAppVersion	(required)
OFXVersion	(required if 2.x OFX version is the one supported by your FI)
OFXUser	(required)
OFXPassword	(required)
Transfer	(required)

The response normally just echoes the values passed in the request. However, if the status of a scheduled transfer changes in any way, the user should expect to receive modification responses when they synchronize with the server. For example, when a server completes a transfer, the status of the transfer 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 (transfer modification).

Error Handling (C++)

Reset Method (BankTransfer 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_banktransfer_reset(void* lpObj);

int Reset();

Remarks

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

Error Handling (C++)

SynchronizeTransfers Method (BankTransfer Class)

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

Syntax

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

Unicode (Windows)
LPWSTR SynchronizeTransfers(LPCWSTR lpszToken);

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

QString SynchronizeTransfers(const QString& qsToken);

Remarks

The transfer synchronization request is applicable for bank accounts only and not for the credit card accounts.

This method can be called when a list of recent server responses is needed whether due to requests submitted by multiple clients or other status changes on the server.

Clients can also choose to perform an explicit synchronization before sending any transfer requests (when TransferFunds, ModifyTransfer or CancelTransfer methods are called). This practice allows clients to be up-to-date and possibly interact with the user before sending any new requests.

If this explicit synchronization 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. The response includes responses more recent than the given token, along with a new token returned by this method.

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 transfers for the specified account.

If a client connection fails, or a client receives a response, but crashes before updating its records, the client will not be able to save the new endpoint. On the next synchronization request, the server sends the same information (plus any further status changes). If a user switches to a backup file, again the client will use the older endpoint in the synchronization request. If multiple clients are in use, each will send requests based on its own endpoint, so that both clients will obtain complete information from the server.

A brand new client, or a client that lost synchronization, might want to learn about in-progress transfers by submitting a synchronization refresh of the transfer 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 transfer models, because these often live for months or years.

A client can request a refresh of current state by calling the SynchronizeTransfers where Token parameter is set to REFRESH (not case sensitive). The response will reflect the current state. For example, if you schedule a transfer 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.

Please note that the servers will not have infinite history available. If the token in the synchronization request was older than the earliest available history, then the LostSync property value returned is True. This allows clients to alert users that some responses have been lost.

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 a list of bank transfers, then the SyncTransfers will be populated and SyncTransfers event will be fired for each transfer transaction. A single transfer 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++)

TransferFunds Method (BankTransfer Class)

Transfers money from one account to another within the same or different Financial Institution(s).

Syntax

ANSI (Cross Platform)
int TransferFunds();

Unicode (Windows)
INT TransferFunds();

int inebank_banktransfer_transferfunds(void* lpObj);

int TransferFunds();

Remarks

This function generates the Signon and Intrabank or Interbank Transfer request page, submits it to the financial institution via secure HTTP Post, 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)
OFXVersion	(required if 2.x OFX version is the one supported by your FI)
OFXUser	(required)
OFXPassword	(required)
Transfer	(required)

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


Id
CurrencyCode
DatePosted or DateProjected	(not both)
Status
DateProcessed

In all cases, a server cannot provide complete confirmation for the transfer. The server can only confirm that it received the transfer instruction; and possibly whether it validated the accounts, amount, and date specified in the transfer. For any transfer where the client does not know the status at the time of the response, a server should confirm that it accepted the instruction by assigning a Id and indicate the DateProjected if the DatePosted is not available. A client can pick up the confirmation at a later date through a synchronization request by calling the SynchronizeTransfers method.

The interbank funds transfers differ from intrabank funds transfers in the following respects:

The routing and transit number of the destination account differs from the source account. That means that the FromBankId and ToBankId should both be set (if the account type is different than CreditCard).
At the discretion of an FI, the destination account (identified by ToAccountId) can be subject to pre-notification.
Source and destination accounts must be enabled for the Automated Clearing House (ACH).

The Interbank Funds Transfer is subject to the rules and regulations governing the ACH network. In all other respects, interbank funds transfers function like intrabank funds transfers.

Error Handling (C++)

ConnectionStatus Event (BankTransfer Class)

Fired to indicate changes in the connection state.

Syntax

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

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


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

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

#define EID_BANKTRANSFER_CONNECTIONSTATUS 1

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

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

// Or, subclass BankTransfer and override this emitter function.
virtual int FireConnectionStatus(BankTransferConnectionStatusEventParams *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 (BankTransfer Class)

Fired when information is available about errors during data delivery.

Syntax

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

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


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

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

#define EID_BANKTRANSFER_ERROR 2

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

class BankTransferErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass BankTransfer and override this emitter function.
virtual int FireError(BankTransferErrorEventParams *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 (BankTransfer Class)

Fired after the server presents its certificate to the client.

Syntax

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

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


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

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

#define EID_BANKTRANSFER_SSLSERVERAUTHENTICATION 3

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

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

// Or, subclass BankTransfer and override this emitter function.
virtual int FireSSLServerAuthentication(BankTransferSSLServerAuthenticationEventParams *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 (BankTransfer Class)

Fired when secure connection progress messages are available.

Syntax

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

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


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

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

#define EID_BANKTRANSFER_SSLSTATUS 4

virtual INT INEBANK_CALL FireSSLStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

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

SyncTransfers Event (BankTransfer Class)

Fired for each intrabank transfer transaction included in the synchronization response.

Syntax

ANSI (Cross Platform)
virtual int FireSyncTransfers(BankTransferSyncTransfersEventParams *e);

typedef struct {
  const char *TransferAggregate;
  const char *TransferTxType;
  const char *TransferId;
  const char *TransferAmount;
  const char *FromAccountId;
  const char *ToAccountId;
  const char *TransferStatus;
  const char *TransferDatePosted;
  int reserved;
} BankTransferSyncTransfersEventParams;


Unicode (Windows)
virtual INT FireSyncTransfers(BankTransferSyncTransfersEventParams *e);

typedef struct {
  LPCWSTR TransferAggregate;
  LPCWSTR TransferTxType;
  LPCWSTR TransferId;
  LPCWSTR TransferAmount;
  LPCWSTR FromAccountId;
  LPCWSTR ToAccountId;
  LPCWSTR TransferStatus;
  LPCWSTR TransferDatePosted;
  INT reserved;
} BankTransferSyncTransfersEventParams;

#define EID_BANKTRANSFER_SYNCTRANSFERS 5

virtual INT INEBANK_CALL FireSyncTransfers(LPSTR &lpszTransferAggregate, LPSTR &lpszTransferTxType, LPSTR &lpszTransferId, LPSTR &lpszTransferAmount, LPSTR &lpszFromAccountId, LPSTR &lpszToAccountId, LPSTR &lpszTransferStatus, LPSTR &lpszTransferDatePosted);

class BankTransferSyncTransfersEventParams {
public:
  const QString &TransferAggregate();

  const QString &TransferTxType();

  const QString &TransferId();

  const QString &TransferAmount();

  const QString &FromAccountId();

  const QString &ToAccountId();

  const QString &TransferStatus();

  const QString &TransferDatePosted();

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

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

// Or, subclass BankTransfer and override this emitter function.
virtual int FireSyncTransfers(BankTransferSyncTransfersEventParams *e) {...}

Remarks

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

TransferAggregate contains the aggregate for a transfer transaction.
TransferTx indicates the transfer transaction type, if this is a new, modified or canceled one (possible values: ADD, MOD, CAN).
TransferId contains the server id of a transaction in the list of transfers (if any) returned in the synchronization response.
TransferAmount contains the amount of a transfer transaction.
FromAccountId contains the account number a transfer has been sent from.
ToAccountId contains the account number a transfer has been sent to.
TransferStatus contains the status of a transfer transaction.
TransferDatePosted contains the actual date of a transfer transaction.

If what you need is not returned through this event, you can always parse each TransferAggregate 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()

TransferDetail Type

This type corresponds to a single bank transfer.

Syntax

InEBankTransferDetail (declared in inebank.h)

Remarks

TransferDetail objects are used when initiating or modifying a bank transfer, or synchronizing the bank transfers (when the corresponding methods: TransferFunds, ModifyTransfer, and SynchronizeTransfers are called).

The following fields are available:

Fields

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

Wrapper for a bank transfer being initiated, modified or synchronized.

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.

Amount
char*
Default Value: ""

Amount of the bank transfer being initiated, modified or synchronized.

This is required to be provided when initiating or modifying a transfer (i.e., when either TransferFunds or ModifyTransfer methods are called),

It is returned in the server response for each payment being synchronized (when the SynchronizeTransfers method is called).

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.

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

Default currency code for this transaction.

Indicates how to interpret the monetary transferred amount. Expressed as a special character, such as $.

DateDue
char*
Default Value: ""

Date the bank transfer (being initiated, modified or synchronized) is scheduled to be sent.

This can be provided when sending a bank transfer request (initiating or modifying a transfer when either TransferFunds or ModifyTransfer methods are called. In these cases, if the DateDue is not specified in the request, the transfer is considered immediate by the server and it occurs as soon as possible. However, this is required for scheduled transfers.

This is also returned in the server response when these methods are called. However, the value may have been adjusted by the server. For example, the server may adjust due date to comply with non-processing days. If a client sends a request to make a transfer on July 4 and July 4 happens to be a non-processing day, the due date in the response may be July 4 (because the server hasn't adjusted it yet), July 5 (because this server rolls dates forward), or some other date. For this reason, the DateDue should be inspected as well.

It may also be returned for each payment being synchronized (when the SynchronizeTransfers methods is called) only if it was specified in the original bank transfer request. These values should be inspected as well as might be different from their original values (for the same reason mentioned above).

Note: Immediate intrabank funds transfers cannot be canceled as they are already committed.

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.

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

Posted date of the bank transfer being initiated, modified or synchronized.

This is the date the transfer actually happens (or happened). This is optional. Server response can contain either a DateProjected or a DatePosted but not both.

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

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

Transfer processing date.

The interpretation of this value depends on Status. This is date on which processing status last changed.

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

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

Projected date of the transfer.

This string gives the date the transfer is expected to take place. This is optional to be returned in the server response. Server response can contain either DateProjected or DatePosted, but not both.

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

FromAccountId
char*
Default Value: ""

Account number where the transfer (being initiated, modified or synchronized) is originating from.

This is required to be provided when initiating or modifying a transfer (i.e., when TransferFunds or ModifyTransfer methods are called).

It is returned in the server response for each transfer being synchronized (when the SynchronizeTransfers method is called).

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

FromAccountKey
char*
Default Value: ""

Checksum for the bank where money has to be withdrawn (international banks only).

This is optional to be provided when initiating or modifying a bank transfer (i.e., when TransferFunds or ModifyTransfer methods are called).

The FromAccountKey is applicable for international banks only.

FromAccountType
int
Default Value: 0

Type of account where the transfer is originating from.

This is required to be provided when initiating or modifying a transfer (i.e., when TransferFunds or ModifyTransfer methods are called). If FromAccountType and ToAccountType are set to CreditCard, then the FromBankId and ToBankId are not required to be provided in the request.

This field uses the following values:

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

FromBankId
char*
Default Value: ""

Number that identifies the bank where the transfer is originating from.

When initiating or modifying a transfer (i.e., when TransferFunds or ModifyTransfer methods are called), and FromAccountType is set to a value different than CreditCard, the FromBankId is required to be provided in the request. Otherwise, it should not be set.

In intrabank transfers requests (transferring funds between two accounts at the same financial institution), the FromBankId represents the source and destination FI (in this case, this is the same as ToBankId and ToBankId should not be set).

FromBranchId
char*
Default Value: ""

Identifier for the bank where the transfer is originating from (international banks only).

This is optional to be provided when initiating or modifying a transfer (i.e., when TransferFunds or ModifyTransfer methods are called).

The FromBranchId is applicable for international banks only, and if this applies, it can be provided in the request only if FromAccountType is set to a value different than CreditCard. Otherwise, it should not be set.

Id
char*
Default Value: ""

Server-assigned id of the bank transfer being initiated, modified or synchronized.

The Id uniquely identifies a transfer. This is assigned by the server when the transfer is initiated (when the TransferFunds method is called.

As a unique transfer identifier, the Id is required to be provided (as parameter) when a transfer modification or cancellation requests are submitted (i.e., when ModifyTransfer or CancelTransfer methods are called) for a scheduled transfer.

This is also required to be provided when submitting the same request types via the OFXBatch class (for each transfer that is going to be part of the batch).

It is also returned for each payment being synchronized when the SynchronizeTransfers method is called.

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

Processing status code of the bank transfer being initiated, modified, canceled or synchronized.

This is returned in the server response when the TransferFunds, ModifyTransfer, CancelTransfer and SynchronizeTransfers methods are called.

If the server provides this information, the possible values are:


Value	Description
WILLPROCESSON	Transfer will be processed on DateProcessed
POSTEDON	Transfer was posted on DateProcessed
NOFUNDSON	There were insufficient funds to make transfer on DateProcessed
CANCELEDON	Transfer request was cancelled by the user
FAILEDON	Unable to make transfer for unspecified reasons on DateProcessed

ToAccountId
char*
Default Value: ""

Account number where the bank transfer ((being initiated, modified or synchronized) is made to.

This is required to be provided when initiating or modifying a transfer (i.e., when TransferFunds or ModifyTransfer methods are called).

It is returned in the server response for each transfer being synchronized (when the SynchronizeTransfers method is called).

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

ToAccountKey
char*
Default Value: ""

Checksum for the bank where money has to be deposited to (international banks only).

This is optional to be provided when initiating or modifying a bank transfer (i.e., when TransferFunds or ModifyTransfer methods are called).

The ToAccountKey is applicable for international banks only.

ToAccountType
int
Default Value: 0

Type of account where money has to be deposited to.

This is required to be provided when initiating or modifying a bank transfer (i.e., when TransferFunds or ModifyTransfer methods are called). If FromAccountType and ToAccountType are set to CreditCard, then the FromBankId and ToBankId are not required to be provided in the request.

This field uses the following values:

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

ToBankId
char*
Default Value: ""

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

This is the bank id where the destination account is located. When initiating or modifying an interbank transfer (i.e., transferring funds between two accounts at different FIs) and ToAccountType is set to a value different than CreditCard, the ToBankId is required to be provided in the request. Otherwise, it should not be set.

ToBranchId
char*
Default Value: ""

Identifier for the bank where money has to be deposited to (international banks only).

This is optional to be provided when initiating or modifying a transfer (i.e., when TransferFunds or ModifyTransfer methods are called).

The ToBranchId is applicable for international banks only and if this applies, it can be provided in the request only if ToAccountType is set to a value different than CreditCard. Otherwise, it should not be set.

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

Transaction type of the bank transfer being synchronized.

Possible values and their meanings are as follows:


ADDED	If the bank transfer being synchronized was a new transaction.
MODIFIED	If the bank transfer being synchronized was a modify transaction.
CANCELED	If the bank transfer being synchronized was a cancel transaction.

Constructors

TransferDetail()

TransferDetail(const char* lpszFromBankId, const char* lpszFromBranchId, const char* lpszFromAccountId, int iFromAccountType, const char* lpszFromAccountKey, const char* lpszToBankId, const char* lpszToBranchId, const char* lpszToAccountId, int iToAccountType, const char* lpszToAccountKey, const char* lpszAmount, const char* lpszDateDue)

TransferDetail(const char* lpszFromBankId, const char* lpszFromBranchId, const char* lpszFromAccountId, int iFromAccountType, const char* lpszFromAccountKey, const char* lpszToBankId, const char* lpszToBranchId, const char* lpszToAccountId, int iToAccountType, const char* lpszToAccountKey, const char* lpszAmount)

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

TransferDetail(const char* lpszId, const char* lpszFromBankId, const char* lpszFromAccountId, int iFromAccountType, const char* lpszToAccountId, int iToAccountType, const char* lpszAmount, const char* lpszDateDue)

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

TransferDetail(const char* lpszFromBankId, const char* lpszFromAccountId, int iFromAccountType, const char* lpszToAccountId, int iToAccountType, const char* lpszAmount, const char* lpszDateDue)

TransferDetail(const char* lpszFromBankId, const char* lpszFromAccountId, int iFromAccountType, const char* lpszToBankId, const char* lpszToAccountId, int iToAccountType, const char* lpszAmount)

TransferDetail(const char* lpszFromBankId, const char* lpszFromAccountId, int iFromAccountType, const char* lpszToAccountId, int iToAccountType, const char* lpszAmount)

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

TransferDetail(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 BankTransfer 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 (BankTransfer 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.

BankTransfer Config Settings

BatchTransferType: Transfer request type when an intrabank or interbank transfer is part of a multiple request (batch).

This configuration is used and required only when intrabank or interbank transfers are part of a batch request (transactions will be submitted via the OFXBatch class through a single connection).

Possible values, their meanings and usage are as follows:


Value	Meaning
0 (default value)	None - a bank transfer request is not part of the batch;
1	an intrabank or interbank transfer is part of the batch (equivalent to the TransferFunds method);
2	an intrabank or interbank transfer modification is part of the batch (equivalent to the ModifyTransfer method);
3	an intrabank or interbank transfer cancellation is part of the batch (equivalent to the CancelTransfer method);

When a bank transfer is present in a batch request, the same rules apply for all fields settings as when the equivalent method is called.

Note: Synchronization can not be part of a multiple request. The client has to submit such request as a single request (by calling the SynchronizeTransfers method in the BankTransfer class).

TransferType: Transfer request type for a specified transaction.

This setting is used to configure the transaction type (automatic, intrabank, or interbank) for a specific transaction.

The appropriate values are as follows:


Value	Meaning
0 (default value)	Automatic - selects the transfer type based on the FromBankId and ToBankId.
1	Intrabank - sends the transaction as an INTRATRNRQ.
2	Interbank - sends the transaction as an INTERTRNRQ.

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.