-
Notifications
You must be signed in to change notification settings - Fork 39
/
openapi.yaml
2906 lines (2837 loc) · 120 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.2
info:
description: Moov Image Cash Letter (ICL) implements an HTTP API for creating, parsing, and validating ImageCashLetter files.
version: v1
title: ImageCashLetter API
contact:
url: https://github.com/moov-io/imagecashletter
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: http://localhost:8083
description: Local development
tags:
- name: 'Image Cash Letter Files'
description: |
Files contain ImageCashLetter Cash Letters and Bundles.
paths:
/ping:
get:
tags: ['Image Cash Letter Files']
summary: Ping ImageCashLetter service
operationId: ping
responses:
'200':
description: Service is running properly
/files:
get:
tags: ['Image Cash Letter Files']
summary: List files
operationId: getICLFiles
security:
- bearerAuth: []
- cookieAuth: []
parameters:
- name: X-Request-ID
in: header
description: Optional Request ID allows application developer to trace requests through the system's logs
example: rs4f9915
schema:
type: string
responses:
'200':
description: A list of File objects
headers:
X-Total-Count:
description: The total number of Originators
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/ICLFiles'
/files/create:
post:
tags: ['Image Cash Letter Files']
summary: Create file
operationId: createICLFile
security:
- bearerAuth: []
- cookieAuth: []
parameters:
- name: X-Request-ID
in: header
description: Optional Request ID allows application developer to trace requests through the system's logs
example: rs4f9915
schema:
type: string
requestBody:
description: Content of the ImageCashLetter file (in json or raw text)
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateICLFile'
text/plain:
schema:
$ref: '#/components/schemas/RawICLFile'
responses:
'201':
description: A JSON object containing a new File
headers:
Location:
description: The location of the new resource
schema:
type: string
format: uri
content:
application/json:
schema:
$ref: '#/components/schemas/ICLFile'
'400':
description: "Invalid File Header Object"
content:
application/json:
schema:
$ref: 'https://raw.githubusercontent.com/moov-io/base/master/api/common.yaml#/components/schemas/Error'
/files/{fileID}:
get:
tags: ['Image Cash Letter Files']
summary: Retrieve file
description: Retrieves the details of an existing File. You need only supply the unique File identifier that was returned upon creation.
operationId: getICLFileByID
security:
- bearerAuth: []
- cookieAuth: []
parameters:
- name: X-Request-ID
in: header
description: Optional Request ID allows application developer to trace requests through the system's logs
example: rs4f9915
schema:
type: string
- name: fileID
in: path
description: File ID
required: true
schema:
type: string
example: 3f2d23ee214
responses:
'200':
description: A File object for the supplied ID
content:
application/json:
schema:
$ref: '#/components/schemas/ICLFile'
'404':
description: A resource with the specified ID was not found
post:
tags: ['Image Cash Letter Files']
summary: Update file header
description: Updates the specified File Header by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
operationId: updateICLFile
security:
- bearerAuth: []
- cookieAuth: []
parameters:
- name: X-Request-ID
in: header
description: Optional Request ID allows application developer to trace requests through the system's logs
example: rs4f9915
schema:
type: string
- name: fileID
in: path
description: File ID
required: true
schema:
type: string
example: 3f2d23ee214
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ICLFileHeader'
responses:
'201':
description: A JSON object containing a new File
headers:
Location:
description: The location of the new resource
schema:
type: string
format: uri
content:
application/json:
schema:
$ref: '#/components/schemas/ICLFile'
'400':
description: "Invalid File Header Object"
content:
application/json:
schema:
$ref: 'https://raw.githubusercontent.com/moov-io/base/master/api/common.yaml#/components/schemas/Error'
delete:
tags: ['Image Cash Letter Files']
summary: Delete file
description: Permanently deletes a File and associated CashLetters and Bundles. It cannot be undone.
operationId: deleteICLFile
security:
- bearerAuth: []
- cookieAuth: []
parameters:
- name: fileID
in: path
description: File ID
required: true
schema:
type: string
example: 3f2d23ee214
- name: X-Request-ID
in: header
description: Optional Request ID allows application developer to trace requests through the system's logs
example: rs4f9915
schema:
type: string
responses:
'200':
description: Permanently deleted File.
'400':
description: A problem was encountered deleting the file, check errors.
/files/{fileID}/contents:
get:
tags: ['Image Cash Letter Files']
summary: Get file contents
description: Assembles the existing file records (Cash Letters, Bundles, and Controls), computes sequence numbers and totals. Returns plaintext file.
operationId: getICLFileContents
security:
- bearerAuth: []
- cookieAuth: []
parameters:
- name: X-Request-ID
in: header
description: Optional Request ID allows application developer to trace requests through the system's logs
example: rs4f9915
schema:
type: string
- name: fileID
in: path
description: File ID
required: true
schema:
type: string
example: 3f2d23ee214
responses:
'200':
description: File built successfully without errors.
content:
text/plain:
schema:
$ref: '#/components/schemas/RawICLFile'
'400':
description: A problem was encountered getting the file, check errors.
/files/{fileID}/validate:
get:
tags: ['Image Cash Letter Files']
summary: Validate file
description: Validates the existing file. You need only supply the unique File identifier that was returned upon creation.
operationId: validateICLFile
security:
- bearerAuth: []
- cookieAuth: []
parameters:
- name: X-Request-ID
in: header
description: Optional Request ID allows application developer to trace requests through the system's logs
example: rs4f9915
schema:
type: string
- name: fileID
in: path
description: File ID
required: true
schema:
type: string
example: 3f2d23ee214
responses:
'200':
description: File validated successfully without errors.
content:
application/json:
schema:
$ref: '#/components/schemas/ICLFile'
'400':
description: Validation failed. Check response for errors
/files/{fileID}/cashLetters:
post:
tags: ['Image Cash Letter Files']
summary: Add cash letter to file
operationId: addICLToFile
security:
- bearerAuth: []
- cookieAuth: []
parameters:
- name: X-Request-ID
in: header
description: Optional Request ID allows application developer to trace requests through the system's logs
example: rs4f9915
schema:
type: string
- name: fileID
in: path
description: File ID
required: true
schema:
type: string
example: 3f2d23ee214
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CashLetter'
responses:
'200':
description: CashLetter added to File
/files/{fileID}/cashLetters/{cashLetterID}:
delete:
tags: ['Image Cash Letter Files']
summary: Delete cash letter from file
operationId: deleteICLFromFile
security:
- bearerAuth: []
- cookieAuth: []
parameters:
- name: X-Request-ID
in: header
description: Optional Request ID allows application developer to trace requests through the system's logs
example: rs4f9915
schema:
type: string
- name: fileID
in: path
description: File ID
required: true
schema:
type: string
example: 3f2d23ee214
- name: cashLetterID
in: path
description: CashLetter ID
required: true
schema:
type: string
example: 45758063
responses:
'200':
description: CashLetter deleted
'404':
description: CashLetter or File not found
/v2/files:
post:
tags: ['Image Cash Letter Files']
summary: Create file
operationId: createICLFileV2
requestBody:
description: |
Content of the ImageCashLetter file in JSON, or X9 (ASCII or EBCDIC) format.
Use the `Accept` header to specify the response format.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateICLFile'
multipart/form-data:
schema:
type: object
properties:
file:
description: |
The file to upload. Set this section's `Content-Type` to `text/plain` for
ASCII-encoded files, or `application/octet-stream` for binary files.
type: string
format: binary
responses:
'201':
description: The file was created successfully
headers:
Location:
description: The location of the new resource
required: true
schema:
type: string
format: url
content:
application/json:
schema:
$ref: '#/components/schemas/ICLFile'
application/octet-stream:
schema:
type: string
format: binary
text/plain:
schema:
type: string
format: binary
'400':
description: The request was invalid
content:
application/json:
schema:
$ref: 'https://raw.githubusercontent.com/moov-io/base/master/api/common.yaml#/components/schemas/Error'
components:
schemas:
CreateICLFile:
properties:
ID:
type: string
description: File ID
example: 3f2d23ee214
fileHeader:
$ref: '#/components/schemas/ICLFileHeader'
cashLetters:
type: array
items:
$ref: '#/components/schemas/CashLetter'
bundles:
type: array
items:
$ref: '#/components/schemas/Bundle'
fileControl:
$ref: '#/components/schemas/ICLFileControl'
required:
- fileHeader
ICLFile:
properties:
ID:
type: string
description: File ID
example: 3f2d23ee214
fileHeader:
$ref: '#/components/schemas/ICLFileHeader'
cashLetters:
type: array
items:
$ref: '#/components/schemas/CashLetter'
bundles:
type: array
items:
$ref: '#/components/schemas/Bundle'
fileControl:
$ref: '#/components/schemas/ICLFileControl'
ICLFileHeader:
properties:
ID:
description: FileHeader ID
type: string
example: d1e26288
standardLevel:
type: string
maxLength: 2
enum:
- '03'
- '30'
- '35'
description: |
StandardLevel identifies the standard level of the file.
* `03` - DSTU X9.37-2003
* `30` - X9.100-187-2008
* `35` - X9.100-187-2013 and X9.100-187-2016
example: '35'
testIndicator:
type: string
maxLength: 1
enum:
- 'T'
- 'P'
description: |
TestIndicator identifies whether the file is a test or production file.
* `T` - Test File
* `P` - Production File
example: 'P'
immediateDestination:
type: string
maxLength: 9
description: |
ImmediateDestination is the routing and transit number of the Federal Reserve Bank (FRB)
or receiver to which the file is being sent.
example: '231380102'
immediateOrigin:
type: string
maxLength: 9
description: |
ImmediateOrigin is the routing and transit number of the Federal Reserve Bank (FRB)
or originator from which the file is being sent.
example: '201982859'
fileCreationDate:
type: string
format: 'date-time'
description: FileCreationDate is the date the immediate origin institution creates the file.
example: '2020-10-23T00:00:00Z'
fileCreationTime:
type: string
format: 'date-time'
description: FileCreationTime is the time the immediate origin institution creates the file.
example: '0000-01-01T09:11:00Z'
resendIndicator:
type: string
maxLength: 1
description: ResendIndicator indicates whether the file has been previously transmitted. (Y - Yes, N - No)
example: 'Y'
immediateDestinationName:
type: string
maxLength: 18
description: ImmediateDestinationName identifies the short name of the institution that receives the file.
example: 'ABC Bank'
immediateOriginName:
type: string
maxLength: 18
description: immediateOriginName identifies the short name of the institution that sends the file.
example: 'Bank One'
fileIDModifier:
type: string
maxLength: 1
description: |
FileIDModifier is a code that permits multiple files, created on the same date, at the same time, and sent between the
same institutions, to be distinguished from one another. If FileHeader ImmediateDestination, ImmediateOrigin, FileCreationDate, and
FileCreationTime in a previous file are equal to the same fields in this file, FileIDModifier must be defined.
example: 'A'
countryCode:
type: string
maxLength: 2
description: |
CountryCode is a 2-character code as approved by the International Organization for Standardization (ISO) used
to identify the country in which the payer bank is located.
example: 'US'
userField:
type: string
maxLength: 4
description: UserField identifies a field used at the discretion of users of the standard.
example: 'ZZZZ'
companionDocumentIndicator:
type: string
maxLength: 1
description: |
CompanionDocumentIndicator indicates the Companion Document being used.
It shall be present only under clearing arrangements, where Companion Document usage and values are
defined.
Values:
* 0–9 - Reserved for United States use
* A–J - Reserved for Canadian use
* Other - Defined by clearing arrangements
example: '1'
required:
- standardLevel
- testIndicator
- resendIndicator
- immediateDestination
- immediateOrigin
- fileCreationDate
- fileCreationTime
ICLFileControl:
properties:
ID:
type: string
description: FileControl ID
example: 'd1e26288'
cashLetterCount:
type: integer
description: CashLetterCount identifies the total number of cash letters within the file.
example: 1
totalRecordCount:
type: integer
description: TotalRecordCount identifies the total number of records of all types sent in the file, including the FileControl.
example: 1
totalItemCount:
type: integer
description: totalItemCount identifies the total number of Items sent within the file.
example: 5
fileTotalAmount:
type: integer
description: FileTotalAmount identifies the total Item amount of the complete file.
example: 100
immediateOriginContactName:
type: string
maxLength: 14
description: immediateOriginContactName identifies a contact at the institution that creates the file.
example: 'John Smith'
immediateOriginContactPhoneNumber:
type: string
maxLength: 10
description: ImmediateOriginContactPhoneNumber identifies the phone number of the contact at the institution that creates the file.
example: '555-555-1212'
creditTotalIndicator:
type: integer
enum:
- 0
- 1
description: |
CreditTotalIndicator is a code that indicates whether Credit Items are included in this record’s totals. If so, they will be included in TotalItemCount and FileTotalAmount.
TotalRecordCount includes all records of all types regardless of the value of this field.
* ` ` - No Credit Items
* `0` - Credit Items are not included in totals
* `1` - Credit Items are included in totals
example: 1
required:
- cashLetterCount
- totalRecordCount
- totalItemCount
- fileTotalAmount
RawICLFile:
type: string
description: A plaintext ImageCashLetter file. See our test files or examples for a complete ICL/X9 file.
example: |
0135T061000146026073150202010230911NWave Money Wave Money 1 1
9900000100000012000000010000000000010000 0
ICLFiles:
type: array
items:
$ref: '#/components/schemas/ICLFile'
CashLetter:
properties:
cashLetterHeader:
$ref: '#/components/schemas/CashLetterHeader'
# Current Implementation: CreditItem(s) Precede Check(s) - CreditItem(s) outside the leading Bundle
# and Within the First Cash Letter. Please adjust reader and writer, and openAPI for your specific clearing arrangement
# implementation or contact MOOV for your particular implementation.
creditItems:
type: array
items:
$ref: '#/components/schemas/CreditItem'
bundles:
type: array
items:
$ref: '#/components/schemas/Bundle'
routingNumberSummary:
type: array
items:
$ref: '#/components/schemas/RoutingNumberSummary'
cashLetterControl:
$ref: '#/components/schemas/CashLetterControl'
CashLetterHeader:
properties:
ID:
description: CashLetterHeader ID
type: string
example: 'd1e26288'
collectionTypeIndicator:
type: string
maxLength: 2
enum:
- '00'
- '01'
- '02'
- '03'
- '04'
- '05'
- '06'
- '20'
- '99'
description: |
CollectionTypeIndicator is a code that identifies the type of cash letter.
* `00` - Preliminary Forward Information
* `01` - Forward Presentment
* `02` - Forward Presentment - Same-Day Settlement
* `03` - Return
* `04` - Return Notification
* `05` - Preliminary Return Notification
* `06` - Final Return Notification
* `20` - No Detail
* `99` - Bundles not the same collection type. Use of the value is only allowed by clearing arrangement.
example:
'00'
destinationRoutingNumber:
type: string
maxLength: 9
description: DestinationRoutingNumber is the routing and transit number of the institution that receives and processes the cash letter or the bundle.
example: '999282654'
eceInstitutionRoutingNumber:
type: string
maxLength: 9
description: ECEInstitutionRoutingNumber is the routing and transit number of the institution that creates the Cash Letter Header record.
example : '217876527'
cashLetterBusinessDate:
type: string
format: 'date-time'
description: cashLetterBusinessDate is the business date of the cash letter.
example: '2020-10-23T00:00:00Z'
cashLetterCreationDate:
type: string
format: 'date-time'
description: cashLetterCreationDate is the date that the cash letter is created.
example: '2020-10-23T00:00:00Z'
cashLetterCreationTime:
type: string
format: 'date-time'
description: CashLetterCreationTime is the time that the cash letter is created.
example: '0000-01-01T09:11:00Z'
recordTypeIndicator:
type: string
maxLength: 1
enum:
- 'N'
- 'E'
- 'I'
- 'F'
description: |
RecordTypeIndicator is a code that indicates the presence of records or the type of records contained in the cash letter.
If an image is associated with any Check or Return, the cash letter must have a RecordTypeIndicator of I or F.
* `N` - No electronic check records or image records (Type 2x’s, 3x’s, 5x’s); e.g., an empty cash letter.
* `E` - Cash letter contains electronic check records with no images (Type 2x’s and 3x’s only).
* `I` - Cash letter contains electronic check records (Type 2x’s, 3x’s) and image records (Type 5x’s).
* `F` - Cash letter contains electronic check records (Type 2x’s and 3x’s) and image records (Type 5x’s)
that correspond to a previously sent cash letter (i.e., E file).
example: 'I'
documentationTypeIndicator:
type: string
maxLength: 1
enum:
- 'A'
- 'B'
- 'C'
- 'D'
- 'E'
- 'F'
- 'G'
- 'H'
- 'I'
- 'J'
- 'K'
- 'L'
- 'M'
- 'Z'
description: |
DocumentationTypeIndicator is a code that indicates the type of documentation that supports all check records in the cash letter.
* `A` - No image provided, paper provided separately
* `B` - No image provided, paper provided separately, image upon request
* `C` - Image provided separately, no paper provided
* `D` - Image provided separately, no paper provided, image upon request
* `E` - Image and paper provided separately
* `F` - Image and paper provided separately, image upon request
* `G` - Image included, no paper provided
* `H` - Image included, no paper provided, image upon request
* `I` - Image included, paper provided separately
* `J` - Image included, paper provided separately, image upon request
* `K` - No image provided, no paper provided
* `L` - No image provided, no paper provided, image upon request
* `M` - No image provided, Electronic Check provided separately
* `Z` - Not Same Type–Documentation associated with each item in Cash Letter will be different.
example: 'A'
cashLetterID:
type: string
maxLength: 8
description: CashLetterID uniquely identifies the cash letter. It is assigned by the institution that creates the cash
letter and must be unique within a Cash Letter Business Date.
example: '1'
originatorContactName:
type: string
maxLength: 14
description: OriginatorContactName is the name of a contact at the institution that creates the cash letter.
example: "John Smith"
originatorContactPhoneNumber:
type: string
maxLength: 10
description: OriginatorContactPhoneNumber is the phone number of the contact at the institution that creates the cash letter.
example: '5685551212'
fedWorkType:
type: string
maxLength: 1
description: fedWorkType is any valid code specified by the Federal Reserve Bank.
example: 'V'
returnsIndicator:
type: string
maxLength: 1
enum:
- 'E'
- 'R'
- 'J'
description: |
ReturnsIndicator identifies type of returns.
* ` ` - Original Message
* `E` - Administrative - items being returned that are handled by the bank and usually do not directly
affect the customer or its account.
* `R` - Customer–items being returned that directly affect a customer’s account.
* `J` - Reject Return
userField:
type: string
maxLength: 1
description: UserField is a field used at the discretion of users of the standard
example: 'V'
CashLetterControl:
properties:
ID:
type: string
description: CashLetterControl ID
example: 'd1e26288'
cashLetterBundleCount:
type: integer
description: CashLetterBundleCount identifies the total number of bundles within the cash letter.
example: 1
cashLetterItemsCount:
type: integer
description: CashLetterItemsCount identifies the total number of items within the cash letter.
example: 1
cashLetterTotalAmount:
type: integer
description: CashLetterTotalAmount identifies the total dollar value of all item amounts within the cash letter.
example: 100
cashLetterImagesCount:
type: integer
description: CashLetterImagesCount identifies the total number of ImageViewDetail(s) within the CashLetter.
example: 1
eceInstitutionName:
type: string
maxLength: 18
description: ECEInstitutionName identifies the short name of the institution that creates the CashLetterControl.
example: "Citadel"
settlementDate:
type: string
format: 'date-time'
description: SettlementDate identifies the date that the institution that creates the cash letter expects settlement.
example: '2018-10-03T00:00:00Z'
creditTotalIndicator:
type: integer
enum:
- 0
- 1
description: |
CreditTotalIndicator is a code that indicates whether Credit Items are included in this record’s totals.
If so, they will be included in TotalItemCount and FileTotalAmount. TotalRecordCount includes all records of
all types regardless of the value of this field.
* ` ` - No Credit Items
* `0` - Credit Items are not included in totals
* `1` - Credit Items are included in totals
example: 1
required:
- cashLetterItemsCount
- cashLetterTotalAmount
- settlementDate
CashLetters:
type: array
items:
$ref: '#/components/schemas/CashLetter'
Bundle:
properties:
bundleHeader:
$ref: '#/components/schemas/BundleHeader'
checks:
type: array
items:
$ref: '#/components/schemas/Checks'
returns:
type: array
items:
$ref: '#/components/schemas/Returns'
bundleControl:
$ref: '#/components/schemas/BundleControl'
BundleHeader:
properties:
ID:
type: string
description: BundleHeader ID
example: 'd1e26288'
collectionTypeIndicator:
type: string
maxLength: 2
enum:
- '00'
- '01'
- '02'
- '03'
- '04'
- '05'
- '06'
description: |
A code that identifies the type of bundle. It is the same value as the CollectionTypeIndicator
in the CashLetterHeader within which the bundle is contained, unless the CollectionTypeIndicator
in the CashLetterHeader is 99.
* `00` - Preliminary Forward Information
* `01` - Forward Presentment
* `02` - Forward Presentment - Same-Day Settlement
* `03` - Return
* `04` - Return Notification
* `05` - Preliminary Return Notification
* `06` - Final Return Notification
example:
'00'
destinationRoutingNumber:
type: string
maxLength: 9
description: DestinationRoutingNumber contains the routing and transit number of the institution that
receives and processes the cash letter or the bundle.
example: '231987654'
eceInstitutionRoutingNumber:
type: string
maxLength: 9
description: ECEInstitutionRoutingNumber contains the routing and transit number of the institution that
that creates the bundle header.
example: '233431587'
bundleBusinessDate:
type: string
format: 'date-time'
description: BundleBusinessDate is the business date of the bundle.
example: '2018-10-03T00:00:00Z'
bundleCreationDate:
type: string
format: 'date-time'
description: BundleCreationDate is the date that the bundle is created.
example: '2018-10-03T00:00:00Z'
bundleID:
type: string
maxLength: 10
description: BundleID is a number that identifies the bundle, assigned by the institution that creates the bundle.
example: '9999'
bundleSequenceNumber:
type: string
maxLength: 4
description: BundleSequenceNumber is a number assigned by the institution that creates the bundle. Usually denotes
the relative position of the bundle within the cash letter.
example: '1'
cycleNumber:
type: string
maxLength: 2
description: CycleNumber is a code assigned by the institution that creates the bundle. Denotes the cycle under which
the bundle is created.
example: "01"
returnLocationRoutingNumber:
type: string
maxLength: 9
description: ReturnLocationRoutingNumber is a bank routing number used by some processors. This will be blank in the resulting file if it is empty.
example: "987654320"
userField:
type: string
maxLength: 5
description: UserField identifies a field used at the discretion of users of the standard.
example: "B1234"
BundleControl:
properties:
ID:
type: string
description: BundleControl ID
example: 'd1e26288'
bundleItemsCount:
type: integer
description: BundleItemsCount identifies the total number of items within the bundle.
example: 1
bundleTotalAmount:
type: integer
description: BundleTotalAmount identifies the total amount of item amounts within the bundle.
example: 100
micrValidTotalAmount:
type: integer
description: MICRValidTotalAmount identifies the total amount of all Check Records within the bundle which
contain 1 in the MICRValidIndicator.
example: 100
bundleImagesCount:
type: integer
description: BundleImagesCount identifies the total number of ImageViewDetail Records within the bundle.
example: 1
userField:
type: string
maxLength: 20
description: UserField identifies a field used at the discretion of users of the standard.
example: "B12345678"
creditTotalIndicator:
type: integer
maxLength: 1
enum:
- 0
- 1
description: |
CreditTotalIndicator is a code that indicates whether Credit Items are included in the totals.
If so, they will be included in this record’s BundleItemsCount, BundleTotalAmount, and BundleImagesCount.
* ` ` - No Credit Items
* `0` - Credit Items are not included in totals
* `1` - Credit Items are included in totals
example: 1
required:
- bundleItemsCount
- bundleTotalAmount
Checks:
properties:
ID:
type: string
description: Check ID
example: d1e26288
auxiliaryOnUs:
type: string
maxLength: 15
description: AuxiliaryOnUs identifies a code used on commercial checks at the discretion of the payor bank.
example: '1001'
externalProcessingCode:
type: string
maxLength: 1
description: ExternalProcessingCode identifies a code used for special purposes as authorized by the Accredited
Standards Committee X9. Also known as Position 44.
example: '1'
payorBankRoutingNumber:
type: string
maxLength: 8
description: |
PayorBankRoutingNumber identifies the institution by or through which the item is
payable. Must be a valid routing and transit number issued by the ABA’s Routing Number Registrar. Shall
represent the first 8 digits of a 9-digit routing number or 8 numeric digits of a 4 dash 4 routing number.
A valid routing number consists of 2 fields: the eight-digit Payor Bank Routing Number and the
one-digit Payor Bank Routing Number Check Digit.
example: '01120036'
payorBankCheckDigit:
type: string
maxLength: 1
description: |
PayorBankCheckDigit identifies the routing number check digit. The
combination of Payor Bank Routing Number and Payor Bank Routing Number Check Digit must be a mod-checked
routing number with a valid check digit.
example: '5'
onUs:
type: string
maxLength: 20