Specification for CIR XML Extract Files (XML Schema Version 5.0.1)

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 voucher-

level 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-to-

system 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).

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-the-

counter, 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.

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. OTCnet-

CHK 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

ProgramData

Business

Transaction

Classifications Program Data

Financial

Transaction

Fedwire ACH

Plastic

Card

Check

Supplemental information that can be associated

to a particular type of financial transaction

Detail Financial Information Deposit Summary 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

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

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

Electronic Check Processing

(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

Navy Cash – Stored Value Card

NAVYCASH

JPMC NavyCash

JPMC NavyCash GUI

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 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

FIR

Voucher info from DW

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-to-

system 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 voucher-

level 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-of-

day 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-of-

day 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

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

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 4

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

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

Transmission Identifier

TrnsmTs

Transmission Timestamp

Sumry

Summary [Element]

A container for all summarized

information.

For the Summary Only extract, the

Sumry record contains voucher-

related 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

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

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

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

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

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.

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

Element Description

XML 5.0.1 Schema Extract

Element and Attribute Names in Text

User Data associated to a

classification

CUI_Ind

CUI Indicator

User Data Field Identifier

Lab

User Data Field Label

OrgLvl

Organization Level [Element]

The container for an Organization

Level item.

IntOrgCd

Internal Organization Code

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.

Program Data Identifier

UserDtaCnt

User Data Count

UDF

User Data Field [Element]

The container allowing for free-

format, unstructured, agency-

CUI_Ind

CUI Indicator

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

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

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

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

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

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

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

Financial Transaction [Element]

The container representing the

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

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.

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

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

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

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

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]

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 Fedwire-

specific financial transactions.

FwireDtl is a container for

content associated with a

Fedwire message.

FwireTypCd

Fedwire Type Code

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

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

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 check-

specific 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

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

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

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

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

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

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

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

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