Name | Tag | Definition
--- | --- | ---
ABA_Number | attribute | The ABA routing number consists of 9 digits, for example XXXXYYYYC where XXXX is Federal Reserve Routing Symbol, YYYY is ABA Institution Identifier, and C is the Check Digit. The first two digits of the nine digit ABA number must be in the ranges 00 through 12, 21 through 32, 61 through 72, or 80. The digits are assigned as follows: 00 is used by the United States Government; 01 through 12 are the normal routing numbers; 21 through 32 were assigned only to thrift institutions (e.g. credit unions and savings banks) through 1985, currently are still used by the thrift institutions, or their successors; 61 through 72 are used for electronic transactions; 80 is used for traveler's cheques. The first two digits correspond to the 12 Federal Reserve Banks. [reference: http://www.tfp.com/text/aba_policy.pdf]
Account | element | Account information for the trading partner, for example, the RDFI (Receiving Depository Financial Institution) Routing number, check digit, and account number.
AccountClassification | element | Identifies the Treasury Account information, for example, this would contain the TAS/BETC or CKey Name/Value.
AccountNumber | attribute | The bank account number.
AccountPartyID | attribute | Unique identifier for this account.
AccountPartyName | attribute | Name on face of credit card or bank account from which the funds will be drawn.
AccountSummary | element | This is a summary for multiple Business Transactions to replicate an SF 215/SF 5515.
Addenda | element | Addenda records will be used by the Originator to supply additional information about Entry Detail Records that will be passed from the ODFI through the ACH Operator to the RDFI.
Addendum | element | The container for all Addenda records associated with a financial transaction.
Address | element | Contains the address for the account.
AddressLine | element | Location for the address line.
Agency | element | Identifies the ALC (Agency Location Code) and other supporting data for example treasury account information like the TAS/BETC (Treasury Account Symbol/Business Event Type Code).
AgencyAccountID | attribute | For example, a Lockbox Number.
AgencyIdentifier | attribute | Agency Identifier of account owner. Used in conjunction with the main account code, the Agency Identifier represents the department, agency or establishment of the U.S. Government that is responsible for the TAS.
AgencyLocationCode | attribute | Identifies the accounting office within an agency that reports disbursements and collections to Treasury.
AgencyName | attribute | Name of the agency.
AgencyOffice | attribute | An office within the agency.
AgencySite | attribute | A site within the agency.
AllocationTransferAgencyIdentifier | attribute | The Agency Identifier of the agency receiving funds through an allocation transfer.
Amount | attribute | The transaction amount.
AvailabilityTypeCode | attribute | Identifies no-year accounts "X", clearing/suspense accounts "F", Treasury's central summary general ledger accounts "A", and merged-surplus accounts "M".
BankInfo | element | Identifies the bank information for the account.
BankName | attribute | The name of the financial institution.
Batch | element | Contains one or many Business Transactions.
BatchDate | attribute | The date for the batch.
BatchNumber | attribute | Container to further identify this batch record, for example, the Cash Link Account Number or LockBox Number.
BeginningPeriodOfAvailability | attribute | In annual and multi-year funds, identifies the first year of availability under law that an appropriation account may incur new obligations. - 4 digit year shall be (0000-9999). - If single/annual year account, it shall be the same value as the Ending Period of Availability. - Value not applicable for no-year "X" accounts, clearing/suspense "F" accounts, merged surplus "M" accounts, central summary general ledger "A" accounts, and unavailable receipt accounts, it shall be blank/spaces/empty. - if the BPOA is not blank then the EPOA cannot be blank. - if the EPOA is not blank then the BPOA cannot be blank. - if the BPOA is not blank, the BPOA must be equal to or less than the EPOA. (if the EPOA is not blank, the EPOA must be equal to or greater than the BPOA.) - if the BPOA and EPOA are blank, the AI must not be blank. - if the AI is not blank the BPOA and EPOA must be blank.
BranchCode | attribute | The branch code of the financial institution.
BusinessEventTypeCode | attribute | Identifies the type of activity (gross disbursement, offsetting collection, investment in Treasury securities, etc.) and the effect of a transaction on the FBWT. Is used in combination with the TAS to classify transactions reported to Treasury through all GWA-compliant FMS systems.
BusinessTransaction | element | Represents a single unit of work for a receivable, for example, a business transaction can contain multiple financial transaction records, or it may contain a single financial transaction record.
CardNumber | attribute | Contains the credit card or debit card number.
CardSecurityCode | attribute | The 3 or 4 digit value printed on the card or signature strip but not available on the magnetic strip. This is for future use for the Credit Card gateway.
CardType | attribute | The type of card used, for example, MC, VI, DI, AX.
CashFlowID | attribute | Identifies the cash flow channel and type of income, for example ALC+2.
CashFlowName | attribute | The CashFlow name assigned to the CashFlowID.
CashFlowType | attribute | Identifies the type of cash flow.
CashlinkAccountNumber | attribute | A CashLink assigned number identifying an account.
ChannelType | attribute | Identifies the source channel application.
CheckMediumType | attribute | Identifies the type of check.
CheckSerialNumber | attribute | This field contains the serial number of a check.
CheckType | attribute | Indicates whether the bank account is a checking or savings account.
City | element | Contains the name of the city.
Ckey | element | A C-KEY is an acronym for classification key which is a unique agency accounting code assigned to a transaction. Agencies will establish C-Keys in SAM for collection transactions that will be used to derive the appropriate values of TAS-BETC(s).
ClassName | attribute | The string that contains the actual CKey Name. For example, the CKey Name could be "Tax Class", and the CKey Values could be "01", "02", etc. Also, non case-sensitive uniqueness will be enforced. (Aa would be a duplicate of aA.)
ClassValue | attribute | The string that contains the actual CKey Value. Also, non case-sensitive uniqueness will be enforced. (Aa would be a duplicate of aA.)
Classification | element | Contains the amount(s) of the breakdown of the Account Classification.
Code | attribute | The transaction code, for example, indicates the standard entry class codes in an ACH transaction.
CoinAmount | attribute | Indicates the coin amount for the transaction.
Count | attribute | Indicates the number of items represented by this record.
Country | element | This code list module defines the enumerated types of standard 2-letter ISO 3166 country codes. For more information on ISO 3166 country codes, see the ISO site: http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html.
DepositDate | attribute | The business date that the payment instruction was received by a business channel. The date that the deposit is presented to a financial institution, for example TGANET. The date that an ACH or Check-21 item is physically entered in the payment stream.
DocumentLink | attribute | This URI refers to an online description of the error or warning that occurred.
EchoID | attribute | Identifies the unique original Transmission message level identifier.
EndingPeriodOfAvailability | attribute | In annual and multi-year funds, identifies the last year of funds availability under law that an appropriation account may incur new obligations.
EntryID | attribute | This field contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.
Error | element | Contains the error metadata fields.
ErrorCode | attribute | If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.
ErrorNode | attribute | The XPath notation to identify the location of the error/warning present in the instance document referenced by the EchoID attribute.
ErrorText | attribute | Provides a short text description of the error or warning.
Errors | element | Container for each Error item
FileName | attribute | The file name reference for the image.
FinancialInstitutionText | attribute | The text supplied by the financial institution, in addition to the agency supplied text.
FinancialTransaction | element | The transfer of funds between a payer and a payee for a given amount on a given day.
HasPrivacyData | attribute | User data contains Personally Identifying Information (PII). If the attribute is not populated or not present in the XML instance document, then the default value is understood to be "0".
ID | attribute | The unique identifier for the record.
Image | element | Contains either the front image or the back image.
InitialLocation | attribute | Initial location of the point of deposit.
InitiationDate | attribute | The date that the transaction was initiated, for example, the date that the lockbox opened up the payment.
InputSystem | attribute | Identifies the sending trading partner.
IsAgencySubmitted | attribute | Transactions are sent to FMS by either public or agencies. For instance, Pay.gov can receive a credit card authorization from an individual or it can receive this from an agency (after the agency has received if from an individual). If directly from an agency, then value is "1". If the attribute is not populated or not present in the XML instance document, then the default value is understood to be "0".
IsClearing | attribute | Indicates if collection of funds is drawn from this account, for example, a value of 1 indicates that this account is the clearing account and not the processing account. If the attribute is not populated or not present in the XML instance document, then the default value is understood to be "0".
IsCorporate | attribute | Indicates whether the account is a corporate account, for example, a value of 1 would mean that the account is a corporate account. If the attribute is not populated or not present in the XML instance document, then the default value is understood to be "0".
IsCredit | attribute | 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".
IsEndOfDay | attribute | Indicates if this transmission is the last transmission for the day. If the value is "1", then this transmission is the last transmission for the day. If the attribute is not populated or not present in the XML instance document, then the default value is understood to be "0".
IsFront | attribute | Indicates whether the data describes either the front or the back of the check. A "1" indicates the front and "0" indicates the back. If the attribute is not populated or not present in the XML instance document, then the default value is understood to be "0".
IsMICR_Overridden | attribute | Indicates if the MICR line was read to overwrite the account number and routing number. If the attribute is not populated or not present in the XML instance document, then the default value is understood to be "0".
IsNonAppropriated | attribute | Indicates non-appropriated fund. If the attribute is not populated or not present in the XML instance document, then the default value is understood to be "0".
IsNonDomestic | attribute | Indicates whether this entity is a US domestic entity, for example, this value would be "1" if the remitter address was an international address or the clearing financial institution was a non-US financial institution. If the attribute is not populated or not present in the XML instance document, then the default value is understood to be "0".
IsRecurring | attribute | Indicates if the item is a recurring debit. If the attribute is not populated or not present in the XML instance document, then the default value is understood to be "0".
IsTax | attribute | 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".
IsUpdate | attribute | Indicates if the item is an origination transaction or an update, for example, a value of "1" would mean that this is an update. If the attribute is not populated or not present in the XML instance document, then the default value is understood to be "0".
MICR_Line | attribute | A character recognition system using special ink and characters which can be magnetized and read automatically.
MainAccountCode | attribute | Identifies the type and purpose of the fund.
MerchantCategoryCode | attribute | Four-digit classification codes used to in the warning bullets, authorization, clearing and settlement systems to identify the type of Merchant Business in various stage of the transaction Processing.
MerchantNumber | attribute | This number is generated by a processor/acquirer and is specific to each individual merchant location. This number is used to identify the merchant.
MonthYearExpire | attribute | Indicates the month/year value of the expiration date.
OfficeLocationCode | attribute | A code assigned by the agency and will hold the ALC+2, ALC+4 data.
Offset | attribute | Indicates the positioning of the image.
OriginalCurrencyCode | attribute | This code list defines the enumerated types of standard 3-letter ISO 4217 currency codes. See the ISO site for an explanation of each code: http://www.iso.ch/iso/en/catsupport/maralist.html#4217. If the attribute is not populated and does not exist in the XML instance document, then the default will be understood to be "USD".
OriginatorCode | attribute | Unique code which identifies the source entity creating the transmission, for example, Public Debt Servicing Center.
PartyID_Prefix | attribute | Contains prepended additional data to identify the account party
PartyID_Suffix | attribute | Contains appended additional data to identify the account party
Payee | element | Person or organization receiving payment. For example, in a general collection, the payee is a federal government entity.
Payer | element | Identifies the point of first deposit for example, in a debit transaction, this would identify the person or organization submitting payment. For example, in a general collection, the payer can be a federal government or a non-federal government entity.
Payment | element | The financial amount of a transaction.
PaymentMedium | attribute | Identifies the payment medium for the transaction.
Plastic | element | Identifies the plastic card information for the account.
PostalCode | element | The postal code as managed by the USPS (United States Postal Service).
ProgramData | element | Container for non-financial data, for example, program data.
ProgramID | attribute | An identifier for the specific program within the agency.
ProgramName | attribute | The specific program name within the agency and can be associated to the ALC+2 (or CashFlow), for example.
ProgramType | attribute | A type category for the specific program within the agency.
ReferenceCode | attribute | The reference code for the data record.
ReferenceName | attribute | The reference name for the data record.
ReferenceNumber | attribute | The reference number for the data record.
ReferenceText | attribute | The reference description for the data record.
RunningDailyAmount | attribute | The cumulative absolute amount within a given day, for example, this is the total amount for all items sent so far on a given day including the items within this transmission.
RunningDailyCount | attribute | The running TotalCount for a given day, for example a day is determined from the end of day indicator of prior day to current end of day.
SequenceNumber | attribute | Indicates the number of transmissions submitted for given day.
SettlementDate | attribute | The anticipated date the funds will transfer (pre-settlement) or the date that the funds have been transferred (post-settlement).
SettlementMechanism | attribute | Identifies the settlement system that was used to complete this transaction.
SeverityLevel | attribute | This value represents the degree of error where the lowest number "1" is the highest degree of error (i.e. a fatal error) and "9" is the lowest degree of error.
State | element | The US state code as managed by the USPS (United States Postal Service).
Status | attribute | Identifies the transaction status.
Sub-accountCode | attribute | Identifies an available receipt or other Treasury-defined subdivision of the main account.
Sub-levelPrefixCode | attribute | The Sub-level Prefix (if populated) is a programmatic breakdown of the account for Treasury publication purposes.
SubType | attribute | The sub type of transaction, for example, indicates the sub type in a FedWire transaction.
Success | element | Conveys the successful receipt or validation of the inbound Transmission.
SuccessType | attribute | Indicates whether the succesful result of the inbound document was received or was validated. "Received" means that the server received the inbound document (no schema-validation or business-rules validation); "Validated" means that the server received the inbound document and that it passed schema-validation. The server relays a successful business-rules validation by the absence of Warning items or Error items.
SummaryDate | attribute | The date for the debit voucher or deposit ticket.
SummaryNumber | attribute | Contains the debit voucher or deposit ticket number.
TimeStamp | attribute | The timestamp of the transmission.
TotalAmount | attribute | Indicates the total absolute dollar amount of items.
TotalCount | attribute | Indicates the total number of items.
TraceNumber | attribute | The trace number for the transaction.
TransactionDate | attribute | The date that the customer either authorized or approved the payment to satisfy debt or pay for purchase or pay down from an appropriation account.
Transmission | element | A collection of a Batch of Business Transaction records.
TransmissionRs | element | Used to identify an application error by either text, code, or by an online description and also to give the status, tag, and/or identification of the record that may have caused the error.
TreasuryAccountSymbol | element | The TAS is an identification code assigned by Treasury, in collaboration with OMB and the owner agency, to an individual appropriation, receipt, or other fund account. (These accounts are defined in I TFM 2-1500.) The term "Treasury Account Symbol" is a generic term used to describe any one of the account identification codes assigned by Treasury. The term "Treasury Appropriation/Fund Symbol" (TAFS) is used to describe a particular type of TAS - one with budget authority. The terms TAS and TAFS are sometimes used synonymously. All financial transactions of the Federal government are classified by TAS for reporting to Treasury and OMB. The TAS should be derived from the internal fund code at the time of reporting. - Sub-level Prefix Code: a 2-character code that represents an account breakdown requested by an agency and approved and implemented by Treasury - Allocation transfer agency identifier: a 3-character code that identifies the agency receiving funds through an allocation transfer (if any) - Agency identifier: a 3-character code that identifies the agency that is responsible for the TAS - Beginning Period of Availability: a 4-character year that, in annual and multiyear accounts, identifies the first year of availability under law that an account may incur new obligations. - Ending Period of Availability: a 4-character year that, in annual and multiyear accounts, identifies the last year of availability under law that an account may incur new obligations. - Availability Type Code: Identifies no-year accounts (X), clearing/suspense accounts (F), Treasury central summary general ledger accounts (A), and merged-surplus accounts (M). - Main account code: a 4-character code that identifies the type and purpose of the fund - Sub-account code: a 3-character code that identifies a Treasury-defined subdivision of a TAS. Not all TAS elements contain all eight component elements. Receipt accounts, for example, generally consist of the owner agency identifier, the main account code, and a sub-account code. Appropriation and other fund accounts (expenditure accounts) consist of the owner agency identifier, the period of availability codes (beginning fiscal year and ending fiscal year), and the main account code. The Sub-level Prefix Code is used only when there is a unique need (requested by the agency) for a subclassification below the TAS.
Type | attribute | The type of transaction, for example, indicates the FedWire type for this record.
TypeCode | attribute | The Addenda Type Code defines the specific interpretation and format for the Addenda Information contained in the same record.
UserData | element | A single record of non-financial data, for example, a single user-defined data record.
Warning | element | Contains the warning metadata fields.
Warnings | element | Container for each Warning item