Specification for CIR XML Extract Files

(XML Schema Version 5.0.1)

October 11, 2016

Version 2.01

CIR Program Office

Bureau of the Fiscal Service 

401 14th Street SW, 

Washington, DC 20227
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page ii

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

Table of Contents

1. REVISION HISTORY........................................................................................................................4

2. INTRODUCTION ..............................................................................................................................5

2.1 Scope of this Document ..............................................................................................................5

2.2 Intended Audience ......................................................................................................................5

2.3 Related Documents.....................................................................................................................6

2.3.1 General Terms .........................................................................................................................6

2.3.2 Data Terms ............................................................................................................................12

3. OVERVIEW OF THE COLLECTIONS INFORMATION REPOSITORY (CIR) ..............................15

3.1 What Is CIR and What Will It Do?.............................................................................................15

3.2 Availability of Data in CIR..........................................................................................................15

3.3 CIR Collections Data Flow ........................................................................................................18

3.4 Reports vs. Extract Files ...........................................................................................................19

3.4.1 Reports...................................................................................................................................19

3.4.2 Extract Files (XML File Transmission) ...................................................................................19

4. SECURITY/USER ACCESS ..........................................................................................................21

4.1 Roles/Functions ........................................................................................................................21

4.2 ALC Security .............................................................................................................................21

4.3 Personally Identifiable Information (PII) ....................................................................................21

5. EXTRACT FILE GENERATION.....................................................................................................22

5.1 Schedule ...................................................................................................................................22

5.2 Data Selection...........................................................................................................................23

6. RECEIVING AN EXTRACT FILE...................................................................................................24

6.1 Downloading Extract Files using the CIR Application...............................................................24

6.2 Automatic Delivery of Extract Files ...........................................................................................24

7. EXTRACT FILE SPECIFICATION .................................................................................................25

7.1 Understanding this Specification Section..................................................................................25

7.2 Global Formatting Details..........................................................................................................25

7.3 Using the Specification Document ............................................................................................26

7.4 EDA Schema.............................................................................................................................26

7.5 CIR TRS Trading Partner Agreement Schema * ......................................................................29

7.6 Summary Only Specification .....................................................................................................30

7.7 Detail Only Specification ...........................................................................................................37

7.8 Summary and Detail Specification ............................................................................................49

7.9 Attribute Definition.....................................................................................................................61

8. TIPS/HINTS FOR CREATING AND PROCESSING XML EXTRACTS ........................................90

8.1 Recommendations when Creating XML Extract Definitions .....................................................90

8.2 Special Characters....................................................................................................................91

9. CUSTOMER SERVICE ..................................................................................................................92

10. APPENDIX A: FEDWIRE TAG NAMES ........................................................................................93

11. APPENDIX B: ACH REASON CODES .........................................................................................98
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page iii

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

12. APPENDIX C: SAMPLE FILES ...................................................................................................101

Table of Figures

Figure 1: CIR Data Model .........................................................................................................................14

Figure 2: Collections Data Flow ................................................................................................................18

Figure 3: Current Business Message Listing from EDA Website .............................................................27

Figure 4: Schema List from EDA Web Site...............................................................................................28

Figure 5: EDA Schema v5.0.1 - Picture for Summary Only Extract .........................................................31

Figure 6: EDA Schema v5.0.1 - Picture for Detail Only ............................................................................38

Figure 7: EDA Schema v5.0.1 - Picture for Summary and Detail.............................................................50

Table of Tables

Table 1: Revision History ............................................................................................................................4

Table 2: Table of Terms..............................................................................................................................6

Table 3: Table of CIR Data Entities ..........................................................................................................13

Table 4: Overview of STP Provided Data .................................................................................................16

Table 5: Overview of STP Provided Data with Associated File Profiles ...................................................16

Table 6: PII Data .......................................................................................................................................21

Table 7: CIR Processing Schedule for Creating Extract Files ..................................................................22

Table 8: Example of an Extract Type Specification Table showing Elements and Attributes ..................25

Table 9: Elements and Attributes for Summary Only Extract ...................................................................32

Table 10: Elements and Attributes for Detail Only Extract........................................................................39

Table 11: Elements and Attributes for Summary and Detail Extract.........................................................51

Table 12: Dictionary of Attributes..............................................................................................................61

Table 13: FedWire Tag Names and Message Data Element Names.......................................................93

Table 14: NACHA Reason Codes and Descriptions.................................................................................98
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 4

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

1. Revision History

Table 1: Revision History

Revision

Number Revision Date Change Requested (Description)

V 0.02 October 22, 2014 Internal draft

V 0.03 November 12, 2014 Internal draft, updated attribute listing

V 0.04 November 24, 2014 Incorporated Fiscal Service feedback.

Table 12 Dictionary of Attributes: Changed "TRS" to "CIR" for the 

CollRpt/IptSysTxt

Appendix C: Changed "TRS" to "CIR" and updated sample XML.

V 1.00 November 24, 2014 Promoted to Final Version 1.00

V 1.01 June 30, 2015 Updated hyperlinks and screenshots for the EDA Fiscal Service 

XML 5.0.1 Schema following Fiscal Service domain name 

changes. 

Table 7 – CIR Processing Schedule for Creating Extract Files to 

add PayPal as STP EOD eligible. 

Added SVC and DVS to the lists of STP-Provided Data (Tables 4 

and 5).

V1.02 July 15, 2015, 

July 20, 2015

Updated Table 2 – Table of Terms to align with the CIR Glossary.

Updated Figure 2 – Collections Data Flow to include DVS. 

Updated Table 12 – Dictionary of Attributes for SVC and DVS.

V2.00 July 24, 2015 Incorporated Fiscal Service feedback. Promoted to Version 2.00.

V2.01 October 11, 2016 CIR Contact information updated
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 5

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

2. Introduction

The Collections Information Repository (CIR) XML Extract Files process provides the ability for a user or 

system to receive an extract of all voucher and detail transaction data within a predefined file format. The 

primary use of these extracts is for system-to-system interfaces where the data will be imported into an 

agency system or other Receiving Trading Partner's (RTP) system.

The purpose of the XML Extract Files Specification is to provide a document that allows the members of 

the Information Technology (IT) staff to understand and process the output that is produced as a result of 

an agency or other RTP user defining a scheduled extract within CIR.

CIR is required to utilize the standard Bureau of the Fiscal Service (Fiscal Service) XML Schema format 

for receiving and sending collection data. The schema is developed and managed by Fiscal Service. The 

first iteration of XML extract files used version 4.3 of the Fiscal Service XML Schema. This iteration of 

XML extract files uses version 5.0.1 of the Fiscal Service XML Schema which can be accessed from the 

following website: https://www.fiscal.treasury.gov/data/. This specification document assumes that 

agencies will also access this site for detailed schema information.

2.1 Scope of this Document

Agencies have the capability to define three different extract types with different frequencies and selection 

criteria in CIR. The three extract types are:

 Summary Only – Only voucher-level information is extracted

 Detail Only – Only individual collection transaction-level information is extracted (credit 

card transactions, wires, ACH transactions). Supports extracting detail transactions 

types and statuses that may not be associated to vouchers.

 Summary and Detail – Voucher-level information along with any associated detail 

transactions is extracted. If no associated detail transactions are available, only voucherlevel information will be provided.

Each of these three types has a single extract format. Within the extract definition, selection criteria can 

be used to determine which instances of data are selected. 

The specification for each extract type is defined in this document. Since CIR was developed as a series 

of projects, it should be expected that as interfaces and data migration with Sending Trading Partners 

(STPs) occurs, additional information will be available in the extract file, and this specification will be 

updated. Primarily these changes are expected to be in Section 7.9 Attribute Definition, where additional 

metadata is provided that describes the specific meaning of a field for a particular STP. In this way the 

extract specification will evolve as more data is received into CIR.

2.2 Intended Audience

The intended users of this document are the technical staff at the Federal Agencies, Fiscal Service, and 

Financial Institutions who are using CIR. Since these extract files are intended primarily for system-tosystem use because of the need to process the XML, this document should allow the members of the 

Information Technology (IT) staff to develop software to process the XML extract produced by CIR.

It is also expected that users of this document have a basic understanding of the CIR application, or have 

access to the CIR web site to obtain further information.
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 6

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

2.3 Related Documents

 CIR Application (https://www.cir.fiscal.treasury.gov/). 

From the home page, click "File Transmissions" for information on XML extracts, 

sample files, and links to additional resources, including the document titled "Fiscal 

Service XML Schema Version 5.0.1 In Plain Language".

 Fiscal Service EDA website (https://www.fiscal.treasury.gov/data/) – Provides detailed 

documentation on the current and the archived schemas.

 CIR website (https://www.fiscal.treasury.gov/fsservices/gov/rvnColl/cir/rvnColl_cir.htm) –

Provides an overview, common questions, and general information on CIR.

 Definitions, Abbreviations, and Acronyms

2.3.1 General Terms

The table below displays the terms referenced in this document. 

Table 2: Table of Terms

Term Definition

ACH Automated Clearing House Network – A nationwide batch-oriented electronic funds 

transfer system that provides for the inter-bank clearing of electronic payments for 

participating depository financial institutions. ACH is also the value used as the Financial 

Mechanism on transactions that take place on this network.

ACR or A/C/R Adjustment Correction Rescission. See CIR Adjustments.

ALC Agency Location Code – A numeric symbol used to identify an agency accounting 

location or regional financial office on accounting reports and documents. The ALC 

consists of an eight-digit agency accounting station, a four-digit disbursing office symbol, 

or a three-digit Treasury Financial Center symbol. An ALC is also a data type within CIR

and is used to restrict access to data secured by an ALC.

BETC Business Event Type Code – An eight-character code used in the CARS (formerly GWA 

or the Governmentwide Accounting system) to indicate the type of activity being reported, 

such as payments, collections, and borrowings.

BMS Bank Management Service – A Fiscal Service program that provides compensation to 

depository institutions for processing transactions and provides services in connection 

with government payments and collections. BMS is a sub-system of the FRB system 

called Central Accounts Receivable System (CARS). See CARS (BMS).

BO Business Objects – Commercial off-the-shelf software used by CIR to facilitate report 

creation.

Bureau of the Fiscal

Service

(Formally Financial Management Service – FMS) – aka Fiscal Service – A bureau of the 

United States Department of the Treasury that provides central payment services to 

federal agencies, operates the Federal Government’s collections and deposit systems, 

provides governmentwide accounting and reporting services, and manages the collection 

of delinquent debt owed to the government. Bureau of Fiscal Service also supports 

Federal Agencies’ financial management improvement efforts in the areas of education, 

consulting, and accounting operations

Business Date The Business Date represents the date used to identify the CIR Business Cycle 

associated to transmissions received from Sending Trading Partners (STPs). Based on 

business logic, either the Online Process Date or the Batch Process Date is used to set 

the business date on each input transaction received into CIR.

CAFE Central Accounting Front-End System – A Fiscal Service system that captures data files 

from source systems and directs them to either STAR or CARS. STAR was retired March 

2015 and CARS became the system of record, so all data is now sent only to 

GWA/CARS. CAFE receives data from CIR.

CA$HLINK II A decommissioned Fiscal Service system that used to manage the collection of U.S. 
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 7

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

Term Definition

government funds throughout the world and to provide deposit information to federal 

agencies.

Card Acquiring Service A Fiscal Service program, formerly referred to as the Plastic Card Network (PCN), 

through which Fiscal Service collects obligations via credit or debit card transactions. 

Card Acquiring Service sends data to CIR. It receives transactions for card settlement 

from Pay.gov and directly from other external sources. Transactions from Pay.gov are 

reported in CIR with a Collection System/Reporting Program of Pay.gov. All other 

transactions are reported with a Collection System/Reporting Program of Card Acquiring 

Service.

CARS (BMS) CARS is the Federal Reserve’s Customer Accounts Receivables System. BMS is the 

Bank Management Service and is a module of CARS. (CARS is also the acronym for the 

Central Accounting Reporting System, a separate system.) 

Customer Accounts Receivable System/Bank Management Service (CARS/BMS) is a 

system for financial institutions to report monthly expenses incurred to compensate them 

for providing depositary services to support the Treasury’s General Account (TGA) 

program. BMS is also a tool for Fiscal Service analysts and program managers to review 

those expenses every month and to approve those expenses online in order to 

compensate the depositaries accurately and in a timely manner.

CARS (GWA) Central Accounting Reporting System – (formerly known as Govemmentwide Accounting 

– GWA) provides the central/financial accounting and reporting infrastructure for federal 

payments, claims, collections, central accounts and other financial transactions such as 

budget execution, accountability, and cash/other asset management. This includes the 

collection and dissemination of financial management and accounting information from 

and to federal program agencies. This infrastructure results in the accumulations of 

governmentwide financial information and the publication and release of various Treasury 

reports.

For more information, see 

http://www.fiscal.treasury.gov/fsservices/gov/acctg/cars/cars_home.htm.

CAS See Card Acquiring Service

CASH TRACK A Fiscal Service system that supports the cash forecasting business line.

CCMM Collections and Cash Management Modernization – A comprehensive, multi-year effort to 

streamline, modernize, and improve the processes and systems supporting Fiscal 

Service’s and Treasury’s collections and cash management programs. CCMM is a top 

strategic priority at Fiscal Service and in Treasury’s Office of the Fiscal Assistant 

Secretary.

CGAC Common Governmentwide Accounting Classification – A uniform structure and set of 

definitions for classifying the financial effects of government business activities.

Channel Delivery method used by a remitter to initiate payment to an agency. Channel identifies 

the original point of payment initiation, the first interface between the end 

consumer/citizen and the government. Payment channels include mail, over the counter, 

internet, and bank. 

Chargeback A chargeback is the return of funds to a consumer, forcibly initiated by the consumer's 

issuing bank. Specifically, it is the reversal of a prior outbound transfer of funds from a 

consumer's bank account or line of credit. Chargebacks apply mainly to plastic card 

transactions when a credit cardholder initiates a refund for a purchase made on their 

credit card.

C-Key Classification Key – A unique agency accounting code assigned to a transaction. 

Agencies will establish C-Keys in the Shared Accounting Module (SAM) for collection 

transactions that will be used to derive the appropriate values of Treasury Account 

Symbol (TAS)/Business Event Type Code (BETC).

CIR Collections Information Repository – (formerly Transaction Reporting System – TRS) - is 

the Fiscal Service transaction broker, data warehouse, and reporting solution that 

provides trading partners and Fiscal Service with the primary source of all financial 

transaction information across all collection systems.
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 8

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

Term Definition

It is used by Federal Program Agencies (FPAs) to support reporting of revenue. CIR 

contains detailed and summarized records of revenue collections transactions processed 

by the Bureau of the Fiscal Service. CIR standardizes and optimizes the data it receives 

for both reporting and business analytics. Data flows to CIR from multiple collections 

systems. 

The collections systems receive and process FPAs’ collections and send deposit and 

detailed transaction information to CIR so that FPAs can view, access, or download the 

information.

CIR sends information to Federal Program Agencies (FPAs), the Central Accounting 

Reporting System (CARS), the Treasury Cash Management System (TCMS), the Bank 

Management System (BMS), and Cash Forecasting.

Payment information is handled by the Payment Information Repository (PIR).

CIR Adjustments CIR accepts adjustments, corrections, and rescissions (A/C/Rs) from Sending Trading 

Partners (STPs) using normal file processing. When STPs cannot use regular 

processing, they can enter A/C/Rs directly into CIR using a manual process. See ACR or 

A/C/R. 

CLOB Character Large Object - an Oracle data type that can hold up to 4 gigabytes of text. 

Connect:Direct Communications software used to connect the CIR network to the networks of the 

collection systems and Federal Program Agencies.

COTS Commercial off-the-shelf – COTS is a term for software or hardware products that are 

ready-made and available for sale, lease, or license to the general public. They are often 

used as alternatives to in-house developments or one-off government-funded 

developments (GOTS). The use of COTS is being mandated across many government 

and business programs, as they may offer significant savings in procurement and 

maintenance.

Credit Gateway A Fiscal Service settlement gateway that will receive all incoming wire transfers and ACH 

credit payments to the Federal government. The Credit Gateway interfaces directly with 

Federal Reserve Bank systems to process transactions. As collections are processed by 

the Credit Gateway, detail transaction information is sent in real time to Fiscal Service 

reporting systems, namely the Collections Information Repository (CIR). Legacy system 

payments will be migrated to the Credit Gateway including the Fedwire Deposit System 

(FDS) and the Remittance Express (REX) application, the Federal Reserve Electronic 

Tax Application (FR-ETA) and electronic lockboxes from the General Lockbox Network 

(GLN). The final migration will include ACH credit payments associated with the 

Electronic Federal Tax Payment System (EFTPS). The Credit Gateway sends data to 

CIR.

Credit Gateway Fedwire The specific interface between USBank's Credit Gateway and CIR for the transmission of 

Fedwire transactions.

CSV Comma Separated Values – CSV is a file format where each value in the file is separated 

from the next by using a comma.

DDA Demand Deposit Account - An account from which deposited funds can be withdrawn at 

any time without any notice to the depository institution. For lockbox processing, this is an 

account maintained by the Treasury at the Lockbox Depositary for crediting agencies for 

lockbox deposits.

Debit Gateway Debit Gateway is a settlement gateway that settles transactions from the over-thecounter, mail, phone, and Internet collection channels for check and ACH preauthorized 

Debits. After settlement, the Debit Gateway sends the settlement activity reports back to 

the channels and to FRB CA$H-LINK. Channels and FRB CA$H-LINK send information 

to CIR. 

Legacy system payments have been migrated to the new gateway, including Pay.gov 

(non-tax electronic payment portal), Electronic Check Processing (ECP) Paper Check 

Conversion Over the Counter (PCC OTC, now OTCnet echeck). Current channel 

programs supported by Debit Gateway: Pay.gov, ECP, OTCnet (check capture), Agency 

Direct.
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 9

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

Term Definition

Deposit Information Information regarding funds credited or debited to a Treasury account. Is also known as a 

voucher/deposit ticket/debit voucher.

Deposit Information 

(Summary)

A summarized record of financial transactions for a particular agency. Is also known as a 

voucher/deposit ticket/debit voucher.

DT or DTN Deposit Ticket Number, also known as voucher.

DV or DVN Debit Voucher Number, also known as voucher.

DVS Direct Voucher System – This system will replace the functionality provided by the CIR 

STP Voucher Reporting GUI that channel applications can use to enter summary voucher 

information into CIR. High level functionality includes but is not limited to: manual and 

assisted A/C/R functionality, support of GWA classification, voucher entering, inquiring, 

and reporting and search and view capabilities.

EagleCash EagleCash is a cash management tool designed to support U.S. military personnel 

deployed in combat zones and on peace-keeping missions. EagleCash cards are a type 

of payment card referred to as Stored Value Cards (SVC)

ECP Electronic Check Processing – A Fiscal Service centralized check-clearing, report inquiry, 

and retrieval mechanism program as well as an imaging archive solution program. ECP 

interfaces with lockbox financial agents to electronically clear paper checks. ECP sends 

data to CIR.

EDA Enterprise Data Architecture – Refers to the Fiscal Service team that serves as Fiscal 

Service's central focal point, consultant, and technical advisor on matters and issues 

related to data exchange, data administration and data standards.

EFTPS The Electronic Federal Tax Payment System (EFTPS) is a free service from the U.S. 

Department of the Treasury. Since it began in 1996, millions of businesses, individuals, 

federal agencies, tax professionals, and payroll services have used EFTPS. All federal 

taxes can be paid using EFTPS using the EFTPS Web site, a voice response system, or 

special channels designed for tax professionals, payroll services, and financial 

institutions. EFTPS sends data to CIR.

Enterprise Architecture A conceptual blueprint that defines the structure and operation of an organization. The 

intent of enterprise architecture is to determine how an organization can most effectively 

achieve its current and future objectives.

EPA (NACHA) The Electronic Payments Association, formerly the National Automated Clearing House 

Association (NACHA), is an organization that develops electronic solutions to improve the 

ACH payment system in the United States. NACHA develops operating rules and 

business practices for the Automated Clearing House (ACH) Network and for electronic 

payments in the areas of Internet commerce, electronic bill presentment and payment 

(EBPP), electronic invoice presentment and payment (EIPP), e-checks, financial 

electronic data interchange (EDI), international payments, and electronic benefit transfer 

(EBT). See NACHA.

EZpay EZpay is a cash management tool designed to support U.S. military personnel training in 

the Army, Air Force, and Marines. EZpay cards are a type of payment card referred to as 

Stored Value Cards (SVC).

FDS Fedwire Deposit System – Decommissioned wire transfer collection system whereby 

remitters can instruct their banks to transfer payments by the Federal Reserve 

Communications System to Treasury's main account at the Federal Reserve Bank of New 

York. System was replaced by Credit Gateway Fedwire.

Fedwire A nationwide program offered by the Federal Reserve Banks to provide real-time 

electronic funds transfers.

Financial Agent A financial institution designated by the Secretary of the Treasury as a depositary and 

financial agent of the US Government. A designated financial agent of Fiscal Service

provides financial services to Federal Program Agencies and the public. A depositary 

agent is specifically authorized to accept deposits of public money. 

Financial Transaction Represents a financial instrument used for payment. A financial transaction may be 

equivalent to a single check or credit card payment. 

Fiscal Service See Bureau of the Fiscal Service.
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 10

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

Term Definition

FMS Financial Management Service - A bureau of the United States Department of the 

Treasury that provides central payment services to federal agencies, operates the 

Federal Government's collections and deposit systems, provides governmentwide 

accounting and reporting services, and manages the collection of delinquent debt owed to

the government. Fiscal Service also supports Federal Agencies' financial management 

improvement efforts in the areas of education, consulting, and accounting operations. 

Currently called Bureau of the Fiscal Service, or Fiscal Service.

FPA Federal Program Agency – A permanent or semi-permanent organization of government 

that is responsible for the oversight and administration of specific functions.

FRB Federal Reserve Bank – The Federal Reserve System (also the Federal Reserve; 

informally The Fed) is the central banking system of the United States.

FRB CA$H-LINK FRB CA$H-LINK is the system for non-commercial funds settled and concentrated 

through the Federal Reserve. FRB CA$H-LINK provides CIR with 2 files. The 

reconciliation file is based on voucher-level information that Sending Trading Partners 

(STPs) and Gateways send to FRB CA$H-LINK, which then sends the information to CIR. 

CIR matches this information with vouchers received from the STPs and creates 

notifications when there is a non-match. CIR now always uses the voucher information 

reported by the STP and the FRB CL Reconciliation data file is for informational purposes 

only. The second file is the Miscellaneous file which contains other transactions reported 

thru FRB CA$H-LINK, not reported on any other input into CIR. These transactions are in 

the process of moving to directly report to CIR, or to report through DVS.

GWA Governmentwide Accounting – GWA – The Assistant Commissioner area responsible for 

the maintenance of the federal government’s set of accounts and accounting data. See 

also CARS above (CARS is the system of record for the government’s financial data. 

Along with GTAS, CARS is a system under the GWA area.)

GWA Classifications Breakdown of funds collected by Treasury Account Symbol (TAS)/Business Event Type 

Code (BETC) or C-Key for reporting to CARS, formerly called Governmentwide 

Accounting (GWA).

ISO International Organization for Standardization - ISO is the organization responsible for the 

ISO 9000, ISO 14000, ISO 27000, ISO 22000 and other international management 

standards.

IT Information Technology

Lockbox A service offered by banks to organizations in which the organization receives payments 

by mail to a post office box, and the bank picks up the payments several times a day, 

deposits them into the organization’s account, and notifies them of the deposit.

NACHA The Electronic Payments Association, formerly the National Automated Clearing House 

Association, is an organization that develops electronic solutions to improve the ACH 

payment system in the United States. NACHA develops operating rules and business 

practices for the Automated Clearing House (ACH) Network and for electronic payments 

in the areas of Internet commerce, electronic bill presentment and payment (EBPP), 

electronic invoice presentment and payment (EIPP), e-checks, financial electronic data 

interchange (EDI), international payments, and electronic benefit transfer (EBT). It is also 

used to refer to the standard record format for processing ACH payments (NACHA 

format) which is documented in the NACHA standards. See EPA (NACHA).

Navy Cash Navy Cash/Marine Cash was developed in partnership with DFAS, the U. S. Navy and 

Marine Corps, and the Department of the Treasury. All personnel permanently assigned 

to a ship are eligible to receive a Navy Cash/Marine Cash card. The Navy Cash/Marine 

Cash card is a branded debit card that looks like a typical debit or check card.

OPS CIR Operations - The Operations center that manages the day-to-day operations of the 

CIR Product in the Production Environment. This term can refer to the actual Operations 

center, employees of this center, or the CIR security community.

OTC Over the Counter – OTC collections describes those funds that are received directly from 

the general public or other remitters by Federal Program Agencies. 

OTCnet A Fiscal Service program that serves as a channel application for all OTC transactions. It 
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 11

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

Term Definition

enables federal Agencies to integrate check capture and deposit reporting activities, 

consolidating management of all check and cash deposits through one Web-based 

application. OTCnet sends check capture and TGA data to CIR. There is an offline check 

capture capability for agencies operating in locations where internet connectivity and 

bandwidth are intermittent or unavailable.

OTCnet-CHK Also referred to as OTCnet electronic check (echeck). One of two types of data sent by 

OTCnet to CIR. Voucher and detailed transaction information is sent to CIR. This 

represents collection activity reported through OTCnet channel application for personal 

and business checks that have been converted to electronic funds transfers. OTCnetCHK replaced the PCC OTC program.

OTCnet-TGA Also referred to as OTCnet Bank Deposit. One of two types of data sent by OTCnet to 

CIR. Only Voucher information is sent to CIR. This represents collection activity 

processed through a TGA Bank and reported through the OTCnet channel application.

PATAX/TIP Paper Tax System/Treasury Investment Program – A decommissioned Fiscal Service 

system that collected, adjusted, and reported on advices of credit that represented paper 

federal tax deposits in commercial financial institutions.

Pay.gov A secure government-wide collections portal providing the ability to complete forms, make 

payments, and submit queries 24 hours a day electronically. Customers can access their 

accounts from any computer with Internet access and can authorize electronic transaction 

funds transfers over the Internet that can be settled through a number of methods 

(Automated Clearing House (ACH), credit card, debit card, or Digital Wallet). Pay.gov 

sends data to CIR.

PCC OTC Paper Check Conversion Over the Counter – A decommissioned Fiscal Service program 

which converted personal and business checks into electronic funds transfers. This 

program has been replaced by OTCnet echecks.

PDF Portable Document Format 

PII Personally Identifiable Information – PII is any information about an individual maintained 

by an agency, including, but not limited to, education, financial transactions, medical 

history, and criminal or employment history and information which can be used to 

distinguish or trace an individual's identity, such as their name, social security number, 

date and place of birth, mother's maiden name, biometric records, etc., including any 

other personal information which is linked or linkable to an individual. 

Program Data Unstructured agency-specific data associated with collections. Typically, it includes 

remittance information posted to receivables. Program data is all business data 

associated with a collection transaction that is not explicitly defined. It is also known as 

“user data”, “form data” and “remittance data”. Program data is not required to settle the 

transaction in the banking arena, but it is vital for the Federal agencies administering the 

program under which the revenue is collected. Program data is expected to be highly 

variable in both format and content. A user must have the authority to view Personally 

Identifiable Information (PII) in CIR in order to view program data.

RTP Receiving Trading Partner - A system that receives data from CIR.

SAM Shared Accounting Module – A Fiscal Service program that allows agencies to classify all 

Fund Balance with Treasury transactions and adjustments to the appropriate Treasury 

Account Symbol (TAS) and Business Event Type code (BETC) at the time the 

transactions or adjustments are reported to the Treasury by assisting CARS (GWA) in 

classifying financial transactions as they occur. SAM provides CIR with supporting 

reference data (ALC information and ABA information). It is considered as the single 

source for Enterprise Reference Data to government agencies and Treasury applications.

Settlement The discharge of financial obligations with respect to a funds transfer between two or 

more parties.

STAR The Federal government's legacy central accounting system, operated by Fiscal Service, 

decommissioned in March 2015. 

Stored Value Card See SVC

STP Sending Trading Partner – A system that provides data to CIR.
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 12

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

Term Definition

SVC Stored Value Card – A Fiscal Service program in which a plastic smart card represents 

money on deposit with the issuer and functions similarly to a debit card. The card’s 

embedded computer chip contains the electronic value. The technology eliminates coin, 

currency, scrip, vouchers, money orders, and other labor-intensive payment mechanisms 

in closed government locations, such as military bases and ships at sea. The stored value 

card programs Eagle Cash, EZPay (U.S. Army, Air Force, and Marines), and Navy Cash 

(U.S. Navy) send data to CIR. EagleCash supports U.S. military personnel deployed in 

combat zones and on peace-keeping missions. EZPay supports U.S. military personnel 

training in the Army, Air Force, and Marines. NavyCash supports U.S. military personnel 

permanently assigned to a ship.

TAS Treasury Account Symbol – Receipt, appropriation, expenditure and other fund account 

symbols and titles as assigned by the Department of the Treasury and Office of 

Management and Budget that identify a specific Treasury account.

TCMS Treasury Cash Management System – A Fiscal Service program that provides federal 

cash concentration services for all deposits reported/processed through Treasury, 

settlement of all inflows and outflows affecting the Treasury's General Account, and cash 

accounting and reporting functions. TCMS receives data from CIR. Financial institutions 

must use the Federal Reserve Bank’s National Settlement Service (NSS) for all Cash 

Concentration transfers.

TGAnet Treasury General Account Deposit Reporting Network – This program was superseded 

by OTCnet. 

TPA CIR Trading Partner Agreement - TPA represents CIR-specific Trading Partner 

Extensions (TPE). The TPA acts as a CIR-defined subschema within the Fiscal Service 

Transaction Schema and is always defined as part of an instance of TPE. Starting with 

XML Schema version 5.0.1 there is no TPE/TPA defined.

TPE Trading Partner Extension – TPE is a generic container for non-financial data, for 

example, program data that can be used with various entities as defined in the Fiscal 

Service Transaction Schema.

TRS See CIR.

Voucher A summary record that represents a grouping of detailed financial transactions for a 

particular agency for funds credited or debited to a Treasury account. It is also known as 

a deposit ticket or debit voucher (in the case of debits). Within the CIR ODS it is referred 

to as a Deposit Information record. Channels group detailed financial transactions into 

vouchers based on their own summarization logic. For example Pay.gov summarizes by 

ALC or ALC+2 based on the agencies defined preference. Card Acquiring Service 

summarizes by Chain/Division. 

VPN Virtual Private Network - A network that uses a public telecommunication infrastructure, 

such as the Internet, to provide remote offices or individual users with secure access to 

an organization's network.

XML eXtensible Markup Language - A general-purpose markup language that supports a wide 

variety of applications. Its primary purpose is to facilitate the sharing of data across 

different information systems, particularly systems connected via the Internet.

XPath XML Path - A language that describes a way to locate and process items in Extensible 

Markup Language (XML) documents by using an addressing syntax based on a path 

through the document's logical structure or hierarchy.

XSD XML Schema Definition - Formally describes the elements in an Extensible Markup 

Language (XML) document. 

2.3.2 Data Terms

The following terms describe the key types of data that CIR receives, stores, and provides in the extract 

files.
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 13

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

Table 3: Table of CIR Data Entities

Element Description

Business Transaction Captures collections information about the specific business event.

Financial Transaction Individual collections transactions received by CIR (credit card transaction, cleared 

check, etc.) associated to the transfer of funds between a payer and payee for a 

particular business event. 

Deposit Information A summarized record of financial transactions for a particular agency, also known 

as a voucher/deposit ticket. 

GWA Classifications Breakdown of funds collected by Treasury Account Symbol (TAS)/Business Event 

Type Code (BETC) or C-Key/Value information for reporting to Governmentwide 

Accounting (GWA). Classification information can be reported at a Deposit 

Information Level (Summary) or at the Business Transaction Level (Detail). 

Program Data Captures unstructured agency-specific data associated to Deposit Information 

Record, Deposit Information Classification Record, or Business Transaction Record. 

Examples of this type of data include: remittance information, claim information, bill 

numbers and lockbox information.

Fedwire Captures the entire Fedwire message associated to the Financial Transaction.

ACH Captures all the ACH Entry Detail and Addenda data associated to the Financial 

Transaction.

Plastic Card Captures card data elements associated to the Financial Transaction.

Check Captured check data elements associated to the Financial Transaction. 

Figure 1: CIR Data Model below provides a visual representation of this data. In addition to the 

relationships shown, the Financial Transaction and Business Transactions can have a relationship with 

other Financial and Business transactions. Some examples of this are:

 An originating ACH Debit could also have an ACH return that was processed at a later 

point

 Electronic Check Processing (ECP) sends updated program data associated to a 

business transaction at a later point. 

CIR captures the information in order to link transactions and provides that as one of the attributes in the 

XML extract file.
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 14

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

Figure 1: CIR Data Model

Deposit Information Classifications Program Data ProgramDataBusiness Transaction

Classifications Program Data Financial Transaction

Fedwire ACH Plastic Card Check Supplemental information that can be associated to a particular type of financial transaction

Deposit Summary Information Detail Financial Information
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 15

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

3. Overview of the Collections Information Repository (CIR)

3.1 What Is CIR and What Will It Do?

CIR is a collections reporting tool, supplying the latest information on deposits and detail of collections 

transactions to Federal agencies. The system allows financial transaction information from all collections 

systems and settlement mechanisms to be exchanged in a single system.

CIR is a key component of the Collections and Cash Management Modernization (CCMM) initiative, a 

multi-year effort to simplify and modernize Fiscal Service's and the US Treasury's collections and cash 

management programs. 

CIR is an RCM Fiscal Service-wide transaction broker, data repository, and reporting solution, and 

 Provides a single touch-point for the exchange of all settled financial transactions across 

all collections systems

 Offers a centralized repository containing detailed and summarized records of all revenue 

collections transactions processed by Fiscal Service systems

 Facilitates CCMM

 Supports reporting of classification information to the Central Accounting Reporting 

System (CARS) formerly known as GWA

 Normalizes financial transaction reporting and standardize the availability of financial 

information across all settlement mechanisms and collections systems.

3.2 Availability of Data in CIR

CIR was deployed using a phased-implementation strategy. Using this approach, different collections 

sources began reporting financial transaction information to CIR at different times over a multiple year 

time period, completing in 2015. 

With the implementation of XML Extract Files, data from the following STPs is available in CIR.

 Card Acquiring Service

 Credit Gateway ACH

 Credit Gateway Fedwire

 Direct Voucher System (DVS)

 Electronic Check Processing (ECP)

 Electronic Federal Tax Payment System (EFTPS)

 FRB CA$H-LINK – Miscellaneous FRB Deposits

 Navy Cash – Stored Value Card

 OTCnet

 Pay.gov

 Stored Value Card (SVC)

The extract data that CIR generates is dependent on the information sent by each STP. The presence of 

attributes on the extract file indicates that CIR will provide the information to agencies if and only if the 
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 16

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

various STPs provide that information to CIR. If an attribute is not provided to CIR, then that attribute will 

not appear on the extract file (since the contents would be null, and null fields are not extracted).

The following tables provide key information about the types of data currently provided to CIR by each of 

the STPs.

Table 4: Overview of STP Provided Data

STP Collection System 

Name Key Characteristics

Card Acquiring Service Card Acquiring 

Service

Sends summary-level and detail-level transaction information with 

additional plastic card details for Over-the-Counter transactions. 

Does not send any program data. Card activity initiated through 

Pay.gov is not reported directly by Card Acquiring Service and 

would be provided in reporting from Pay.gov

Credit Gateway ACH ACH CG Sends non-tax summary-level and detail-level transaction 

information with additional ACH details. Program data is contained 

within the ACH details and is not separated into the program data 

section.

Credit Gateway Fedwire Fedwire CG Sends non-tax summary-level and detail-level transaction 

information with additional Fedwire details. Program data is 

contained within fields of the Fedwire details and is not separated 

into the program data section.

Direct Voucher System DVS Sends summary-level deposit information for collections processed 

through the Direct Voucher System.

Electronic Check Processing 

(ECP)

ECP Sends summary-level and detail-level transaction information. 

Sends program data associated to a business transaction. Sends 

only summary-level data for tax credit activity

Electronic Federal Tax Payment 

System

EFTPS Sends summary-level deposit information for ACH and Fedwires (all 

non-commercial). Does not send any program data.

FRB CA$H-LINK Miscellaneous 

Deposit Activity

FRBCL MISC Sends summary-level deposit information for miscellaneous 

collections processed and settled at Federal Reserve Banks

Navy Cash – Stored Value Card NAVYCASH Sends summary-level deposit information for Stored Value Card 

activity processed through Navy Cash Program

OTCnet OTCnet Sends summary-level information for Bank Deposits, including 

program data associated to both the summary and the account 

classification. The Bank Deposits are commercial only. 

Sends summary-level and detail-level transaction information for 

Electronic Check Deposits (or E-Check Deposits), including program 

data. Sends only summary-level data for tax activity

Pay.gov Pay.gov Sends summary-level and detail-level transaction information. 

Sends program data associated to a business transaction (forms

and bills). 

Stored Value Card SVC Sends summary-level deposit information for EagleCash and EZpay 

activity processed through the Stored Value Card program. 

Table 5: Overview of STP Provided Data with Associated File Profiles

STP Collection System 

Name File Profiles 

Card Acquiring Service Card Acquiring 

Service

Card Acquiring Service Collections Data

Card Acquiring Service GUI (Manual voucher entries – no details)

Credit Gateway ACH ACH CG ACH Credit Gateway

ACH Credit Gateway Intra-day (Detail Only extract)
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 17

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

STP Collection System 

Name File Profiles 

Credit Gateway Fedwire Fedwire CG Fedwire Credit Gateway

Fedwire Credit Gateway Real-time (Detail Only extract)

Direct Voucher System DVS DVS

Electronic Check Processing 

(ECP)

ECP ECP

ECP GUI (Manual voucher entries – no details)

Electronic Federal Tax Payment 

System

EFTPS EFTPS-BAML

EFTPSAGYTAX

EFTPS Agency Taxes GUI

EFTPS Wire GUI

EFTPS ACH GUI

FRB CA$H-LINK Miscellaneous 

Deposit Activity

FRBCL MISC FRBCL MISC

Navy Cash – Stored Value Card NAVYCASH JPMC NavyCash

JPMC NavyCash GUI

OTCnet OTCnet OTCnet-TGA bank deposit information

OTCnet-TGA bank deposit GUI

OTCnet-CHK deposit information

OTCnet-CHK Deposit GUI (Manual voucher entries – no details)

Pay.gov Pay.gov Pay.gov

Pay.gov ACH collection files 

Pay.gov Credit Card collection files

Pay.gov Exception collection files

Pay.gov PayPal collection files (April 2015)

Pay.gov GUI (Manual voucher entries – no details)

Pay.gov FRB GUI (Manual voucher entries – no details)

Stored Value Card SVC SVC EagleC/EZPay 
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 18

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

3.3 CIR Collections Data Flow

The following diagram illustrates a high-level view of CIR describing the flow of information at the current 

time. This flow is expected to evolve as the full vision of CCMM is implemented. 

FRB CA$H- LINK Vouchers with Classifications

Stored Value Card Vouchers with Classifications DVS

EFTPS CIR TCMS

CAFE/ CARS SAM

Cash Forecasting

Agencies (Reports and XML extracts) Agencies & TGAs

Lockboxes

Source Systems (STPS) Downstream Reporting

Card Acquiring Service

Credit Gateway

Pay.gov

ECP

OTCnet

Vouchers with Classifications & Transactions Vouchers with Classifications & Transactions

Vouchers with Classifications & Transactions Vouchers with Classifications & Transactions

Vouchers with Classifications

Vouchers with Classifications & Transactions Vouchers with Classifications & Transactions

Vouchers

Vouchers with Classifications

Vouchers

BMS Bank Deposit Totals and Agency Totals

ABA & ALC Ref

CAN Ref

Financial Systems

Voucher info from DW FIR

Vouchers with Classifications

Transfer Info

Figure 2: Collections Data Flow 

 CIR receives and stores collections data (details and summaries) from the various source 

systems (channel applications). 

 Agencies can access CIR to view and download collection information including 

classification information for their Agency Location Codes.

 CIR provides financial accounting entries to CAFE/CARS, including classification 

information (CKeys or Treasury Account Symbols/Business Event Type Codes 

(TAS/BETCs)).

 CIR provides TCMS with information on all commercial vouchers to perform cash 

concentration activities. 

 CIR provides Cash Forecasting with information on all vouchers to perform cash 

forecasting activities.
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 19

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

3.4 Reports vs. Extract Files

CIR provides the capability for users to download both reports and XML extract files. Both reports and 

extract files can be downloaded to a user's computer through the CIR application. However, since extract 

files are produced using XML, their primary use is for system-to-system interfaces.

3.4.1 Reports

CIR reports provide the ability for a user to view and download a formatted subset of data, predetermined 

by the report, such as by voucher number, ALC, business date, or other search criteria. CIR generates 

reports via a commercial off-the-shelf product called Business Objects (BO). The CIR reports are not 

intended to be used for extracting extremely large volumes of detail transactions.

Reports can be accessed online and downloaded to the user's computer in the following formats:

 PDF

 Excel

 CSV

Users are able to schedule reports to run on a predefined frequency (for example, daily or weekly). 

3.4.2 Extract Files (XML File Transmission)

CIR XML Extract Files provides the ability for a user or system to receive an extract of all summary and 

detail transaction data within a predefined file format. The primary use of these extracts is for system-tosystem interfaces or downloading and importing into another system.

CIR is required to utilize the standard Fiscal Service XML Schema format for receiving and sending 

collection data. The schema is developed and managed by the Enterprise Data Architecture (EDA) Team 

within Fiscal Service. The version of the Fiscal Service XML Schema that is used for the CIR XML Extract 

is the Fiscal Service XML 5.0.1 Schema and can be accessed from the following website: 

https://www.fiscal.treasury.gov/data/.

Agencies have the capability to define three different extract types with different frequencies and selection 

criteria (ALCs, accounts, date range, input systems, etc.). The three extract types are:

 Summary Only – Only voucher-level information is extracted

 Detail Only – Only individual collection transaction-level information is extracted (credit 

card transactions, wires, ACH transactions). Supports extracting detail transactions 

types and statuses that may not be associated to vouchers.

 Summary and Detail – Voucher-level information along with any associated detail 

transactions is extracted. If no associated detail transactions are available, only voucherlevel information will be provided.

All extracts are automatically scheduled based on the extract definition which supports four frequencies 

(Daily, Weekly, Monthly, and STP end of day). The frequency determines when the extract will be created 

based on the Schedule Start Date entered on the Extract File Definition. The Schedule Start and End

dates are used to indicate when the extract will run to retrieve the activity based on the frequency defined, 

and does not represent the dates of the activity to be pulled into the extract. If the End date is not 

entered, the extract will be generated indefinitely until the status or end date is provided. 

Currently the Extract process can only pull data for activity going forward, and not in the past. However, a 

user may define a monthly extract with a scheduled start date in the "current" month, and when the 
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 20

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

monthly extract runs on the last day of the month, the extract will select all activity for the "current" month.

For example, a monthly extract may be set up on January 16, and when the monthly extract runs on 

January 31, the extract will contain activity for the calendar month of January. 

See Section 5.1 of this document for additional information on Scheduling Extracts. 
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 21

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

4. Security/User Access

4.1 Roles/Functions

When CIR users are created in the CIR system, they are associated with certain functions. In order to 

view and download files, a user will need the function "View Files". This function provides a list of 

extract files that have been created for a specific access group. A user will only be able to view and 

download extract files that were defined by a user within their own access group.

4.2 ALC Security

The ALCs that a user can select for an extract are limited to those ALCs included in the permissions for 

that user's access group. If no ALCs are selected, when the extract is generated, the data is limited to the 

ALCs associated to the access group via permissions. This means that if subsequent to the definition of 

an extract file, the permission set is updated and one or more ALCs are removed, those ALCs will not be 

included in the extract file.

4.3 Personally Identifiable Information (PII)

As part of the extract definition, the user selects a parameter to include or exclude PII data. If the user 

selects to exclude the PII data, then the following attributes within the following elements are not included 

in the file. 

Table 6: PII Data

XML 5.0.1 Elements XML 5.0.1 Attributes

User Data UDF

Payer BnkAcctNr

PtyID

PtyNm

AddrLnTxt (lines 1-5)

PlstcCrdDtl CrdNr

FwireDtl/MssgDtaElmt MssgDtaElmt value

ACH_Dtl ACH_Rec

ACH_Dtl/ACH_Btch ACH_Rec

ACH_Dtl/ACH_Addn ACH_Rec

If the user selects to include PII, all the attributes are included on the extract file. However, for a user to 

view or download an extract file that includes PII, the user must have been defined with a permission to 

access PII.
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 22

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

5. Extract File Generation

5.1 Schedule

CIR produces the extracts based on the extract file frequency defined in the XML Extract File definition. 

The extract file frequency is listed below with a brief description of when the extracts are actually run by 

CIR, as well as an explanation of the contents of the extract file for each frequency. The contents of the 

file will also be limited by the criteria defined in the Extract File Definition and the Extract Type. All activity 

received over a weekend or holiday will have the next business processing day assigned. For example, 

Monday business processing day will always include activity received over the weekend. If Monday is a 

holiday, then Tuesday business processing day will include all activity received over the weekend and 

holiday.

Table 7: CIR Processing Schedule for Creating Extract Files

Extract File 

Frequency

CIR Processing Schedule for Creating an Extract 

File

Activity Reported in the Extract File

Daily Each business day at approximately 12:00 AM 

(midnight), Monday through Friday, except for 

Federal Reserve Bank (FRB) holidays 

All activity from the current business 

processing day.

Weekly Each Friday at approximately 10:00 PM after 

CIR's End of Day processing and the CARS/GWA 

processing. If Friday is an FRB Holiday, then 

weekly extracts are produced on Friday 3:00 AM. 

All activity from the business dates of the 

Monday prior to the day when the extract is 

run. For example, on Friday evening, 

February 1, the weekly extract will contain 

activity from the business dates of Monday 

January 28, through Friday February 1. 

Any transactions received on Saturday

January 26, and Sunday January 27, will 

have a Business Date of Monday January 

28, and will be included in this weekly 

extract.

Monthly Each month on the last business day of the 

month after CIR processing completes. 

All activity for the current calendar month, 

reporting all activity from the first business 

day of the month through the last business 

day of the month. 

For example, on Friday March 29, the 

monthly extract is run and contains activity 

for the calendar month of March, from 

March 1 through March 29. There is no 

activity to report for Saturday March 30 and 

Sunday March 31.

STP End of Day Daily after receiving and processing the end-ofday file for a specific STP file profile. 

The End of Day option is available only for STPs 

who provide their end of day file early in the day. 

Currently this is limited to Card Acquiring Service, 

Credit Gateway ACH, Pay.gov Plastic Card, 

Pay.gov ACH, and Pay.gov PayPal.

Card Acquiring Service – Each day an end-ofday file is received (every day) at approximately 

5:00 AM

Credit Gateway ACH – Each day an end-of-day 

All activity since the last STP End of Day 

file was received. An extract can only be 

setup to include activity for one STP File 

Profile when using this frequency, but 

supports ability to receive data at earlier 

time frames based on when STP has 

notified CIR that they have completed 

reporting all activity for a particular type of 

activity
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 23

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

Extract File 

Frequency

CIR Processing Schedule for Creating an Extract 

File

Activity Reported in the Extract File

file is received at approximately 9:00 AM, Monday 

through Friday except for FRB holidays

Pay.gov Plastic Card – Each day an end-of-day 

file is received (every day) at approximately 8:00 

AM

Pay.gov ACH Settled – each day an end-of-day 

file is received at approximately 8:00 AM, Monday 

through Friday except for FRB holidays.

Pay.gov PayPal – each day an end-of-day file is 

received (every day) at approximately 11:00 AM.

5.2 Data Selection

Data is selected based on the defined extract selection criteria. If no value is selected for particular 

selection criterion then all possible values will be selected for inclusion in extract. 

Criteria selections only need to be made if the extract should not contain all values. If no data is found 

that meets the criteria, then a file is generated with just a Transmission record, where the total amount 

and total count are both zero. 
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 24

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

6. Receiving an Extract File

There are two ways for an agency or other RTP to receive an extract file. A user can view the file name, 

then select and download the file through the CIR application, if it is smaller than 50 megabytes (MB). 

The file name will be in the following format:

BaseFileName_YYYYMMDD_file_id.xml where

 BaseFileName = Base Extract Name defined in the XML Extract Definition in CIR

concatenated with the Access Group ID

 YYYYMMDD = Business Date for the end of the extract period. For a Daily this is the 

single Business Date being extracted. For a Weekly this is the last Business Date of the 

week. For a Monthly this is the last Business Date of the month.

 File_id = Unique ID assigned by CIR

Alternatively a user can work with CIR to establish an automated communication path. Currently the CIR

solution for automated communications utilizes a secure Virtual Private Network (VPN) over the Internet, 

using Connect:Direct, Secure + as the transmission software.

6.1 Downloading Extract Files using the CIR Application

Within the CIR application, under the Management > File menu, there is a View Files function. This 

function allows a user to search for and download an extract file created by CIR. CIR restricts the list of 

available files to extract files created by a user within the same user group. A user can view the file 

status and view and/or download the extract file, provided the file is less than 50 MB. If the extract file is 

larger than 50 MB, the CIR application prevents the user from viewing or downloading the file by disabling 

the download link and displaying a pop-up that says "Cannot Download – the file size is too large". 

6.2 Automatic Delivery of Extract Files 

Agencies can request that CIR automatically send the extract file to their system. This requires the 

establishment of a network connection between CIR and the agency. The CIR standard for this 

connection is VPN over the Internet using Connect:Direct. If an agency is interested in setting up a 

network connection with CIR, the agency should contact CIR Customer Support. 

CIR Customer Support is available between 7:00 AM - 9:00 PM Eastern Time Monday through Friday 

except Federal holidays. CIR Customer Support can be reached at 1-800-624-1373 (option #3) or 

internationally at 216-579-2112 (option #3). CIR Customer Support also can be reached by email at 

CIR.customersupport@clev.frb.org. 

Someone from the CIR Team will then contact the agency to discuss the next steps.
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 25

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

7. Extract File Specification

Downloading and interpreting a CIR XML Extract File requires an understanding of XML coding.

7.1 Understanding this Specification Section

As previously discussed, the format of the output files is XML using the Fiscal Service EDA schema. The 

version of the schema used with the implementation of XML files is version 5.0.1. In the future, as 

additional data is received by CIR and as Fiscal Service EDA updates the schema, additional versions 

are likely to be supported. Section 7.4 gives an overview of the Fiscal Service EDA XML schema.

There is a separate section for each of the three extract types: Summary Only, Summary and Detail, and 

Detail Only. Within each section, there is a specification table that shows the elements and attributes 

provided in the extract. On any given extract, if there is no data for an attribute, that attribute is not 

provided in the XML output. If there is no data for any attribute in a container, that container is not 

provided in the XML output.

A table within each section contains the schema containers that will be included in that extract type along 

with the list of attributes. Field lengths and specifications are not included as they are fully documented 

on the Fiscal Service EDA web site as part of the schema materials. Table 8: Example of an Extract Type 

Specification Table illustrates a sample row from one of these tables.

 Column 1: XML Schema Element – Name of the XML container.

 Column 2: Element Description – In some instances this may differ from the generic 

description provided in the EDA documentation to include information on how that 

container is used within CIR.

 Column 3: Attributes/Elements in the XML 5.0.1 Schema – A list of attributes/elements

that will be provided by CIR for that container. As indicated earlier if an attribute has not 

been provided by the channel application sending data to CIR, or is not appropriate for an 

individual transaction (for example a check number on a wire transaction), that attribute 

will not be included in the extract file for that transaction.

 Column 4: Element and Attribute Names in Text – A list of attribute and element names in 

full text, which correspond to the attribute and element names in the document titled 

"XML Schema Version 5.0.1 In Plain Language".

Table 8: Example of an Extract Type Specification Table showing Elements and Attributes

XML Schema Element Element Description Attributes/Elements in the 

XML 5.0.1 Schema

Element and Attribute

Names in Text

CollRpt A collection of financial 

transactions for the purpose 

of creating or updating detail 

or summary information.

EOD_Ind

IptSysTxt

SeqNr

ID

TrnsmTs

End of Day Indicator

Input System Text

Sequence Number

Transmission Identifier

Transmission Timestamp

7.2 Global Formatting Details

The following general rules apply to all data attributes extracted from CIR.

 All amounts include an explicit decimal point but not commas or dollar signs unless 

otherwise noted. Zeroes that follow a decimal point are not included.
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 26

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

 $2,145.55 is reported as 2145.55

 $2,145.50 is reported as 2145.5

 $2,145.00 is reported as 2145

 $0.00 is reported as 0

 All fields defined as string with maximum values will be limited to the actual length 

received (additional spaces are not added), unless otherwise noted. 

 Voucher number is always a six-digit number where it is possible to have leading zeroes.

 All date fields will be formatted YYYY-MM-DD.

 All date/time fields will be formatted YYYY-MM-DDTHH:MM:SS where "T" is a literal.

7.3 Using the Specification Document

This specification document is engineered to be used in conjunction with the Fiscal Service EDA website.

If the XML file will be processed using a software solution capable of reading XSDs, then the following 

provides an example of how this document could be used:

 Download 5.0.1 Transmission Message XSDs from Fiscal Service EDA website

https://www.fiscal.treasury.gov/data/

 Use the tables in Sections 7.6, 7.7 and 7.8 to identify which containers and attributes will 

be provided on the extract file based on the Extract Type.

 When determining how to map the data into your system, use the attribute definitions 

provided in Section 7.9 for more detailed information on each attribute.

If developing a software solution that will not read XSDs, the steps would be similar. However, to obtain 

field types and lengths, the Fiscal Service EDA website would be used.

7.4 EDA Schema

As stated previously, the 5.0.1 schema is the standard Fiscal Service XML Schema format for receiving 

and sending collection data. The schema is developed and managed by the EDA Team within Fiscal 

Service. 

For specific information on the Fiscal Service EDA XML schema, see

https://www.fiscal.treasury.gov/data/, and the following screen will be returned:
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 27

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

Figure 3: Current Business Message Listing from EDA Website

The screen displays the current active Fiscal Service EDA Schema version which is "COLLECTION REPORT 

V 5.0.1" and the version used by the CIR XML extract. 

To access additional schema versions, click "COLLECTION REPORT V 5.0.1" displayed under the heading 

"DATA EXCHANGE LISTING". The next figure shows a snapshot of the current schema version and also the 

available archived releases. 
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 28

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

Figure 4: Schema List from EDA Web Site

On this website you will have the ability to:

 View the schema

 View a full data dictionary for the schema

 Download the schema (XSDs)
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 29

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

 View a data listing of the schema (schema path with all containers and attributes in a 

spreadsheet listing)

 View how each attribute is used via an attribute data dictionary

Note in the above figure, the EDA Schema Release 5.0.1 is listed as the "CURRENT 5.0.1 RELEASE" under

"PUBLISHED RELEASES" and is available for download as a zip file. The CIR extracts use the following 

XSDs which are included in the zip file: 

 In the directory named "collections":

o CollectionsReport_x.xsd 

 In the directory named "core":

o Common_ComplexTypes.xsd 

o Common_Groups.xsd 

o Common_SimpleTypes.xsd 

o Non_FMS_Standards.xsd 

o TransmissionRs_x.xsd 

7.5 CIR TRS Trading Partner Agreement Schema *

In the previous iteration of the CIR Extracts, the CIR TRS Trading Partner Agreement Schema was used 

in conjunction with the XML Schema version 4.3 to report data in the XML extract file when a data 

element was available for reporting but was not defined in the XML Schema version 4.3. 

The XML Schema version 5.0.1 has been updated to incorporate all data elements that were previously

defined in the CIR TRS Trading Partner Agreement, and therefore a CIR Trading Partner Agreement has 

not been defined for use with the XML Schema version 5.0.1. If additional data elements are needed in 

the XML extracts, the Trading Partner Agreement is available to provide additional data. 
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 30

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

7.6 Summary Only Specification

This section contains the specification for a Summary Only Extract Type. Figure 5: EDA Schema v5.0.1 - Picture for Summary Only Extract

illustrates the schema hierarchy for Summary Only. Some elements are not expanded in the diagram below. See the full EDA Schema 

documentation on the EDA website for more details.
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 31

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

Figure 5: EDA Schema v5.0.1 - Picture for Summary Only Extract
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 32

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

Table 9: Elements and Attributes for Summary Only Extract contains the elements and descriptions for the elements that will be extracted for 

the Summary Only Extract type. The level number shown in the heading corresponds to the number of levels in the XPath. For example the XPath 

for the first reference to AcctCls (Account Classification) in the table below is /CollRpt/Sumry/Vchr/AcctCls. Therefore AcctCls is at the 4th level and 

appears under the column marked with a 4. The elements are listed in the order they will appear in the output extract file.

New with the v.5.0.1 XML schema is an optimized naming convention that is used for both element and attributes where the names are shortened 

to save space in the output file. Optimized names are used in the XML 5.0.1 extract files. 

In the table below, element names are displayed on the left side. An example of this is CollRpt. Attribute names are displayed in the column after 

the Element Description column. The full names for elements and attributes are displayed in the right-most column titled "Element and Attribute 

Names in Text". An example is EOD_Ind with the full name of "End of Day Indicator" in the right-most column. The full name also corresponds to 

the element and attribute names in the document titled "XML Schema Version 5.0.1 In Plain Language". 

Table 9: Elements and Attributes for Summary Only Extract

XML Schema Element Attributes in the 

1 2 3 4 5 6 7 Element Description XML 5.0.1 Schema Extract Element and Attribute Names in Text

CollRpt Collections Report [Element]

A collection of financial 

transactions for the purpose of 

creating or updating detail or 

summary information. 

EOD_Ind End of Day Indicator

IptSysTxt Input System Text

SeqNr Sequence Number

ID Transmission Identifier

TrnsmTs Transmission Timestamp

Sumry Summary [Element]

A container for all summarized 

information.

For the Summary Only extract, the 

Sumry record contains voucherrelated information. There is one 

Sumry record per Vchr record. 

ALC Agency Location Code

AgcySiteID Agency Site Identifier

AgcySiteNm Agency Site Name

AgtBnkAcctNr Agent Bank Account Number

AgtRTN Agent Routing Number

BnkBrnchID Bank Branch Identifier

BnkPostDt Bank Posting Date

BulkPrvrNm Bulk Provider Name

CshFlwID Cash Flow Identifier

CshFlwNm Cash Flow Name

ChnID Chain Identifier

ChnlTypCd Channel Type Code

CAN Collections Account Number

CollBusDt Collections Business Date

CollStatCd Collections Status Code
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 33

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

XML Schema Element Attributes in the 

1 2 3 4 5 6 7 Element Description XML 5.0.1 Schema Extract Element and Attribute Names in Text

CostCtrWrkUnitCd Cost Center Work Unit Code

ComlBnkInd Commercial Bank Indicator

CrInd Credit Indicator

DivID Division Identifier

FRB_AcctKeyCd FRB Account Key Code

FRB_DistCd FRB District Code

FRB_OfcCd FRB Office Code

InitProcgSiteID Initial Processing Site Identifier

IptSysTxt Input System Text

IRS_TaxInd IRS Tax Indicator

LkbxAcctID Lockbox Account Identifier

NonDomBnkInd Non Domestic Bank Indicator

NonTreasCollCd Non Treasury Collection Code

OthScndryRTN Other Secondary Routing Number

ProcgPgmNm Processing Program Name

ProcgSbprgNm Processing Subprogram Name

PgmTrcID Program Trace Identifier

RcptMchsmCd Receipt Mechanism Code

RptPgmNm Reporting Program Name

RptSbprgNm Reporting Subprogram Name

SvcngALC Servicing ALC

SttlMchsmCd Settlement Mechanism Code

ID Summary Identifier

SubAcctRTN Sub Account Routing Number

Vchr Voucher [Element]

The Vchr element is the container 

that represents an agency's 

deposit summary for a given 

program and settlement 

mechanism. 

For the Summary Only extract, 

there is one Vchr record to a 

Sumry record. 

AgcyCmtTxt Agency Comment Text

AgtCmtTxt Agent Comment Text

ChnlInitnDt Channel Initiation Date

ChnlRcptDt Channel Receipt Date

CoinCrncyTotAmt Coin Currency Total Amount

CnfrmDt Confirmed Date

CrncyTotAmt Currency Total Amount

FY Fiscal Year

ExcptTypCd Exception Type Code

NonDomCollInd Non Domestic Collection Indicator

RcptFromDt Receipts From Date
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 34

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

XML Schema Element Attributes in the 

1 2 3 4 5 6 7 Element Description XML 5.0.1 Schema Extract Element and Attribute Names in Text

RcptToDt Receipts To Date

SvcdALC Serviced ALC

SmrzdDtlCnt Summarized Detail Count

TaxBkdwnCnt Tax Breakdown Count

VchrDt Voucher Date

VchrFormCd Voucher Form Code

ID Voucher Identifier

VchrNr Voucher Number

AcctCls Account Classification [Element]

The container for information 

regarding Treasury accounting 

information, including TAS/BETC 

or Ckey Name/Value.

CrInd Credit Indicator

Amt Amount

Ckey Classification Key [Element]

A Ckey is an acronym for 

classification key which is a 

unique agency accounting code 

assigned to a transaction. 

CkeyNm Classification Key Name

CkeyVal Classification Key Value

TAS_BETC Treasury Account Symbol Business Event 

Type Code [Element]

The Treasury Account Symbol is 

an identification code assigned by 

Treasury, in collaboration with 

OMB and the owner agency, to an 

individual appropriation, receipt, or 

other fund account. The Business 

Event Type Code is used in 

combination with the Treasury 

Account Symbol to classify 

transactions reported to the 

Treasury.

SubLvlPrfxCd Sub-level Prefix Code

AlctnTrfrAgcyID Allocation Transfer Agency Identifier

AgcyID Agency Identifier

BegngPdOfAvlblty Beginning Period Of Availability

EndPdOfAvlblty Ending Period Of Availability

AvlbltyTypCd Availability Type Code

MnAcctCd Main Account Code

SubAcctCd Sub Account Code

BETC Business Event Type Code

PgmDta Program Data [Element]

Container for Program and User 

Data associated to a 

classification. 

ID Program Data Identifier

UserDtaCnt User Data Count

UDF User Data Field [Element]
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 35

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

XML Schema Element Attributes in the 

1 2 3 4 5 6 7 Element Description XML 5.0.1 Schema Extract Element and Attribute Names in Text

User Data associated to a 

classification

CUI_Ind CUI Indicator

ID User Data Field Identifier

Lab User Data Field Label

OrgLvl Organization Level [Element]

The container for an Organization 

Level item. 

IntOrgCd Internal Organization Code

ID Organization Level Identifier

RefNm Reference Name

TaxBkdwnDta Tax Breakdown Data [Element]

The container for the breakout of

the summary total amount by 

categories. This information is 

reported only for tax collections. 

Amt Amount

ChnlTypCd Channel Type Code

CrInd Credit Indicator

FclSvcTaxSubClsCd Fiscal Service Tax Sub Class Code

FclSvcTaxClsCd Fiscal Service Tax Class Code

NAICS_Cd NAICS Code

SttlMchsmCd Settlement Mechanism Code

TaxBusCnt Tax Business Count

TaxPayerTypCd Tax Payer Type Code

TaxSubTypCd Tax Sub Type Code

TaxTypCd Tax Type Code

FrgnCrncy Foreign Currency (Element

The container for information 

related to the exchange of foreign 

currency.

OrigCrncyCdTxt Original Currency Code Text

ExchRte Exchange Rate

ConvMthdCd Conversion Method Code

FrgnCrncyAmt Foreign Currency Amount

Excpt Exception [Element]

The container for information 

regarding a type of change to a 

previously reported transaction.

OrigBnkPostDt Original Bank Posting Date

OrigVchrDt Original Voucher Date

OrigVchrNr Original Voucher Number

ResnCd Reason Code

ResnTxt Reason Text

PgmDta Program Data [Element]

Container for Program and User 

Data associated to a voucher.

ID Program Data Identifier

UserDtaCnt User Data Count

UDF User Data Field [Element]

The container allowing for freeformat, unstructured, agencyCUI_Ind CUI Indicator

ID User Data Field Identifier
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 36

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

XML Schema Element Attributes in the 

1 2 3 4 5 6 7 Element Description XML 5.0.1 Schema Extract Element and Attribute Names in Text

specific data. Lab User Data Field Label

Tot Totals [Element]

The container that represents 

totals for the Sumry record. 

TotCnt Total Count

SumryTotInd Summary Total Indicator

TotCrAmt Total Credit Amount

TotCrAmt Total Credit Amount

TotDbtAmt Total Debit Amount

TotDbtCnt Total Debit Count

Tot Totals [Element]

The container that represents 

totals for the CollRpt transmission. 

TotCnt Total Count

SumryTotInd Summary Total Indicator

TotCrAmt Total Credit Amount

TotCrCnt Total Credit Count

TotDbtAmt Total Debit Amount

TotDbtCnt Total Debit Count
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 37

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

7.7 Detail Only Specification

This section contains the specification for a Detail Only Extract Type. Figure 6: EDA Schema v5.0.1 - Picture for Detail Only illustrates the

schema hierarchy for Detail Only. Some elements are not expanded in the diagram below. See the full EDA Schema documentation on the EDA 

website for more details.
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 38

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

Figure 6: EDA Schema v5.0.1 - Picture for Detail Only
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 39

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

Table 10: Elements and Attributes for Detail Only Extract contains the elements and descriptions for the elements that will be extracted for the 

Detail Only Extract type. The level number shown in the heading corresponds to the number of levels in the XPath. For example the XPath for the 

reference to FT (Financial Transaction) in the table below is /CollRpt/Sumry/BT/FT. Therefore FT is at the 4th level and appears under the column 

marked with a 4. The elements are listed in the order they will appear in the output extract file.

New with the v.5.0.1 XML schema is an optimized naming convention that is used for both element and attributes where the names are shortened 

to save space in the output file. Optimized names are used in the XML 5.0.1 extract files. 

In the table below, element names are displayed on the left side. An example of this is CollRpt. Attribute names are displayed in the column after 

the Element Description column. The full names for elements and attributes are displayed in the right-most column titled "Element and Attribute 

Names in Text". An example is EOD_Ind with the full name of "End of Day Indicator" in the right-most column. The full name also corresponds to 

the element and attribute names in the document titled "XML Schema Version 5.0.1 In Plain Language".

Table 10: Elements and Attributes for Detail Only Extract

XML Schema Element Attributes in the

1 2 3 4 5 6 7 Element Description XML 5.0.1 Schema Extract Element and Attribute Names in Text

CollRpt Collections Report [Element]

The container for summarized 

voucher and business 

transaction information. 

EOD_Ind End of Day Indicator

IptSysTxt Input System Text

SeqNr Sequence Number

ID Transmission Identifier

TrnsmTs Transmission Timestamp

Sumry Summary [Element]

A container for all summarized 

information. 

For the Detail Only extracts, 

the data reported in Sumry is 

grouped by the attributes 

identified by an asterisk (*). 

When a break on the grouping 

is identified that is at a lower 

level than the voucher deposit 

grouping, then the Sumry is 

identified as "partial" Vchr.

ALC * Agency Location Code

AgcySiteID * Agency Site Identifier

AgcySiteNm * Agency Site Name

AgtRTN * Agent Routing Number

BnkPostDt * Bank Posting Date

BulkPrvrNm Bulk Provider Name

CshFlwID * Cash Flow Identifier

CshFlwNm * Cash Flow Name

ChnID * Chain Identifier

ChnlTypCd * Channel Type Code

CAN * Collections Account Number

CollBusDt * Collections Business Date

CollStatCd * Collections Status Code

CostCtrWrkUnitCd * Cost Center Work Unit Code

ComlBnkInd * Commercial Bank Indicator
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 40

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

XML Schema Element Attributes in the

1 2 3 4 5 6 7 Element Description XML 5.0.1 Schema Extract Element and Attribute Names in Text

CrInd * Credit Indicator

DivID * Division Identifier

FRB_AcctKeyCd * FRB Account Key Code

FRB_DistCd * FRB District Code

FRB_OfcCd * FRB Office Code

InitProcgSiteID * Initial Processing Site Identifier

IptSysTxt * Input System Text

IRS_TaxInd * IRS Tax Indicator

LkbxAcctID * Lockbox Account Identifier

NonTreasCollCd * Non Treasury Collection Code

ProcgPgmNm * Processing Program Name

ProcgSbprgNm * Processing Subprogram Name

PgmTrcID * Program Trace Identifier

RcptMchsmCd * Receipt Mechanism Code

RptPgmNm * Reporting Program Name

RptSbprgNm * Reporting Subprogram Name

SvcngALC * Servicing ALC

SttlMchsmCd * Settlement Mechanism Code

SttlRcptDt * Settlement Receipt Date

ID * Summary Identifier

BT Business Transaction [Element]

The container for items 

associated to business 

transactions representing a 

single unit of work. All of the 

child elements are optional, as 

business transactions vary for 

different kinds of collections. 

The BT may contain one or 

many financial transactions. 

Remittance information, paper 

coupon, invoice, bill, form, etc., 

are reported in BT_PgmDta. 

AgcyGrpID Agency Grouping Identifier

ID Business Transaction Identifier

CollTxnTyp Collections Transaction Type Code

CnfrmDt Confirmed Date

IptBtchID Input Batch Identifier

InstlmInstncNr Installment Instance Number

Intragov Intragovernmental Indicator

NonDomCollInd Non Domestic Collection Indicator

NOC_UpdtRsltTxt Notification Of Change Update Result

RecrFreqCd Recurring Frequency Code

SvcdALC Serviced ALC

TotInstlmCnt Total Installment Count

UpdtInd Update Indicator

FT Financial Transaction [Element]

The container representing the ID Financial Transaction Identifier
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 41

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

XML Schema Element Attributes in the

1 2 3 4 5 6 7 Element Description XML 5.0.1 Schema Extract Element and Attribute Names in Text

transfer of funds between 

payer and payee in a given 

day. Only one of the child 

financial instrument types 

(PlstcCrdDtl, ACH_Dtl, 

FwireDtl or ChkDtl) can be 

reported per financial 

transaction. 

AgcyTxnID Agency Transaction Identifier

ChnlTxnID Channel Transaction Identifier

PayerMchsmCd Payer Mechanism Code

SttlTxnID Settlement Transaction Identifier

RecrInd Recurring Indicator

RptrID Reporter Identifier

ChnlRcptDt Channel Receipt Date

SttlStatCd Settlement Status Code

ChnlInitnDt Channel Initiation Date

Amt Amount

PlstcCrdDtl Plastic Card Detail [Element]

A container representing a 

financial instrument type for 

plastic card-specific financial 

transactions. PlstcCrdDtl is a 

container for content 

associated with a plastic card 

transaction. 

ID Plastic Card Identifier

MthYrExpirDt Month Year Expiration Date

MskdCrdNr Masked Card Number

OrigIntchgCd Original Interchange Code

IntchgCd Interchange Code

IntchgRembrsFeeAmt Interchange Reimbursement Fee 

Amount

IntchgRembrsFeeAmtSgnInd Interchange Reimbursement Fee 

Amount Sign Indicator

IntchgAdjResnCd Interchange Adjustment Reason 

Code

IntchgAdjAmt Interchange Adjustment Amount

IntchgAdjAmtSgnInd Interchange Adjustment Amount Sign 

Indicator

AuthChrsCd Authorization Characteristics Code

AuthCd Authorization Code

AuthSrcCd Authorization Source Code

AVS_RspCd Address Verification Service 

Response Code

MrchntStrNr Merchant Store Number

MrchntCatCd Merchant Category Code

MrchntNr Merchant Number

CrdPrdctTypCd Card Product Type Code

ClntBtchNr Client Batch Number

CshBckAmt Cash Back Amount
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 42

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

XML Schema Element Attributes in the

1 2 3 4 5 6 7 Element Description XML 5.0.1 Schema Extract Element and Attribute Names in Text

CrdNtwrkTypCd Card Network Type Code

CrdPrdctCd Card Product Code

NtwrkRspCd Network Response Code

CrgbkRefNr Chargeback Reference Number

CrdRspCd Card Response Code

CrgbkRecNr Chargeback Record Number

DrftLoctNr Draft Locator Number

CAT_Cd Cardholder Activated Terminal Code

OrdID Order Identifier

POS_EntyMde Point Of Sale Entry Mode

RgstrNr Register Number

StrPrsnID Store Person Identifier

TrmNr Terminal Number

TaxblAmt Taxable Amount

TxnTmZnCd Transaction Time Zone Code

TxnTm Transaction Time

ChnlCtffTm Channel Cutoff Time

CrdEvnTypCd Card Event Type Code

AuthRqstRspCd Authorization Request Response 

Code

PlstcTypCd Plastic Type Code

AdjTypCd Adjustment Type Code

OrdLvl_III_Dta Specific plastic card 

information provided by the 

agency.

Order Level III Data [Element]

ACH_Dtl ACH Detail [Element]

A container representing a 

financial instrument type for 

ACH-specific financial 

transactions. The ACH_Dtl 

element contains data 

associated to every ACH entry 

detail record. The ACH_Dtl 

element has 3 child elements: 

ACH_Btch, ACH_Rec, and 

ACH_Addn

ACH_TypCd ACH Type Code

StdEntyClsCd Standard Entry Class Code

EffEntyDt Effective Entry Date

CoEntyDesc Company Entry Description Text

SvcClsCd Service Class Code

ACH_TxnCd ACH Transaction Code

ACH_TrcNr ACH Trace Number

ACH_OrigTrcNr ACH Original Trace Number

AddnCnt Addenda Count

ACH_CoDescDtTxt ACH Company Descriptive Date Text
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 43

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

XML Schema Element Attributes in the

1 2 3 4 5 6 7 Element Description XML 5.0.1 Schema Extract Element and Attribute Names in Text

CoDscnyDtaTxt Company Discretionary Data Text

DscnyDtaCd Discretionary Data Code

OrgntrStatCd Originator Status Code

ID ACH Identifier

ACH_Btch The ACH_Btch element 

contains data associated to the 

batch header record 

associated to an ACH entry 

detail record. 

ACH Batch [Element]

ID ACH Batch Identifier

ACH_Rec The ACH_Rec element 

contains the 94-character 

string of content data from the 

NACHA batch record.

ACH Record [Element]

ACH_Rec The ACH_Rec element 

contains the 94-character 

string of content data from the 

NACHA entry detail record. 

ACH Record [Element]

ACH_Addn ACH Addendum [Element]

The ACH_Addn element is a 

container for reporting data 

contained in addenda records 

associated to an entry detail 

record. There can be zero to 

many occurrences of 

Addendum data. 

SeqNr Sequence Number

EntyDtlSeqNr Entry Detail Sequence Number

AddnTypCd Addendum Type Code

ACH_PmtRelatInfoTxt ACH Payment Related Information

ACH_Rec The ACH_Rec element 

contains the 94-character 

string of content data from the 

NACHA addendum record.

ACH Record [Element]

FwireDtl Fedwire Detail [Element]

Represents a financial 

instrument type for Fedwirespecific financial transactions. 

FwireDtl is a container for 

content associated with a 

Fedwire message. 

FwireTypCd Fedwire Type Code

IMAD IMAD

FwireSubTypCd Fedwire Sub Type Code

BusFcnCd Business Function Code

OrigIMAD Original IMAD

IncmgTxnInd Incoming Transaction Indicator
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 44

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

XML Schema Element Attributes in the

1 2 3 4 5 6 7 Element Description XML 5.0.1 Schema Extract Element and Attribute Names in Text

TotCnt Total Count

MssgDtaElmt Message Data Element [Element]

Represents a section of a 

Fedwire message associated 

to a particular Fedwire tag 

label. Each instance of the 

MssgDtaElmt includes the 

Fedwire tag code, the 

corresponding message text 

and the associated value for 

that tag. There can be multiple 

occurrences of MssgDtaElmt 

depending on the Fedwire 

message. 

SeqNr Sequence Number

FwireTagCd Fedwire Tag Code

ID Message Data Element Identifier

ElmtNm Element Name

UnstrdDtaInd Unstructured Data Indicator

CUI_Ind CUI Indicator

ChkDtl Check Detail [Element]

Represents a financial 

instrument type for checkspecific financial transactions. 

Additional information can be 

provided using the ACH_Info 

child element. 

ChkTrcNr Check Trace Number

ChkSerNr Check Serial Number

ChkTypCd Check Type Code

ProcgMthdCd Processing Method Code

RsrhRqrdInd Research Required Indicator

MICR_Unprsd MICR Unparsed

ACH_Info ACH Info [Element]

A container for ACH 

information that is related to 

the settlement of the check 

transaction. 

ACH_TypCd ACH Type Code

StdEntyClsCd Standard Entry Class Code

EffEntyDt Effective Entry Date

CoEntyDesc Company Entry Description Text

SvcClsCd Service Class Code

ACH_TxnCd ACH Transaction Code

ACH_TrcNr ACH Trace Number

ACH_OrigTrcNr ACH Original Trace Number

RecrInd Recurring Indicator

Payer Payer [Element]

Identifies the point of first 

deposit in a debit transaction 

and identifies the person of 

organization submitting the 

BnkAcctNr Bank Account Number

BnkAcctTypCd Bank Account Type Code

EmlAddrTxt Email Address Text

NonDomBnkInd Non Domestic Bank Indicator
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 45

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

XML Schema Element Attributes in the

1 2 3 4 5 6 7 Element Description XML 5.0.1 Schema Extract Element and Attribute Names in Text

payment. The Addr child 

element is available for 

reporting address information 

for the payer.

PtyID Party Identifier

PtyNm Party Name

PtyTypCd Party Type Code

RTN Routing Number

Addr Address [Element]

Contains the address of the 

payer. 

NonDomInd Non Domestic Indicator

FrgnPostalCd Foreign Postal Code

StCd State Code

CtyNm City Name

PostalCd Postal Code

PostalCdExt Postal Code Extension

CntryCd Country Code

AddrLnTxt Address Line Text [Element]

Container for individual lines of 

address information, up to 5 

entries. 

Payee Payee [Element]

Identifies the person or 

organization receiving 

payment. The Addr child 

element is available for 

reporting address information 

for the payee.

PtyID Party Identifier

PtyNm Party Name

Addr Address [Element]

Contains the address of the 

payee.

NonDomInd Non Domestic Indicator

FrgnPostalCd Foreign Postal Code

StCd State Code

CtyNm City Name

PostalCd Postal Code

AddrLnTxt Address Line Text [Element]

Container for individual lines of 

address information, up to 5 

entries. 

FrgnCrncy Foreign Currency [Element

A container for describing 

foreign currency information 

OrigCrncyCdTxt Original Currency Code Text

ExchRte Exchange Rate
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 46

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

XML Schema Element Attributes in the

1 2 3 4 5 6 7 Element Description XML 5.0.1 Schema Extract Element and Attribute Names in Text

associated to a detailed 

transaction.

ConvMthdCd Conversion Method Code

FrgnCrncyAmt Foreign Currency Amount

Excpt Exception [Element]

A container for reporting 

adjustments, corrections and 

rescissions (ACRs). The ACR 

information reported in the 

Excpt element provides a way 

back to the original report in 

which the affected transaction 

occurred. 

LglTxnAmt Legal Transaction Amount

OrigAgcyTxnID Original Agency Transaction Identifier

OrigBnkPostDt Original Bank Posting Date

OrigChnlTxnID Original Channel Transaction 

Identifier

OrigRecAmt Original Recorded Amount

OrigSttlTxnID Original Settlement Transaction 

Identifier

OrigVchrDt Original Voucher Number

OrigVchrNr Original Voucher Date

ResnCd Reason Code

ResnTxt Reason Text

AcctCls Account Classification [Element]

The container for Treasury 

accounting information, 

including TAS/BETC or Ckey 

Name/Value.

CrInd Credit Indicator

Amt Amount

Ckey Ckey [Element]

The container for reporting the 

classification key which is a 

unique agency accounting

code assigned to a 

transaction. 

CkeyNm Classification Name

CkeyVal Classification Value

TAS_BETC TAS BETC [Element]

The container for Treasury 

Account Symbol (TAS) and 

Business Event Type Code 

(BETC) pairs. 

SubLvlPrfxCd Sub-level Prefix Code

AlctnTrfrAgcyID Allocation Transfer Agency Identifier

AgcyID Agency Identifier

BegngPdOfAvlblty Beginning Period Of Availability

EndPdOfAvlblty Ending Period Of Availability

AvlbltyTypCd Availability Type Code

MnAcctCd Main Account Code

SubAcctCd Sub Account Code

BETC Business Event Type Code
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 47

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

XML Schema Element Attributes in the

1 2 3 4 5 6 7 Element Description XML 5.0.1 Schema Extract Element and Attribute Names in Text

OrgLvl Organization Level [Element]

The container for items 

representing organizational 

hierarchy.

IntOrgCd Internal Organization Code

ID Internal Organization Code

RefNm Reference Name

BT_PgmDta Business Transaction Program Data 

[Element]

The BT_PgmDta element is a 

container for unstructured 

agency-specific data 

associated with the business 

transaction. Typically, it 

includes remittance 

information posted to 

receivables. There can be 

multiple occurrences 

BT_PgmDta

AgcyBillNm Agency Bill Name

AgcyFormNr Agency Form Number

AgcyFormNm Agency Form Name

BillAcctNr Bill Account Number

BillDt Bill Date

FormRvsnFileNm Form Revision File Name

ID Business Transaction Program Data 

Identifier

OMB_CtlNr Office of Management and Budget 

Control Number

RmtnID Remittance Identifier

UserDtaCnt User Data Count

UDF User Data Field [Element]

The UDF element has the 

actual content of the 

unstructured agency-specific 

data along with labels that 

describe what information is 

provided in the user data field. 

CUI_Ind CUI Indicator

ID User Data Field Identifier

Lab User Data Field Label

Vchr Voucher [Element]

The Vchr element is the 

container for an Agency’s 

deposit summary for a given 

program. 

For detail only extracts, the 

Vchr may be reported as 

"partial" to indicate a break in 

the grouping of the information 

reported within the Sumry 

element. This is a new feature 

PartlInd Partial Indicator

VchrDt Voucher Date

ID Voucher Identifier

VchrNr Voucher Number
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 48

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

XML Schema Element Attributes in the

1 2 3 4 5 6 7 Element Description XML 5.0.1 Schema Extract Element and Attribute Names in Text

with the XML 5.0.1 Extract 

files. 

The Vchr element will only be 

provided if detail transactions 

reported were associated to a 

voucher with a voucher 

number 

Tot Totals [Element]

A container that represents 

totals for information reported 

within the Sumry element. 

For Detail Only extracts, the 

totals will be calculated from 

the detail transactions within 

the Sumry. 

TotCnt Total Count

InfoOnlyTxnCnt Informational Only Transaction Count

SumryTotInd Summary Total Indicator

TotCrAmt Total Credit Amount

TotCrCnt Total Credit Count

TotDbtAmt Total Debit Amount

TotDbtCnt Total Debit Count

Tot Totals [Element]

A container that represents 

totals for information reported 

on the CollRpt (transmission) 

level. For Detail Only extracts, 

totals are provided for both 

Vchr level information and also 

detail level information. 

TotCnt Total Count

SumryTotInd Summary Total Indicator

TotCrAmt Total Credit Amount

TotCrCnt Total Credit Count

TotDbtAmt Total Debit Amount

TotDbtCnt Total Debit Count
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 49

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

7.8 Summary and Detail Specification

This section contains the specification for a Summary and Detail Extract Type. Figure 7: EDA Schema v5.0.1 - Picture for Summary and Detail

illustrates the schema hierarchy for Summary and Detail. Some elements are not expanded in the diagram below. See the full EDA Schema 

documentation on the EDA website for more details.
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 50

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

Figure 7: EDA Schema v5.0.1 - Picture for Summary and Detail
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 51

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

Table 11: Elements and Attributes for Summary and Detail Extract contains the elements and descriptions for the elements that will be 

extracted for the Summary and Detail Extract type. This extract type provides similar reporting to the detail only extract except this extract will only 

report out details associated to a voucher and/or any vouchers that do not have detail transactions available in CIR based on criteria defined in 

extract definition. The level number shown in the heading corresponds to the number of levels in the XPath. For example the XPath for the 

reference to FT (Financial Transaction) in the table below is /CollRpt/Sumry/BT/FT. Therefore FT is at the 4th level and appears under the column 

marked with a 4. The elements are listed in the order they will appear in the output extract file.

New with the v.5.0.1 XML schema is an optimized naming convention that is used for both element and attributes where the names are shortened 

to save space in the output file. Optimized names are used in the XML 5.0.1 extract files. 

In the table below, element names are displayed on the left side. An example of this is CollRpt. Attribute names are displayed in the column after 

the Element Description column. The full names for elements and attributes are displayed in the right-most column titled "Element and Attribute 

Names in Text". An example is EOD_Ind with the full name of "End of Day Indicator" in the right-most column. The full name also corresponds to 

the element and attribute names in the document titled "XML Schema Version 5.0.1 In Plain Language".

Table 11: Elements and Attributes for Summary and Detail Extract

XML Schema Element Attributes in the

1 2 3 4 5 6 7 Element Description XML 5.0.1 Schema Extract Element and Attribute Names in Text

CollRpt Collections Report [Element]

The container for summarized 

voucher and business 

transaction information. 

EOD_Ind End of Day Indicator

IptSysTxt Input System Text

SeqNr Sequence Number

ID Transmission Identifier

TrnsmTs Transmission Timestamp

Sumry Summary [Element]

A container for all summarized 

information. 

For the Detail Only extracts, 

the data reported in Sumry is 

grouped by the attributes 

identified by an asterisk (*). 

When a break on the grouping 

is identified that is at a lower 

level than the voucher deposit 

grouping,, then the Sumry is 

identified as "partial" Vchr. 

ALC * Agency Location Code

AgcySiteID * Agency Site Identifier

AgcySiteNm * Agency Site Name

AgtRTN * Agent Routing Number

BnkPostDt * Bank Posting Date

BulkPrvrNm Bulk Provider Name

CshFlwID * Cash Flow Identifier

CshFlwNm * Cash Flow Name

ChnID * Chain Identifier

ChnlTypCd * Channel Type Code

CAN * Collections Account Number

CollBusDt * Collections Business Date

CollStatCd * Collections Status Code
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 52

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

XML Schema Element Attributes in the

1 2 3 4 5 6 7 Element Description XML 5.0.1 Schema Extract Element and Attribute Names in Text

For Vouchers with no details 

transactions reported to CIR, 

the Sumry record contains 

voucher-related information. 

There is one Sumry record per 

Vchr record. 

CostCtrWrkUnitCd * Cost Center Work Unit Code

ComlBnkInd * Commercial Bank Indicator

CrInd * Credit Indicator

DivID * Division Identifier

FRB_AcctKeyCd * FRB Account Key Code

FRB_DistCd * FRB District Code

FRB_OfcCd * FRB Office Code

InitProcgSiteID * Initial Processing Site Identifier

IptSysTxt * Input System Text

IRS_TaxInd * IRS Tax Indicator

LkbxAcctID * Lockbox Account Identifier

NonTreasCollCd * Non Treasury Collection Code

ProcgPgmNm * Processing Program Name

ProcgSbprgNm * Processing Subprogram Name

PgmTrcID * Program Trace Identifier

RcptMchsmCd * Receipt Mechanism Code

RptPgmNm * Reporting Program Name

RptSbprgNm * Reporting Subprogram Name

SvcngALC * Servicing ALC

SttlMchsmCd * Settlement Mechanism Code

SttlRcptDt * Settlement Receipt Date

ID * Summary Identifier

BT Business Transaction [Element]

The container for items 

associated to business 

transactions representing a 

single unit of work. All of the 

child elements are optional, as 

business transactions vary for 

different kinds of collections. 

The BT may contain one or 

many financial transactions. 

Remittance information, paper 

coupon, invoice, bill, form, etc., 

are reported in BT_PgmDta. 

AgcyGrpID Agency Grouping Identifier

ID Business Transaction Identifier

CollTxnTyp Collections Transaction Type Code

CnfrmDt Confirmed Date

IptBtchID Input Batch Identifier

InstlmInstncNr Installment Instance Number

Intragov Intragovernmental Indicator

NonDomCollInd Non Domestic Collection Indicator

NOC_UpdtRsltTxt Notification Of Change Update Result

RecrFreqCd Recurring Frequency Code

SvcdALC Serviced ALC

TotInstlmCnt Total Installment Count

UpdtInd Update Indicator
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 53

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

XML Schema Element Attributes in the

1 2 3 4 5 6 7 Element Description XML 5.0.1 Schema Extract Element and Attribute Names in Text

This element and lower-level 

elements will only be 

populated for summary 

vouchers where detail 

transactions were reported to 

CIR

FT Financial Transaction [Element]

The container representing the 

transfer of funds between 

payer and payee in a given 

day. Only one of the child 

financial instrument types 

(PlstcCrdDtl, ACH_Dtl, 

FwireDtl or ChkDtl) can be 

reported per financial 

transaction. 

ID Financial Transaction Identifier

AgcyTxnID Agency Transaction Identifier

ChnlTxnID Channel Transaction Identifier

PayerMchsmCd Payer Mechanism Code

SttlTxnID Settlement Transaction Identifier

RecrInd Recurring Indicator

RptrID Reporter Identifier

ChnlRcptDt Channel Receipt Date

SttlStatCd Settlement Status Code

ChnlInitnDt Channel Initiation Date

Amt Amount

PlstcCrdDtl Plastic Card Detail [Element]

A container representing a 

financial instrument type for 

plastic card-specific financial 

transactions. PlstcCrdDtl is a 

container for content 

associated with a plastic card 

transaction. 

ID Plastic Card Identifier

MthYrExpirDt Month Year Expiration Date

MskdCrdNr Masked Card Number

OrigIntchgCd Original Interchange Code

IntchgCd Interchange Code

IntchgRembrsFeeAmt Interchange Reimbursement Fee 

Amount

IntchgRembrsFeeAmtSgnInd Interchange Reimbursement Fee 

Amount Sign Indicator

IntchgAdjResnCd Interchange Adjustment Reason 

Code

IntchgAdjAmt Interchange Adjustment Amount

IntchgAdjAmtSgnInd Interchange Adjustment Amount Sign 

Indicator

AuthChrsCd Authorization Characteristics Code

AuthCd Authorization Code

AuthSrcCd Authorization Source Code
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 54

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

XML Schema Element Attributes in the

1 2 3 4 5 6 7 Element Description XML 5.0.1 Schema Extract Element and Attribute Names in Text

AVS_RspCd Address Verification Service 

Response Code

MrchntStrNr Merchant Store Number

MrchntCatCd Merchant Category Code

MrchntNr Merchant Number

CrdPrdctTypCd Card Product Type Code

ClntBtchNr Client Batch Number

CshBckAmt Cash Back Amount

CrdNtwrkTypCd Card Network Type Code

CrdPrdctCd Card Product Code

NtwrkRspCd Network Response Code

CrgbkRefNr Chargeback Reference Number

CrdRspCd Card Response Code

CrgbkRecNr Chargeback Record Number

DrftLoctNr Draft Locator Number

CAT_Cd Cardholder Activated Terminal Code

OrdID Order Identifier

POS_EntyMde Point Of Sale Entry Mode

RgstrNr Register Number

StrPrsnID Store Person Identifier

TrmNr Terminal Number

TaxblAmt Taxable Amount

TxnTmZnCd Transaction Time Zone Code

TxnTm Transaction Time

ChnlCtffTm Channel Cutoff Time

CrdEvnTypCd Card Event Type Code

AuthRqstRspCd Authorization Request Response 

Code

PlstcTypCd Plastic Type Code

AdjTypCd Adjustment Type Code

OrdLvl_III_Dta Specific plastic card 

information provided by the 

agency.

Order Level III Data [Element]

ACH_Dtl ACH Detail [Element]

A container representing a 

financial instrument type for 

ACH_TypCd ACH Type Code

StdEntyClsCd Standard Entry Class Code
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 55

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

XML Schema Element Attributes in the

1 2 3 4 5 6 7 Element Description XML 5.0.1 Schema Extract Element and Attribute Names in Text

ACH-specific financial 

transactions. The ACH_Dtl 

element contains data 

associated to every ACH entry 

detail record. The ACH_Dtl 

element has 3 child elements: 

ACH_Btch, ACH_Rec, and 

ACH_Addn

EffEntyDt Effective Entry Date

CoEntyDesc Company Entry Description Text

SvcClsCd Service Class Code

ACH_TxnCd ACH Transaction Code

ACH_TrcNr ACH Trace Number

ACH_OrigTrcNr ACH Original Trace Number

AddnCnt Addenda Count

ACH_CoDescDtTxt ACH Company Descriptive Date Text

CoDscnyDtaTxt Company Discretionary Data Text

DscnyDtaCd Discretionary Data Code

OrgntrStatCd Originator Status Code

ID ACH Identifier

ACH_Btch The ACH_Btch element 

contains data associated to the 

batch header record 

associated to an ACH entry 

detail record. 

ACH Batch [Element]

ID ACH Batch Identifier

ACH_Rec The ACH_Rec element 

contains the 94-character 

string of content data from the 

NACHA batch record.

ACH Record [Element]

ACH_Rec The ACH_Rec element 

contains the 94-character 

string of content data from the 

NACHA entry detail record. 

ACH Record [Element]

ACH_Addn ACH Addendum [Element]

The ACH_Addn element is a

container for reporting data 

contained in addenda records 

associated to an entry detail 

record. There can be zero to 

many occurrences of 

Addendum data. 

SeqNr Sequence Number

EntyDtlSeqNr Entry Detail Sequence Number

AddnTypCd Addendum Type Code

ACH_PmtRelatInfoTxt ACH Payment Related Information

ACH_Rec The ACH_Rec element 

contains the 94-character 

string of content data from the 

ACH Record [Element]
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 56

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

XML Schema Element Attributes in the

1 2 3 4 5 6 7 Element Description XML 5.0.1 Schema Extract Element and Attribute Names in Text

NACHA addendum record.

FwireDtl Fedwire Detail [Element]

Represents a financial 

instrument type for Fedwirespecific financial transactions. 

FwireDtl is a container for 

content associated with a 

Fedwire message. 

FwireTypCd Fedwire Type Code

IMAD IMAD

FwireSubTypCd Fedwire Sub Type Code

BusFcnCd Business Function Code

OrigIMAD Original IMAD

IncmgTxnInd Incoming Transaction Indicator

TotCnt Total Count

MssgDtaElmt Message Data Element [Element]

Represents a section of a 

Fedwire message associated 

to a particular Fedwire tag 

label. Each instance of the 

MssgDtaElmt includes the 

Fedwire tag code, the 

corresponding message text 

and the associated value for 

that tag. There can be multiple 

occurrences of MssgDtaElmt 

depending on the Fedwire 

message.

SeqNr Sequence Number

FwireTagCd Fedwire Tag Code

ID Message Data Element Identifier

ElmtNm Element Name

UnstrdDtaInd Unstructured Data Indicator

CUI_Ind CUI Indicator

ChkDtl Check Detail [Element]

Represents a financial 

instrument type for checkspecific financial transactions. 

Additional information can be 

provided using the ACH_Info 

child element. 

ChkTrcNr Check Trace Number

ChkSerNr Check Serial Number

ChkTypCd Check Type Code

ProcgMthdCd Processing Method Code

RsrhRqrdInd Research Required Indicator

MICR_Unprsd MICR Unparsed

ACH_Info ACH Info [Element]

A container for ACH 

information that is related to 

the settlement of the check

transaction. 

ACH_TypCd ACH Type Code

StdEntyClsCd Standard Entry Class Code

EffEntyDt Effective Entry Date

CoEntyDesc Company Entry Description Text

SvcClsCd Service Class Code

ACH_TxnCd ACH Transaction Code
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 57

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

XML Schema Element Attributes in the

1 2 3 4 5 6 7 Element Description XML 5.0.1 Schema Extract Element and Attribute Names in Text

ACH_TrcNr ACH Trace Number

ACH_OrigTrcNr ACH Original Trace Number

RecrInd Recurring Indicator

Payer Payer [Element]

Identifies the point of first 

deposit in a debit transaction 

and identifies the person of 

organization submitting the 

payment. The Addr child 

element is available for 

reporting address information 

for the payer.

BnkAcctNr Bank Account Number

BnkAcctTypCd Bank Account Type Code

EmlAddrTxt Email Address Text

NonDomBnkInd Non Domestic Bank Indicator

PtyID Party Identifier

PtyNm Party Name

PtyTypCd Party Type Code

RTN Routing Number

Addr Address [Element]

Contains the address of the 

payer. 

NonDomInd Non Domestic Indicator

FrgnPostalCd Foreign Postal Code

StCd State Code

CtyNm City Name

PostalCd Postal Code

PostalCdExt Postal Code Extension

CntryCd Country Code

AddrLnTxt Address Line Text [Element]

Container for individual lines of 

address information, up to 5 

entries. 

Payee Payee [Element]

Identifies the person or 

organization receiving 

payment. The Addr child 

element is available for 

reporting address information 

for the payee.

PtyID Party Identifier

PtyNm Party Name

Addr Address [Element]

Contains the address of the 

payee.

NonDomInd Non Domestic Indicator

FrgnPostalCd Foreign Postal Code

StCd State Code

CtyNm City Name
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 58

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

XML Schema Element Attributes in the

1 2 3 4 5 6 7 Element Description XML 5.0.1 Schema Extract Element and Attribute Names in Text

PostalCd Postal Code

AddrLnTxt Address Line Text [Element]

Container for individual lines of 

address information, up to 5 

entries. 

FrgnCrncy Foreign Currency [Element

A container for describing 

foreign currency information 

associated to a detailed 

transaction.

OrigCrncyCdTxt Original Currency Code Text

ExchRte Exchange Rate

ConvMthdCd Conversion Method Code

FrgnCrncyAmt Foreign Currency Amount

Excpt Exception [Element]

A container for reporting 

adjustments, corrections and 

rescissions (ACRs). The ACR 

information reported in the 

Excpt element provides a way 

back to the original report in 

which the affected transaction 

occurred. 

LglTxnAmt Legal Transaction Amount

OrigAgcyTxnID Original Agency Transaction Identifier

OrigBnkPostDt Original Bank Posting Date

OrigChnlTxnID Original Channel Transaction 

Identifier

OrigRecAmt Original Recorded Amount

OrigSttlTxnID Original Settlement Transaction 

Identifier

OrigVchrDt Original Voucher Number

OrigVchrNr Original Voucher Date

ResnCd Reason Code

ResnTxt Reason Text

AcctCls Account Classification [Element]

The container for Treasury 

accounting information, 

including TAS/BETC or Ckey 

Name/Value.

CrInd Credit Indicator

Amt Amount

Ckey Ckey [Element]

The container for reporting the 

classification key which is a 

unique agency accounting 

code assigned to a 

transaction. 

CkeyNm Classification Name

CkeyVal Classification Value

TAS_BETC TAS BETC [Element]

The container for Treasury SubLvlPrfxCd Sub-level Prefix Code
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 59

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

XML Schema Element Attributes in the

1 2 3 4 5 6 7 Element Description XML 5.0.1 Schema Extract Element and Attribute Names in Text

Account Symbol (TAS) and 

Business Event Type Code 

(BETC) pairs. 

AlctnTrfrAgcyID Allocation Transfer Agency Identifier

AgcyID Agency Identifier

BegngPdOfAvlblty Beginning Period Of Availability

EndPdOfAvlblty Ending Period Of Availability

AvlbltyTypCd Availability Type Code

MnAcctCd Main Account Code

SubAcctCd Sub Account Code

BETC Business Event Type Code

OrgLvl Organization Level [Element]

The container for items 

representing organizational 

hierarchy.

IntOrgCd Internal Organization Code

ID Internal Organization Code

RefNm Reference Name

BT_PgmDta Business Transaction Program Data 

[Element]

The BT_PgmDta element is a 

container for unstructured 

agency-specific data 

associated with the business 

transaction. Typically, it 

includes remittance 

information posted to 

receivables. There can be 

multiple occurrences 

BT_PgmDta

AgcyBillNm Agency Bill Name

AgcyFormNr Agency Form Number

AgcyFormNm Agency Form Name

BillAcctNr Bill Account Number

BillDt Bill Date

FormRvsnFileNm Form Revision File Name

ID Business Transaction Program Data 

Identifier

OMB_CtlNr Office of Management and Budget 

Control Number

RmtnID Remittance Identifier

UserDtaCnt User Data Count

UDF User Data Field [Element]

The UDF element has the 

actual content of the 

unstructured agency-specific 

data along with labels that 

describe what information is 

provided in the user data field. 

CUI_Ind CUI Indicator

ID User Data Field Identifier

Lab User Data Field Label

Vchr Voucher [Element]

The Vchr element is the 

container for an Agency’s 

AgcyCmtTxt Agency Comment Text

AgtCmtTxt Agent Comment Text
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 60

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

XML Schema Element Attributes in the

1 2 3 4 5 6 7 Element Description XML 5.0.1 Schema Extract Element and Attribute Names in Text

deposit summary for a given 

program. 

For summary and detail 

extracts, the Vchr may be 

reported as "partial" to indicate 

a break in the grouping of the 

information reported within the 

Sumry element. This is a new 

feature with the XML 5.0.1 

Extract files. 

ChnlInitnDt Channel Initiation Date

ChnlRcptDt Channel Receipt Date

CoinCrncyTotAmt Coin Currency Total Amount

CnfrmDt Confirmed Date

CrncyTotAmt Currency Total Amount

FY Fiscal Year

ExcptTypCd Exception Type Code

NonDomCollInd Non Domestic Collection Indicator

PartlInd Partial Indicator

RcptFromDt Receipts From Date

RcptToDt Receipts To Date

SvcdALC Serviced ALC

SmrzdDtlCnt Summarized Detail Count

TaxBkdwnCnt Tax Breakdown Count

VchrDt Voucher Date

VchrFormCd Voucher Form Code

ID Voucher Identifier

VchrNr Voucher Number

Tot Totals [Element]

A container that represents 

totals for information reported 

within the Sumry element. 

For summary and detail 

extracts, the totals will be 

calculated from the detail 

transactions within the Sumry. 

TotCnt Total Count

InfoOnlyTxnCnt Informational Only Transaction Count

SumryTotInd Summary Total Indicator

TotCrAmt Total Credit Amount

TotCrCnt Total Credit Count

TotDbtAmt Total Debit Amount

TotDbtCnt Total Debit Count

Tot Totals [Element]

A container that represents 

totals for information reported 

on the CollRpt (transmission) 

level. For summary and detail 

extracts, totals are provided for 

both Vchr level information and 

also detail level information.

TotCnt Total Count

SumryTotInd Summary Total Indicator

TotCrAmt Total Credit Amount

TotCrCnt Total Credit Count

TotDbtAmt Total Debit Amount

TotDbtCnt Total Debit Count
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 61

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

7.9 Attribute Definition

Table 12: Dictionary of Attributes provides a data dictionary for all the attributes that can appear in the XML extract file. The information in the 

table is sorted alphabetically by Element and then Attribute. 

The column "Additional Collection System Information" provides supplemental information when an attribute is used in different ways by different 

collection systems, or is only used by a specific collection system. 

 If there is no entry in this column, the standard definition supplies all the information needed to understand the attribute and is 

applicable for all Collection Systems. 

 If there is a value in quotes within the column that is the actual value that the particular collection system is providing. For 

example, the additional collection system information for Ckey for CkeyNm shows CAS containing 'Merchant ID'. This indicates 

that the literal 'Merchant ID' will be in the CkeyNm for CAS. 

 If there are no quotes, this is the attribute name in the collection system. For example, the additional collection system information 

for Ckey CkeyVal shows CAS containing the Merchant ID. This indicates that CAS will populate the Ckey CkeyVal with the value 

of Merchant ID.

The additional abbreviations used in this table (and not defined in the glossary) are:

 CAS: Card Acquiring Service 

 CG ACH: Credit Gateway ACH 

 CG Fed: Credit Gateway Fedwire 

Table 12: Dictionary of Attributes

5.01 Element 5.0.1 Attribute Standard definition Additional Collection System Information

AcctCls Amt The transaction amount associated to the accounting 

classification assigned by the input system.

AcctCls CrInd The indicator denoting whether a financial amount is a debit or 

credit. If the amount is greater than zero a value of '1' would be 

assigned and would be considered a 'credit'. If the amount is 

less than zero a value of '0' would be assigned and would be 

considered a 'debit'.
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 62

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

5.01 Element 5.0.1 Attribute Standard definition Additional Collection System Information

ACH_Addn ACH_PmtRelatInfoTxt The additional information an originator supplies about ACH 

entry detail records. This term is a standard field in an ACH 

item and its use is not limited to disbursements. The ACH 

payment related information is limited to 80 characters. 

CG ACH, Pay.gov ACH Debits

ACH_Addn AddnTypCd A code that specifically identifies the type, format and contents 

of the Addendum record.

CG ACH

ACH_Addn EntyDtlSeqNr A number assigned by the ODFI that uniquely identifies each 

entry within a batch in an ACH input file. First eight positions 

are the Routing Number of ODFI and the last seven positions is 

an item number assigned in ascending order to the entries 

within each batch. For Addenda Records, the Trace Number 

will be identical to the Trace Number in the associated Entry 

Detail Record

CG ACH

ACH_Addn SeqNr A sequence number used to order the addendum records in the 

ACH addendum.

CG ACH

ACH_Btch ID A unique identifier used for the ACH Batch. CG ACH

ACH_Dtl ACH_CoDescDtTxt The date an originator established to describe a transaction, for 

example, invoice date or due date.

CG ACH

ACH_Dtl ACH_OrigTrcNr The trace number as originally included on the entry being 

returned or acknowledged, or on the Prenotification being 

rejected or corrected. 

CG ACH

ACH_Dtl ACH_TrcNr The number used to identify an individual ACH entry within a 

batch.

CG ACH

ACH_Dtl ACH_TxnCd A code that identifies various types of debit and credit 

transactions. Portions of the code value can also be used to 

identify the account type associated with the transaction.

CG ACH, Pay.gov ACH Debits

ACH_Dtl ACH_TypCd The code that identifies the general categorization for the type 

of ACH Transaction, for example, Credit, Debit, Prenote, etc.

CG ACH, Pay.gov ACH Debits

ACH_Dtl AddnCnt The count of the records in the Addendum node. CG ACH, Pay.gov ACH Debits

ACH_Dtl CoDscnyDtaTxt The reference information an originator includes to enable 

specialized handling of the entry. 

CG ACH

ACH_Dtl CoEntyDesc A description of the purpose of the entry or transaction. 

Reversal transactions will be identified with a value of 

"REVERSAL".

CG ACH
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 63

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

5.01 Element 5.0.1 Attribute Standard definition Additional Collection System Information

ACH_Dtl DscnyDtaCd The code that an originator includes to enable specialized 

handling of the entry. 

CG ACH

ACH_Dtl EffEntyDt The intended settlement date, as provided by the originator. CG ACH, Pay.gov ACH Debits

ACH_Dtl ID A unique identifier used for the ACH_Dtl element to satisfy the 

XML hierarchy.

CG ACH, Pay.gov ACH Debits

ACH_Dtl OrgntrStatCd The code that identifies whether an originator is bound by 

certain ACH rules. 

CG ACH

ACH_Dtl StdEntyClsCd An acronym to specifically identify the type of entry or 

transaction. List of possible values is identified in the EDA 

schema.

CG ACH, Pay.gov ACH Debits

ACH_Dtl SvcClsCd The code that identifies whether the ACH entries in the batch 

are debits, credits, or both. List of possible values is identified in 

the EDA schema.

CG ACH

ACH_Info ACH_OrigTrcNr The trace number as originally included on the entry being 

returned or acknowledged, or on the Prenotification being 

rejected or corrected. 

ECP if the settlement mechanism is ACH. 

OTCnet E-Check Deposit if the settlement mechanism 

is ACH. Currently not captured by ECP or OTCnet

ACH_Info ACH_TrcNr A number assigned by the ODFI that uniquely identifies each 

entry within a batch in an ACH input file. First eight positions 

are the Routing Number of ODFI and the last seven positions is 

an item number assigned in ascending order to the entries 

within each batch. For Addenda records, the trace number will 

be identical to the trace number in the associated Entry Detail 

Record. 

ECP if the settlement mechanism is ACH. 

OTCnet E-Check Deposit if the settlement mechanism 

is ACH. Currently not captured by ECP or OTCnet

ACH_Info ACH_TxnCd A code that identifies various types of debit and credit 

transactions. Portions of the code value can also be used to 

identify the account type associated with the transaction. List of 

possible values is identified in the EDA schema.

ECP if the settlement mechanism is ACH. 

OTCnet E-Check Deposit if the settlement mechanism 

is ACH

ACH_Info ACH_TypCd The code that identifies the general categorization for the type 

of ACH Transaction, for example, Credit, Debit, Prenote, etc.

List of possible values is identified in the EDA schema.

ECP if the settlement mechanism is ACH. 

OTCnet E-Check Deposit if the settlement mechanism 

is ACH.

ACH_Info CoEntyDesc A description of the purpose of the entry or transaction. 

Reversal transactions will be identified with a value of 

"REVERSAL".

ECP if the settlement mechanism = ACH. OTCnet ECheck Deposit if the settlement mechanism = ACH. 

Currently not captured by ECP or OTCnet
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 64

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

5.01 Element 5.0.1 Attribute Standard definition Additional Collection System Information

ACH_Info EffEntyDt The intended settlement date, as provided by the Originator. ECP if the settlement mechanism = ACH. OTCnet ECheck Deposit if the settlement mechanism = ACH. 

Currently not captured by ECP or OTCnet

ACH_Info RecrInd Indicates if the item is a recurring transaction. ECP if the settlement mechanism = ACH. OTCnet ECheck Deposit if the settlement mechanism = ACH. 

Currently not captured by ECP or OTCnet

ACH_Info StdEntyClsCd An acronym to specifically identify the type of entry or 

transaction. List of possible values is identified in the EDA 

schema.

ECP if the settlement mechanism = ACH. OTCnet ECheck Deposit if the settlement mechanism = ACH.

ACH_Info SvcClsCd The code that identifies whether the ACH entries in the batch 

are debits, credits, or both. List of possible values is identified in 

the EDA schema. 

ECP if the settlement mechanism = ACH. OTCnet ECheck Deposit if the settlement mechanism = ACH. 

Currently not captured by ECP or OTCnet

ACH_Rec The 94-character NACHA formatted record value. Only provided for CG ACH Entry Detail, Batch 

Header, Addenda(s)

Addr AddrTypCd The code that identifies the type of address, e.g., shipping or 

billing.

Currently not used

Addr CnsulrCd The predefined code used between Treasury and USPS for 

mailing bulk check shipments to non-US countries via the 

consulate.

Currently not used

Addr CntryCd Country for the payer or payee giving or receiving the payment. 

Standard ISO 2-letter country code. List of possible values is 

identified in the EDA schema.

Addr CtyNm City name for the payer or payee giving or receiving the 

payment.

Addr FrgnPostalCd A code of letters and/or digits added to an address line of the 

financial institution giving or receiving the payment.

Addr NonDomInd Indicates whether the address for the payer or payee is within 

the US.

Addr PostalCd The 5-digit (ZIP) code that geographically identifies individual 

Post Offices or metropolitan area delivery stations associated 

with every mailing address.

Addr PostalCdExt The 4-digit code (ZIP+4) addition to a postal code that identifies 

a specific range of delivery addresses.
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 65

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

5.01 Element 5.0.1 Attribute Standard definition Additional Collection System Information

Addr PostNetBrcdDelPnt The PostNet barcode that is applied to the check for obtaining 

postage discounts. Currently not used

Currently not used

Addr RgnNm The foreign state, territory, or province name. Currently not used

Addr StCd The US state code or Canadian province for the payer or payee 

giving or receiving the payment. 

Addr USPS_IntelMlBarCd The field used for all intelligent barcode data elements. An 

agency must work with their Treasury payment servicing center 

and the US Postal Service to arrange for this service.

Currently not used

AddrLnTxt Address line for the payer or payee giving or receiving the 

payment. There are 0 to 5 address lines.

BT AgcyGrpID The identifier for a logical grouping of similar business units. Pay.gov Agency ID

BT AgcySiteID An identifier used by the agency for an account, for example, a 

Lockbox Number.

Reported in Sumry element

BT AgcySiteNm The name of the agency site that processes the transaction Reported in Sumry element

BT CnfrmDt The date that an agent or depositary electronically records or 

confirms a transaction. 

BT CollTxnTyp A high-level categorization of a financial transaction that 

identifies what type of transaction activity the financial 

transaction represents. List of possible values identified in the 

EDA schema: 'Adjustment', 'Chargeback', 'Collection', 

'Correction', 'Informational', 'Re-presentment', 'Return/Reversal', 

'Unknown'.

BT CshFlwID Identifies the cash flow channel and type of income. Reported in Sumry element

BT CshFlwNm The cash flow name assigned to the cash flow identifier. Reported in Sumry element
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 66

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

5.01 Element 5.0.1 Attribute Standard definition Additional Collection System Information

BT ID The identifier for a business transaction record provided to CIR 

by the sending channel application. 

CAS: Network Reference Number/Acquirer Reference 

Number 

CG Fed: PAR Sequence(12 (YYMMDD + 6-digit 

sequence) + 0/1 (credit/debit) 

CG ACH: Reference ID (ACH Entry Detail Trace 

Number + Amount + Effective Entry Date) + 0/1 

(credit/debit if Correction) 

Pay.gov: Pay.gov Tracking ID 

ECP: Sequence Generated Number (PIRN) 

OTCnet E-Check Deposit: IRN prefixed with a 

sequence number and a colon delimiter

BT InstlmInstncNr The number denoting a particular installment within a series of 

installments. 

Pay.gov

BT IntragovInd The indicator denoting whether a payer and payee are both 

federal government entities. 

BT IP_Addr The Internet Protocol (IP) address associated with a 

transaction. 

Currently not available

BT IptBtchID The identifier for a batch of transactions received by a program ECP: Batch ID

OTCnet E-Check Deposit: Batch ID

Pay.gov

BT NOC_UpdtRsltTxt The result of a notification of change (NOC) request against, for 

example, a payer profile. 

Pay.gov

BT NonDomCollInd Indicates whether the transaction associated with a collection is 

considered non-domestic. The values are: '0' - US currency; '1' -

Foreign currency

BT ProcgPgmNm The name of a source processing program, for example, the 

name of a Fiscal Service program that first processes a 

transaction. 

Reported in Sumry element.

BT ProcgSbprgNm The name of a subprogram or component of a source 

processing program. 

Reported in Sumry element.

BT RecrFreqCd The frequency of a recurring collection, for example: Annual, 

Bimonthly, Semiweekly, etc. See the EDA schema for additional 

values. 

Pay.gov

BT RmtnCnt The total number of remittance documents. ECP
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 67

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

5.01 Element 5.0.1 Attribute Standard definition Additional Collection System Information

BT RptSbprgNm The name of a subprogram or component of a reporting 

program.

Reported in Sumry element.

BT ScndryProcgPgmNm The name of an additional processing program; i.e., the name 

of a Fiscal Service program that is involved in processing a 

transaction.

Currently not used

BT ScndryProcgSbprgNm The name of a subprogram or component of an additional 

processing program.

Currently not used

BT SvcdALC The Agency Location Code (ALC) of the agency that receives 

services from another agency.

BT TotInstlmCnt The total count of installments in a related series of 

installments.

Pay.gov

BT UpdtInd The indicator denoting whether an item is an original transaction 

or an update. A value of "1" would mean that this is an update.

OTCnet E-Check Deposit for Represented 

transactions 

ECP for changes to the original transaction and 

Program Data Updates 

Pay.gov for Program Data updates. 

BT_PgmDta AgcyBillNm The name an agency assigns to an agency bill or invoice. Pay.gov Credit Card, ACH, PayPal, Dwolla

BT_PgmDta AgcyFormNm The number an agency assigns to an agency form. Pay.gov Credit Card, ACH, PayPal, Dwolla

ECP

BT_PgmDta AgcyFormNr The name an agency assigns to an agency form. Pay.gov Credit Card, ACH, PayPal, Dwolla

BT_PgmDta BillAcctNr The account number that links the instance of a bill to a user. 

Account numbers control which bills a user can view, update, 

and pay.

Pay.gov Credit Card, ACH, PayPal, Dwolla

BT_PgmDta BillDt The date a bill instance is created for an Agency cash flow. For 

example the Bill Date on the bill for which the payment is being 

rendered.

Pay.gov Credit Card, ACH, PayPal, Dwolla

BT_PgmDta CrspdCnt The total number of correspondence documents. Currently not available (future ECP)

BT_PgmDta FormRvsnFileNm The name that identifies the version of the form used for the 

transaction. 

Pay.gov Credit Card, ACH, PayPal, Dwolla

BT_PgmDta ID An identifier for the program data element, usually corresponds 

to the BT ID and FT ID. 

Pay.gov Credit Card, ACH, PayPal, Dwolla

ECP

OTCnet E-Check Deposit
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 68

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

5.01 Element 5.0.1 Attribute Standard definition Additional Collection System Information

BT_PgmDta OMB_CtlNr The number assigned by the Office of Management and Budget 

(OMB) to uniquely identify a government form.

Pay.gov Credit Card, ACH, PayPal, Dwolla

BT_PgmDta PgCnt The total number of pages for all documents. Currently not 

used. 

Currently not available (future ECP)

BT_PgmDta RmtnID The identifier for the remittance document provided. ECP

BT_PgmDta RmtnNm The name of the remittance document provided. ECP

BT_PgmDta UserDtaCnt The count of User Data occurrences for a specific remittance. Pay.gov Credit Card, ACH, PayPal, Dwolla

ECP

OTCnet E-Check Deposit

ChkDtl ChkSerNr Contains the serial number of a check and so only applies if the 

payment medium is Check.

OTCnet E-Check Deposit

ECP

ChkDtl ChkTrcNr The unique identifier for traceability within Check21 processing. Currently not available

ChkDtl ChkTypCd The code that identifies the type of check, e.g. personal, 

business, money order, etc. Only applies if the payment 

mechanism is Check. List of possible values is identified in the 

EDA schema.

OTCnet E-Check Deposit

ECP

ChkDtl MICR_Unprsd The Magnetic Ink Character Recognition (MICR) information 

from a check, captured as a single string.

OTCnet E-Check Deposit

ECP

ChkDtl ProcgMthdCd The code that identifies whether a check is presented by a 

check writer who is present at the agency location.

OTCnet E-Check Deposit

ECP

ChkDtl RsrhRqrdInd The indicator denoting whether the check transaction has been 

flagged for research.

ECP

ChkImgRef ChkImgTypCd The code that identifies whether a check image is the front or 

back of the check. List of possible values is identified in the 

EDA schema. 

Currently not used

ChkImgRef ID The unique identifier for an image. Currently not used

ChkImgRef ImgAddrID The address that provides the unique location for the image 

content.

Currently not used

ChkImgRef ImgLenNr The size of an image in bytes. Currently not used

ChkImgRef ImgOffstNr The starting point in bytes for a particular image within a batch. Currently not used
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 69

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

5.01 Element 5.0.1 Attribute Standard definition Additional Collection System Information

Ckey CkeyNm 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.

OTCnet: 'Agency Accounting Code' 

CAS: 'Merchant ID' 

ECP: 'ECP ALC+2', 'Tax Class' 

Pay.gov: 'Pay.gov ALC+2' for most transactions;

'Merchant ID' for some credit card transactions 

CG ACH: 'CG ACH' 

CG Fed: 'CG Fedwire' 

EFTPS: 'IRS TAX CLASS' 

FRBCL MISC: Populated with a literal value that 

pertains to the reporting program and subprogram, 

separated by a 'pipe' character. The data that is sent 

is restricted to a length of 25 characters. Some 

examples include: 'BPD|SCHED OF FED DEBT ALC', 

'DEBIT GATEWAY-AGENCY DIRE', 'PCC OTC| ALC', 

'BPD|ADMIN ALC', 'OTCNET|E-CHECK DEPOSIT 

AL', 'CURRENCY BUREAUS| ALC'

SVC Eagle Cash: 'SVC EagleCash ALC'

SVC EZ Pay: 'SVC EZpay ALC'

Ckey CkeyVal The string that contains the actual CKey Value. OTCnet: Agency Accounting Code 

CAS: Merchant ID 

ECP: ALC+2 

Pay.gov: ALC+2 (for most transactions), Merchant ID 

for some credit card transactions 

CG ACH: Credit Gateway sub-account 

CG Fed: Credit Gateway sub-account EFTPS: 'TAXCLASS-(n)-AMT' where n is the Tax Class Code (1, 2, 

3, 4, 5, 7, 8, 9) FRBCL MISC: ALC

CollRpt EOD_Ind The indicator denoting whether a file is considered the end-ofday file. CIR will always populate with a value of '0' for extract 

files. 

CollRpt ID Value generated by CIR that uniquely identifies the extract file.

CollRpt IptSysTxt The sending partner that provides information to a receiving 

partner. CIR will always populate with the value "CIR" for 

extract files. 

CollRpt SeqNr CIR will always populate with the value "1".
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 70

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

5.01 Element 5.0.1 Attribute Standard definition Additional Collection System Information

CollRpt TrnsmTs The date and time when the extract was created.

Excpt LglTxnAmt The amount that should have been reported on the original 

transaction. For an encoded error, this amount equals the 

amount of the adjustment transaction plus the original recorded 

amount. 

ECP – Adjustments

OTCnet E-Check Deposits – Adjustments (future)

Excpt OrigAgcyTxnID The agency transaction identifier an agency assigned for the 

original transaction.

Pay.gov: Agency Tracking ID

Excpt OrigBnkPostDt The bank posting date associated with the original transaction. ECP

OTCnet E-Check Deposits

Pay.gov

Excpt OrigChnlTxnID The identifier a channel assigned for the original transaction.

Excpt OrigRecAmt The amount originally recorded for the transaction. ECP – Adjustments

OTCnet E-Check Deposits – Adjustments (future)

Excpt OrigSttlTxnID The settlement transaction identifier a settlement provider 

assigned for the original transaction.

Excpt OrigVchrDt The voucher date of the original voucher or ticket that is being 

adjusted or corrected.

ECP

OTCnet E-Check Deposits

Pay.gov

Excpt OrigVchrID The voucher identifier of a voucher that a subsequent voucher 

adjusts, corrects, or rescinds.

Excpt OrigVchrNr The voucher number (debit voucher or deposit ticket number) 

that identifies the original voucher or ticket that is being 

adjusted or corrected.

ECP

OTCnet E-Check Deposits

Pay.gov

OTCnet Bank Deposits 

Excpt ResnCd Code to identify the reason for an adjustment and could be 

populated for adjustments, returns and corrections.

ECP

Pay.gov PayPal: PayPal Transaction Code

OTCnet E-Check Deposits: 

Pay.gov ACH: ACH Reason Code

Excpt ResnTxt The descriptive reason for an adjustment, return or correction. Pay.gov PayPal: PayPal Transaction Code description

Pay.gov ACH: ACH Reason Description

CAS: Chargeback reason
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 71

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

5.01 Element 5.0.1 Attribute Standard definition Additional Collection System Information

FrgnCrncy ConvMthdCd The method used to convert the foreign currency amount to US 

Dollars. List of possible values is identified in the EDA schema. 

CG ACH: ACH IAT Transactions

FrgnCrncy ExchRte The exchange rate used to convert a foreign currency to an 

amount in US currency. Since multiple formats can be used for 

foreign currencies the format for this exchange rate amount field 

is string.

OTCnet Bank Deposit

FrgnCrncy FrgnCrncyAmt The amount of the transaction as expressed in the foreign 

currency. Since multiple formats can be used for foreign 

currencies the format for this amount field is string.

CG Fed: 3710 Instructed Amount CG ACH: ACH IAT 

Transactions OTCnet Bank Deposit

FrgnCrncy OrigCrncyCd The code that defines the type of foreign currency using the 

standard three-letter ISO 4217 currency codes.

Currently not used

FrgnCrncy OrigCrncyCdTxt The non-standard currency code. OTCnet Bank Deposit

FT AgcyTxnID The identifier an agency provides for a transaction. Pay.gov: Agency Tracking ID

FT Amt The detail transaction amount. The amount is always positive 

(unsigned). The actual sign of the amount is determined based 

on the Sumry CrInd value. 

FT ChnlInitnDt The date that the transaction was initiated, for example, the 

date that the lockbox opened up the payment or the date the 

payment was mailed.

CG Fed: IMAD Input Cycle Date 

Pay.gov: Transaction Date 

CAS: Transaction Date 

OTCnet E-Check Deposit: Capture date, or the date 

the check was scanned.

FT ChnlRcptDt The date that an agent or depositary receives a transaction. ECP: Capture Date 

Pay.gov: Transaction Date 

CG ACH: Process Date 

CG Fed: Process Date 

CAS: Transaction Date 

OTCnet E-Check Deposit: Receive Date

FT ChnlTxnID The identifier a channel assigned for the original transaction.
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 72

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

5.01 Element 5.0.1 Attribute Standard definition Additional Collection System Information

FT ID The identifier for a financial transaction record provided to CIR 

by the sending channel application.

CAS: Network Reference Number/Acquirer Reference 

Number 

CG Fed: PAR Sequence(12 (YYMMDD + 6-digit 

sequence) + 0/1 (credit/debit) 

CG ACH: Reference ID (ACH Entry Detail Trace 

Number + Amount + Effective Entry Date) + 0/1 

(credit/debit if Correction)

Pay.gov: Pay.gov Tracking ID 

ECP: Sequence Generated Number (PIRN) 

OTCnet E-Check Deposit: IRN

FT PayerMchsmCd The payment medium for the transaction. List of possible 

values is identified in the EDA schema.

CAS: 'Credit Card', 'Debit Card' 

CG ACH: 'ACH' 

CG Fed: 'Wire'

Pay.gov: 'ACH', 'Credit Card', 'Other'

ECP: 'Paper Check' 

OTCnet E-Check Deposit: 'Paper Check'

FT RecrInd Indicates if the item is a recurring transaction. Pay.gov: ACH Debits only 

CG ACH: Applicable only to some WEB transactions

FT RptrID The identifier of the person or entity submitting the transaction 

to the channel application.

OTCnet E-Check Deposit: Cashier ID

ECP: Operator ID

Pay.gov: UserName

FT SttlMchsmCd The settlement system that was used to complete this 

transaction. List of possible values is identified in the EDA 

schema.

Reported in Sumry element.

FT SttlRcptDt The date payment was received. An example would be the 

date that the lockbox opened up the payment.

Reported in Sumry element.

FT SttlStatCd The settlement status code that identifies how the transaction 

was settled.

OTCnet E-Check Deposit

ECP

Pay.gov

Pay.gov PayPal: PayPal Transaction Status 

FT SttlTxnID The identifier for a transaction within the settlement service. Pay.gov PayPal: PayPal Transaction ID
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 73

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

5.01 Element 5.0.1 Attribute Standard definition Additional Collection System Information

FwireDtl BusFcnCd The code that identifies the type of business the message 

represents, e.g., bank transfer (BTR), drawdown response 

(DRW), etc.

CG Fed

FwireDtl FwireSubTypCd The code used in combination with the Fedwire type code to 

identify the type of Fedwire Message. List of possible values is

identified in the EDA schema.

CG Fed

FwireDtl FwireTypCd The code used to identify the type of Fedwire Message, e.g., 

funds transfer, foreign transfer, etc. List of possible values is 

identified in the EDA schema.

CG Fed

FwireDtl IMAD Identifies the transaction within the collection system/settlement 

service.

CG Fed

FwireDtl IncmgTxnInd The indicator denoting whether the Fedwire message 

represents a transaction received into the Treasury's Fedwire 

account or sent from the Treasury's Fedwire account. A value of 

'1' indicates the Fedwire message is incoming. 

CG Fed

FwireDtl OMAD The Output Messaging Accountability Data (OMAD) is a 

combination of a date, destination identifier, and sequence 

number assigned to a Fedwire message when it is processed 

by the Federal Reserve Bank Funds Transfer application.

Currently not used

FwireDtl OrigIMAD The original Input Messaging Accountability Data (IMAD) 

associated with an earlier Fedwire message, also known as 

'Previous IMAD'.

CG Fed

FwireDtl TotCnt The total number of items. CG Fed

ImgRef ID The container that provides the reference identifiers to an image 

file. Currently not used.

Currently not used

ImgRef ImgAddrID The address that provides the unique location for the image 

content.

Currently not used

ImgRef ImgLenNr The size of an image in bytes. Currently not used

ImgRef ImgOffstNr The starting point in bytes for a particular image within a batch. Currently not used

MssgDtaElmt CUI_Ind Indicator that the Fedwire Data Element contains privacy data. CG Fed

MssgDtaElmt ElmtNm Name of element within the tag (e.g. Output Cycle Date). See 

Appendix A for the list of possible values.

CG Fed
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 74

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

5.01 Element 5.0.1 Attribute Standard definition Additional Collection System Information

MssgDtaElmt FwireTagCd The numeric value for the Fedwire Section that represents the 

tag number as defined in a Fedwire message. For example 

"1520". See Appendix A for the list of possible values.

CG Fed

MssgDtaElmt ID 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.

CG Fed

MssgDtaElmt SeqNr A sequence number used to order the Fedwire message data 

elements. 

CG Fed

MssgDtaElmt UnstrdDtaInd The indicator denoting whether the value element contains 

unstructured content. A value of '1' indicates that the data in 

MssgDtaElmt is unstructured. 

CG Fed

MssgDtaElmt Value of element within the tag (e.g. value of the Output Cycle 

Date).

CG Fed

OrdLvl_III_Dta Card Order Unstructured Data Pay.gov Credit Card

OrgLvl ID The identifier for a particular level within an organizational unit 

of the Federal Government.

OTCnet Bank Deposit 

OTCnet E-Check Deposit

OrgLvl IntOrgCd The code that identifies the entity that manages resources 

below the agency and bureau level, such as an office or a 

division.

OTCnet Bank Deposit 

OTCnet E-Check Deposit

OrgLvl RefNm The reference name for a data record. OTCnet Bank Deposit 

OTCnet E-Check Deposit

Payee AgtBnkAcctNr The account number of a deposit account at a financial agent or 

depositary that the bank uses for transactions involving public 

money.

Reported on Sumry

Payee AgtRTN The routing number (RTN) associated with an agent or 

depositary.

Reported on Sumry

Payee PtyID The ID by which the Payee recognizes the originator of the 

transaction, for example the beneficiary ID on a FedWire or the 

Entry Detail Identification Number or Batch Company ID on an 

ACH.

CG Fed: Beneficiary Identifier

CG ACH: Entry Detail Identification Number or Batch 

Company ID
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 75

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

5.01 Element 5.0.1 Attribute Standard definition Additional Collection System Information

Payee PtyNm The name of the party receiving the payment whether individual 

or organization.

CG Fed: Originator Name or Beneficiary Name or 

DRW Name 

CG ACH: ACH Entry Detail Receiving Company 

Name/Individual Name 

CAS: Merchant Name (DBA Name)

Pay.gov: Agency Name 

ECP: Owner Organization of the cash flow

Payer BnkAcctNr The bank account number of the financial institution giving the 

payment. 

Payer BnkAcctTypCd Indicates whether the bank account is a checking account (C), 

savings account (S), or general ledger account (G). The EDA 

schema includes a value for loan account (L) which is not used 

within CIR.

Payer NonDomBnkInd Indicates whether the bank is a US domestic bank based on the 

bank's address.

Payer PtyID The ID by which the Receiver is known to the Originator. For 

example the invoice number on an ACH (from the ACH 

Individual ID number).

CG Fed: Beneficiary Reference 

CG ACH: ACH Batch Company Identification or Entry 

Detail Individual Identification Number

Payer PtyNm The name on face of credit card or bank account from which the 

funds will be drawn.

CG Fed: Originator Name or Beneficiary Name or 

DRW Name 

CG ACH: ACH Batch Company Name/Individual 

Name

Pay.gov: Account Holder Name

Payer PtyTypCd Indicates whether the party giving the payment is an Individual, 

Business or Government. If unknown, then no value is provided. 

List of possible values identified in the EDA schema are 

'Individual', 'Business' and 'Government.'

CAS: Derived from Card Product Type

Payer RTN Used synonymously as ABA routing number and routing transit 

number. The 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. When BankInfo appears in the XML hierarchy under 

Payer or under Summary it represents the institution giving the 

money. When BankInfo appears in the XML hierarchy under 

Payee it represents the institution receiving the money.
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 76

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

5.01 Element 5.0.1 Attribute Standard definition Additional Collection System Information

PgmDta ID The identifier for the Program Data provided to CIR by the 

sending channel application. 

ECP: Remittance ID (RIRN) 

Pay.gov: Tracking ID 

OTCnet E-Check Deposit: IRN 

OTCnet Bank Deposit: sequential number

PgmDta UserDtaCnt The count of User Data occurrences for a specific Program 

Data ID.

ECP

Pay.gov

OTCnet E-Check Deposit

PlstcCrdDtl AdjTypCd The code identifying the type of change to a previous 

transaction.

CAS and Pay.gov Credit Card transactions only.

PlstcCrdDtl AuthCd A three-character code that defines how the authorization for 

the card was read. The first two positions refer to how the card 

was read and the third position refers to the capture of the PIN. 

CAS and Pay.gov Credit Card transactions only. 

An example of the code and the meaning for the first 2 

positions is '02' means Magnetic Stripe Read. An 

example of the code for the third position is '1' means 

Terminal Can Accept and Capture PINS.

PlstcCrdDtl AuthChrsCd A one-character code that defines if the card was presented for 

authorization, whether the merchant name and location were 

provided, if the card was not provided what authorization was 

used. 

CAS and Pay.gov Credit Card transactions only. 

An example of the code is 'A' means Card present.

PlstcCrdDtl AuthRqstRspCd The code that indicates whether the transaction is approved or 

declined. If declined, it will indicate why it was declined.

CAS and Pay.gov Credit Card transactions only.

PlstcCrdDtl AuthSrcCd A one-character code that identifies the authorization source for 

the card transaction.

CAS and Pay.gov Credit Card transactions only. 

An example of the code is '9' means Automated 

Referral Service Response

PlstcCrdDtl AVS_RspCd A one-character code that the merchant received when 

processing the transaction related to the processing of the 

address information.

CAS and Pay.gov Credit Card transactions only. 

An example of the code is 'Y' means Address and 5-

digit ZIP code match

PlstcCrdDtl CAT_Cd A one-character code that provides the type of Cardholder 

Activated Terminal Indicator (CAT).

CAS and Pay.gov Credit Card transactions only. 

An example of the code is '1' means Type A UATLimited Amount Terminal

PlstcCrdDtl ChnlCtffTm The time that determines the end of a 24 hour day for plastic 

card payments, when a transaction will be sent for settlement, 

as defined by the agency.

CAS and Pay.gov Credit Card transactions only.

PlstcCrdDtl ClntBtchNr A six character client batch number if supplied. CAS and Pay.gov Credit Card transactions only.
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 77

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

5.01 Element 5.0.1 Attribute Standard definition Additional Collection System Information

PlstcCrdDtl CrdEvnTypCd The event type of the plastic card transaction, e.g., Sale, 

Authorization, Void Sale, etc.

CAS and Pay.gov Credit Card transactions only. 

Pay.gov Plastic Card: 'Sale', 'Authorization', 'Force', 

'Refund'. 

CAS: 'Card Sale', 'Card Return', 'POS Debit', 'POS 

Credit'. 

CrdEvnTypCd is not available on Credit Card 

Chargebacks and Returns 

PlstcCrdDtl CrdNr The partial portion of the credit card or debit card number used 

for the payment that was provided to CIR.

Currently not used

PlstcCrdDtl CrdNtwrkTypCd The type of network the plastic card used for a payment. Valid

Values: VISA, MCRD, AMEX, DISC

CAS and Pay.gov Credit Card transactions only.

PlstcCrdDtl CrdPrdctCd The type of card used for the transaction. For example, AX 

(American Express).

CAS and Pay.gov Credit Card transactions only.

PlstcCrdDtl CrdPrdctTypCd A code valid only for Visa, Discover and MasterCard that 

provides information on the type of card.

CAS and Pay.gov Credit Card transactions only.

An example of the code is 'CC' for Visa Classic Credit

PlstcCrdDtl CrdRspCd A value that corresponds with the results of the transaction. 

This value represents whether the CVV2 matches or has been 

processed.

CAS and Pay.gov Credit Card transactions only. 

PlstcCrdDtl CrdSctyCd The 3 or 4 digit value printed on the card or signature strip but 

not available on the magnetic strip.

Currently not used

PlstcCrdDtl CrgbkRecNr Record number for any single customer transaction that is 

questioned, used to relate all disputes and subsequent records.

CAS and Pay.gov Credit Card transactions only. 

PlstcCrdDtl CrgbkRefNr The network reference number related to the chargeback. CAS and Pay.gov Credit Card transactions only. 

PlstcCrdDtl CshBckAmt Amount of money that is added to the total purchase price of a 

transaction (paid by debit card). The customer receives the 

extra amount in cash along with their goods.

CAS and Pay.gov Credit Card transactions only. 

PlstcCrdDtl DrftLoctNr Customer supplied reference data used for matching and/or 

tracking transactions.

CAS and Pay.gov Credit Card transactions only. 

PlstcCrdDtl ID An identifier for the plastic card detail element as required by 

the XML schema. 

CAS and Pay.gov Credit Card transactions only. 

PlstcCrdDtl IntchgAdjAmt The amount that the merchant must pay to the network carrier 

(i.e. Visa, MasterCard, AMEX, Discover) representing the true 

cost of a plastic card transaction.

CAS and Pay.gov Credit Card transactions only. 
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 78

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

5.01 Element 5.0.1 Attribute Standard definition Additional Collection System Information

PlstcCrdDtl IntchgAdjAmtSgnInd The sign of the InterchangeAdjustmentAmount. If the 

Interchange Adjustment Amount is less than zero then this 

value equals '-' else it equals '+'.

CAS and Pay.gov Credit Card transactions only. 

PlstcCrdDtl IntchgAdjResnCd A code value that provides the reason for the interchange fee 

adjustment.

CAS and Pay.gov Credit Card transactions only. 

PlstcCrdDtl IntchgCd A code that identifies the type of transaction that the 

interchange fee applies to and dictates the interchange fee 

amount applied to the transaction.

CAS and Pay.gov Credit Card transactions only. 

PlstcCrdDtl IntchgRembrsFeeAmt The amount that the merchant must pay to the network carrier 

(i.e. Visa, MasterCard, AMEX, Discover) representing the true 

cost of a plastic card transaction.

CAS and Pay.gov Credit Card transactions only. 

PlstcCrdDtl IntchgRembrsFeeAmtSgnInd The sign of the InterchangeReimbursmentFeeAmount. If the 

Interchange Adjustment Amount is less than zero then this 

value equals '-' else it equals '+'.

CAS and Pay.gov Credit Card transactions only. 

PlstcCrdDtl MrchntCatCd The code that designates the type of merchant business (food, 

department store, etc.) for a plastic card transaction.

CAS and Pay.gov Credit Card transactions only. 

PlstcCrdDtl MrchntNr The unique identifier of the plastic card merchant, as assigned 

by the settlement provider. For collections activities this 

identifier currently uniquely represents an Agency within the 

plastic card settlement provider.

CAS and Pay.gov Credit Card transactions only. 

PlstcCrdDtl MrchntStrNr A nine-digit merchant store number assigned by Fifth Third. 

Field is right justified and zero filled. Example: '000054321'

CAS and Pay.gov Credit Card transactions only. 

PlstcCrdDtl MskdCrdNr The masked credit card or debit card number. CAS and Pay.gov Credit Card transactions only. 

PlstcCrdDtl MthYrExpirDt The month/year value of the expiration date on the plastic card 

used for the payment.

CAS and Pay.gov Credit Card transactions only. 
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 79

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

5.01 Element 5.0.1 Attribute Standard definition Additional Collection System Information

PlstcCrdDtl NtwrkRspCd A string of fields used to define the card provider's response. 

Different strings are used for Visa, for MasterCard, and for all 

other provider response codes. 

For Visa: 15 character Transaction ID + 4 character Validation 

Code and a 2 character Authorization Response Code 

For MasterCard: 9 Character Banknet Reference Number + 4 

character Banknet Settlement Date + 8 characters that are 

reserved for future use.

For all other providers: Business Date -MMDDCCYY format + 

12 character Retrieval Reference Number + 1 character CAVV 

Response + 1 character Void Indicator + 3 character Origin 

Type + 2 character Visa Card Level Results/Visa Product Code.

CAS and Pay.gov Credit Card transactions only. 

PlstcCrdDtl OrdID The identifier for plastic card order-level data. CAS and Pay.gov Credit Card transactions only. 

PlstcCrdDtl OrigIntchgCd A two-character value that identifies the business type of the 

merchant. The classification is used for interchange fee 

purposes.

CAS and Pay.gov Credit Card transactions only. 

PlstcCrdDtl PlstcTypCd The code that identifies the type of plastic card medium used, 

e.g., credit card, gift card, etc. List of possible values identified 

in the EDA schema are: 'CRT', 'DBT', 'EBT', 'GFT', 'WIC'

CAS and Pay.gov Credit Card transactions only. 

PlstcCrdDtl POS_EntyMde A three-character code that provides the entry mode. The first 

two positions refer to how the card was read and the third 

position refers to the capture of the PIN. 

CAS and Pay.gov Credit Card transactions only. 

An example of the code is for the first 2 positions '02' 

means Magnetic Stripe Read. For the third position '1' 

means Terminal Can Accept and Capture PINS.

PlstcCrdDtl RgstrNr A four-character number provided if available with the number 

of the register where the card transaction occurred.

CAS and Pay.gov Credit Card transactions only. 

PlstcCrdDtl StrPrsnID The identifier of the salesperson who performed the transaction. CAS and Pay.gov Credit Card transactions only. 

PlstcCrdDtl TaxblAmt The taxable amount of the transaction. CAS and Pay.gov Credit Card transactions only. 

PlstcCrdDtl TrmNr A nine-character number provided if available with the number 

of the terminal where the card transaction occurred.

CAS and Pay.gov Credit Card transactions only. 

PlstcCrdDtl TxnTm The time of the transaction (along with transaction date). CAS and Pay.gov Credit Card transactions only. 

PlstcCrdDtl TxnTmZnCd The time zone where the transaction occurred. CAS and Pay.gov Credit Card transactions only. 

Sumry AcctbBusLnCd The business line of a transaction's content (as opposed to the 

business line of the program that processes the transaction, 

which is not always the same).

Currently not used
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 80

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

5.01 Element 5.0.1 Attribute Standard definition Additional Collection System Information

Sumry AgcySiteID The physical location where the transaction occurred. CAS and Pay.gov Credit Card: Merchant ID 

Navy Cash: Ship Name

SVC Eagle Cash, EZ Pay: Base Camp ID

OTCnet E-Check Deposit: OTC Endpoint Short Name

OTCnet Bank Deposit: OTC Endpoint

Sumry AgcySiteNm The name of the agency site that processes a transaction.

Sumry AgtBnkAcctNr The account number of a deposit account at a financial agent or 

depositary that the bank uses for transactions involving public 

money.

Sumry AgtBnkNm The name of the agent or depositary. Currently not used

Sumry AgtRTN The routing number (RTN) associated with an agent or 

depositary.

Sumry ALC Identifies the accounting office within an agency that reports 

disbursements and collections to Treasury.

Sumry BnkBrnchID The identifier for a financial institution branch. Currently not available (future OTCnet Bank Deposit)

Sumry BnkPostDt The date that an agent or depositary credits or debits funds to 

or from a Treasury account (either a deposit account or routing 

number (RTN)). Formerly Settlement Date/Deposit Date

CAS: Wire Date 

CG ACH: ACH Batch Settlement Date 

CG Fed: Confirmed Date 

ECP: Effective date 

Pay.gov: Effective date 

OTCnet E-Check Deposit: Debit Gateway deposit 

date for Settled and Retired transactions; representment effective date for Represented 

transactions, and expected settlement date for Failed 

transactions.

Sumry BulkPrvrNm The name of a payroll provider that makes tax payments 

through an Electronic Data Interchange (EDI) compatible 

system.

EFTPS only

Sumry BurNm The name of a bureau. Currently not used

Sumry CAN The six-digit identifier representing a Central Accounts 

Receivable System (CARS) account profile that includes a 

legacy CA$HLINK account type, routing number (RTN), deposit 

account, deposit funds availability, and cost code information, 

as well as potentially other factors.
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 81

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

5.01 Element 5.0.1 Attribute Standard definition Additional Collection System Information

Sumry ChnID The identifier assigned to each account by a plastic card 

provider. Some agencies have more than one chain to 

differentiate between major lines of business. The chain 

identifier is associated to division identifier. 

CAS: Chain identifier

Pay.gov Credit Card: Chain identifier

Sumry ChnlEInd The indicator denoting whether the Fiscal Service program 

received the transactions electronically.

Currently not used

Sumry ChnlTypCd The delivery method used by remitter to initiate payment to the 

agency. Channel identifies the original point of payment 

initiation, the first interface between the payer and the 

government. List of possible values identified in the EDA 

schema are: 'Bank', 'Internet', 'Mail', 'Mobile', 'OTC', 'Phone'.

Note that 'Mobile' is currently not used in the extracts. 

Sumry CollBusDt The business date that the transaction was assigned when it 

was processed by CIR. The business date controls when the 

transaction is reported to CARS/GWA and corresponds to the 

report date in CARS/GWA. 

Sumry CollStatCd Identifies what state the transaction currently represents in the 

collection transaction life cycle. List of possible values identified 

in the EDA schema are: 'Cancelled', 'In-Process', Received', 

'Rejected', 'Retired', 'Settled', 'Unknown'. 

CG ACH Intraday, CG Fed Real-Time and OTCnet ECheck Deposit Represented transactions all have a 

status of 'In-Process' since the financially settled 

transaction is sent separately to CIR

Sumry ComlBnkInd The indicator denoting whether the item was settled through a 

commercial depositary. A value of '1' would mean that it is a 

commercial transaction. 

CAS: All commercial 

CG ACH: Non-commercial (though this indicator does 

not apply)

CG Fed: Non-commercial (though this indicator does 

not apply)

ECP: All non-commercial (at least until FA settled 

items are sent) 

EFTPS: All non-commercial

OTCnet Bank Deposit: All commercial

OTCnet E-Check Deposit: All non-commercial

Pay.gov ACH: Non-commercial

Pay.gov Credit Card, PayPal, Dwolla: Commercial. 

FRB CL Misc: All non-commercial 

SVC Navy Cash, Eagle Cash, EZ Pay: Commercial
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 82

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

5.01 Element 5.0.1 Attribute Standard definition Additional Collection System Information

Sumry CostCtrWrkUnitCd The Cost Center Work Unit for FRB deposits and adjustments 

often abbreviated as CCWU.

Provided only on non-commercial (FRB settled) 

transactions

Sumry CrInd The indicator denoting whether a financial amount is a debit or 

credit. If the amount is greater than zero a value of '1' would be 

assigned and would be considered a 'credit'. If the amount is 

less than zero a value of '0' would be assigned and would be 

considered a 'debit'.

Sumry CshFlwID Identifies the cash flow channel and type of income. Pay.gov: ALC +2 

ECP: ALC +2 

CG Fed: Credit Gateway sub-account 

CG ACH: Credit Gateway sub-account

OTCnet E-Check Deposit: ALC + 2

Sumry CshFlwNm The cash flow name assigned to the cash flow identifier. Pay.gov: Application Name 

ECP: Cashflow Name 

CG Fed: Sub-account Name 

CG ACH: Sub-account Name

OTCnet E-Check Deposit: Endpoint Description

Sumry DivID The identifier assigned to each account by a plastic card 

provider that represents a deposit into the Collections 

Information Repository (CIR), when combined with a Chain. 

CAS: Division identifier

Pay.gov Credit Card: Division identifier

Sumry FRB_AcctKeyCd The identifier for a program assigned within FRB CA$H-LINK, 

known within that system as an account key. The FRB CA$HLINK account key is similar to the Collections Account Number 

(CAN), but is only used for financial activity involving Federal 

Reserve Banks.

Provided only on non-commercial, FRB settled,

transactions

Sumry FRB_DistCd The code denoting the general area of coverage for a Federal 

Reserve Bank. The Federal Reserve System assigns district 

codes. List of possible values is identified in the EDA schema.

Provided only on non-commercial, FRB settled,

transactions

Sumry FRB_OfcCd The code denoting a particular Federal Reserve Bank location 

within a given Federal Reserve Bank district.

Provided only on non-commercial, FRB settled,

transactions

Sumry ID A CIR generated identifier for the summary element that is 

required by the schema hierarchy.
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 83

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

5.01 Element 5.0.1 Attribute Standard definition Additional Collection System Information

Sumry InitProcgSiteID The identifier for initial agent or depositary site that receives a 

transaction. For example, each lockbox processing site can 

have its own identifier.

ECP: Financial Agent ID (FAID)

Sumry IptSysTxt The sending trading partner (e.g. what channel provided the 

collection information to CIR).

CAS (Card Acquiring Service) 

CGACH (Credit Gateway ACH)

CGFEDWIRE (Credit Gateway Fedwire)

DVS (Direct Voucher System)

ECP (ECP) 

EFTPS-ACH CR (EFTPS ACH Credits)

EFTPS-ACH DR (EFTPS ACH Debits)

EFTPS-OLBP (EFTPS ACH OLBP)

EFTPSAGYTAX (EFTPS Agency Tax)

EFTPS-WIRE (EFTPS Wire)

FRBCL MISC (FRB CA$H-LINK – Miscellaneous FRB 

Deposits 

NAVYCASH 

OTCNET-CHK (OTCnet E-Check Deposit)

OTCNET-TGA (OTCnet Bank Deposit)

PAYGOV (Pay.gov)

SVCBOS (Eagle Cash. EZ Pay)

Sumry IRS_TaxInd Indicates if the item is a tax collection transaction. A value of '1' 

indicates an IRS Tax collection.

Sumry LkbxAcctID The identifier for the lockbox activity received by a lockbox 

processing site.

ECP only

Sumry MnlEntyInd The indicator denoting whether an entry was captured through 

manual entry by an agent. A value of '1' indicates manual entry. 

Currently not used

Sumry NonDomBnkInd The identifier denoting whether the Fiscal Service considers an 

entity to be non-domestic. A value of '1' indicates non-domestic.

Sumry NonTreasCollCd The identifier that indicates whether a collection is the 

responsibility of a non-governmental agency or a government 

agency that holds cash outside of Treasury. List of possible 

values identified in the EDA schema are 'NGAF' and, 'CIHO'.

OTCnet E-Check Deposit only
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 84

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

5.01 Element 5.0.1 Attribute Standard definition Additional Collection System Information

Sumry OrgNm The official name by which an Organization Unit of the United 

States Federal Government is referred. (Title of the Agency 

Location)

Currently not used

Sumry OthScndryRTN The routing number (RTN) used to segregate transaction 

activity that is reported to the Treasury's Master Account 

through a Subaccount RTN, to accommodate reporting and 

operational needs. It is also referred to as an Other Secondary 

Customer Identification Number (CIN) by the Federal Reserve 

or as a Tier 3 RTN by Treasury.

Sumry PgmTrcID The identifier a financial agent provides to support traceability 

throughout a collection lifecycle.

ECP: Agent Trace ID

Sumry ProcgPgmNm The name of a source processing program; i.e., the name of a 

Fiscal Service program that first processes a transaction.

Sumry ProcgSbprgNm The name of a subprogram or component of a source 

processing program.

Sumry RcptMchsmCd The code that identifies the format of a financial instrument 

when a collections channel program receives it. List of possible 

values is identified in the EDA schema.

CAS: 'Card'

NAVYCASH: 'SVC'

OTCnet Bank Deposit: 'Cash/Und Check'

OTCnet E-Check Deposit: 'Check Image'

Pay.gov: 'Card', 'Other', 'ACH', ‘Digital Wallet’

ECP: 'Paper Check'

EFTPSAGYTAX: 'Book Entry'

CG ACH: 'ACH'

CG Fedwire: 'Wire'

SVC Eagle Cash: 'SVC'

SVC EZ Pay: 'SVC'

Sumry RptBusLnCd The business line of the program that processes the transaction 

(as opposed to the business line of a transaction's content, 

which is not always the same).

Currently not used

Sumry RptPgmNm The name of a reporting program; i.e., the name of a Fiscal 

Service program that reports transactions to a central 

repository.

Sumry RptSbprgNm The name of a subprogram or component of a reporting 

program.
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 85

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

5.01 Element 5.0.1 Attribute Standard definition Additional Collection System Information

Sumry ScndryProcgPgmNm The name of an additional processing program; i.e., the name 

of a Fiscal Service program that is involved in processing a 

transaction.

Currently not used

Sumry ScndryProcgSbprgNm The name of a subprogram or component of an additional 

processing program.

Currently not used

Sumry SttlMchsmCd The settlement system that was used to complete this 

transaction. List of possible values is identified in the EDA 

schema.

CAS: 'Card' 

CG ACH: 'ACH' 

CG Fed: 'FedWire' 

Pay.gov: 'ACH', 'Card', 'Other', ‘Digital Wallet’

ECP: 'ACH', 'Paper Check', 'Check Image'

OTCnet E-Check Deposit: 'ACH', 'Check Image', 

'Paper Check'

OTCnet Bank Deposit: 'Cash/Und Check'

SVC Eagle Cash: 'SVC'

SVC EZ Pay: 'SVC'

Sumry SttlRcptDt The date payment was received. An example would be the 

date that the lockbox opened up the payment.

Sumry SubAcctRTN The routing number (RTN) used to segregate transaction 

activity that is reported directly to the Treasury Master Account, 

to accommodate reporting and operational needs. It is also 

referred to as a SubAccount Customer Identification Number 

(CIN) by the Federal Reserve or as a Tier 2 RTN by Treasury.

Sumry SvcngALC The Agency Location Code (ALC) of the agency that provides 

services to another agency.

TAS_BETC AgcyID Used in conjunction with the main account code, the

department, agency, or establishment of the US government 

that is responsible for the TAS.

TAS_BETC AlctnTrfrAgcyID The agency receiving funds through an allocation transfer.

TAS_BETC AvlbltyTypCd Identifies no-year accounts (X), clearing/suspense accounts (F), 

Treasury central summary general ledger accounts (A), and 

merged-surplus accounts (M).

TAS_BETC BegngPdOfAvlblty In annual and multiyear accounts, identifies the first year of 

availability under law that an account may incur new 

obligations.
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 86

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

5.01 Element 5.0.1 Attribute Standard definition Additional Collection System Information

TAS_BETC BETC The type of activity (gross disbursement, offsetting collection, 

investment in Treasury securities, etc.) and the effect of a 

transaction on the Fund Balance With Treasury (FBWT). Is 

used in combination with the Treasury Account Symbol to 

classify transactions reported to Treasury through all 

Governmentwide Accounting (CARS/GWA-compliant) Fiscal 

Service Systems.

TAS_BETC BusEvnTypNm The name associated with a Business Event Type Code value. Currently not used

TAS_BETC EndPdOfAvlblty In annual and multiyear accounts, identifies the last year of 

availability under law that an account may incur new 

obligations.

TAS_BETC MnAcctCd Identifies the type and purpose of the fund.

TAS_BETC SubAcctCd Identifies an available receipt or other Treasury-defined 

subdivision of the main account.

TAS_BETC SubLvlPrfxCd When populated, represents a programmatic breakdown of the 

account for Treasury publication purposes.

TaxBkdwnDta Amt The transaction amount of the tax breakdown. OTCnet Bank Deposit

OTCnet E-Check Deposit

ECP

TaxBkdwnDta ChnlTypCd The code that identifies the channel through which an agent or 

depositary receives a transaction.

OTCnet Bank Deposit

OTCnet E-Check Deposit

ECP

TaxBkdwnDta CrInd The indicator denoting whether a financial amount is a debit or 

credit. If the amount is greater than zero a value of '1' would be 

assigned and would be considered a 'credit'. If the amount is 

less than zero a value of '0' would be assigned and would be 

considered a 'debit'.

OTCnet Bank Deposit

OTCnet E-Check Deposit

ECP

TaxBkdwnDta FclSvcTaxClsCd The subclass within a class of tax transactions, as defined by 

the Fiscal Service. List of possible values is identified in the 

EDA schema.

OTCnet Bank Deposit

OTCnet E-Check Deposit

ECP

TaxBkdwnDta FclSvcTaxSubClsCd The classification of a tax transaction, as defined by the Fiscal 

Service. List of possible values is identified in the EDA schema.

OTCnet Bank Deposit

OTCnet E-Check Deposit

ECP
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 87

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

5.01 Element 5.0.1 Attribute Standard definition Additional Collection System Information

TaxBkdwnDta NAICS_Cd The code that the North American Industry Classification 

System (NAICS) uses to classify business establishments for 

the purpose of collecting, analyzing, and publishing statistical 

data on the U.S. economy.

OTCnet Bank Deposit

OTCnet E-Check Deposit

ECP

TaxBkdwnDta RptSbprgNm The name of a subprogram or component of a reporting 

program.

Currently not used

TaxBkdwnDta SttlMchsmCd The mechanism by which a financial institution settles a 

transaction.

OTCnet Bank Deposit

OTCnet E-Check Deposit

ECP

TaxBkdwnDta TaxBusCnt The total count of tax business items associated with a Tax 

Breakdown. 

OTCnet Bank Deposit

OTCnet E-Check Deposit

ECP

TaxBkdwnDta TaxPayerTypCd The type of entity remitting or receiving a tax payment. List of 

possible values is identified in the EDA schema.

OTCnet Bank Deposit

OTCnet E-Check Deposit

ECP

TaxBkdwnDta TaxSubTypCd The single alpha-numeric character defined by the IRS that 

reflects a reason for the tax payment. 

OTCnet Bank Deposit

OTCnet E-Check Deposit

ECP

TaxBkdwnDta TaxTypCd The four-digit code defined by the IRS that corresponds to an 

IRS form number. 

OTCnet Bank Deposit

OTCnet E-Check Deposit

ECP

Tot InfoOnlyTxnCnt Calculated total of the number of non-accountable transactions 

on the extract file to be used as a control total.

Tot SumryTotInd An indicator that denotes whether the totals reported in the Tot 

element are calculated from detail transactions or calculated 

from the summary level. A value of '0' denotes that the totals 

are calculated from the detail transactions, and a value of '1' 

denotes that the totals are calculated from the summary level. 

Tot TotCnt Calculated total of the number of transactions on the extract file 

to be used as a control total.

Tot TotCrAmt Calculated total of all accountable credit amounts on the extract 

file to be used as a control total. 
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 88

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

5.01 Element 5.0.1 Attribute Standard definition Additional Collection System Information

Tot TotCrCnt Calculated total of the number of accountable credit 

transactions on the extract file to be used as a control total.

Tot TotDbtAmt Calculated total of all accountable debit amounts on the extract 

file to be used as a control total. 

Tot TotDbtCnt Calculated total of the number of accountable debit transactions 

on the extract file to be used as a control total.

UDF CUI_Ind Indicator that the User Data Content contains privacy data.

UDF ID The identifier for the User Data provided to CIR by the sending 

channel application. 

ECP: UDD Field Number 

OTCnet: UDD Field Number 

Pay.gov: Sequential number

UDF Lab The label provided by the agency to the channel that describes 

what is contained in the UserDataContent. For example: "Claim 

Number" or "Name".

UDF Free format unstructured agency-specific data. This data is 

wrapped within "CDATA" tags so that any characters can be 

included.

Vchr AgcyCmtTxt The comments an agency associates with processing. Pay.gov: Application Name

OTCnet: Agency Comments

Pay.gov/PayPal: 'PayPal'

Vchr AgtCmtTxt The comments that an agent or depositary associates with 

processing.

OTCnet Bank Deposit: Financial Agent comments

Navy Cash: Ship Name

Vchr ChnlInitnDt The date that the public or an agency (on behalf of a public 

remitter or as a remitter itself) initiates or sends a transaction to 

an agent or depositary.

Vchr ChnlRcptDt The date that an agent or depositary receives a transaction.

Vchr CnfrmDt The date that an agent or depositary electronically records or 

confirms a transaction.

Vchr CoinCrncyTotAmt The total value of coins contained within a deposit. OTCnet Bank deposit only. 

Vchr CrncyTotAmt The total value of coin and paper currency contained within a 

deposit.

OTCnet Bank deposit only. 

Vchr ExcptTypCd The type of change to a previously reported transaction. List of 

possible values is identified in the EDA schema. Formerly 

known as Corrective Type Code
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 89

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

5.01 Element 5.0.1 Attribute Standard definition Additional Collection System Information

Vchr FY The fiscal year for which the transaction is reported/effective. 

Fiscal Year is a term that is used to differentiate a budget or 

financial year from the calendar year.

OTCnet Bank Deposit: Fiscal Year (YYYY)

Vchr ID The identifier for a voucher provided to CIR by the sending 

channel application. 

Vchr NonDomCollInd The indicator denoting whether the transaction associated with 

a collection is considered non domestic. A value of '1' indicates 

a non-domestic or foreign collection. 

Vchr PartlInd The indicator denoting whether the details associated represent 

a partial summarization. A value of '1' indicates a partial Sumry.

Valid for Detail Only and Summary and Detail Only extracts.

Vchr RcptFromDt The starting date of one or more collections summarized into a 

voucher.

OTCnet Bank Deposit

Vchr RcptToDt The ending date of one or more collections summarized into a 

voucher.

OTCnet Bank Deposit

Vchr SmrzdDtlCnt The total number of financial transactions represented by a 

voucher.

Vchr SvcdALC The Agency Location Code (ALC) of the agency that receives 

services from another agency.

Vchr TaxBkdwnCnt The total count of Tax Breakdown items. Valid for tax reporters 

only.

Vchr VchrDt The date that a depositary or agent uses for Fiscal Service 

reconciliation, for example the deposit ticket date or the debit 

voucher date.

Vchr VchrFormCd The type of voucher record. Values are 215, 215A, 215B, and 

5515. The value of 5515 indicates a debit, and the remaining 

values indicate a credit. List of possible values is identified in 

the EDA schema.

Vchr VchrHndlgCd The code that denotes how the voucher information should be 

handled in downstream reporting. List of possible values is 

identified in the EDA schema.

Currently not used. 

Vchr VchrNr The six digit number that helps identify an agency's deposit 

summary.
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 90

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

8. Tips/Hints for Creating and Processing XML Extracts

8.1 Recommendations when Creating XML Extract Definitions

XML Extract files are designed to be used as Manual Downloads to the user's local workstation or 

system-to-system (S2S) files where the file is received automatically and processed by a receiving 

system. When initially setting up an extract it may be useful for a user to define a small sample file in 

order to become more familiar with the XML file format. Users can then download the file to their 

personal computer using the CIR application (specifically the "View Files" function). In order to view the 

extract file the file size must be less than 50 megabytes which corresponds to approximately 36,000 detail

transactions. 

The following are suggestions for creating smaller test files:

 Select only one ALC

 If there is a large quantity of data for the ALC – add secondary selection criteria for 

example, ABA, or CAN. 

 When defining selection criteria, it is important to remember that CIR is limited to the data 

supplied by the STPs. All STPs provide ALC, ABA and CAN but other selection criteria, 

for example, AgcySiteID and Cshflw Nm and Cshflw ID, are only provided by some STPs. 

See the attribute definition in Section 7.9 for information on what information is provided 

by different STPs.

 Select only one File Profile or Reporting System.

 Select an Extract Type of Summary. This will limit the data provided to voucher level 

information. Once the user is familiar with this data, then the user can define an extract 

with the ultimate desired Extract Type if that is different, for example Summary and 

Detail.

 Select an Extract Frequency of Daily. This will ensure that an extract file is produced 

each day for viewing. As described in Section 5.1, once the extract definition is 

completed an extract will be created around 3:00 AM each day for the previous business 

date.

The following are suggestions for defining production files: 

 Try minimizing or eliminating some or all selection criteria in order to get all of your data 

in one extract file. If this can be done without exceeding the 50 megabyte (MB) limitation, 

then additional maintenance to merge smaller extracts into one database or file for further 

processing on your end might be avoided. 
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 91

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

8.2 Special Characters

There are five characters that are part of the XML Schema declaration and so cannot be used within any 

attributes. There are two mechanisms for sending special characters. The first is the replacement of the 

special character with a preset equivalent:

Character Description Replacement 

& Ampersand &

< Less than <

> Greater than >

" Double quote "

' Apostrophe '

For example a CshFlwNm containing "parking & bldg. space rent" would be sent as follows:

CshFlwNm="GSA Ft Worth - parking & bldg space rent" 

The second is the CDATA mechanism which was designed to let an author quote fragments of text 

containing restricted characters (ampersand, LT, GT, etc.). For example, this method is used extensively 

when documenting XML. A CDATA Section turns off markup recognition for the duration of the section (it 

gets turned on again only by the closing sequence of double end-square-brackets and a close-anglebracket). 

Consequently, nothing in a CDATA section is ever recognized as anything to do with markup: it's just a 

string of opaque characters, and if you use an XML transformation language like XSLT, any markup 

characters in it will get turned into their character entity equivalents. 

Example using a CDATA section:

<MssgDtaElmt ID="149252600000032" SeqNr="3" FwireTagCd="5100" ElmtNm="ORIGINATOR-FIADDRESS-LINE1" CUI_Ind="0" UnstrdDtaInd="0"><![CDATA[1 LIBERTY & MAIN

STREET]]></MssgDtaElmt>

The CDATA mechanism cannot be used when the XML has defined the field as an attribute. CIR uses 

the first replacement method within an attribute and the CDATA mechanism for any other containers. 

Standard COTS XML Readers will automatically normalize either of these mechanisms as part of 

processing an XML file. 
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 92

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

9. Customer Service

If an agency has questions about the CIR specification the agency should first contact CIR Customer 

Support. CIR Customer Support is available between 7:00 AM - 9:00 PM Eastern Time Monday through 

Friday except Federal holidays. CIR Customer Support can be reached at 1-800-624-1373 (option #3) or 

internationally at 216-579-2112 (option #3). CIR Customer Support also can be reached by email at 

CIR.customersupport@clev.frb.org. 
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 93

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

10. Appendix A: FedWire Tag Names

The following table lists the static names that will be found in the FwireDtl/MssgDtaElmt FwireTagCd and 

the FwireDtl/MssgDtaElmt ElmtNm. The column titled 'Tag Name' is for references purposes only. 

Table 13: FedWire Tag Names and Message Data Element Names

Tag Code Tag Name Data Element Name

1100 MSG-DISPOSITION

FORMAT-VERSION

TEST-PRODUCTION-CODE

MSG-DUPLICATION-CODE

MSG-STATUS-IND

1110 ACCEPTANCE-TIMESTAMP

ACCEPTANCE-DATE

ACCEPTANCE-TIME

ACCEPTANCE-APPL-ID

1120 OMAD

OUTPUT-CYCLE-DATE

OUTPUT-DESTINATION-ID

OUTPUT-SEQUENCE-NUMBER

OUTPUT-DATE

OUTPUT-TIME

OUTPUT-FRB-APPL-ID

1130 ERROR-FIELD

ERROR-CATEGORY

ERROR-CODE

ERROR-DESCRIPTION

1500 SENDER-SUPPLIED-INFO

FORMAT-VERSION

URC-DATA

TEST-PROD-CODE

MSG-DUPLICATION-CODE

FILLER

1510 TYPE-SUBTYPE

TYPE-CODE

SUBTYPE-CODE

1520 IMAD

INPUT-CYCLE-DATE

INPUT-SOURCE

INPUT-SEQUENCE-NUMBER

2000 AMOUNT

AMOUNT

3000 ADJUSTMENT

ADJUSTMENT-DATE

ADJUSTMENT-REASON

3100 SENDER-DI

SENDER-DI-NUMBER

SENDER-SHORT-NAME

3320 SENDER-REFERENCE

SENDER-REFERENCE

3400 RECEIVER-DI

RECEIVER-DI-NUMBER
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 94

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

Tag Code Tag Name Data Element Name

RECEIVER-SHORT-NAME

3500 PREVIOUS-MSG-IMAD

PREV-INPUT-CYCLE-DATE

PREV-INPUT-SOURCE-ID

PREV-INPUT-SEQ-NBR

3600 BUSINESS-FUNCTION

BUSINESS-FUNCTION-CODE

TRAN-TYPE-CODE

3610 LOCAL-INSTRUMENT

LOCAL-INSTRUMENT-CODE

3700 CHARGES

CHARGE-CODE

CURRENCY-CODE1

SENDERS-CHARGES1

CURRENCY-CODE2

SENDERS-CHARGES2

CURRENCY-CODE3

SENDERS-CHARGES3

CURRENCY-CODE4

SENDERS-CHARGES4

3710 INSTRUCTED-AMOUNT

CURRENCY-CODE

INSTRUCTED-AMOUNT

3720 EXCHANGE-RATE

EXCHANGE-RATE

4000 INTERMEDIARY-FI

INTERMEDIARY-FI-ID-CODE

INTERMEDIARY-FI-IDENTIFIER

INTERMEDIARY-FI-NAME

INTERMEDIARY-FI-ADDRESS-LINE1

INTERMEDIARY-FI-ADDRESS-LINE2

INTERMEDIARY-FI-ADDRESS-LINE3

4100 BENEFICIARY-FI

BENEFICIARY-FI-ID-CODE

BENEFICIARY-FI-IDENTIFIER

BENEFICIARY-FI-NAME

BENEFICIARY-FI-ADDRESS-LINE1

BENEFICIARY-FI-ADDRESS-LINE2

BENEFICIARY-FI-ADDRESS-LINE3

4200 BENEFICIARY

BENEFICIARY-ID-CODE

BENEFICIARY-IDENTIFIER

BENEFICIARY-NAME

BENEFICIARY-ADDRESS-LINE1

BENEFICIARY-ADDRESS-LINE2

BENEFICIARY-ADDRESS-LINE3

4320 REF-FOR-BNF

BENEFICIARY-REF

4400 ACCOUNT-DEBITED-IN-DRAWDOWN

DRW-DEBIT-ACCT-ID-CODE

DRW-DEBIT-ACCT-IDENTIFIER

DRW-DEBIT-ACCT-NAME
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 95

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

Tag Code Tag Name Data Element Name

DRW-DEBIT-ACCT-ADDRESS-LINE1

DRW-DEBIT-ACCT-ADDRESS-LINE2

DRW-DEBIT-ACCT-ADDRESS-LINE3

5000 ORIGINATOR

ORIGINATOR-ID-CODE

ORIGINATOR-IDENTIFIER

ORIGINATOR-NAME

ORIGINATOR-ADDRESS-LINE1

ORIGINATOR-ADDRESS-LINE2

ORIGINATOR-ADDRESS-LINE3

5100 ORIGINATOR-FI

ORIGINATOR-FI-ID-CODE

ORIGINATOR-FI-IDENTIFIER

ORIGINATOR-FI-NAME

ORIGINATOR-FI-ADDRESS-LINE1

ORIGINATOR-FI-ADDRESS-LINE2

ORIGINATOR-FI-ADDRESS-LINE3

5200 INSTRUCTING-FI

INSTRUCTING-FI-ID-CODE

INSTRUCTING-FI-IDENTIFIER

INSTRUCTING-FI-NAME

INSTRUCTING-FI-ADDRESS-LINE1

INSTRUCTING-FI-ADDRESS-LINE2

INSTRUCTING-FI-ADDRESS-LINE3

5400 ACCOUNT-CREDITED-IN-DRAWDOWN

DRW-CREDIT-ACCT-NR

6000 ORIGINATOR-TO-BENEFICIARY-INFO

ORIGINATOR-TO-BENEFICIARY-LINE1

ORIGINATOR-TO-BENEFICIARY-LINE2

ORIGINATOR-TO-BENEFICIARY-LINE3

ORIGINATOR-TO-BENEFICIARY-LINE4

6100 RECEIVER-FI-INFO

RECEIVER-FI-INFO-LINE1

RECEIVER-FI-INFO-LINE2

RECEIVER-FI-INFO-LINE3

RECEIVER-FI-INFO-LINE4

RECEIVER-FI-INFO-LINE5

RECEIVER-FI-INFO-LINE6

6110 DRW-DEBIT-ACCT-ADVICE-INFO

DRW-DEBIT-ACCT-ADVICE-CODE

DRW-DEBIT-ACCT-INFO-LINE1

DRW-DEBIT-ACCT-INFO-LINE2

DRW-DEBIT-ACCT-INFO-LINE3

DRW-DEBIT-ACCT-INFO-LINE4

DRW-DEBIT-ACCT-INFO-LINE5

DRW-DEBIT-ACCT-INFO-LINE6

6200 INTERMEDIARY-FI

INTERMEDIARY-FI-INFO-LINE1

INTERMEDIARY-FI-INFO-LINE2

INTERMEDIARY-FI-INFO-LINE3

INTERMEDIARY-FI-INFO-LINE4

INTERMEDIARY-FI-INFO-LINE5
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 96

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

Tag Code Tag Name Data Element Name

INTERMEDIARY-FI-INFO-LINE6

6210 INTERMEDIARY-FI-ADVICE-INFO

INTERMEDIARY-FI-ADVICE-INFO-CODE

INTERMEDIARY-FI-ADVICE-INFO-LINE1

INTERMEDIARY-FI-ADVICE-INFO-LINE2

INTERMEDIARY-FI-ADVICE-INFO-LINE3

INTERMEDIARY-FI-ADVICE-INFO-LINE4

INTERMEDIARY-FI-ADVICE-INFO-LINE5

INTERMEDIARY-FI-ADVICE-INFO-LINE6

6300 BENEFICIARY-FI-INFO

BENEFICIARY-FI-INFO-LINE1

BENEFICIARY-FI-INFO-LINE2

BENEFICIARY-FI-INFO-LINE3

BENEFICIARY-FI-INFO-LINE4

BENEFICIARY-FI-INFO-LINE5

BENEFICIARY-FI-INFO-LINE6

6310 BENEFICIARY-FI-ADVICE-INFO

BENEFICIARY-FI-ADVICE-CODE

BENEFICIARY-FI-ADVICE-INFO-LINE1

BENEFICIARY-FI-ADVICE-INFO-LINE2

BENEFICIARY-FI-ADVICE-INFO-LINE3

BENEFICIARY-FI-ADVICE-INFO-LINE4

BENEFICIARY-FI-ADVICE-INFO-LINE5

BENEFICIARY-FI-ADVICE-INFO-LINE6

6400 BENEFICIARY-INFO

BENEFICIARY-INFO-LINE1

BENEFICIARY-INFO-LINE2

BENEFICIARY-INFO-LINE3

BENEFICIARY-INFO-LINE4

BENEFICIARY-INFO-LINE5

BENEFICIARY-INFO-LINE6

6410 BENEFICIARY-ADVICE-INFO

BENEFICIARY-ADVICE-CODE

BENEFICIARY-ADVICE-INFO-LINE1

BENEFICIARY-ADVICE-INFO-LINE2

BENEFICIARY-ADVICE-INFO-LINE3

BENEFICIARY-ADVICE-INFO-LINE4

BENEFICIARY-ADVICE-INFO-LINE5

BENEFICIARY-ADVICE-INFO-LINE6

6420 BENEFICIARY-METHOD-OF-PAYMENT

METHOD-OF-PAYMENT-CODE

METHOD-OF-PAYMENT-INFO-LINE

6430 PAYMENT-LIMIT

PAYMENT-LIMIT

6500 FI-TO-FI-INFO

FI-TO-FI-FREE-TEXT-LINE1

FI-TO-FI-FREE-TEXT-LINE2

FI-TO-FI-FREE-TEXT-LINE3

FI-TO-FI-FREE-TEXT-LINE4

FI-TO-FI-FREE-TEXT-LINE5
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 97

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

Tag Code Tag Name Data Element Name

FI-TO-FI-FREE-TEXT-LINE6

8200 UNSTRUCTURED-ADDENDA-INFORMATION

ADDENDA-LENGTH

ADDENDA-INFORMATION

9000 FREE-FORMATTED-TEXT

FREE-TEXT-INFO-LINE1

FREE-TEXT-INFO-LINE2

FREE-TEXT-INFO-LINE3

FREE-TEXT-INFO-LINE4

FREE-TEXT-INFO-LINE5

FREE-TEXT-INFO-LINE6

FREE-TEXT-INFO-LINE7

FREE-TEXT-INFO-LINE8

FREE-TEXT-INFO-LINE9

FREE-TEXT-INFO-LINE10

FREE-TEXT-INFO-LINE11

FREE-TEXT-INFO-LINE12
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 98

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

11. Appendix B: ACH Reason Codes

The ACH Reason Codes provided below are used for exception reporting. This information is provided in 

this document because it is not documented in the XML Schema. 

The information in the following table was obtained from the ACH Rules Book. 

Table 14: NACHA Reason Codes and Descriptions

Reason Code Description Usage

R01 Insufficient Funds Returns

R02 Account Closed Returns

R03 No Account/Unable to Locate Account Returns

R04 Invalid Account Number Returns

R05 Unauthorized Debit to Consumer Account using Corporate 

SEC Code (Adjustment Entries)

Returns

R06 Returned per Originating Depository Financial Institution's 

Request

Returns

R07 Authorization Revoked by Customer Returns

R08 Payment Stopped Returns

R09 Uncollected Funds Returns

R10 Customer Advises not Authorized, Notice Not Provided, 

Improper Source Document, etc.

Returns

R11 Check Truncation Entry Return Returns

R12 Account Sold to Another DFI Returns

R13 Invalid ACH Routing Number Returns

R14 Representative Payee (account holder) Deceased or 

Unable to Continue in that Capacity

Returns

R15 Beneficiary or Account Holder (other than a representative 

payee) Deceased

Returns

R16 Account Frozen Returns

R17 File Record Edit Criteria Returns

R18 Improper Effective Entry Date Returns

R19 Amount Field Error Returns

R20 Non-transaction Account Returns

R21 Invalid Company Identification Returns

R22 Invalid Individual I.D. Number Returns

R23 Credit Entry Refused by Receiver Returns

R24 Duplicate Entry Returns

R25 Addenda Error Returns

R26 Mandatory Field Error Returns

R27 Trace Number Error Returns

R28 Routing Number Check Digit Error Returns

R29 Corporate Customer Advises not Authorized (CCD) Returns

R30 RDFI not Participant in Check Truncation Program Returns

R31 Permissible return entry (CCD) Returns

R32 RDFI Non-Settlement Returns

R33 Return of XCK Entry Returns

R34 Limited Participation D.F.I. Returns

R35 Return of Improper Debit Entry Returns

R36 Return of Improper Credit Entry Returns

R37 Source Document Presented for Payment (adjustment 

entries) (ARC.)

Returns

R38 Stop Payment on Source Document (adjustment entries) Returns
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 99

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

Reason Code Description Usage

R39 Improper Source Document Returns

R40 Non Participant in ENR Program Returns

R41 Invalid Transaction Code (ENR only) Returns

R42 Routing Number/Check Digit Error (ENR only) Returns

R43 Invalid DFI Account Number (ENR only) Returns

R44 Invalid Individual I.D. Number (ENR only) Returns

R45 Invalid Individual Name (ENR only) Returns

R46 Invalid Representative Payee Indicator (ENR only) Returns

R47 Duplicate Enrollment (ENR only) Returns

R50 State Law Prohibits Truncated Checks Returns

R51 Item is Ineligible, Notice Not Provided, Signature Not 

Genuine, Item Altered, Amount of Entry ...

Returns

R52 Stop Pay on Item Returns

R53 Item and A.C.H. Entry Presented for Payment Returns

R61 Misrouted Return Automated Dishonored Returns

R67 Duplicate Return Automated Dishonored Returns

R68 Untimely Return Automated Dishonored Returns

R69 Field Errors Automated Dishonored Returns

R70 Permissible Return Entry Not Accepted Automated Dishonored Returns

R71 Misrouted Dishonored Return Automated Contested Dishonored 

Returns

R72 Untimely Dishonored Return Automated Contested Dishonored 

Returns

R73 Timely Original Return Automated Contested Dishonored 

Returns

R74 Corrected Return Automated Contested Dishonored 

Returns

R75 Original Return not a Duplicate Automated Contested Dishonored 

Returns

R76 No Errors Found Automated Contested Dishonored 

Returns

R80 Cross-Border Payment Coding Error Cross Border Payments

R81 Non-Participant in Cross-Border Program Cross Border Payments

R82 Invalid Foreign Receiving DFI Identification Cross Border Payments

R83 Foreign Receiving DFI Unable to Settle Cross Border Payments

R84 Entry Not Processed by OGO Cross Border Payments

C01 Incorrect DFI Account Number Notification of Change

C02 Incorrect Routing Number Notification of Change

C03 Incorrect Routing Number and Incorrect DFI Account 

Number

Notification of Change

C04 Incorrect Individual Name / Receiving Company Name Notification of Change

C05 Incorrect Transaction Code Notification of Change

C06 Incorrect DFI Account Number and Incorrect Transaction 

Code

Notification of Change

C07 Incorrect Routing Number, Incorrect DFI Account Number, 

and Incorrect Transaction Code

Notification of Change

C08 Incorrect Foreign Receiving DFI Identification Notification of Change

C09 Incorrect Individual Identification Number Notification of Change

C13 Addenda Format Error Notification of Change

C61 Misrouted Notification of Change Refused Notification of Change

C62 Incorrect Trace Number Refused Notification of Change

C63 Incorrect Company Identification Number Refused Notification of Change
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 100

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

Reason Code Description Usage

C64 Incorrect Individual Identification Number / Identification 

Number

Refused Notification of Change

C65 Incorrectly Formatted Corrected Data Refused Notification of Change

C66 Incorrect Discretionary Data Refused Notification of Change

C67 Routing Number Not From Original Entry Detail Record Refused Notification of Change

C68 DFI Account Number Not From Original Entry Detail 

Record

Refused Notification of Change

C69 Incorrect Transaction Code Refused Notification of Change
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 101

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

12. Appendix C: Sample Files

Shown below is a sample file for a Summary Only Extract Type. The purpose of this example is to familiarize users of this document with the 

basic XML structure. Additional larger example files can be found on the CIR web site.

<?xml version="1.0" encoding="ISO-8859-1"?>

<CollRpt xsi:schemaLocation="urn:us:gov:treasury CollectionsReport_x.xsd" xmlns="urn:us:gov:treasury"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ID="1498133" EOD_Ind="0" IptSysTxt="CIR" SeqNr="1" TrnsmTs="2014-10-

22T15:03:34">

<!—Card Acquiring Service -->

<Sumry ID="149143300000085" ALC="99999999" ChnID="Chain Identifier" DivID="Division Identifier" AgtRTN="042000314"

BnkPostDt="2014-10-09" CAN="999999" CollBusDt="2014-10-09" CollStatCd="Settled" ComlBnkInd="1" CrInd="1" IptSysTxt="CAS"

IRS_TaxInd="0" RptPgmNm="Card Acquiring Service">

<Vchr ID="149143300000085" PartlInd="0" VchrFormCd="215" VchrDt="2014-10-08" VchrNr="146995" SmrzdDtlCnt="2"

AgcyCmtTxt="Agency Comment Text – Chain/Division value">

<AcctCls CrInd="1" Amt="312.28">

<Ckey CkeyNm="Merchant ID" CkeyVal="Merchant ID Value"/>

</AcctCls>

</Vchr>

<Tot SumryTotInd="1" TotCrAmt="312.28" TotCrCnt="0" TotDbtAmt="0" TotCnt="0"/>

</Sumry>

<!-- Pay.gov Credit Card -->

<Sumry ID="149144900000072" ALC="99999999" ChnID="Chain Identifier" DivID="Division Identifier" AgtRTN="042000314" BnkPostDt="2014-

10-09" ChnlTypCd="Internet" CAN="999999" CollBusDt="2014-10-09" CollStatCd="Settled" ComlBnkInd="1" CrInd="1" IptSysTxt="PAYGOV"

IRS_TaxInd="0" RptPgmNm="Pay.gov" SttlMchsmCd="Card" RcptMchsmCd="Card">

<Vchr ID="149144900000072" PartlInd="0" VchrFormCd="215" VchrDt="2014-10-08" VchrNr="400140" SmrzdDtlCnt="3"

AgcyCmtTxt="Agency Comment Text – Chain/Division value">

<AcctCls CrInd="1" Amt="1140.96">

<Ckey CkeyNm="Pay.gov ALC+2" CkeyVal="ALC + 2 value"/>

</AcctCls>

</Vchr>

<Tot SumryTotInd="1" TotCrAmt="1140.96" TotCrCnt="0" TotDbtAmt="0" TotCnt="0"/>

</Sumry>

<!— Pay.gov ACH -->
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 102

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

<Sumry ID="149250100000003" ALC="99999999" AgtRTN="041036046" BnkPostDt="2014-10-09" ChnlTypCd="Internet" CAN="999999"

CollBusDt="2014-10-09" CollStatCd="Settled" ComlBnkInd="0" CrInd="0" IptSysTxt="PAYGOV" IRS_TaxInd="0" RptPgmNm="Pay.gov"

SttlMchsmCd="ACH" RcptMchsmCd="ACH">

<Vchr ID="149250100000003" PartlInd="0" VchrFormCd="5515" VchrDt="2014-10-09" VchrNr="005742" SmrzdDtlCnt="1"

AgcyCmtTxt="Agency Comment Text">

<AcctCls CrInd="0" Amt="68">

<Ckey CkeyNm="Pay.gov ALC+2" CkeyVal="ALC + 2 value"/>

</AcctCls>

</Vchr>

<Tot SumryTotInd="1" TotCrAmt="0" TotDbtAmt="68" TotDbtCnt="0" TotCnt="0"/>

</Sumry>

<!—Credit Gateway ACH Debit Voucher -- >

<Sumry ID="149144500000081" ALC="99999999" AgtRTN="051036706" BnkPostDt="2014-10-09" CshFlwID="Cash Flow Identifier"

CshFlwNm="Cash Flow Name" CAN="999999" CollBusDt="2014-10-09" CollStatCd="Settled" ComlBnkInd="0" CrInd="0" IptSysTxt="CGACH"

IRS_TaxInd="0" RptPgmNm="Credit Gateway" RptSbprgNm="ACH">

<Vchr ID="149144500000081" PartlInd="0" VchrFormCd="5515" VchrDt="2014-10-09" VchrNr="090081" SmrzdDtlCnt="53">

<AcctCls CrInd="0" Amt="6178.72">

<Ckey CkeyNm="CG ACH" CkeyVal="Gateway Account"/>

</AcctCls>

</Vchr>

<Tot SumryTotInd="1" TotCrAmt="0" TotDbtAmt="6178.72" TotDbtCnt="0" TotCnt="0"/>

</Sumry>

<!—OTCnet E-Check – with multiple classifications -->

<Sumry ID="149143500000294" ALC="00003801" AgtRTN="041036033" BnkPostDt="2014-10-09" ChnlTypCd="OTC" CAN="999999"

CollBusDt="2014-10-09" CollStatCd="Settled" ComlBnkInd="0" CrInd="1" IptSysTxt="OTCNET-CHK" IRS_TaxInd="0" RptPgmNm="OTCnet"

RptSbprgNm="E-Check Deposit" RcptMchsmCd="Check Image">

<Vchr ID="149143500000294" PartlInd="0" VchrFormCd="215" VchrDt="2014-10-09" VchrNr="000228" SmrzdDtlCnt="3"

AgcyCmtTxt="F.O. Tinker Finance Office Tinker">

<AcctCls CrInd="1" Amt="284.18">

<Ckey CkeyNm="Agency Accounting Code" CkeyVal="57143500"/>

</AcctCls>

<AcctCls CrInd="1" Amt="920">

<Ckey CkeyNm="Agency Accounting Code" CkeyVal="97X5189"/>

</AcctCls>
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 103

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

</Vchr>

<Tot SumryTotInd="1" TotCrAmt="1204.18" TotCrCnt="0" TotDbtAmt="0" TotCnt="0"/>

</Sumry>

<!— OTCnet Bank Deposit (Commercial, Multiple Classifications) -->

<Sumry ID="149203300000233" ALC="99999999" AgcySiteID="Concatenated Org Level values" AgtRTN="051400549" BnkPostDt="2014-10-08"

ChnlTypCd="OTC" CAN="006082" CollBusDt="2014-10-09" CollStatCd="Settled" ComlBnkInd="1" CrInd="1" IptSysTxt="OTCNET-TGA"

IRS_TaxInd="0" RptPgmNm="OTCnet" RptSbprgNm="Bank Deposit" ProcgPgmNm="TGA Network" ProcgSbprgNm="TGA Network"

SttlMchsmCd="Cash/Und Check" RcptMchsmCd="Cash/Und Check">

<Vchr ID="149203300000233" PartlInd="0" VchrFormCd="215" VchrDt="2014-10-08" VchrNr="631777" SmrzdDtlCnt="0"

AgcyCmtTxt="A1C Mercedes D. Wilcox 49FSS/FSVF 575.572.5859">

<AcctCls CrInd="1" Amt="401.43">

<Ckey CkeyNm="Agency Accounting Code" CkeyVal="57143500"/>

</AcctCls>

<AcctCls CrInd="1" Amt="56.92">

<Ckey CkeyNm="Agency Accounting Code" CkeyVal="57143400"/>

</AcctCls>

<OrgLvl ID="1" IntOrgCd="Org Level 1 Value"/>

<OrgLvl ID="2" IntOrgCd="Org Level 2 Value"/>

<OrgLvl ID="3" IntOrgCd="Org Level 3 Value"/>

<OrgLvl ID="4" IntOrgCd="Org Level 4 Value"/>

<OrgLvl ID="5" IntOrgCd="Org Level 5 Value"/>

<OrgLvl ID="6" IntOrgCd="Org Level 6 Value"/>

<OrgLvl ID="7" IntOrgCd="Org Level 7 Value"/>

</Vchr>

<Tot SumryTotInd="1" TotCrAmt="458.35" TotCrCnt="0" TotDbtAmt="0" TotCnt="0"/>

</Sumry>

<!— Credit Gateway Fedwire -->

<Sumry ID="149252600000001" ALC="99999999" AgtRTN="021030004" BnkPostDt="2014-10-09" CshFlwID="Cash Flow Identifier – Gateway 

Account" CshFlwNm="Cash Flow Name" CAN="999999" CollBusDt="2014-10-09" CollStatCd="Settled" ComlBnkInd="0" CrInd="1"

IptSysTxt="CGFEDWIRE" IRS_TaxInd="0" RptPgmNm="Credit Gateway" RptSbprgNm="Fedwire">

<Vchr ID="149252600000001" PartlInd="0" VchrFormCd="215" VchrDt="2014-10-09" VchrNr="590002" SmrzdDtlCnt="4">

<AcctCls CrInd="1" Amt="69595032.71">

<Ckey CkeyNm="CG FEDWIRE" CkeyVal="Gateway Account"/>

</AcctCls>
 

XML 5.0.1 Extract Files Specification

October 11, 2016

Version 2.01

Program: CIR (Collections Information Repository) Page 104

Doc File Name: XML_5_0_1_Extract_Files_Specification_v201

</Vchr>

<Tot SumryTotInd="1" TotCrAmt="69595032.71" TotCrCnt="0" TotDbtAmt="0" TotCnt="0"/>

</Sumry>

<Tot SumryTotInd="1" TotCrAmt="69598148.48" TotCrCnt="5" TotDbtAmt="6246.72" TotDbtCnt="2" TotCnt="66"/>

</CollRpt>