/Transmission/Batch/BusinessTransaction/FinancialTransaction XML Schema Model

Treasury :: Financial Management Service

Enterprise Data Architecture

Transmission Business Message

Element Information
Name	FinancialTransaction
Definition	The management of funds between a payer and payee for a specific business event.
Namespace	urn:us:gov:treas:fms:BusinessTransaction:v4.6
Cardinality	[0..unbounded]
Content Model	The <FinancialTransaction> element contains 13 children elements and has a multiple content model where there exists more than one content model (sequence, choice, all or some combination of these three content models). Please review the XML Schema document to fully understand the implications of the multiple content model.
Description	The <FinancialTransaction> element is a child element of the <BusinessTransaction> element. The <FinancialTransaction> element is the first element under the <BusinessTransaction> element and is an optional repeating (unbounded) element.

Attribute Name	Use	DataType	Definition
ID	[1..1]	String [0, 80]	An identifier for the record. For a receiving system, this value can be used to reconcile updates to an existing record and qualify new records. For a sending system, this value can be used to reconcile acknowledgements for the submitted records.
AgencyTransactionIdentifier	[0..1]	String [0, 80]	Identifier for a transaction (may not be unique), as provided by an agency.
SettlementTransactionIdentifier	[0..1]	String [0, 80]	Identifies a transaction (may not be unique) within a settlement service.
ChannelTransactionIdentifier	[0..1]	String [0, 80]	Identifies a transaction (may not be unique) within a channel application.
Status	[0..1]	Cancelled [The financial transaction has been cancelled before submission to the settlement mechanism.], Rejected [The financial transaction has been rejected by the settlement mechanism.], Retired [No more collection efforts will be initiated on the financial item and the agency is debited for the uncollected funds.], Settled [The financial transaction has been settled.], In-Process [The financial transaction has been delivered to the settlement mechanism but has not settled.], Received [The financial transaction has been submitted to the channel.], Unknown [The status of the financial transaction is not known.]	Identifies the status of a transaction; i.e., where it is in its lifecycle.
FinancialTransactionType	[0..1]	Adjustment [A financial transaction that represents a monetary adjustment to an existing transaction.], Chargeback [A card transaction where one or more items are returned.], Collection [A financial transaction that is the initial settlement of the payment.], Correction [A financial transaction that represents a change to classification and non-monetary information for an existing transaction.], Informational [A financial transaction that does not have a monetary accounting outcome.], Re-presentment [A financial transaction that is not the initial settlement of the payment.], Return/Reversal [A financial transaction where the payment was returned to the payer.], Unknown [Financial transactions of an unknown type.]	Standard transaction types which represent a high-level categorization of a financial transaction that is used to help identify what type of transaction activity the financial transaction represents.
PayerMechanism	[0..1]	Cash [Coin or paper currency.], Check, CreditCard, DebitCard, SVC [Stored Value Card], ACH [A transaction that takes place across the Automated Clearing House (ACH) Network.], BookEntry, Wire [A transaction done through the Federal Reserve Banks as a real-time electronic funds transfers.], EBT [Electronic Benefits Card]	Identifies the payment medium for the transaction.
IsCredit	[1..1]	1\|0	Indicates if the item is a debit or credit, for example, a value of '1' would mean that it is a 'credit'. If the attribute is not populated or not present in the XML instance document, then the default value is understood to be '0'.
IsTax	[0..1]	1\|0	Indicates if the item is a tax collection transaction. If the attribute is not populated or not present in the XML instance document, then the default value is understood to be '0'.
DepositDate	[0..1]	YYYY-MM-DD	The date that funds are credited to or debited from a Treasury account.
AgentTraceIdentifier	[0..1]	String [0, 80]	Identifier provided by the financial agent to support traceability through the collection lifecycle.
SettlementMechanism	[0..1]	Cash [Coin or paper currency.], Cash/Und Check, Book Entry, Check, ACH [A transaction that takes place across the Automated Clearing House (ACH) Network.], Wire [A transaction done through the Federal Reserve Banks as a real-time electronic funds transfers.], Card [A transaction using a Plastic Card settlement service.], SVC [Stored Value Card], NSS [Net Settlement Service], IAS [FRB Integrated Account System], Other	Identifies the mechanism by which a transaction is settled.
ReceiptMechanismCode	[0..1]	Cash [Coin or paper currency.], Cash/Und Check, Book Entry, Check, ACH [A transaction that takes place across the Automated Clearing House (ACH) Network.], Wire [A transaction done through the Federal Reserve Banks as a real-time electronic funds transfers.], Card [A transaction using a Plastic Card settlement service.], SVC [Stored Value Card], NSS [Net Settlement Service], IAS [FRB Integrated Account System], Other	The format of a financial instrument as received by a collections channel program.
ChannelType	[0..1]	OTC [Over The Counter], Mail [Mail], Internet [Electronic], Phone [Phone], Bank [Bank]	Refers to the general channel category through which FMS receives a transaction: OTC, mail, Internet, phone, and bank.
ReasonText	[0..1]	String [0, 80]	Description of the reason for the type of corrective or return transaction.
ReasonCode	[0..1]	String [0, 35]	Internal code to identify the reason for the type of corrective or return transaction.
GatewayReceiptDate	[0..1]	YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS[dateTime] and [date]	Indicates the date that a settlement gateway or provider receives financial data for processing.
SettlementStatusCode	[0..1]	String [3, 3]	The settlement status code reported by the Debit Gateway that identifies how the transaction was settled.
IsNonDomestic	[0..1]	1\|0	Indicates whether the entity or transaction is considered non domestic. For example, this value would be '1' if the transaction amount was originally tendered in a foreign currency. If the attribute is not populated or not present in the XML instance document, then the default value is understood to be '0'.
GroupIdentifier	[0..1]	String [0, 80]	A generated identifier used to link transactions within the same lifecycle.

For help, please contact the Treasury FMS Enterprise Data Architecture team.

Last Updated: 2011-05-31T21:19:17.33-04:00

This web site is informative only and may contain publishing errors/inconsistencies - please carefully review the appropriate XML Schema documents in the Download section.