OFXBatchItem Type

This type corresponds to a single OFX batch item in the list of OFX batch items.

Remarks

OFXBatchItem objects are used when adding new items in the current OFX, or when listing OFX batch items (if any) returned by the FI OFX server (when the corresponding methods: PostRequest, ReadOFXDataFile, or WriteOFXDataFile are called).

Fields

Request
String

OFX request aggregate. The Request is obtained by setting it to a OFXRequest aggregate of a bean 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.

RequestType
String

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:


Value	Meaning
ACCTINFO	Account Information request
STMT	Bank Statement request
CCSTMT	Credit Card Statement request
LOANSTMT	Loan Statement request
INVSTMT	Investment Statement request
INTRA	Intrabank Transfer request (Note: This is subject to synchronization and should be followed by calling the SynchronizeTransfers; method in BankTransfer bean, depending on what was requested as part of the batch.)
INTER	Interbank Transfer request (Note: This is subject to synchronization and should be followed by calling the SynchronizeTransfers; method in BankTransfer bean, depending on what was requested as part of the batch.)
BILLPAY	Bill Payment request (Note: This is subject to synchronization and should be followed by calling the SynchronizePayments; and/or SynchronizePayees methods in BillPayment bean, depending on what was requested as part of the batch.)
PROF	FI Profile request

RequestUID
String

The current batch item's unique transaction ID.

The value in Response is parsed out of the server's response to the batch and matched to the appropriate original Request using by matching the response UID to the RequestUID.

Response
String

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

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 bean 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 bean are now populated and ready for retrieval.

Constructors

public OFXBatchItem();