OFXBatch Class

Properties   Methods   Events   Config Settings   Errors  

Enables sending of multiple requests to an OFX server through a single connection.

Class Name

InEBank_OFXBatch

Procedural Interface

 inebank_ofxbatch_open();
 inebank_ofxbatch_close($res);
 inebank_ofxbatch_register_callback($res, $id, $function);
 inebank_ofxbatch_get_last_error($res);
 inebank_ofxbatch_get_last_error_code($res);
 inebank_ofxbatch_set($res, $id, $index, $value);
 inebank_ofxbatch_get($res, $id, $index);
 inebank_ofxbatch_do_config($res, $configurationstring);
 inebank_ofxbatch_do_postrequest($res);
 inebank_ofxbatch_do_readofxdatafile($res, $filename);
 inebank_ofxbatch_do_reset($res);
 inebank_ofxbatch_do_writeofxdatafile($res, $filename);

Remarks

The OFXBatch class allows your application to download account information, bank, credit card, investment, loan statements, make intrabank and/or interbank transfers, and/or download your FI profile in one single request submitted to the FI's OFX server. This class provides for applying a single authentication context to multiple requests in order to reduce the overhead of user authentication.

All downloads are batched into a single secure HTTPS connection to the financial institution. To use the OFXBatch class first identify the financial institution by setting the FIId, FIOrganization and FIUrl,properties. Next identify the OFX user and application by setting the OFXUser, OFXPassword, OFXAppId and OFXAppVersion properties. The same signon information will be used for the entire batch.

To build the request, depending on each request type, the corresponding IPWorks OFX components should be used. So, if account information, bank, credit card, investment, loan statement, bank transfer, and FI profile are part of this multiple request, then instances of Account, BankStatement, CCStatement, InvStatement, LoanStatement, BankTransfer, and FIProfile (corresponding to the each request type) should be used. The individual components that generate the OFX request aggregate will not need the sign on data to generate their request.

Set properties of each corresponding component (excluding the SignOn part which is already set), as you would do when using these components to send single requests to the server. Please refer to each class help files for details on how to build each individual OFX request .

Once you have finished setting the properties that describe each individual request, set the OFXBatchItemRequest in OFXBatch to the OFXRequest of each corresponding component. For example:

OFXBatch.OFXBatchItems[0].Request = BankStatement.OFXRequest; OFXBatch.OFXBatchItems[1].Request = CCStatement.OFXRequest; OFXBatch.OFXBatchItems[2].Request = FIProfile.OFXRequest;

Then, use the PostRequest method to build and transmit the request automatically.

Message sets will/must appear in the following order in the request: Signon, Signup, Bank statement, Intrabank funds transfers, Credit card statements, Loan statements, Investment statements, Interbank funds transfers, and FI Profile, regardless of their order while populating the OFXBatchItems. In the server response, the message sets will be returned in the server response in the same order.

Upon successful response, the OFXBatchItemResponse array property will be populated automatically, which will contain several blocks of information consisting of a server response for each request. To parse this response, the OFXBatchItemResponse at the same index should be passed as OFXResponse of the corresponding component using the same order as submitted in the request.

BankStatement.OFXResponse = OFXBatch.OFXBatchItems[0].Response; CCStatement.OFXResponse = OFXBatch.OFXBatchItems[1].Response; FIProfile.OFXResponse = OFXBatch.OFXBatchItems[2].Response;

Properties of each class are now populated and ready for retrieval.

Note: If signon data is different across components, then they cannot be used in the same batch, otherwise an error will be thrown.

Property List

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

Method List

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

Event List

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

Config Settings

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

FIId Property (InEBank_OFXBatch Class)

Financial institution identifier.

Object Oriented Interface

public function getFIId();


public function setFIId($value);

Procedural Interface

inebank_ofxbatch_get($res, 1 );


inebank_ofxbatch_set($res, 1, $value );

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

Financial institution organization name.

Object Oriented Interface

public function getFIOrganization();


public function setFIOrganization($value);

Procedural Interface

inebank_ofxbatch_get($res, 2 );


inebank_ofxbatch_set($res, 2, $value );

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

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

Object Oriented Interface

public function getFirewallAutoDetect();


public function setFirewallAutoDetect($value);

Procedural Interface

inebank_ofxbatch_get($res, 3 );


inebank_ofxbatch_set($res, 3, $value );

Default Value

false

Remarks

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

Data Type

Boolean

FirewallType Property (InEBank_OFXBatch Class)

This property determines the type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();


public function setFirewallType($value);

Procedural Interface

inebank_ofxbatch_get($res, 4 );


inebank_ofxbatch_set($res, 4, $value );

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (InEBank_OFXBatch Class)

This property contains the name or IP address of firewall (optional).

Object Oriented Interface

public function getFirewallHost();


public function setFirewallHost($value);

Procedural Interface

inebank_ofxbatch_get($res, 5 );


inebank_ofxbatch_set($res, 5, $value );

Default Value

''

Remarks

This property contains the name or IP address of 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 class fails with an error.

Data Type

String

FirewallPassword Property (InEBank_OFXBatch Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Object Oriented Interface

public function getFirewallPassword();


public function setFirewallPassword($value);

Procedural Interface

inebank_ofxbatch_get($res, 6 );


inebank_ofxbatch_set($res, 6, $value );

Default Value

''

Remarks

This property contains 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 class fails with an error.

Data Type

String

FirewallPort Property (InEBank_OFXBatch Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();


public function setFirewallPort($value);

Procedural Interface

inebank_ofxbatch_get($res, 7 );


inebank_ofxbatch_set($res, 7, $value );

Default Value

0

Remarks

This property contains 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 (InEBank_OFXBatch Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();


public function setFirewallUser($value);

Procedural Interface

inebank_ofxbatch_get($res, 8 );


inebank_ofxbatch_set($res, 8, $value );

Default Value

''

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

FIUrl Property (InEBank_OFXBatch Class)

Financial institution URL.

Object Oriented Interface

public function getFIUrl();


public function setFIUrl($value);

Procedural Interface

inebank_ofxbatch_get($res, 9 );


inebank_ofxbatch_set($res, 9, $value );

Default Value

''

Remarks

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

Data Type

String

OFXAppId Property (InEBank_OFXBatch Class)

OFX application identifier.

Object Oriented Interface

public function getOFXAppId();


public function setOFXAppId($value);

Procedural Interface

inebank_ofxbatch_get($res, 10 );


inebank_ofxbatch_set($res, 10, $value );

Default Value

''

Remarks

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

Data Type

String

OFXAppVersion Property (InEBank_OFXBatch Class)

OFX application version.

Object Oriented Interface

public function getOFXAppVersion();


public function setOFXAppVersion($value);

Procedural Interface

inebank_ofxbatch_get($res, 11 );


inebank_ofxbatch_set($res, 11, $value );

Default Value

''

Remarks

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

Data Type

String

OFXBatchItemCount Property (InEBank_OFXBatch Class)

The number of records in the OFXBatchItem arrays.

Object Oriented Interface

public function getOFXBatchItemCount();


public function setOFXBatchItemCount($value);

Procedural Interface

inebank_ofxbatch_get($res, 12 );


inebank_ofxbatch_set($res, 12, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• OFXBatchItemRequest
• OFXBatchItemRequestType
• OFXBatchItemRequestUID
• OFXBatchItemResponse

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

This property is not available at design time.

Data Type

Integer

OFXBatchItemRequest Property (InEBank_OFXBatch Class)

OFX request aggregate.

Object Oriented Interface

public function getOFXBatchItemRequest($ofxbatchitemindex);


public function setOFXBatchItemRequest($ofxbatchitemindex, $value);

Procedural Interface

inebank_ofxbatch_get($res, 13 , $ofxbatchitemindex);


inebank_ofxbatch_set($res, 13, $value , $ofxbatchitemindex);

Default Value

''

Remarks

OFX request aggregate. The OFXBatchItemRequest is obtained by setting it to a OFXRequest aggregate of a class that corresponds to that request type. For example:

OFXBatch.OFXBatchItemCount = 3; OFXBatch.OFXBathcItems[0].Request = BankStatement.OFXRequest; OFXBatch.OFXBathcItems[1].Request = CCStatement.OFXRequest; OFXBatch.OFXBathcItems[2].Request = FIProfile.OFXRequest;

Message sets will/must appear in the following order in the batch request sent to the server: Signon, Signup, Bank statement, Intrabank funds transfers, Credit card statements, Loan statements, Investment statements, Interbank funds transfers, and FI Profile, regardless of their order while populating the OFXBatchItems. In the server response, the message sets will be returned in the server response in the same order.

The $ofxbatchitemindex parameter specifies the index of the item in the array. The size of the array is controlled by the OFXBatchItemCount property.

This property is not available at design time.

Data Type

String

OFXBatchItemRequestType Property (InEBank_OFXBatch Class)

The type of OFX request included in the batch.

Object Oriented Interface

public function getOFXBatchItemRequestType($ofxbatchitemindex);

Procedural Interface

inebank_ofxbatch_get($res, 14 , $ofxbatchitemindex);

Default Value

''

Remarks

The type of OFX request included in the batch. Request types supported by OFXBatch component are: Account Info, Bank, Credit Card, Loan, and Investment statement download, Intrabank and Interbank Transfer, Bill Pay, and FI Profile. The support for these requests depend whether the FI OFX server supports that request type and whether they allow it to be part of a batch request.

Possible values and their meanings are as follows:

The $ofxbatchitemindex parameter specifies the index of the item in the array. The size of the array is controlled by the OFXBatchItemCount property.

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

Data Type

String

OFXBatchItemRequestUID Property (InEBank_OFXBatch Class)

The current batch item's unique transaction ID.

Object Oriented Interface

public function getOFXBatchItemRequestUID($ofxbatchitemindex);

Procedural Interface

inebank_ofxbatch_get($res, 15 , $ofxbatchitemindex);

Default Value

''

Remarks

The current batch item's unique transaction ID.

The value in OFXBatchItemResponse is parsed out of the server's response to the batch and matched to the appropriate original OFXBatchItemRequest using by matching the response UID to the OFXBatchItemRequestUID.

The $ofxbatchitemindex parameter specifies the index of the item in the array. The size of the array is controlled by the OFXBatchItemCount property.

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

Data Type

String

OFXBatchItemResponse Property (InEBank_OFXBatch Class)

The OFX response aggregate.

Object Oriented Interface

public function getOFXBatchItemResponse($ofxbatchitemindex);


public function setOFXBatchItemResponse($ofxbatchitemindex, $value);

Procedural Interface

inebank_ofxbatch_get($res, 16 , $ofxbatchitemindex);


inebank_ofxbatch_set($res, 16, $value , $ofxbatchitemindex);

Default Value

''

Remarks

The OFX response aggregate. This string represents the OFX response aggregate for the current OFXBatchItemRequest. When the OFXBatch is posted, the OFXBatchItemResponse property will be populated automatically with the server's response to the OFXBatchItemRequest.

For example, if the batch request consisted of BankStatement, CCStatement and FIProfile, such as:

OFXBatch.OFXBatchItemCount = 3; OFXBatch.OFXBatchItems[0].Request = BankStatement.OFXRequest; OFXBatch.OFXBatchItems[1].Request = CCStatement.OFXRequest; OFXBatch.OFXBatchItems[2].Request = FIProfile.OFXRequest;

Upon successful server response, the OFXResponse aggregate of the corresponding class should be set (in the same order as they were included in the batch request), for example:

BankStatement.OFXResponse = OFXBatch.OFXBatchItems[0].Response; CCStatement.OFXResponse = OFXBatch.OFXBatchItems[1].Response; FIProfile.OFXResponse = OFXBatch.OFXBatchItems[2].Response;

Properties of each class are now populated and ready for retrieval.

The $ofxbatchitemindex parameter specifies the index of the item in the array. The size of the array is controlled by the OFXBatchItemCount property.

This property is not available at design time.

Data Type

String

OFXPassword Property (InEBank_OFXBatch Class)

User's password.

Object Oriented Interface

public function getOFXPassword();


public function setOFXPassword($value);

Procedural Interface

inebank_ofxbatch_get($res, 17 );


inebank_ofxbatch_set($res, 17, $value );

Default Value

''

Remarks

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

Data Type

String

OFXUser Property (InEBank_OFXBatch Class)

User's id.

Object Oriented Interface

public function getOFXUser();


public function setOFXUser($value);

Procedural Interface

inebank_ofxbatch_get($res, 18 );


inebank_ofxbatch_set($res, 18, $value );

Default Value

''

Remarks

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

Data Type

String

ProxyAuthScheme Property (InEBank_OFXBatch Class)

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

Object Oriented Interface

public function getProxyAuthScheme();


public function setProxyAuthScheme($value);

Procedural Interface

inebank_ofxbatch_get($res, 19 );


inebank_ofxbatch_set($res, 19, $value );

Default Value

0

Remarks

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

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

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

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

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

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

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

Data Type

Integer

ProxyAutoDetect Property (InEBank_OFXBatch Class)

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

Object Oriented Interface

public function getProxyAutoDetect();


public function setProxyAutoDetect($value);

Procedural Interface

inebank_ofxbatch_get($res, 20 );


inebank_ofxbatch_set($res, 20, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyPassword Property (InEBank_OFXBatch Class)

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

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

inebank_ofxbatch_get($res, 21 );


inebank_ofxbatch_set($res, 21, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

ProxyPort Property (InEBank_OFXBatch Class)

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

Object Oriented Interface

public function getProxyPort();


public function setProxyPort($value);

Procedural Interface

inebank_ofxbatch_get($res, 22 );


inebank_ofxbatch_set($res, 22, $value );

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (InEBank_OFXBatch Class)

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

Object Oriented Interface

public function getProxyServer();


public function setProxyServer($value);

Procedural Interface

inebank_ofxbatch_get($res, 23 );


inebank_ofxbatch_set($res, 23, $value );

Default Value

''

Remarks

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

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

Data Type

String

ProxySSL Property (InEBank_OFXBatch Class)

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

Object Oriented Interface

public function getProxySSL();


public function setProxySSL($value);

Procedural Interface

inebank_ofxbatch_get($res, 24 );


inebank_ofxbatch_set($res, 24, $value );

Default Value

0

Remarks

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

Data Type

Integer

ProxyUser Property (InEBank_OFXBatch Class)

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

Object Oriented Interface

public function getProxyUser();


public function setProxyUser($value);

Procedural Interface

inebank_ofxbatch_get($res, 25 );


inebank_ofxbatch_set($res, 25, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

SSLAcceptServerCertEncoded Property (InEBank_OFXBatch Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

inebank_ofxbatch_get($res, 27 );


inebank_ofxbatch_set($res, 27, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (InEBank_OFXBatch Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

inebank_ofxbatch_get($res, 55 );


inebank_ofxbatch_set($res, 55, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (InEBank_OFXBatch Class)

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

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

inebank_ofxbatch_get($res, 71 );


inebank_ofxbatch_set($res, 71, $value );

Default Value

'MY'

Remarks

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

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

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

Designations of certificate stores are platform-dependent.

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

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (InEBank_OFXBatch Class)

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

Object Oriented Interface

public function getSSLCertStorePassword();


public function setSSLCertStorePassword($value);

Procedural Interface

inebank_ofxbatch_get($res, 72 );


inebank_ofxbatch_set($res, 72, $value );

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

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

inebank_ofxbatch_get($res, 73 );


inebank_ofxbatch_set($res, 73, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (InEBank_OFXBatch Class)

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

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

inebank_ofxbatch_get($res, 74 );


inebank_ofxbatch_set($res, 74, $value );

Default Value

''

Remarks

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

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

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

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

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

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

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

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

Data Type

String

SSLProvider Property (InEBank_OFXBatch Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

inebank_ofxbatch_get($res, 82 );


inebank_ofxbatch_set($res, 82, $value );

Default Value

0

Remarks

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

Possible values are:

Additional Notes

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

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (InEBank_OFXBatch Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

inebank_ofxbatch_get($res, 84 );

Default Value

''

Remarks

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

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

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

Data Type

Binary String

Timeout Property (InEBank_OFXBatch Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

inebank_ofxbatch_get($res, 111 );


inebank_ofxbatch_set($res, 111, $value );

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

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

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

Please note that by default, all timeouts are inactivity timeouts, i.e. 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

Config Method (InEBank_OFXBatch Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

inebank_ofxbatch_do_config($res, $configurationstring);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

PostRequest Method (InEBank_OFXBatch Class)

Submits a batch of requests to an OFX server through a single connection.

Object Oriented Interface

public function doPostRequest();

Procedural Interface

inebank_ofxbatch_do_postrequest($res);

Remarks

This function generates the Signon and multiple requests page, submits it to the financial institution via secure HTTPS Post, and receives the multiple responses stored in OFXBatchItems property.

To create the batch of requests, first you will to create instances of the corresponding components to request type such as BankStatement, CCStatement, InvStatement, or FIProfile. Then, build the OFX request for each component used.

Finally, set the OFXBatchItemRequest array property to each OFXRequest of the corresponding component.

When PostRequest is called, the server response will be returned in OFXBatchItemResponse array property, ready to be retrieved by each individual component.

ReadOFXDataFile Method (InEBank_OFXBatch Class)

Reads an OFX response from a file.

Object Oriented Interface

public function doReadOFXDataFile($filename);

Procedural Interface

inebank_ofxbatch_do_readofxdatafile($res, $filename);

Remarks

This method reads a previously recorded OFX response from a file, including HTTP and OFX headers.

The following read-only properties are populated as a result of parsing the data file:

Reset Method (InEBank_OFXBatch Class)

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

Object Oriented Interface

public function doReset();

Procedural Interface

inebank_ofxbatch_do_reset($res);

Remarks

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

WriteOFXDataFile Method (InEBank_OFXBatch Class)

Writes the OFX response sent by the server to a file.

Object Oriented Interface

public function doWriteOFXDataFile($filename);

Procedural Interface

inebank_ofxbatch_do_writeofxdatafile($res, $filename);

Remarks

This method records the entire OFX response, including HTTP and OFX headers to a file. This file can later be read and parsed by the ReadOFXDataFile method as though it were a live response.

ConnectionStatus Event (InEBank_OFXBatch Class)

This event is fired to indicate changes in the connection state.

Object Oriented Interface

public function fireConnectionStatus($param);

Procedural Interface

inebank_ofxbatch_register_callback($res, 1, array($this, 'fireConnectionStatus'));

Parameter List

 'connectionevent'
 'statuscode'
 'description'

Remarks

The ConnectionStatus 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:

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

Error Event (InEBank_OFXBatch Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

inebank_ofxbatch_register_callback($res, 2, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

SSLServerAuthentication Event (InEBank_OFXBatch Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

inebank_ofxbatch_register_callback($res, 3, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

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

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

SSLStatus Event (InEBank_OFXBatch Class)

Shows the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

inebank_ofxbatch_register_callback($res, 4, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

Config Settings (OFXBatch Class)

<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
...

Trappable Errors (OFXBatch Class)

XML Errors

	101   Invalid attribute index.
	102   No attributes available.
	103   Invalid namespace index.
	104   No namespaces available.
	105   Invalid element index.
	106   No elements available.
	107   Attribute does not exist.
	201   Unbalanced element tag.
	202   Unknown element prefix (can't find namespace).
	203   Unknown attribute prefix (can't find namespace).
	204   Invalid XML markup.
	205   Invalid end state for parser.
	206   Document contains unbalanced elements.
	207   Invalid XPath.
	208   No such child.
	209   Top element does not match start of path.
	210   DOM tree unavailable (set BuildDOM to true and reparse).
	302   Can't open file.
	401   Invalid XML would be generated.
	402   An invalid XML name has been specified.