TransactionDetail Type

This type corresponds to a single bank or credit card transaction in the list of transactions.

Remarks

TransactionDetail objects are used when listing bank or credit card transactions (if any) returned by the FI OFX server when the GetStatement, ReadOFXDataFile, or WriteOFXDataFile methods are called.

Fields

Aggregate
String

Wrapper for a bank transaction.

Each bank transaction aggregate contains data (elements and values) associated with the following fields:

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the class's fields. 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.

Amount
String

This is the amount of money exchanged during a given transaction.

Note: the financial institution usually returns amounts as a string that includes the sign (+/-) of the amount. However, the server may sometimes leave out a particular field if it is not required by the OFX specification. To avoid confusion that can be caused by returning integers, the class will return all amount types as a string, with the empty string ("") for fields not returned by the server.

Where there is a value returned by the server, the class will attempt to convert the string into a format that can be easily parsed into an integer value. This behavior can be controlled by the CurrencyFormat config setting. .

CheckNumber
String

The check number as found on the original check. Some stores that use electronic checks may put a randomly generated value in This field.

Date
String

This is the date the transaction was made by the account holder as recorded by the financial institution, stored as a string.

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: this field is optional. This is not applicable to loan accounts. If the server's response does not contain this information, querying this field will return an empty string.

DatePosted
String

This is the date the transaction was posted to the financial institution, stored as a string.

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.

Escrow
String

This is the total amount of payment applied to Escrow.

This is applicable to loan statements only.

Note: the financial institution usually returns amounts as a string that includes the sign (+/-) of the amount. However, the server may sometimes leave out a particular field if it is not required by the OFX specification. To avoid confusion that can be caused by returning integers, the class will return all amount types as a string, with the empty string ("") for fields not returned by the server.

Where there is a value returned by the server, the class will attempt to convert the string into a format that can be easily parsed into an integer value. This behavior can be controlled by the CurrencyFormat config setting. .

FITID
String

Transaction Id assigned by the financial institution.

This is a unique id number that the financial institution uses to identify a particular transaction. Its primary purpose is to allow a client to detect duplicate responses, whether the server previously downloaded the transaction.

ImageRef
String

Server specified unique identifier for the transaction image.

This can be either image identifier (to be used during the request to retrieve the actual image when the GetImage method is called) or URL, depending on the value of ImageRefType.

Note: This is not applicable for credit card accounts.

ImageRefType
String

Type of retrieval method for actual transaction image.

If ImageRef is returned in the response, this can be either image identifier (to be used during the request for the image when the GetImage method is called) or a URL.

Possible values for ImageRefType are:

Value Meaning
OPAQUE Requires the client to send a separate OFX request to access the image. The image can be retrieved by calling the GetImage method where ImageRef will be the parameter value for this method.
URL The image is accessed directly via the URL provided. The client will not provide authentication and will simply follow the URL provided.
FORMURL The image is accessed directly via an encoded URL. The client will send authentication to the server.

Note: This is not applicable for credit card accounts.

Interest
String

This is the amount of payment applied to Interest.

This is applicable to loan statements only.

Note: the financial institution usually returns amounts as a string that includes the sign (+/-) of the amount. However, the server may sometimes leave out a particular field if it is not required by the OFX specification. To avoid confusion that can be caused by returning integers, the class will return all amount types as a string, with the empty string ("") for fields not returned by the server.

Where there is a value returned by the server, the class will attempt to convert the string into a format that can be easily parsed into an integer value. This behavior can be controlled by the CurrencyFormat config setting. .

Memo
String

The memo field stores a notice from the payee to the customer as a string.

PayeeName
String

If This field has a value, the NAME element replaces the entire PAYEE aggregate in the request XML.

Principal
String

This is the amount of payment applied to Principal.

This is applicable to loan statements only.

Note: the financial institution usually returns amounts as a string that includes the sign (+/-) of the amount. However, the server may sometimes leave out a particular field if it is not required by the OFX specification. To avoid confusion that can be caused by returning integers, the class will return all amount types as a string, with the empty string ("") for fields not returned by the server.

Where there is a value returned by the server, the class will attempt to convert the string into a format that can be easily parsed into an integer value. This behavior can be controlled by the CurrencyFormat config setting. .

TxType
int

This is the type of transaction that was made on the account. The effect on the account balance depends upon the sign of the amount, not upon the value of this transaction.

For example, if the amount is negative and the type is a credit, a negative credit is applied to the account. If the amount is negative and the type is debit, the amount is still debited from the account. A positive amount indicates the addition of money to the account, regardless of the type.

The types and their meanings are as follows:

ttCredit (0)Generic credit
ttDebit (1)Generic debit
ttInterest (2)Interest earned or paid (note: depends on signage of amount)
ttDividend (3)Dividend
ttFIFee (4)FI fee
ttServiceCharge (5)Service charge
ttDeposit (6)Deposit
ttATM (7)ATM debit or credit (note: depends on signage of amount)
ttPointOfSale (8)Point of sale debit or credit (note: depends on signage of amount)
ttTransfer (9)Transfer
ttCheck (10)Check
ttPayment (11)Payment
ttCash (12)Cash withdrawal
ttDirectDeposit (13)Direct deposit
ttDirectDebit (14)Merchant initiated debit
ttRepeatPayment (15)Repeating payment/standing order
ttLateFee (16)Late Fee (note: applicable to loan accounts only)
ttAdvance (17)Cash Advance which adds to Principal Balance (note: applicable to loan accounts only)
ttBalloon (18)Payment of Balloon Amount (note: applicable to loan accounts only)
ttOther (255)Other (note: see Memo for a possible transaction description)

TypeDescription
String

A description of the transaction type. This is a string representation of the value returned by the TxType field.

The values translate as follows:

The types and their meanings are as follows:

ttCredit (0)Credit
ttDebit (1)Debit
ttInterest (2)Interest
ttDivident (3)Dividend
ttFIFee (4)FI Fee
ttServiceCharge (5)Service Charge
ttDeposit (6)Deposit
ttATM (7)ATM
ttPointOfSale (8)Point of Sale
ttTransfer (9)Transfer
ttCheck (10)Check
ttPayment (11)Payment
ttCash (12)Cash Withdrawal
ttDirectDeposit (13)Direct Deposit
ttDirectDebit (14)Direct Debit
ttRepeatPayment (15)Repeat Payment
ttLateFee (16)Late Fee (note: applicable to loan accounts only)
ttAdvance (17)Cash Advance which adds to Principal Balance (note: applicable to loan accounts only)
ttBalloon (18)Payment of Balloon Amount (note: applicable to loan accounts only)
ttOther (255)Other

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks OFX 2020 Java Edition - Version 20.0 [Build 7941]