BankTransfer Control

Properties   Methods   Events   Config Settings   Errors  

The BankTransfer control is a single control 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 control 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.

• source account you wish to transfer the funds from, by setting TransferFromBankId, TransferFromAccountId, TransferFromAccountType, and for international banks also TransferFromBranchId and TransferFromAccountKey properties;
• destination account where the funds will be deposited to, by setting TransferToBankId (if requesting interbank transfer), TransferToAccountId, TransferToAccountType, and for international banks also TransferToBranchId and TransferToAccountKey;
• transfer amount by setting TransferAmount to the desired value;
• transfer date by setting TransferDateDue (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 TransferId. In this case, it should also indicate the expected posting date of the transfer stored in TransferDatePosted.

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 TransferDatePosted. In this case, synchronization is not required.

Property List

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

Method List

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

Event List

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

Config Settings

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

FIId Property (BankTransfer Control)

Financial institution identifier.

Syntax

banktransfercontrol.FIId[=string]

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

Financial institution organization name.

Syntax

banktransfercontrol.FIOrganization[=string]

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

FirewallAutoDetect Property (BankTransfer Control)

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

Syntax

banktransfercontrol.FirewallAutoDetect[=boolean]

Default Value

False

Remarks

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

Data Type

Boolean

FirewallType Property (BankTransfer Control)

The type of firewall to connect through.

Syntax

banktransfercontrol.FirewallType[=integer]

Possible Values

fwNone(0), 
fwTunnel(1), 
fwSOCKS4(2), 
fwSOCKS5(3), 
fwSOCKS4A(10)

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (BankTransfer Control)

The name or IP address of the firewall (optional).

Syntax

banktransfercontrol.FirewallHost[=string]

Default Value

""

Remarks

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

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

Data Type

String

FirewallPassword Property (BankTransfer Control)

A password if authentication is to be used when connecting through the firewall.

Syntax

banktransfercontrol.FirewallPassword[=string]

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.

Data Type

String

FirewallPort Property (BankTransfer Control)

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

banktransfercontrol.FirewallPort[=integer]

Default Value

0

Remarks

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

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

Data Type

Integer

FirewallUser Property (BankTransfer Control)

A username if authentication is to be used when connecting through a firewall.

Syntax

banktransfercontrol.FirewallUser[=string]

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the control fails with an error.

Data Type

String

FIUrl Property (BankTransfer Control)

Financial institution URL.

Syntax

banktransfercontrol.FIUrl[=string]

Default Value

""

Remarks

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

Data Type

String

LostSync Property (BankTransfer Control)

Whether the token in the synchronization request is older.

Syntax

banktransfercontrol.LostSync

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

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

Syntax

banktransfercontrol.OFXAccessKey[=string]

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 control 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 control 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 control). This allows the server to determine the lifetime of the OFXAccessKey.

Data Type

String

OFXAppId Property (BankTransfer Control)

OFX application identifier.

Syntax

banktransfercontrol.OFXAppId[=string]

Default Value

""

Remarks

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

Data Type

String

OFXAppVersion Property (BankTransfer Control)

OFX application version.

Syntax

banktransfercontrol.OFXAppVersion[=string]

Default Value

""

Remarks

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

Data Type

String

OFXPassword Property (BankTransfer Control)

User's password.

Syntax

banktransfercontrol.OFXPassword[=string]

Default Value

""

Remarks

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

Data Type

String

OFXRequest Property (BankTransfer Control)

The current OFX request aggregate.

Syntax

banktransfercontrol.OFXRequest

Default Value

""

Remarks

Polling OFXRequest will cause the control 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 Control)

The current OFX response aggregate.

Syntax

banktransfercontrol.OFXResponse[=string]

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

User's id.

Syntax

banktransfercontrol.OFXUser[=string]

Default Value

""

Remarks

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

Data Type

String

OFXVersion Property (BankTransfer Control)

OFX API version.

Syntax

banktransfercontrol.OFXVersion[=string]

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

SSLAcceptServerCertEffectiveDate Property (BankTransfer Control)

The date on which this certificate becomes valid.

Syntax

banktransfercontrol.SSLAcceptServerCertEffectiveDate

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (BankTransfer Control)

The date on which the certificate expires.

Syntax

banktransfercontrol.SSLAcceptServerCertExpirationDate

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (BankTransfer Control)

A comma-delimited list of extended key usage identifiers.

Syntax

banktransfercontrol.SSLAcceptServerCertExtendedKeyUsage

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (BankTransfer Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

banktransfercontrol.SSLAcceptServerCertFingerprint

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (BankTransfer Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

banktransfercontrol.SSLAcceptServerCertFingerprintSHA1

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (BankTransfer Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

banktransfercontrol.SSLAcceptServerCertFingerprintSHA256

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (BankTransfer Control)

The issuer of the certificate.

Syntax

banktransfercontrol.SSLAcceptServerCertIssuer

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (BankTransfer Control)

The private key of the certificate (if available).

Syntax

banktransfercontrol.SSLAcceptServerCertPrivateKey

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (BankTransfer Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

banktransfercontrol.SSLAcceptServerCertPrivateKeyAvailable

Default Value

False

Remarks

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

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (BankTransfer Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

banktransfercontrol.SSLAcceptServerCertPrivateKeyContainer

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (BankTransfer Control)

The public key of the certificate.

Syntax

banktransfercontrol.SSLAcceptServerCertPublicKey

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (BankTransfer Control)

The textual description of the certificate's public key algorithm.

Syntax

banktransfercontrol.SSLAcceptServerCertPublicKeyAlgorithm

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (BankTransfer Control)

The length of the certificate's public key (in bits).

Syntax

banktransfercontrol.SSLAcceptServerCertPublicKeyLength

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (BankTransfer Control)

The serial number of the certificate encoded as a string.

Syntax

banktransfercontrol.SSLAcceptServerCertSerialNumber

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (BankTransfer Control)

The text description of the certificate's signature algorithm.

Syntax

banktransfercontrol.SSLAcceptServerCertSignatureAlgorithm

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (BankTransfer Control)

The name of the certificate store for the client certificate.

Syntax

banktransfercontrol.SSLAcceptServerCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertStoreB.

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (BankTransfer Control)

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

Syntax

banktransfercontrol.SSLAcceptServerCertStorePassword[=string]

Default Value

""

Remarks

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

Data Type

String

SSLAcceptServerCertStoreType Property (BankTransfer Control)

The type of certificate store for this certificate.

Syntax

banktransfercontrol.SSLAcceptServerCertStoreType[=integer]

Possible Values

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

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (BankTransfer Control)

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

Syntax

banktransfercontrol.SSLAcceptServerCertSubjectAltNames

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (BankTransfer Control)

The MD5 hash of the certificate.

Syntax

banktransfercontrol.SSLAcceptServerCertThumbprintMD5

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (BankTransfer Control)

The SHA-1 hash of the certificate.

Syntax

banktransfercontrol.SSLAcceptServerCertThumbprintSHA1

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (BankTransfer Control)

The SHA-256 hash of the certificate.

Syntax

banktransfercontrol.SSLAcceptServerCertThumbprintSHA256

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (BankTransfer Control)

The text description of UsageFlags .

Syntax

banktransfercontrol.SSLAcceptServerCertUsage

Default Value

""

Remarks

The text description of SSLAcceptServerCertUsageFlags.

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (BankTransfer Control)

The flags that show intended use for the certificate.

Syntax

banktransfercontrol.SSLAcceptServerCertUsageFlags

Default Value

0

Remarks

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

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (BankTransfer Control)

The certificate's version number.

Syntax

banktransfercontrol.SSLAcceptServerCertVersion

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (BankTransfer Control)

The subject of the certificate used for client authentication.

Syntax

banktransfercontrol.SSLAcceptServerCertSubject[=string]

Default Value

""

Remarks

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 property is set to the full subject of the matching certificate.

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

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

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

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

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

Data Type

String

SSLAcceptServerCertEncoded Property (BankTransfer Control)

The certificate (PEM/Base64 encoded).

Syntax

banktransfercontrol.SSLAcceptServerCertEncoded[=string]

Default Value

""

Remarks

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (BankTransfer Control)

The date on which this certificate becomes valid.

Syntax

banktransfercontrol.SSLCertEffectiveDate

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (BankTransfer Control)

The date on which the certificate expires.

Syntax

banktransfercontrol.SSLCertExpirationDate

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (BankTransfer Control)

A comma-delimited list of extended key usage identifiers.

Syntax

banktransfercontrol.SSLCertExtendedKeyUsage

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertFingerprint Property (BankTransfer Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

banktransfercontrol.SSLCertFingerprint

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (BankTransfer Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

banktransfercontrol.SSLCertFingerprintSHA1

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (BankTransfer Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

banktransfercontrol.SSLCertFingerprintSHA256

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertIssuer Property (BankTransfer Control)

The issuer of the certificate.

Syntax

banktransfercontrol.SSLCertIssuer

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (BankTransfer Control)

The private key of the certificate (if available).

Syntax

banktransfercontrol.SSLCertPrivateKey

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (BankTransfer Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

banktransfercontrol.SSLCertPrivateKeyAvailable

Default Value

False

Remarks

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

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (BankTransfer Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

banktransfercontrol.SSLCertPrivateKeyContainer

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKey Property (BankTransfer Control)

The public key of the certificate.

Syntax

banktransfercontrol.SSLCertPublicKey

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (BankTransfer Control)

The textual description of the certificate's public key algorithm.

Syntax

banktransfercontrol.SSLCertPublicKeyAlgorithm

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (BankTransfer Control)

The length of the certificate's public key (in bits).

Syntax

banktransfercontrol.SSLCertPublicKeyLength

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (BankTransfer Control)

The serial number of the certificate encoded as a string.

Syntax

banktransfercontrol.SSLCertSerialNumber

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (BankTransfer Control)

The text description of the certificate's signature algorithm.

Syntax

banktransfercontrol.SSLCertSignatureAlgorithm

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertStore Property (BankTransfer Control)

The name of the certificate store for the client certificate.

Syntax

banktransfercontrol.SSLCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (BankTransfer Control)

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

Syntax

banktransfercontrol.SSLCertStorePassword[=string]

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (BankTransfer Control)

The type of certificate store for this certificate.

Syntax

banktransfercontrol.SSLCertStoreType[=integer]

Possible Values

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

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubjectAltNames Property (BankTransfer Control)

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

Syntax

banktransfercontrol.SSLCertSubjectAltNames

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (BankTransfer Control)

The MD5 hash of the certificate.

Syntax

banktransfercontrol.SSLCertThumbprintMD5

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (BankTransfer Control)

The SHA-1 hash of the certificate.

Syntax

banktransfercontrol.SSLCertThumbprintSHA1

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (BankTransfer Control)

The SHA-256 hash of the certificate.

Syntax

banktransfercontrol.SSLCertThumbprintSHA256

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertUsage Property (BankTransfer Control)

The text description of UsageFlags .

Syntax

banktransfercontrol.SSLCertUsage

Default Value

""

Remarks

The text description of SSLCertUsageFlags.

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.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (BankTransfer Control)

The flags that show intended use for the certificate.

Syntax

banktransfercontrol.SSLCertUsageFlags

Default Value

0

Remarks

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

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLCertVersion Property (BankTransfer Control)

The certificate's version number.

Syntax

banktransfercontrol.SSLCertVersion

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertSubject Property (BankTransfer Control)

The subject of the certificate used for client authentication.

Syntax

banktransfercontrol.SSLCertSubject[=string]

Default Value

""

Remarks

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 property is set to the full subject of the matching certificate.

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

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

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

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

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

Data Type

String

SSLCertEncoded Property (BankTransfer Control)

The certificate (PEM/Base64 encoded).

Syntax

banktransfercontrol.SSLCertEncoded[=string]

Default Value

""

Remarks

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (BankTransfer Control)

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

Syntax

banktransfercontrol.SSLProvider[=integer]

Possible Values

sslpAutomatic(0), 
sslpPlatform(1), 
sslpInternal(2)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the control 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:

In most cases using the default value (Automatic) is recommended. The control will select a provider depending on the current platform.

When Automatic is selected, the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used.

Data Type

Integer

SSLServerCertEffectiveDate Property (BankTransfer Control)

The date on which this certificate becomes valid.

Syntax

banktransfercontrol.SSLServerCertEffectiveDate

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (BankTransfer Control)

The date on which the certificate expires.

Syntax

banktransfercontrol.SSLServerCertExpirationDate

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (BankTransfer Control)

A comma-delimited list of extended key usage identifiers.

Syntax

banktransfercontrol.SSLServerCertExtendedKeyUsage

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (BankTransfer Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

banktransfercontrol.SSLServerCertFingerprint

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (BankTransfer Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

banktransfercontrol.SSLServerCertFingerprintSHA1

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (BankTransfer Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

banktransfercontrol.SSLServerCertFingerprintSHA256

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (BankTransfer Control)

The issuer of the certificate.

Syntax

banktransfercontrol.SSLServerCertIssuer

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (BankTransfer Control)

The private key of the certificate (if available).

Syntax

banktransfercontrol.SSLServerCertPrivateKey

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (BankTransfer Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

banktransfercontrol.SSLServerCertPrivateKeyAvailable

Default Value

False

Remarks

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

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (BankTransfer Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

banktransfercontrol.SSLServerCertPrivateKeyContainer

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (BankTransfer Control)

The public key of the certificate.

Syntax

banktransfercontrol.SSLServerCertPublicKey

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (BankTransfer Control)

The textual description of the certificate's public key algorithm.

Syntax

banktransfercontrol.SSLServerCertPublicKeyAlgorithm

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (BankTransfer Control)

The length of the certificate's public key (in bits).

Syntax

banktransfercontrol.SSLServerCertPublicKeyLength

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (BankTransfer Control)

The serial number of the certificate encoded as a string.

Syntax

banktransfercontrol.SSLServerCertSerialNumber

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (BankTransfer Control)

The text description of the certificate's signature algorithm.

Syntax

banktransfercontrol.SSLServerCertSignatureAlgorithm

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertStore Property (BankTransfer Control)

The name of the certificate store for the client certificate.

Syntax

banktransfercontrol.SSLServerCertStore

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertStoreB.

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (BankTransfer Control)

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

Syntax

banktransfercontrol.SSLServerCertStorePassword

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (BankTransfer Control)

The type of certificate store for this certificate.

Syntax

banktransfercontrol.SSLServerCertStoreType

Possible Values

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

Default Value

0

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (BankTransfer Control)

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

Syntax

banktransfercontrol.SSLServerCertSubjectAltNames

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (BankTransfer Control)

The MD5 hash of the certificate.

Syntax

banktransfercontrol.SSLServerCertThumbprintMD5

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (BankTransfer Control)

The SHA-1 hash of the certificate.

Syntax

banktransfercontrol.SSLServerCertThumbprintSHA1

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (BankTransfer Control)

The SHA-256 hash of the certificate.

Syntax

banktransfercontrol.SSLServerCertThumbprintSHA256

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (BankTransfer Control)

The text description of UsageFlags .

Syntax

banktransfercontrol.SSLServerCertUsage

Default Value

""

Remarks

The text description of SSLServerCertUsageFlags.

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.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (BankTransfer Control)

The flags that show intended use for the certificate.

Syntax

banktransfercontrol.SSLServerCertUsageFlags

Default Value

0

Remarks

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

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (BankTransfer Control)

The certificate's version number.

Syntax

banktransfercontrol.SSLServerCertVersion

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertSubject Property (BankTransfer Control)

The subject of the certificate used for client authentication.

Syntax

banktransfercontrol.SSLServerCertSubject

Default Value

""

Remarks

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 property is set to the full subject of the matching certificate.

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

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

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

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

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

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (BankTransfer Control)

The certificate (PEM/Base64 encoded).

Syntax

banktransfercontrol.SSLServerCertEncoded

Default Value

""

Remarks

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.

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

Data Type

Binary String

SyncTransferCount Property (BankTransfer Control)

The number of records in the SyncTransfer arrays.

Syntax

banktransfercontrol.SyncTransferCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• SyncTransferAggregate
• SyncTransferAmount
• SyncTransferDateDue
• SyncTransferDatePosted
• SyncTransferDateProcessed
• SyncTransferDateProjected
• SyncTransferFromAccountId
• SyncTransferId
• SyncTransferStatus
• SyncTransferToAccountId
• SyncTransferTxType

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

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

Data Type

Integer

SyncTransferAggregate Property (BankTransfer Control)

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

Syntax

banktransfercontrol.SyncTransferAggregate(SyncTransferIndex)

Default Value

""

Remarks

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 control's properties. However, some of these elements, and/or their potential values, may not be supported by the control. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate control 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 control 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.

The SyncTransferIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncTransferCount property.

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

Data Type

String

SyncTransferAmount Property (BankTransfer Control)

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

Syntax

banktransfercontrol.SyncTransferAmount(SyncTransferIndex)

Default Value

""

Remarks

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

The SyncTransferIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncTransferCount property.

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

Data Type

String

SyncTransferDateDue Property (BankTransfer Control)

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

Syntax

banktransfercontrol.SyncTransferDateDue(SyncTransferIndex)

Default Value

""

Remarks

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

The SyncTransferIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncTransferCount property.

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

Data Type

String

SyncTransferDatePosted Property (BankTransfer Control)

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

Syntax

banktransfercontrol.SyncTransferDatePosted(SyncTransferIndex)

Default Value

""

Remarks

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 SyncTransferDateProjected or a SyncTransferDatePosted but not both.

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.

The SyncTransferIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncTransferCount property.

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

Data Type

String

SyncTransferDateProcessed Property (BankTransfer Control)

Transfer processing date.

Syntax

banktransfercontrol.SyncTransferDateProcessed(SyncTransferIndex)

Default Value

""

Remarks

Transfer processing date.

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

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.

The SyncTransferIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncTransferCount property.

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

Data Type

String

SyncTransferDateProjected Property (BankTransfer Control)

Projected date of the transfer.

Syntax

banktransfercontrol.SyncTransferDateProjected(SyncTransferIndex)

Default Value

""

Remarks

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 SyncTransferDateProjected or SyncTransferDatePosted, but not both.

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.

The SyncTransferIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncTransferCount property.

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

Data Type

String

SyncTransferFromAccountId Property (BankTransfer Control)

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

Syntax

banktransfercontrol.SyncTransferFromAccountId(SyncTransferIndex)

Default Value

""

Remarks

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 SyncTransferFromAccountType is set to CreditCard, the SyncTransferFromAccountId is a credit card account number.

The SyncTransferIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncTransferCount property.

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

Data Type

String

SyncTransferId Property (BankTransfer Control)

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

Syntax

banktransfercontrol.SyncTransferId(SyncTransferIndex)

Default Value

""

Remarks

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

The SyncTransferId 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 SyncTransferId 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 control (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.

The SyncTransferIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncTransferCount property.

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

Data Type

String

SyncTransferStatus Property (BankTransfer Control)

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

Syntax

banktransfercontrol.SyncTransferStatus(SyncTransferIndex)

Default Value

""

Remarks

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:

The SyncTransferIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncTransferCount property.

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

Data Type

String

SyncTransferToAccountId Property (BankTransfer Control)

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

Syntax

banktransfercontrol.SyncTransferToAccountId(SyncTransferIndex)

Default Value

""

Remarks

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 SyncTransferToAccountType is set to CreditCard, the SyncTransferToAccountId is a credit card account number.

The SyncTransferIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncTransferCount property.

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

Data Type

String

SyncTransferTxType Property (BankTransfer Control)

Transaction type of the bank transfer being synchronized.

Syntax

banktransfercontrol.SyncTransferTxType(SyncTransferIndex)

Default Value

""

Remarks

Transaction type of the bank transfer being synchronized.

Possible values and their meanings are as follows:

The SyncTransferIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncTransferCount property.

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

Data Type

String

Timeout Property (BankTransfer Control)

The timeout for the control.

Syntax

banktransfercontrol.Timeout[=integer]

Default Value

60

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 control will wait for the operation to complete before returning control.

The control 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 control 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

TransferAmount Property (BankTransfer Control)

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

Syntax

banktransfercontrol.TransferAmount[=string]

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

TransferCurrencyCode Property (BankTransfer Control)

Default currency code for this transaction.

Syntax

banktransfercontrol.TransferCurrencyCode

Default Value

""

Remarks

Default currency code for this transaction.

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

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

Data Type

String

TransferDateDue Property (BankTransfer Control)

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

Syntax

banktransfercontrol.TransferDateDue[=string]

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

TransferDatePosted Property (BankTransfer Control)

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

Syntax

banktransfercontrol.TransferDatePosted

Default Value

""

Remarks

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 TransferDateProjected or a TransferDatePosted but not both.

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.

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

Data Type

String

TransferDateProcessed Property (BankTransfer Control)

Transfer processing date.

Syntax

banktransfercontrol.TransferDateProcessed

Default Value

""

Remarks

Transfer processing date.

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

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.

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

Data Type

String

TransferFromAccountId Property (BankTransfer Control)

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

Syntax

banktransfercontrol.TransferFromAccountId[=string]

Default Value

""

Remarks

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 TransferFromAccountType is set to CreditCard, the TransferFromAccountId is a credit card account number.

This property is not available at design time.

Data Type

String

TransferFromAccountKey Property (BankTransfer Control)

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

Syntax

banktransfercontrol.TransferFromAccountKey[=string]

Default Value

""

Remarks

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 TransferFromAccountKey is applicable for international banks only.

This property is not available at design time.

Data Type

String

TransferFromAccountType Property (BankTransfer Control)

Type of account where the transfer is originating from.

Syntax

banktransfercontrol.TransferFromAccountType[=integer]

Possible Values

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

Default Value

0

Remarks

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 TransferFromAccountType and TransferToAccountType are set to CreditCard, then the TransferFromBankId and TransferToBankId are not required to be provided in the request.

This property uses the following values:

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

This property is not available at design time.

Data Type

Integer

TransferFromBankId Property (BankTransfer Control)

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

Syntax

banktransfercontrol.TransferFromBankId[=string]

Default Value

""

Remarks

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 TransferFromAccountType is set to a value different than CreditCard, the TransferFromBankId 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 TransferFromBankId represents the source and destination FI (in this case, this is the same as TransferToBankId and TransferToBankId should not be set).

This property is not available at design time.

Data Type

String

TransferFromBranchId Property (BankTransfer Control)

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

Syntax

banktransfercontrol.TransferFromBranchId[=string]

Default Value

""

Remarks

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 TransferFromBranchId is applicable for international banks only, and if this applies, it can be provided in the request only if TransferFromAccountType is set to a value different than CreditCard. Otherwise, it should not be set.

This property is not available at design time.

Data Type

String

TransferId Property (BankTransfer Control)

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

Syntax

banktransfercontrol.TransferId[=string]

Default Value

""

Remarks

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

The TransferId 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 TransferId 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 control (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.

This property is not available at design time.

Data Type

String

TransferStatus Property (BankTransfer Control)

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

Syntax

banktransfercontrol.TransferStatus

Default Value

""

Remarks

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:

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

Data Type

String

TransferToAccountId Property (BankTransfer Control)

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

Syntax

banktransfercontrol.TransferToAccountId[=string]

Default Value

""

Remarks

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 TransferToAccountType is set to CreditCard, the TransferToAccountId is a credit card account number.

This property is not available at design time.

Data Type

String

TransferToAccountKey Property (BankTransfer Control)

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

Syntax

banktransfercontrol.TransferToAccountKey[=string]

Default Value

""

Remarks

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 TransferToAccountKey is applicable for international banks only.

This property is not available at design time.

Data Type

String

TransferToAccountType Property (BankTransfer Control)

Type of account where money has to be deposited to.

Syntax

banktransfercontrol.TransferToAccountType[=integer]

Possible Values

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

Default Value

0

Remarks

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 TransferFromAccountType and TransferToAccountType are set to CreditCard, then the TransferFromBankId and TransferToBankId are not required to be provided in the request.

This property uses the following values:

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

This property is not available at design time.

Data Type

Integer

TransferToBankId Property (BankTransfer Control)

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

Syntax

banktransfercontrol.TransferToBankId[=string]

Default Value

""

Remarks

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 TransferToAccountType is set to a value different than CreditCard, the TransferToBankId is required to be provided in the request. Otherwise, it should not be set.

This property is not available at design time.

Data Type

String

TransferToBranchId Property (BankTransfer Control)

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

Syntax

banktransfercontrol.TransferToBranchId[=string]

Default Value

""

Remarks

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 TransferToBranchId is applicable for international banks only and if this applies, it can be provided in the request only if TransferToAccountType is set to a value different than CreditCard. Otherwise, it should not be set.

This property is not available at design time.

Data Type

String

CancelTransfer Method (BankTransfer Control)

Cancels a scheduled transfer.

Syntax

banktransfercontrol.CancelTransfer TransferId

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

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

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

Config Method (BankTransfer Control)

Sets or retrieves a configuration setting.

Syntax

banktransfercontrol.Config ConfigurationString

Remarks

Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, 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.

ModifyTransfer Method (BankTransfer Control)

Modifies a scheduled transfer.

Syntax

banktransfercontrol.ModifyTransfer TransferId

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

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:

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

Reset Method (BankTransfer Control)

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

Syntax

banktransfercontrol.Reset 

Remarks

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

SynchronizeTransfers Method (BankTransfer Control)

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

Syntax

banktransfercontrol.SynchronizeTransfers Token

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:

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 TransferId, but it can undergo several state changes over its life and thus might have several entries in the token history.

TransferFunds Method (BankTransfer Control)

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

Syntax

banktransfercontrol.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:

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

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 TransferDatePosted. In this case, synchronization is not required.

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 TransferId and indicate the TransferDateProjected if the TransferDatePosted 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 TransferFromBankId and TransferToBankId should both be set (if the account type is different than CreditCard).
• At the discretion of an FI, the destination account (identified by TransferToAccountId) 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.

ConnectionStatus Event (BankTransfer Control)

Fired to indicate changes in the connection state.

Syntax

Sub banktransfercontrol_ConnectionStatus(ConnectionEvent As String, StatusCode As Integer, Description As String)

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:

Error Event (BankTransfer Control)

Fired when information is available about errors during data delivery.

Syntax

Sub banktransfercontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control 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 Control)

Fired after the server presents its certificate to the client.

Syntax

Sub banktransfercontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

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

Fired when secure connection progress messages are available.

Syntax

Sub banktransfercontrol_SSLStatus(Message As String)

Remarks

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

SyncTransfers Event (BankTransfer Control)

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

Syntax

Sub banktransfercontrol_SyncTransfers(TransferAggregate As String, TransferTxType As String, TransferId As String, TransferAmount As String, FromAccountId As String, ToAccountId As String, TransferStatus As String, TransferDatePosted As String)

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.

Config Settings (BankTransfer Control)

BankTransfer Config Settings

OFX Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (BankTransfer Control)

OFX Errors

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

XML Errors

HTTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors