FIProfile Class

Properties   Methods   Events   Config Settings   Errors  

The FIProfile control is a single class that supports the SignOn and FI Profile functions of Open Financial eXchange, as described by the OFX Specification version 1.0.2.

Class Name

InEBank_FIProfile

Procedural Interface

 inebank_fiprofile_open();
 inebank_fiprofile_close($res);
 inebank_fiprofile_register_callback($res, $id, $function);
 inebank_fiprofile_get_last_error($res);
 inebank_fiprofile_get_last_error_code($res);
 inebank_fiprofile_set($res, $id, $index, $value);
 inebank_fiprofile_get($res, $id, $index);
 inebank_fiprofile_do_config($res, $configurationstring);
 inebank_fiprofile_do_getprofile($res);
 inebank_fiprofile_do_readofxdatafile($res, $filename);
 inebank_fiprofile_do_requestchallengequestions($res);
 inebank_fiprofile_do_reset($res);
 inebank_fiprofile_do_sendchallengeanswers($res);
 inebank_fiprofile_do_writeofxdatafile($res, $filename);

Remarks

The FIProfile class provides the ability to download an OFX Financial Institution Profile. These profiles contain information about how to communicate with the financial institution, such as what message sets are supported and what URLs to post to for them as well as the type of data that is supported for sign on.

To use the FIProfile 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. Use the ClientRouting property to notify the server as to the client's routing capabilities. Finally, set the LastUpdate property to the date of the most recent profile request. Then just call the GetProfile method to retrieve the financial institution's profile.

To determine whether the client has the latest version of the FI profile, the server checks the date and time passed by the client in LastUpdate. If the client has the latest version of the FI profile, the server does not return a profile specific response. In this case, the ServerMessage will contain the message returned by the server (such as: 'Up to date', etc.).

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.

ChallengeQuestionCount Property (InEBank_FIProfile Class)

The number of records in the Challenge arrays.

Object Oriented Interface

public function getChallengeQuestionCount();


public function setChallengeQuestionCount($value);

Procedural Interface

inebank_fiprofile_get($res, 1 );


inebank_fiprofile_set($res, 1, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ChallengeAggregate
• ChallengeAnswer
• ChallengeQuestion
• ChallengeQuestionId

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

This property is not available at design time.

Data Type

Integer

ChallengeAggregate Property (InEBank_FIProfile Class)

Wrapper for a MFA challenge question.

Object Oriented Interface

public function getChallengeAggregate($challengequestionindex);

Procedural Interface

inebank_fiprofile_get($res, 2 , $challengequestionindex);

Default Value

''

Remarks

Wrapper for a MFA challenge question.

Each challenge question aggregate contains elements and values associated with the following properties:

• ChallengeQuestionId
• ChallengeQuestion

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

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

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

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

Data Type

String

ChallengeAnswer Property (InEBank_FIProfile Class)

User's answer to the challenge question identified by QuestionId .

Object Oriented Interface

public function getChallengeAnswer($challengequestionindex);


public function setChallengeAnswer($challengequestionindex, $value);

Procedural Interface

inebank_fiprofile_get($res, 3 , $challengequestionindex);


inebank_fiprofile_set($res, 3, $value , $challengequestionindex);

Default Value

''

Remarks

User's answer to the challenge question identified by ChallengeQuestionId.

Depending on the value of ChallengeQuestionId, this answer can be collected by user or client. Values above MFA100 are reserved for questions that the server expects the client to answer. These do not require customer responses. All other IDs as well as server specific IDs expect customer responses. Clients may need to identify out of band which of the IDs above MFA100 they support.

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

This property is not available at design time.

Data Type

String

ChallengeQuestion Property (InEBank_FIProfile Class)

The textual challenge question.

Object Oriented Interface

public function getChallengeQuestion($challengequestionindex);

Procedural Interface

inebank_fiprofile_get($res, 4 , $challengequestionindex);

Default Value

''

Remarks

The textual challenge question.

The following table details the list of possible reserved values for ChallengeQuestionId and corresponding textual description of the challenge question:

Note:Values above MFA100 are reserved for questions that the server expects the client to answer. These do not require customer responses. All other IDs as well as server specific IDs expect customer responses. Clients may need to identify out of band which of the IDs above MFA100 they support.

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

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

Data Type

String

ChallengeQuestionId Property (InEBank_FIProfile Class)

Identifier for the challenge question.

Object Oriented Interface

public function getChallengeQuestionId($challengequestionindex);

Procedural Interface

inebank_fiprofile_get($res, 5 , $challengequestionindex);

Default Value

''

Remarks

Identifier for the challenge question.

This is unique for this challenge question, but not unique for the user, session, etc.

The following table details the list of possible reserved values for ChallengeQuestionId and corresponding textual description of the challenge question:

Note:Values above MFA100 are reserved for questions that the server expects the client to answer. These do not require customer responses. All other IDs as well as server specific IDs expect customer responses. Clients may need to identify out of band which of the IDs above MFA100 they support.

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

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

Data Type

String

ClientRouting Property (InEBank_FIProfile Class)

Client routing capabilities of the Financial Institution.

Object Oriented Interface

public function getClientRouting();


public function setClientRouting($value);

Procedural Interface

inebank_fiprofile_get($res, 6 );


inebank_fiprofile_set($res, 6, $value );

Default Value

0

Remarks

Data Type

Integer

FIAddress1 Property (InEBank_FIProfile Class)

Street address.

Object Oriented Interface

public function getFIAddress1();

Procedural Interface

inebank_fiprofile_get($res, 7 );

Default Value

''

Remarks

The first line of the street address of the individual or business is stored in this property as a string.

This property is read-only.

Data Type

String

FIAddress2 Property (InEBank_FIProfile Class)

Street address.

Object Oriented Interface

public function getFIAddress2();

Procedural Interface

inebank_fiprofile_get($res, 8 );

Default Value

''

Remarks

The second line of the street address of the individual or business is stored in this property as a string.

This property is read-only.

Data Type

String

FIAddress3 Property (InEBank_FIProfile Class)

Street address.

Object Oriented Interface

public function getFIAddress3();

Procedural Interface

inebank_fiprofile_get($res, 9 );

Default Value

''

Remarks

The third line of the street address of the individual or business is stored in this property as a string.

This property is read-only.

Data Type

String

FICity Property (InEBank_FIProfile Class)

City.

Object Oriented Interface

public function getFICity();

Procedural Interface

inebank_fiprofile_get($res, 10 );

Default Value

''

Remarks

The city where the individual or business is located is stored in this property as a string.

This property is read-only.

Data Type

String

FICountry Property (InEBank_FIProfile Class)

Country.

Object Oriented Interface

public function getFICountry();

Procedural Interface

inebank_fiprofile_get($res, 11 );

Default Value

''

Remarks

The country where the individual or business is located is stored in this property as a string.

This property is read-only.

Data Type

String

FICustomerServicePhone Property (InEBank_FIProfile Class)

Phone number for Customer Service.

Object Oriented Interface

public function getFICustomerServicePhone();

Procedural Interface

inebank_fiprofile_get($res, 12 );

Default Value

''

Remarks

This is the Financial Institution's Customer Service phone number.

This property is read-only.

Data Type

String

FIEmailAddress Property (InEBank_FIProfile Class)

Email address for contacting the Financial Institution.

Object Oriented Interface

public function getFIEmailAddress();

Procedural Interface

inebank_fiprofile_get($res, 13 );

Default Value

''

Remarks

The FI email address.

This property is read-only.

Data Type

String

FIHomePage Property (InEBank_FIProfile Class)

Home web page for general information about the Financial Institution.

Object Oriented Interface

public function getFIHomePage();

Procedural Interface

inebank_fiprofile_get($res, 14 );

Default Value

''

Remarks

The Financial Institution's home page URL.

This property is read-only.

Data Type

String

FIId Property (InEBank_FIProfile Class)

Financial institution identifier.

Object Oriented Interface

public function getFIId();


public function setFIId($value);

Procedural Interface

inebank_fiprofile_get($res, 15 );


inebank_fiprofile_set($res, 15, $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

FIName Property (InEBank_FIProfile Class)

Name.

Object Oriented Interface

public function getFIName();

Procedural Interface

inebank_fiprofile_get($res, 16 );

Default Value

''

Remarks

The name of the individual or business is stored in this property as a string.

This property is read-only.

Data Type

String

FIOrganization Property (InEBank_FIProfile Class)

Financial institution organization name.

Object Oriented Interface

public function getFIOrganization();


public function setFIOrganization($value);

Procedural Interface

inebank_fiprofile_get($res, 17 );


inebank_fiprofile_set($res, 17, $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

FIPostalCode Property (InEBank_FIProfile Class)

Postal Code.

Object Oriented Interface

public function getFIPostalCode();

Procedural Interface

inebank_fiprofile_get($res, 18 );

Default Value

''

Remarks

The postal code where the individual or business is located is stored in this property as a string.

This property is read-only.

Data Type

String

FIProfileDate Property (InEBank_FIProfile Class)

The date the current profile was posted.

Object Oriented Interface

public function getFIProfileDate();

Procedural Interface

inebank_fiprofile_get($res, 19 );

Default Value

''

Remarks

The date the OFX Financial Institution posted the current profile.

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.

Note: you may use this date on subsequent profile requests to ensure that you receive the latest profile. Simply set the LastUpdate property to the value in this property on any subsequent profile requests.

This property is read-only.

Data Type

String

FirewallAutoDetect Property (InEBank_FIProfile 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_fiprofile_get($res, 20 );


inebank_fiprofile_set($res, 20, $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_FIProfile Class)

This property determines the type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();


public function setFirewallType($value);

Procedural Interface

inebank_fiprofile_get($res, 21 );


inebank_fiprofile_set($res, 21, $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_FIProfile 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_fiprofile_get($res, 22 );


inebank_fiprofile_set($res, 22, $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_FIProfile 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_fiprofile_get($res, 23 );


inebank_fiprofile_set($res, 23, $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_FIProfile 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_fiprofile_get($res, 24 );


inebank_fiprofile_set($res, 24, $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_FIProfile 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_fiprofile_get($res, 25 );


inebank_fiprofile_set($res, 25, $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

FIState Property (InEBank_FIProfile Class)

State.

Object Oriented Interface

public function getFIState();

Procedural Interface

inebank_fiprofile_get($res, 26 );

Default Value

''

Remarks

The state or province where the individual or business is located is stored in this property as a string.

This property is read-only.

Data Type

String

FITechSupportPhone Property (InEBank_FIProfile Class)

Phone number for Technical Support.

Object Oriented Interface

public function getFITechSupportPhone();

Procedural Interface

inebank_fiprofile_get($res, 27 );

Default Value

''

Remarks

The Financial Institution's Tech Support department phone number.

This property is read-only.

Data Type

String

FIUrl Property (InEBank_FIProfile Class)

Financial institution URL.

Object Oriented Interface

public function getFIUrl();


public function setFIUrl($value);

Procedural Interface

inebank_fiprofile_get($res, 28 );


inebank_fiprofile_set($res, 28, $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

LastUpdate Property (InEBank_FIProfile Class)

Date and time of the last profile update.

Object Oriented Interface

public function getLastUpdate();


public function setLastUpdate($value);

Procedural Interface

inebank_fiprofile_get($res, 29 );


inebank_fiprofile_set($res, 29, $value );

Default Value

'20000101120000.000[+0:GMT]'

Remarks

This is the date (last time) the FI updated the profile on their end. If this is the first time the FIProfile class is being used, use the default value to ensure that the latest update is received. This property must be set to a value that was returned in the FIProfileDate property after a previous profile request.

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

MessageSetCount Property (InEBank_FIProfile Class)

The number of records in the MessageSet arrays.

Object Oriented Interface

public function getMessageSetCount();

Procedural Interface

inebank_fiprofile_get($res, 30 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• MessageSetAggregate
• MessageSetClosingInfoAvailability
• MessageSetClosingInfoImage
• MessageSetLanguage
• MessageSetName
• MessageSetRecovery
• MessageSetRefresh
• MessageSetSecurityLevel
• MessageSetServiceProvider
• MessageSetSignOnRealm
• MessageSetSyncMode
• MessageSetTransportSecurity
• MessageSetTxImage
• MessageSetURL
• MessageSetVersion

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

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

Data Type

Integer

MessageSetAggregate Property (InEBank_FIProfile Class)

Wrapper for a message set.

Object Oriented Interface

public function getMessageSetAggregate($messagesetindex);

Procedural Interface

inebank_fiprofile_get($res, 31 , $messagesetindex);

Default Value

''

Remarks

Wrapper for a message set.

A list of all of a given Financial Institution's supported services are stored in a series of aggregates called 'Message Sets'.

Each message set aggregate contains data (elements and values) associated with the following properties:

• MessageSetName
• MessageSetLanguage
• MessageSetRecovery
• MessageSetRefresh
• MessageSetSecurityLevel
• MessageSetServiceProvider
• MessageSetSignOnRealm
• MessageSetSyncMode
• MessageSetTransportSecurity
• MessageSetURL
• MessageSetVersion

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

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

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

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

Data Type

String

MessageSetClosingInfoAvailability Property (InEBank_FIProfile Class)

This is an indicator of the Financial Institution's statement closing information capabilities.

Object Oriented Interface

public function getMessageSetClosingInfoAvailability($messagesetindex);

Procedural Interface

inebank_fiprofile_get($res, 32 , $messagesetindex);

Default Value

false

Remarks

This is an indicator of the Financial Institution's statement closing information capabilities. If true, the server can support statement closing information download for this message set.

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

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

Data Type

Boolean

MessageSetClosingInfoImage Property (InEBank_FIProfile Class)

This is an indicator of the Financial Institution's statement closing image capabilities.

Object Oriented Interface

public function getMessageSetClosingInfoImage($messagesetindex);

Procedural Interface

inebank_fiprofile_get($res, 33 , $messagesetindex);

Default Value

false

Remarks

This is an indicator of the Financial Institution's statement closing image capabilities. If true, the server can support image of the statement closing information for this message set.

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

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

Data Type

Boolean

MessageSetLanguage Property (InEBank_FIProfile Class)

Languages the server supports.

Object Oriented Interface

public function getMessageSetLanguage($messagesetindex);

Procedural Interface

inebank_fiprofile_get($res, 34 , $messagesetindex);

Default Value

''

Remarks

Languages the server supports. More than one may appear in given response.

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

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

Data Type

String

MessageSetName Property (InEBank_FIProfile Class)

Name of a message set supported by the given FI.

Object Oriented Interface

public function getMessageSetName($messagesetindex);

Procedural Interface

inebank_fiprofile_get($res, 35 , $messagesetindex);

Default Value

''

Remarks

Name of a message set supported by the given FI.

Each MessageSetAggregate corresponds to a different OFX command. For example, SIGNONMSGSET corresponds to SignOn Request Message. The MessageSetName is used to retrieve the name of the command associated with this Message Set.

The following table lists each message set, along with its aggregate name and the OFX Versions that support it.

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

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

Data Type

String

MessageSetRecovery Property (InEBank_FIProfile Class)

This is an indicator of the Financial Institution's error-recovery capabilities.

Object Oriented Interface

public function getMessageSetRecovery($messagesetindex);

Procedural Interface

inebank_fiprofile_get($res, 36 , $messagesetindex);

Default Value

false

Remarks

This is an indicator of the Financial Institution's error-recovery capabilities. If true, the server can support file-based error recovery.

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

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

Data Type

Boolean

MessageSetRefresh Property (InEBank_FIProfile Class)

If true, the server can support Synchronized Refresh.

Object Oriented Interface

public function getMessageSetRefresh($messagesetindex);

Procedural Interface

inebank_fiprofile_get($res, 37 , $messagesetindex);

Default Value

false

Remarks

If true, the server can support Synchronized Refresh. Even if this property is set to false, the Financial Institution's server may still be able to support Lite Synchronization.

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

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

Data Type

Boolean

MessageSetSecurityLevel Property (InEBank_FIProfile Class)

Security level of the Message Set.

Object Oriented Interface

public function getMessageSetSecurityLevel($messagesetindex);

Procedural Interface

inebank_fiprofile_get($res, 38 , $messagesetindex);

Default Value

''

Remarks

Security level of the Message Set.

Legal values are defined as follows: "NONE" and "TYPE 1". If the MessageSetSecurityLevel of a Message Set is 'TYPE 1', then the requests for that Message Set submitted to that FI will require a challenge request to be present during the signon.

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

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

Data Type

String

MessageSetServiceProvider Property (InEBank_FIProfile Class)

If the OFX server has been outsourced to a service provider other than the Financial Institution, then the name of that provider should appear here.

Object Oriented Interface

public function getMessageSetServiceProvider($messagesetindex);

Procedural Interface

inebank_fiprofile_get($res, 39 , $messagesetindex);

Default Value

''

Remarks

If the OFX server has been outsourced to a service provider other than the Financial Institution, then the name of that provider should appear here.

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

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

Data Type

String

MessageSetSignOnRealm Property (InEBank_FIProfile Class)

This is the name of the SignOn realm used by this message set.

Object Oriented Interface

public function getMessageSetSignOnRealm($messagesetindex);

Procedural Interface

inebank_fiprofile_get($res, 40 , $messagesetindex);

Default Value

''

Remarks

This is the name of the SignOn realm used by this message set.

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

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

Data Type

String

MessageSetSyncMode Property (InEBank_FIProfile Class)

Level of synchronization offered by the server for this message set.

Object Oriented Interface

public function getMessageSetSyncMode($messagesetindex);

Procedural Interface

inebank_fiprofile_get($res, 41 , $messagesetindex);

Default Value

''

Remarks

Level of synchronization offered by the server for this message set. The valid values are:

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

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

Data Type

String

MessageSetTransportSecurity Property (InEBank_FIProfile Class)

It indicates whether any security measures are taken at the Transport Layer for this message set.

Object Oriented Interface

public function getMessageSetTransportSecurity($messagesetindex);

Procedural Interface

inebank_fiprofile_get($res, 42 , $messagesetindex);

Default Value

false

Remarks

It indicates whether any security measures are taken at the Transport Layer for this message set.

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

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

Data Type

Boolean

MessageSetTxImage Property (InEBank_FIProfile Class)

It indicates whether FI supports transaction image download for this message set.

Object Oriented Interface

public function getMessageSetTxImage($messagesetindex);

Procedural Interface

inebank_fiprofile_get($res, 43 , $messagesetindex);

Default Value

false

Remarks

It indicates whether FI supports transaction image download for this message set. If True, the server supports transaction image (e.g., check image) for this message set.

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

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

Data Type

Boolean

MessageSetURL Property (InEBank_FIProfile Class)

This is the address of the server to which OFX (HTTP) connections are made for this particular message set.

Object Oriented Interface

public function getMessageSetURL($messagesetindex);

Procedural Interface

inebank_fiprofile_get($res, 44 , $messagesetindex);

Default Value

''

Remarks

This is the address of the server to which OFX (HTTP) connections are made for this particular message set.

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

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

Data Type

String

MessageSetVersion Property (InEBank_FIProfile Class)

This version number corresponds to the version of the OFX Specification which the server uses for the message set.

Object Oriented Interface

public function getMessageSetVersion($messagesetindex);

Procedural Interface

inebank_fiprofile_get($res, 45 , $messagesetindex);

Default Value

''

Remarks

This version number corresponds to the version of the OFX Specification which the server uses for the message set. Usually this will be the same version supplied by the client, but sometimes versions may differ across message sets. Servers are required to provide this value in the VER element of the message set aggregate.

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

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

Data Type

String

OFXAccessKey Property (InEBank_FIProfile Class)

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

Object Oriented Interface

public function getOFXAccessKey();


public function setOFXAccessKey($value);

Procedural Interface

inebank_fiprofile_get($res, 46 );


inebank_fiprofile_set($res, 46, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

OFXAppId Property (InEBank_FIProfile Class)

OFX application identifier.

Object Oriented Interface

public function getOFXAppId();


public function setOFXAppId($value);

Procedural Interface

inebank_fiprofile_get($res, 47 );


inebank_fiprofile_set($res, 47, $value );

Default Value

''

Remarks

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

Data Type

String

OFXAppVersion Property (InEBank_FIProfile Class)

OFX application version.

Object Oriented Interface

public function getOFXAppVersion();


public function setOFXAppVersion($value);

Procedural Interface

inebank_fiprofile_get($res, 48 );


inebank_fiprofile_set($res, 48, $value );

Default Value

''

Remarks

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

Data Type

String

OFXPassword Property (InEBank_FIProfile Class)

User's password.

Object Oriented Interface

public function getOFXPassword();


public function setOFXPassword($value);

Procedural Interface

inebank_fiprofile_get($res, 49 );


inebank_fiprofile_set($res, 49, $value );

Default Value

''

Remarks

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

Data Type

String

OFXRequest Property (InEBank_FIProfile Class)

The current OFX request aggregate.

Object Oriented Interface

public function getOFXRequest();

Procedural Interface

inebank_fiprofile_get($res, 50 );

Default Value

''

Remarks

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

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

Data Type

String

OFXResponse Property (InEBank_FIProfile Class)

The current OFX response aggregate.

Object Oriented Interface

public function getOFXResponse();


public function setOFXResponse($value);

Procedural Interface

inebank_fiprofile_get($res, 51 );


inebank_fiprofile_set($res, 51, $value );

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

User's id.

Object Oriented Interface

public function getOFXUser();


public function setOFXUser($value);

Procedural Interface

inebank_fiprofile_get($res, 52 );


inebank_fiprofile_set($res, 52, $value );

Default Value

''

Remarks

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

Data Type

String

OFXVersion Property (InEBank_FIProfile Class)

OFX API version.

Object Oriented Interface

public function getOFXVersion();


public function setOFXVersion($value);

Procedural Interface

inebank_fiprofile_get($res, 53 );


inebank_fiprofile_set($res, 53, $value );

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

SignOnInfoCount Property (InEBank_FIProfile Class)

The number of records in the SignOn arrays.

Object Oriented Interface

public function getSignOnInfoCount();

Procedural Interface

inebank_fiprofile_get($res, 54 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SignOnAggregate
• SignOnAuthToken
• SignOnAuthTokenFirst
• SignOnAuthTokenUrl
• SignOnCaseSensitive
• SignOnCharType
• SignOnClientUIdReq
• SignOnMaxPwdLength
• SignOnMFAChallengeFirst
• SignOnMFAChallengeReq
• SignOnMinPwdLength
• SignOnPINChange
• SignOnPINChangeFirst
• SignOnRealm
• SignOnSpaces
• SignOnSpecial
• SignOnUserCred1Q
• SignOnUserCred2Q

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

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

Data Type

Integer

SignOnAggregate Property (InEBank_FIProfile Class)

Wrapper for signon information.

Object Oriented Interface

public function getSignOnAggregate($signonindex);

Procedural Interface

inebank_fiprofile_get($res, 55 , $signonindex);

Default Value

''

Remarks

Wrapper for signon information.

Each signon information aggregate contains data (elements and values) associated with the following properties:

• SignOnMaxPwdLength
• SignOnMinPwdLength
• SignOnCaseSensitive
• SignOnCharType
• SignOnSpaces
• SignOnSpecial
• SignOnPINChangeFirst
• SignOnPINChange
• SignOnAuthTokenFirst
• SignOnAuthToken
• SignOnAuthTokenUrl
• SignOnClientUIdReq
• SignOnMFAChallengeReq
• SignOnMFAChallengeFirst
• SignOnUserCred1Q
• SignOnUserCred2Q
• SignOnRealm

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

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

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

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

Data Type

String

SignOnAuthToken Property (InEBank_FIProfile Class)

Text label for the Authentication Token.

Object Oriented Interface

public function getSignOnAuthToken($signonindex);

Procedural Interface

inebank_fiprofile_get($res, 56 , $signonindex);

Default Value

''

Remarks

Text label for the Authentication Token.

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

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

Data Type

String

SignOnAuthTokenFirst Property (InEBank_FIProfile Class)

Indicates whether server requires clients to send the Authentication Token as part of first signon.

Object Oriented Interface

public function getSignOnAuthTokenFirst($signonindex);

Procedural Interface

inebank_fiprofile_get($res, 57 , $signonindex);

Default Value

false

Remarks

Indicates whether server requires clients to send the Authentication Token as part of first signon.

If True, then server requires clients to send the AuthToken as part of first signon.

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

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

Data Type

Boolean

SignOnAuthTokenUrl Property (InEBank_FIProfile Class)

URL where Authentication Token information is provided by the institution operating the OFX server.

Object Oriented Interface

public function getSignOnAuthTokenUrl($signonindex);

Procedural Interface

inebank_fiprofile_get($res, 58 , $signonindex);

Default Value

''

Remarks

URL where Authentication Token information is provided by the institution operating the OFX server.

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

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

Data Type

String

SignOnCaseSensitive Property (InEBank_FIProfile Class)

Indicates whether the password is case-sensitive or not.

Object Oriented Interface

public function getSignOnCaseSensitive($signonindex);

Procedural Interface

inebank_fiprofile_get($res, 59 , $signonindex);

Default Value

false

Remarks

Indicates whether the password is case-sensitive or not.

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

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

Data Type

Boolean

SignOnCharType Property (InEBank_FIProfile Class)

Type of characters the password can contain.

Object Oriented Interface

public function getSignOnCharType($signonindex);

Procedural Interface

inebank_fiprofile_get($res, 60 , $signonindex);

Default Value

1

Remarks

Type of characters the password can contain. The valid values of this string are:

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

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

Data Type

Integer

SignOnClientUIdReq Property (InEBank_FIProfile Class)

Indicates whether the Client Unique Identifier is required to be included in the signon.

Object Oriented Interface

public function getSignOnClientUIdReq($signonindex);

Procedural Interface

inebank_fiprofile_get($res, 61 , $signonindex);

Default Value

false

Remarks

Indicates whether the Client Unique Identifier is required to be included in the signon.

If this is True, then the ClientUId is required to be set and included in the request.

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

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

Data Type

Boolean

SignOnMaxPwdLength Property (InEBank_FIProfile Class)

Maximum number of characters a SignOn password on this server can have.

Object Oriented Interface

public function getSignOnMaxPwdLength($signonindex);

Procedural Interface

inebank_fiprofile_get($res, 62 , $signonindex);

Default Value

0

Remarks

Maximum number of characters a SignOn password on this server can have.

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

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

Data Type

Integer

SignOnMFAChallengeFirst Property (InEBank_FIProfile Class)

Indicates whether the Multi-Factor Authentication (MFA) challenge is required to be included in the first signon to this server.

Object Oriented Interface

public function getSignOnMFAChallengeFirst($signonindex);

Procedural Interface

inebank_fiprofile_get($res, 63 , $signonindex);

Default Value

false

Remarks

Indicates whether the Multi-Factor Authentication (MFA) challenge is required to be included in the first signon to this server.

If True, then server requires clients to request MFA challenge questions (required for MFA) in the first signon request. See RequestChallengeQuestions in FIProfile for more information.

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

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

Data Type

Boolean

SignOnMFAChallengeReq Property (InEBank_FIProfile Class)

Indicates whether the Multi-Factor Authentication (MFA) challenge is required by this FI server.

Object Oriented Interface

public function getSignOnMFAChallengeReq($signonindex);

Procedural Interface

inebank_fiprofile_get($res, 64 , $signonindex);

Default Value

false

Remarks

Indicates whether the Multi-Factor Authentication (MFA) challenge is required by this FI server.

If True, then server requires multi-factor authentication during each signon. See RequestChallengeQuestions in FIProfile for more information.

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

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

Data Type

Boolean

SignOnMinPwdLength Property (InEBank_FIProfile Class)

Minimum number of characters a SignOn password on this server can have.

Object Oriented Interface

public function getSignOnMinPwdLength($signonindex);

Procedural Interface

inebank_fiprofile_get($res, 65 , $signonindex);

Default Value

0

Remarks

Minimum number of characters a SignOn password on this server can have.

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

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

Data Type

Integer

SignOnPINChange Property (InEBank_FIProfile Class)

It indicates whether the server accepts any PIN Change Requests at all.

Object Oriented Interface

public function getSignOnPINChange($signonindex);

Procedural Interface

inebank_fiprofile_get($res, 66 , $signonindex);

Default Value

false

Remarks

It indicates whether the server accepts any PIN Change Requests at all.

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

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

Data Type

Boolean

SignOnPINChangeFirst Property (InEBank_FIProfile Class)

Indicates whether server requires clients to change password as part of first signon.

Object Oriented Interface

public function getSignOnPINChangeFirst($signonindex);

Procedural Interface

inebank_fiprofile_get($res, 67 , $signonindex);

Default Value

false

Remarks

Indicates whether server requires clients to change password as part of first signon.

If True, then server requires clients to change OFXPassword as part of first signon. However, if SignOnMFAChallengeFirst is also True, this pin change request should be sent immediately after the session containing multi-factor authentication.

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

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

Data Type

Boolean

SignOnRealm Property (InEBank_FIProfile Class)

SignOn realm used by this message set.

Object Oriented Interface

public function getSignOnRealm($signonindex);

Procedural Interface

inebank_fiprofile_get($res, 68 , $signonindex);

Default Value

''

Remarks

SignOn realm used by this message set. The name of the SignOn realm in this message set.

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

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

Data Type

String

SignOnSpaces Property (InEBank_FIProfile Class)

It indicates whether the password can contain whitespaces.

Object Oriented Interface

public function getSignOnSpaces($signonindex);

Procedural Interface

inebank_fiprofile_get($res, 69 , $signonindex);

Default Value

false

Remarks

It indicates whether the password can contain whitespaces.

This does not refer to any special characters. To determine whether special characters are allowed, check the value of SignOnSpecial.

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

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

Data Type

Boolean

SignOnSpecial Property (InEBank_FIProfile Class)

It indicates whether the password can contain special characters.

Object Oriented Interface

public function getSignOnSpecial($signonindex);

Procedural Interface

inebank_fiprofile_get($res, 70 , $signonindex);

Default Value

false

Remarks

It indicates whether the password can contain special characters. Special characters do not include spaces.

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

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

Data Type

Boolean

SignOnUserCred1Q Property (InEBank_FIProfile Class)

Text prompt for user credential.

Object Oriented Interface

public function getSignOnUserCred1Q($signonindex);

Procedural Interface

inebank_fiprofile_get($res, 71 , $signonindex);

Default Value

''

Remarks

Text prompt for user credential.

If this is present in the server response, a third credential is required to authenticate the user in all future requests. This is in addition to OFXUser and OFXPassword. This new credential is represented by UserCred1A) which is the corresponding answer of SignOnUserCred1Q. This should be then included in each request.

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

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

Data Type

String

SignOnUserCred2Q Property (InEBank_FIProfile Class)

Text prompt for user credential.

Object Oriented Interface

public function getSignOnUserCred2Q($signonindex);

Procedural Interface

inebank_fiprofile_get($res, 72 , $signonindex);

Default Value

''

Remarks

Text prompt for user credential.

If this is present in the server response, a fourth credential is required to authenticate the user in all future requests. This is in addition to OFXUser, OFXPassword and SignOnUserCred2Q. This new credential is represented by UserCred2A) which is the corresponding answer of SignOnUserCred2Q. This should be then included in each request. In this case, the UserCred1A should also be present in the request.

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

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

Data Type

String

SSLAcceptServerCertEncoded Property (InEBank_FIProfile Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

inebank_fiprofile_get($res, 74 );


inebank_fiprofile_set($res, 74, $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_FIProfile Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

inebank_fiprofile_get($res, 102 );


inebank_fiprofile_set($res, 102, $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_FIProfile 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_fiprofile_get($res, 118 );


inebank_fiprofile_set($res, 118, $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_FIProfile 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_fiprofile_get($res, 119 );


inebank_fiprofile_set($res, 119, $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_FIProfile Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

inebank_fiprofile_get($res, 120 );


inebank_fiprofile_set($res, 120, $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_FIProfile 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_fiprofile_get($res, 121 );


inebank_fiprofile_set($res, 121, $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_FIProfile Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

inebank_fiprofile_get($res, 129 );


inebank_fiprofile_set($res, 129, $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_FIProfile Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

inebank_fiprofile_get($res, 131 );

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_FIProfile Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

inebank_fiprofile_get($res, 158 );


inebank_fiprofile_set($res, 158, $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_FIProfile Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

GetProfile Method (InEBank_FIProfile Class)

Download the message set profile for a given Financial Institution.

Object Oriented Interface

public function doGetProfile();

Procedural Interface

inebank_fiprofile_do_getprofile($res);

Remarks

This function generates the Signon and FIProfile request page, submits it to the financial institution via HTTP, receives the response, and parses it. Individual transactions are downloaded with the statement.

Read-only properties that are populated as a result of response parsing include:

• FIAddress1
• FIAddress2
• FIAddress3
• FICity
• FICountry
• FICustomerServicePhone
• FIEmailAddress
• FIHomePage
• FIName
• FIPostalCode
• FIProfileDate
• FIState
• FITechSupportPhone
• MessageSets
• SignOnDetails

ReadOFXDataFile Method (InEBank_FIProfile Class)

Reads an OFX response from a file.

Object Oriented Interface

public function doReadOFXDataFile($filename);

Procedural Interface

inebank_fiprofile_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:

• FIAddress1
• FIAddress2
• FIAddress3
• FICity
• FICountry
• FICustomerServicePhone
• FIEmailAddress
• FIHomePage
• FIName
• FIPostalCode
• FIProfileDate
• FIState
• FITechSupportPhone
• MessageSets
• SignOnDetails

RequestChallengeQuestions Method (InEBank_FIProfile Class)

Download the challenge questions when Multi-Factor Authentication (MFA) is required.

Object Oriented Interface

public function doRequestChallengeQuestions();

Procedural Interface

inebank_fiprofile_do_requestchallengequestions($res);

Remarks

This function generates the Signon and Multi-Factor Authentication challenge questions request page, submits it to the financial institution via HTTP, receives the response, and parses it.

When sending requests to a FI, if the information in the signon request is correct, but it is not sufficient to authenticate the user, the server can reply with a signon error code of 3000, which indicates that the client must perform multi-factor challenge authentication before proceeding with future OFX requests.

When this error is returned, the user should call this RequestChallengeQuestions method, which request the server to send a list of challenge questions that must be correctly answered before the OFX client may proceed with further OFX requests.

Upon successful response, the server will return a list of challenge questions, stored to ChallengeQuestions, where each question is specified by ChallengeQuestionId and ChallengeQuestion. If the server does not return such list, the class will throw an HTTP 400 error.

The user should inspect the ChallengeQuestions. When this list of challenge questions is returned, then the user has to answer each question by setting the ChallengeAnswer for each ChallengeQuestion, and then call the SendChallengeAnswers method to send the answers back to the server. The class will include these answers within the signon request included as part of the next request message. If these answers are correct, the server will process the request file. If they are incorrect, the server will return an error code of 3001.

When MFA is required, to prevent servers from needing to authenticate the user with each OFX request, the server may respond to a correct set of challenge answers with a OFXAccessKey on the signon response. However, 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. This allows the server to determine the lifetime of the OFXAccessKey.

Note: If in the profile response SignOnMFAChallengeFirst is True, the client must send this MFA challenge request in the first connection with the server, before sending any other requests.

The following properties are populated as a result of parsing a successful response:

• ChallengeQuestions

Note: The Multi-Factor Authentication (MFA) is applicable only in OFXVersions: 1.0.3, 2.0.3, 2.1.0, and 2.1.1.

Reset Method (InEBank_FIProfile Class)

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

Object Oriented Interface

public function doReset();

Procedural Interface

inebank_fiprofile_do_reset($res);

Remarks

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

SendChallengeAnswers Method (InEBank_FIProfile Class)

Send the answers to challenge questions for a Multi-Factor Authentication (MFA).

Object Oriented Interface

public function doSendChallengeAnswers();

Procedural Interface

inebank_fiprofile_do_sendchallengeanswers($res);

Remarks

This function generates the Signon and Multi-Factor Authentication challenge questions request page, submits it to the financial institution via HTTP, receives the response, and parses it.

When sending requests to a FI, if the information in the signon request is correct, but it is not sufficient to authenticate the user, the server can reply with a signon error code of 3000, which indicates that the client must perform multi-factor challenge authentication before proceeding with future OFX requests.

When this error is returned, the user should call this RequestChallengeQuestions method, which request the server to send a list of challenge questions that must be correctly answered before the OFX client may proceed with further OFX requests.

Upon successful response, the server will return a list of challenge questions, stored to ChallengeQuestions, where each question is specified by ChallengeQuestionId and ChallengeQuestion. If the server does not return such list, the class will throw an HTTP 400 error.

The user should inspect the ChallengeQuestions. When this list of challenge questions is returned, then the user has to answer each question by setting the ChallengeAnswer for each ChallengeQuestion, and then call the SendChallengeAnswers method to send the answers back to the server. The class will include these answers within the signon request included as part of the next request message. If these answers are correct, the server will process the request file. If they are incorrect, the server will return an error code of 3001.

When MFA is required, to prevent servers from needing to authenticate the user with each OFX request, the server may respond to a correct set of challenge answers with a OFXAccessKey on the signon response. However, 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. This allows the server to determine the lifetime of the OFXAccessKey.

Note: If in the profile response SignOnMFAChallengeFirst is True, the client must send this MFA challenge request in the first connection with the server, before sending any other requests.

The following properties are populated as a result of parsing a successful response:

• ChallengeQuestions

Note: The Multi-Factor Authentication (MFA) is applicable only in OFXVersions: 1.0.3, 2.0.3, 2.1.0, and 2.1.1.

WriteOFXDataFile Method (InEBank_FIProfile Class)

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

Object Oriented Interface

public function doWriteOFXDataFile($filename);

Procedural Interface

inebank_fiprofile_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_FIProfile Class)

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

Object Oriented Interface

public function fireConnectionStatus($param);

Procedural Interface

inebank_fiprofile_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_FIProfile Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

inebank_fiprofile_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_FIProfile Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

inebank_fiprofile_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_FIProfile Class)

Shows the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

inebank_fiprofile_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 (FIProfile Class)

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

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

Trappable Errors (FIProfile Class)

OFX Errors

	2000   Required field missing from server response.
	2001   OFX server error. Description follows.
	2002   Invalid OFX response.
	2003   OFX response contains unknown element tags.

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

XML Errors

	101   Invalid attribute index.
	102   No attributes available.
	103   Invalid namespace index.
	104   No namespaces available.
	105   Invalid element index.
	106   No elements available.
	107   Attribute does not exist.
	201   Unbalanced element tag.
	202   Unknown element prefix (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.

HTTP Errors

	118   Firewall Error. Error description contains detailed message.
	143   Busy executing current method.
	151   HTTP protocol error. The error message has the server response.
	152   No server specified in URL
	153   Specified URLScheme is invalid.
	155   Range operation is not supported by server.
	156   Invalid cookie index (out of range).
	301   Interrupted.
	302   Can't open AttachedFile.

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

TCPClient Errors

	100   You cannot change the RemotePort at this time. A connection is in progress.
	101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
	102   The RemoteHost address is invalid (0.0.0.0).
	104   Already connected. If you want to reconnect, close the current connection first.
	106   You cannot change the LocalPort at this time. A connection is in progress.
	107   You cannot change the LocalHost at this time. A connection is in progress.
	112   You cannot change MaxLineLength at this time. A connection is in progress.
	116   RemotePort cannot be zero. Please specify a valid service port number.
	117   You cannot change the UseConnection option while the class is active.
	135   Operation would block.
	201   Timeout.
	211   Action impossible in control's present state.
	212   Action impossible while not connected.
	213   Action impossible while listening.
	301   Timeout.
	302   Could not open file.
	434   Unable to convert string to selected CodePage.
	1105   Already connecting. If you want to reconnect, close the current connection first.
	1117   You need to connect first.
	1119   You cannot change the LocalHost at this time. A connection is in progress.
	1120   Connection dropped by remote host.

SSL Errors

	270   Cannot load specified security library.
	271   Cannot open certificate store.
	272   Cannot find specified certificate.
	273   Cannot acquire security credentials.
	274   Cannot find certificate chain.
	275   Cannot verify certificate chain.
	276   Error during handshake.
	280   Error verifying certificate.
	281   Could not find client certificate.
	282   Could not find server certificate.
	283   Error encrypting data.
	284   Error decrypting data.

TCP/IP Errors

	10004   [10004] Interrupted system call.
	10009   [10009] Bad file number.
	10013   [10013] Access denied.
	10014   [10014] Bad address.
	10022   [10022] Invalid argument.
	10024   [10024] Too many open files.
	10035   [10035] Operation would block.
	10036   [10036] Operation now in progress.
	10037   [10037] Operation already in progress.
	10038   [10038] Socket operation on non-socket.
	10039   [10039] Destination address required.
	10040   [10040] Message too long.
	10041   [10041] Protocol wrong type for socket.
	10042   [10042] Bad protocol option.
	10043   [10043] Protocol not supported.
	10044   [10044] Socket type not supported.
	10045   [10045] Operation not supported on socket.
	10046   [10046] Protocol family not supported.
	10047   [10047] Address family not supported by protocol family.
	10048   [10048] Address already in use.
	10049   [10049] Can't assign requested address.
	10050   [10050] Network is down.
	10051   [10051] Network is unreachable.
	10052   [10052] Net dropped connection or reset.
	10053   [10053] Software caused connection abort.
	10054   [10054] Connection reset by peer.
	10055   [10055] No buffer space available.
	10056   [10056] Socket is already connected.
	10057   [10057] Socket is not connected.
	10058   [10058] Can't send after socket shutdown.
	10059   [10059] Too many references, can't splice.
	10060   [10060] Connection timed out.
	10061   [10061] Connection refused.
	10062   [10062] Too many levels of symbolic links.
	10063   [10063] File name too long.
	10064   [10064] Host is down.
	10065   [10065] No route to host.
	10066   [10066] Directory not empty
	10067   [10067] Too many processes.
	10068   [10068] Too many users.
	10069   [10069] Disc Quota Exceeded.
	10070   [10070] Stale NFS file handle.
	10071   [10071] Too many levels of remote in path.
	10091   [10091] Network subsystem is unavailable.
	10092   [10092] WINSOCK DLL Version out of range.
	10093   [10093] Winsock not loaded yet.
	11001   [11001] Host not found.
	11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	11004   [11004] Valid name, no data record (check DNS setup).