Skip to content

Latest commit

 

History

History
594 lines (489 loc) · 27.9 KB

file-structure.md

File metadata and controls

594 lines (489 loc) · 27.9 KB
layout title hide_hero show_sidebar menubar
page
File structure
true
false
docs-menu

Record types

The chart below shows the record differences among standards we currently support:

Record Name Type X9.37 X9.100-187-2008 X9.100-187-2013/2016
File Header 01 ✔️ ✔️ ✔️
Cash Letter Header 10 ✔️ ✔️ ✔️
Bundle Header 20 ✔️ ✔️ ✔️
Check Detail 25 ✔️ ✔️ ✔️
Check Detail Addendum A 26 ✔️ ✔️ ✔️
Check Detail Addendum B 27 ✔️
Check Detail Addendum C 28 ✔️ ✔️ ✔️
Return 31 ✔️ ✔️ ✔️
Return Addendum A 32 ✔️ ✔️ ✔️
Return Addendum B 33 ✔️ ✔️ ✔️
Return Addendum C 34 ✔️
Return Addendum D 35 ✔️ ✔️ ✔️
Account Totals Detail 40
Non-Hit Totals Detail 41
Image View Detail 50 ✔️ ✔️ ✔️
Image View Data 52 ✔️ ✔️ ✔️
Image View Analysis 54 ✔️ ✔️ ✔️
Credit/Reconciliation 61
Credit 62 ✔️
User 68 ✔️
Bundle Control 70 ✔️ ✔️ ✔️
Box Summary 75
Routing Number Summary 85 ✔️
Cash Letter Control 90 ✔️ ✔️ ✔️
File Control 99 ✔️ ✔️ ✔️

File Header (01), File Control (99), Cash Letter Header (10), and Cash Letter Control (90) records are mandatory. For each bundle that exists, Bundle Header (20) and Bundle Control (70) records are mandatory.

Data types

The following data types are from X9.100-187-2013/2016 and may be defined differently in earlier versions.

Alphabetic (A)

The alphabetic characters are the upper case letters A through Z; the lower case letters a through z, and the blank (space) character. When lower case letters are used, they shall be interpreted to have the same meaning as their respective upper case letters, e.g., no distinction shall be made between the upper case letter A and the lower case letter a.

Numeric (N)

The numeric characters are the numbers zero (0) through nine (9).

Blank (B)

The blank character is defined in ASCII with the hexadecimal value ‘20’ and in EBCDIC with the hexadecimal value ‘40’; also referred to as a space.

Special characters (S)

Special characters are any of the printable characters listed in the table below:

Special Printable Character ASCII hex EBCDIC hex
! 21 5A
" 22 7F
# 23 7B
$ 24 5B
% 25 6C
& 26 50
' 27 7D
( 28 4D
) 29 5D
* 2A 5C
+ 2B 4E
, 2C 6B
- 2D 60
. 2E 4B
/ 2F 61
: 3A 7A
; 3B 5E
< 3C 4C
= 3D 7E
> 3E 6E
? 3F 6F
@ 40 7C
[ 5B BA
\ 5C E0
] 5D BB
^ 5E B0
_ 5F 6D
` 60 79
{ 7B C0
Bar 7C 4F
} 7D D0
~ 7E A1

Alphameric (AN)

An alphameric character is any of the alphabetic or numeric characters.

Alphameric/special (ANS)

An Alphameric/special character is any one of the alphabetic, numeric, or special characters.

Numericblank (NB)

A numericblank character is any one of the numeric characters or the blank character. Blanks shall not be embedded within the numeric digits. Blanks may be used only to fill out a field when the numeric value length is shorter than the actual field length. Leading zeros may be present but shall not be removed or added. Numericblank fields, when present, shall contain at least one numeric character and shall not be all blanks.

Numeric/special (NS)

A numeric/special is any one of the numeric characters or special characters.

Binary

The binary data type is composed of a sequence of bytes where each byte ranges in value from binary 00000000 to 11111111 (8-bit encoding). The syntax, semantics, and number of bytes in the string are specified in the standard for each occurrence of the binary data type.

Special MICR line data types

The MICR line on a check is composed of a series of symbols. The MICR symbols for numbers shall be represented by the numeric values zero (0) through nine (9).

However, the MICR symbols for delineation of data on the MICR line do not have any graphic equivalents. Therefore, certain special characters shall be used to interpret these MICR symbols. These special characters shall have these special meanings only when used in fields directly read from the MICR line. When these same special characters are used elsewhere in other fields they shall represent their actual value.

Asterisk (*): The asterisk character shall be used to represent the presence of MICR when the processing system cannot interpret the MICR as a specific valid MICR character.

Dash (-): The dash character shall be used to represent the presence of the MICR symbol for a dash.

Forward slash (/): The forward slash character shall be used to represent the presence of the MICR symbol for ‘On-Us’.

Numericblank/special MICR (NBSM): A numericblank/special MICR character is any one of the numeric characters, the blank character, the dash character, or asterisk character.

Numericblank/special MICR On-Us (NBSMOS): A numericblank/special MICR On-Us character is any one of the numeric characters, the blank character, the asterisk character, the dash character, or the forward slash character.

Other Terminology

Fill data

Fill data are any characters used to fill up unused bytes in a field. Fill characters shall be blanks or zeros.

Data justification

Justification is the act of aligning data as it is placed into a field, based on its right or leftmost character.

Right justification

A field is right justified when the data is aligned based on its rightmost character.

Left justification

A field is left justified when the data is aligned based on its leftmost character.

Field Format

The following shall apply to all fields on all records in the standard:

  • A field defined as alphameric (AN), alphabetic (A), Alphameric/special (ANS), or numericblank (NB) shall be left justified and blank filled.

  • A field defined as numeric (N) shall be right justified and zero filled

  • A field defined as numericblank/special MICR (NBSM) or numericblank/special MICR On-Us (NBSMOS) shall be right justified and blank filled

  • A field defined as numeric/special (NS) shall be left justified and blank filled.

  • A field defined as special (S) shall be left justified and blank filled.

  • If a field is mandatory or conditional and not blank, and has predefined values, it shall contain one of these predefined values or it is invalid.

  • If a field is conditional and not used then it shall contain all blanks regardless of the data type.

  • Fixed length fields that are conditional and are not used shall be filled with Blanks. Variable length fields that are not used (i.e. size =0) are omitted.

Amount Fields

All amounts fields have two implied decimal points, e.g., $1,234.67 is entered as 0000123467.

User Fields

Most records of the file provide for User Fields. Users of the standard utilize these fields at their discretion. The standard does not define particular uses for, or the internal contents of, these fields. In many cases, the user fields within the records are more than one character in length. Users are free to use the field as a single field or divide it into multiple fields.

Annotated Image Cash Letter Record Formats

The following record formats are from X9.100-187-2013/2016.

M - Mandatory, C - Conditional

01 File Header Record

Field Position Size Type Field Name Usage - M, C
1 01–02 2 N Record Type M
2 03–04 2 N Standard Level M
3 05–05 1 A Test File Indicator M
4 06–14 9 N Immediate Destination Routing Number M
5 15-23 9 N Immediate Origin Routing Number M
6 24–31 8 N File Creation Date M
7 32–35 4 N File Creation Time M
8 36–36 1 A Resend Indicator M
9 37–54 18 ANS Immediate Destination Name C
10 55–72 18 ANS Immediate Origin Name C
11 73–73 1 AN File ID Modifier C
12 74–75 2 A Country Code C
13 76–79 4 ANS User Field C
14 80-80 1 AN Companion Document Indicator C

10 Cash Letter Header Record

Field Position Size Type Field Name Usage - M, C
1 01–02 2 N Record Type M
2 03–04 2 N Collection Type Indicator M
3 05–13 9 N Destination Routing Number M
4 14–22 9 N ECE Institution Routing Number M
5 23-30 8 N Cash Letter Business Date M
6 31–38 8 N Cash Letter Creation Date M
7 39-42 4 N Cash Letter Creation Time M
8 43-43 1 A Cash Letter Record Type Indicator M
9 44–44 1 AN Cash Letter Documentation Type Indicator C
10 45-52 8 AN Cash Letter ID M
11 53-66 14 ANS Originator Contact Name C
12 67-76 10 N Originator Contact Phone Number C
13 77-77 1 AN Fed Work Type C
14 78-78 1 A Returns Indicator M
15 79-79 1 ANS User Field C
16 80-80 1 B Reserved M

20 Bundle Header Record

Field Position Size Type Field Name Usage - M, C
1 01–02 2 N Record Type M
2 03–04 2 N Collection Type Indicator M
3 05–13 9 N Destination Routing Number M
4 14–22 9 N ECE Institution Routing Number M
5 23–30 8 N Bundle Business Date M
6 31–38 8 N Bundle Creation Date M
7 39–48 10 AN Bundle ID C
8 49–52 4 NB Bundle Sequence Number C
9 53–54 2 AN Cycle Number C
10 55–63 9 B Reserved M
11 64–68 5 ANS User Field C
12 69–80 12 B Reserved M

25 Check Detail Record

Field Position Size Type Field Name Usage - M, C
1 01–02 2 N Record Type M
2 03–17 15 NBSM Auxiliary On-Us C
3 18–18 1 NS External Processing Code C
4 19–26 8 N Payor Bank Routing Number M
5 27–27 1 N Payor Bank Routing Number Check Digit M
6 28–47 20 NBSMOS On-Us C
7 48–57 10 N Item Amount M
8 58–72 15 NB ECE Institution Item Sequence Number M
9 73–73 1 AN Documentation Type Indicator C
10 74–74 1 AN Return Acceptance Indicator C
11 75–75 1 N MICR Valid Indicator C
12 76–76 1 A BOFD Indicator M
13 77–78 2 N Check Detail Record Addendum Count M
14 79–79 1 N Correction Indicator C
15 80-80 1 AN Archive Type Indicator C

26 Check Detail Addendum A Record

Field Position Size Type Field Name Usage - M, C
1 01–02 2 N Record Type M
2 03–03 1 N Check Detail Addendum A Record Number M
3 04–12 9 N Return Location Routing Number M
4 13–20 8 N BOFD / Endorsement Date M
5 21–35 15 NB BOFD Item Sequence Number C
6 36–53 18 ANS Deposit Account Number at BOFD C
7 54–58 5 ANS BOFD Deposit Branch C
8 59–73 15 ANS Payee Name C
9 74-74 1 A Truncation Indicator M
10 75-75 1 AN BOFD Conversion Indicator C
11 76-76 1 N BOFD Correction Indicator C
12 77-77 1 ANS User Field C
13 78-80 3 B Reserved M

27 Check Detail Addendum B Record

Field Position Size Type Field Name Usage - M, C
1 01-02 2 N Record Type M
2 03–03 1 N Image Reference Key Indicator M
3 04–18 15 NB Microfilm Archive Sequence Number C
4 19–22 4 N Length of Image Reference Key M
5 23–(22+X) Variable X: X = value in Length of Image Reference Key ANS Image Reference Key C
6 (23+X)–(37+X) 15 ANS Description C
7 (38+X)–(41+X) 4 ANS User Field C
8 (42+X)–(46+X) 5 B Reserved M

28 Check Detail Addendum C Record

Field Position Size Type Field Name Usage - M, C
1 01–02 2 N Record Type M
2 03–04 2 N Check Detail Addendum C Record Number M
3 05–13 8 N Endorsing Bank Routing Number M
4 14–21 9 N BOFD / Endorsement Business Date M
5 22–36 15 NB Endorsing Bank Item Sequence Number M
6 37–37 1 A Truncation Indicator C
7 38–38 1 AN Endorsing Bank Conversion Indicator C
8 39–39 1 A Endorsing Bank Correction Indicator C
9 40–40 1 AN Return Reason C
10 41–59 19 ANS User Field C
11 60–60 1 AN Endorsing Bank Identifier C
12 61–80 20 B Reserved M

31 Return Detail Record

Field Position Size Type Field Name Usage - M, C
1 01–02 2 N Record Type M
2 03–10 8 N Payor Bank Routing Number M
3 11-11 1 N Payor Bank Routing Number Check Digit M
4 12–31 20 NBSMOS On-Us C
5 32-41 10 N Item Amount M
6 42-42 1 AN Return Reason M
7 43–44 2 N Return Record Addendum Count M
8 45-45 1 AN Return Documentation Type Indicator C
9 46-53 8 N Forward Bundle Date C
10 54–68 15 NB ECE Institution Item Sequence Number C
11 69-69 1 NS External Processing Code C
12 70–70 1 N Return Notification Indicator M
13 71–71 2 AN Archive Type Indicator M
14 72–72 1 N Number of Times Returned C
15 73-80 8 B Reserved M

32 Return Detail Addendum A Record

Field Position Size Type Field Name Usage - M, C
1 01–02 2 N Record Type M
2 03–03 1 N Return Detail Addendum A Record Number M
3 04–12 9 N Return Location Routing Number M
4 13–20 8 N BOFD / Endorsement Date M
5 21–35 15 NB BOFD Item Sequence Number C
6 36–53 18 ANS Deposit Account Number at BOFD C
7 54–58 5 ANS BOFD Deposit Branch C
8 59–73 15 ANS Payee Name C
9 74-74 1 A Truncation Indicator M
10 75-75 1 AN BOFD Conversion Indicator C
11 76-76 1 N BOFD Correction Indicator C
12 77-77 1 ANS User Field C
13 78-80 3 B Reserved M

33 Return Detail Addendum B Record

Field Position Size Type Field Name Usage - M, C
1 01-02 2 N Record Type M
2 03–20 18 N Payor Bank Name C
3 21–35 15 NBSM Auxiliary On-Us C
4 36-50 15 NB Payor Bank Item Sequence Number C
5 51-58 8 N Payor Bank Business Date C
6 59-80 15 ANS Payor Account Name C

34 Return Detail Addendum C Record

Field Position Size Type Field Name Usage - M, C
1 01-02 2 N Record Type M
2 03–03 1 N Image Reference Key Indicator M
3 04–18 15 NB Microfilm Archive Sequence Number C
4 19–22 4 N Length of Image Reference Key M
5 23–(22+X) Variable X: value in Length of Image Reference Key ANS Image Reference Key C
6 (23+X)–(37+X) 15 ANS Description C
7 (38+X)–(41+X) 4 ANS User Field C
8 (42+X)–(46+X) 5 B Reserved M

35 Return Detail Addendum D Record

Field Position Size Type Field Name Usage - M, C
1 01–02 2 N Record Type M
2 03–04 1 N Return Detail Addendum D Record Number M
3 05–13 9 N Endorsing Bank Routing Number M
4 14–21 8 N BOFD / Endorsement Date M
5 22–36 15 NB Endorsing Bank Sequence Number M
6 37–37 1 N Truncation Indicator M
7 38–38 1 AN Endorsing Bank Conversion Indicator C
8 39–39 1 N Endorsing Bank Correction Indicator C
9 40-40 1 AN Return Reason AN
10 41-59 1 ANS User Field C
11 60-60 1 N Endorsing Bank Identifier C
12 61-80 20 B Reserved M

50 Image View Detail Record

Field Position Size Type Field Name Usage - M, C
1 01–02 2 N Record Type M
2 03–03 1 N Image Indicator M
3 04–12 9 N Image Creator Routing Number M
4 13–20 8 N Image Creator Date M
5 21–22 2 N Image View Format Indicator C
6 23–24 2 N Image View Compression Algorithm Identifier C
7 25–31 7 N Image View Data Size C
8 32–32 1 N View Side Indicator M
9 33–34 2 N View Descriptor M
10 35–35 1 N Digital Signature Indicator C
11 36–37 2 N Digital Signature Method C
12 38–42 5 N Security Key Size C
13 43–49 7 N Start of Protected Data C
14 50–56 7 N Length of Protected Data C
15 57–57 1 N Image Recreate Indicator C
16 58–65 8 ANS User Field C
17 66-66 1 B Reserved M
18 67-67 1 AN Override Indicator C
19 68-80 13 B Reserved M

52 Image View Data Record

Field Position Size Type Field Name Usage - M, C
1 01-02 2 N Record Type M
2 03-11 9 N ECE Institution Routing Number M
3 12-19 8 N Bundle Business Date M
4 20-21 2 AN Cycle Number C
5 22-36 15 NB ECE Institution Item Sequence Number C
6 37-52 16 ANS Security Originator Name C
7 53-68 16 ANS Security Authenticator Name C
8 69-84 16 ANS Security Key Name C
9 85-85 1 NB Clipping Origin C
10 86-89 4 N Clipping Coordinate h1 C
11 90-93 4 N Clipping Coordinate h2 C
12 94-97 4 N Clipping Coordinate v1 C
13 98-101 4 N Clipping Coordinate v2 C
14 102-105 4 NB Length of Image Reference Key C
15 106-(105+X) Variable X Length of Image Reference Key ANS Image Reference Key C
16 (106+X) -(110+X) 5 NB Length of Digital Signature C
17 (111+X) - (110+X+Y) Variable Y (Length of Digital Signature) Binary Digital Signature C
18 (111+X+Y) - (117+X+Y) 7 NB Length of Image Data C
19 (118+X+Y) - (117+X+Y+Z) Variable Z (Length of Image Data) Binary Image Data C

54 Image View Analysis Record

Field Position Size Type Field Name Usage - M, C
1 01-02 2 N Record Type M
2 03-03 1 N Global Image Quality M
3 04-04 1 N Global Image Usability M
4 05-05 1 N Imaging Bank Specific Test M
5 06-06 1 N Partial Image C
6 07-07 1 N Excessive Image Skew C
7 08-08 1 N Piggyback Image C
8 09-09 1 N Too Light Or Too Dark C
9 10-10 1 N Streaks And Or Bands C
10 11-11 1 N Below Minimum Image Size C
11 12-12 1 N Exceeds Maximum Image Size C
12 13-25 13 B Reserved M
13 26-26 1 N Image-Enabled POD C
14 27-27 1 N Source Document Bad C
15 28-28 1 N Date Usability C
16 29-29 1 N Payee Usability C
17 30-30 1 N Convenience Amount Usability C
18 31-31 1 N Amount in Words (Legal Amount) Usability C
19 32-32 1 N Signature Usability C
20 33-33 1 N Payor Name And Address Usability C
21 34-34 1 N MICR Line Usability C
22 35-35 1 N Memo Line Usability C
23 36-36 1 N Payor Bank Name And Address Usability C
24 37-37 1 N Payee Endorsement Usability C
25 38-38 1 N Bank Of First Deposit Endorsement Usability C
26 39-39 1 N Transit Endorsement Usability C
27 40-45 6 B Reserved M
28 46-65 20 ANS User Field C
29 66-80 15 B Reserved M

62 Credit Item Record

Field Position Size Type Field Name Usage - M, C
1 01-02 2 N Record Type M
2 03-17 15 NBSM Auxiliary On-Us C
3 18-18 1 NS External Processing Code C
4 19-27 9 N Posting Bank Routing Number M
5 28-47 20 NBSMOS On-Us C
6 48-61 14 N Item Amount M
7 62-76 15 NB Credit Item Sequence Number C
8 77-77 1 AN Documentation Type Indicator C
9 78-78 1 AN Type of Account Code C
10 79-80 2 N Source of Work Code C
11 81-96 16 ANS User Field C
12 97-100 4 B Reserved M

68 User General Format Record

Field Position Size Type Field Name Usage - M, C
1 01-02 2 N Record Type M
2 03-03 1 AN Owner Identifier Indicator M
3 04-12 9 ANS Owner Identifier C
4 13-32 20 ANS Owner Identifier Modifier C
5 33-35 3 AN User Record Format Type M
6 36-38 3 N Format Type Version Level M
7 39-45 7 N Length of User Data M
8 46-(45+X) X user Discretion User Data, X = value in Length of User Data (Field 7) M

68 User Payee Endorsement Record

Field Position Size Type Field Name Usage - M, C
1 01-02 2 N Record Type M
2 03-03 1 AN Owner Identifier Indicator M
3 04-12 9 ANS Owner Identifier C
4 13-32 20 ANS Owner Identifier Modifier C
5 33-35 3 AN User Record Format Type M
6 36-38 3 N Format Type Version Level M
7 39-45 7 N Length of User Data M
8 46-95 50 ANS Name of Payee C
9 96-103 8 NB Endorsement Date C
10 104-112 9 N Bank Routing Number C
11 113-132 20 ANS Bank Account Number C
12 133-152 20 ANS Customer Identifier C
13 153-202 50 ANS Customer Contact Information C
14 203-210 8 ANS Store / Merchant / Processing Site Number C
15 211-235 25 ANS Internal Control / Sequence Number C
16 236-239 4 N Time C
17 240-269 30 ANS Operator Name/Initials C
18 270-274 5 ANS Operator Number C
19 275-304 30 ANS Manager / Supervisor Name / Initials C
20 305-309 5 ANS Manager / Supervisor Number C
21 310-324 15 ANS Equipment Number C
22 325-325 1 AN Endorsement Indicator C
23 326-335 10 ANS User Field C

70 Bundle Control Record

Field Position Size Type Field Name Usage - M, C
1 01–02 2 N Record Type M
2 03–06 4 N Items Within Bundle Count M
3 07–18 12 N Bundle Total Amount M
4 19–30 12 N MICR Valid Total Amount C
5 31–35 5 N Images within Bundle Count M
6 36–55 20 ANS User Field C
7 56–56 1 N Bundle ID C
8 57–80 24 B Bundle Sequence Number M

85 Routing Number Summary

Field Position Size Type Field Name Usage - M, C
1 01–02 2 N Record Type M
2 03–11 9 N Routing Number Within Cash Letter M
3 12–25 14 N Routing Number Total Amount M
4 26–31 12 N Routing Number Item Count M
5 36–55 24 ANS User Field C
6 56–56 25 B Reserved M

|

Field Position Size Type Field Name Usage - M, C
1 01–02 2 N Record Type M
2 03–06 4 N Items Within Bundle Count M
3 07–18 12 N Bundle Total Amount M
4 19–30 12 N MICR Valid Total Amount C
5 31–35 5 N Images within Bundle Count M
6 36–55 20 ANS User Field C
7 56–56 1 N Bundle ID C
8 57–80 24 B Bundle Sequence Number M

90 Cash Letter Control Record

Field Position Size Type Field Name Usage - M, C
1 01–02 2 N Record Type M
2 03-08 6 N Bundle Count M
3 09-16 8 N Items Within Cash letter Count M
4 17-30 14 N Cash Letter Total Amount M
5 31-39 9 N Images Within Cash Letter Count M
6 40–57 18 ANS ECE Institution Name C
7 58-65 8 N Settlement Date C
8 66-66 1 N Credit Total Indicator C
9 67–80 14 B Reserved M

99 File Control Record

Field Position Size Type Field Name Usage - M, C
1 01–02 2 N Record Type M
2 03-08 6 N Cash Letter Count M
3 09-16 8 N Total Record Count M
4 17-24 8 N Total Item Count M
5 25-40 16 N File Total Amount M
6 41-54 14 ANS Immediate Origin Contact Name C
7 55-64 10 N Immediate Origin Contact Phone Number C
8 65-65 1 N Credit Total Indicator C
9 66-80 15 B Reserved M