FIMessageSet Type

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

• Name
• Language
• Recovery
• Refresh
• SecurityLevel
• ServiceProvider
• SignOnRealm
• SyncMode
• TransportSecurity
• URL
• Version

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

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.

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.

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

Name of a message set supported by the given FI.

Each Aggregate corresponds to a different OFX command. For example, SIGNONMSGSET corresponds to SignOn Request Message. The Name 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.

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

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.

Security level of the Message Set.

Legal values are defined as follows: "NONE" and "TYPE 1". If the SecurityLevel 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.

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.

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

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

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

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.

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

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.