-
Notifications
You must be signed in to change notification settings - Fork 6
/
api.ts
3819 lines (3640 loc) · 175 KB
/
api.ts
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
/* tslint:disable */
/* eslint-disable */
/**
* ACH API
* Moov ACH ([Automated Clearing House](https://en.wikipedia.org/wiki/Automated_Clearing_House)) implements an HTTP API for creating, parsing, and validating ACH files. ACH is the primary method of electronic money movement throughout the United States.
*
* The version of the OpenAPI document: v1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { Configuration } from './configuration';
import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
import globalAxios from 'axios';
// Some imports not used depending on template conditions
// @ts-ignore
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
import type { RequestArgs } from './base';
// @ts-ignore
import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError } from './base';
/**
*
* @export
* @interface ADVBatchControl
*/
export interface ADVBatchControl {
/**
* Batch ID
* @type {string}
* @memberof ADVBatchControl
*/
'id'?: string;
/**
* Same as ServiceClassCode in BatchHeader record
* @type {number}
* @memberof ADVBatchControl
*/
'serviceClassCode': number;
/**
* EntryAddendaCount is a tally of each Entry Detail Record and each Addenda Record processed, within either the batch or file as appropriate.
* @type {number}
* @memberof ADVBatchControl
*/
'entryAddendaCount': number;
/**
* Validate the Receiving DFI Identification in each Entry Detail Record is hashed to provide a check against inadvertent alteration of data contents due to hardware failure or program error. In this context the Entry Hash is the sum of the corresponding fields in the Entry Detail Records on the file.
* @type {number}
* @memberof ADVBatchControl
*/
'entryHash': number;
/**
* Contains accumulated Entry debit totals within the batch.
* @type {number}
* @memberof ADVBatchControl
*/
'totalDebit': number;
/**
* Contains accumulated Entry credit totals within the batch.
* @type {number}
* @memberof ADVBatchControl
*/
'totalCredit': number;
/**
* Alphanumeric code used to identify an ACH Operator
* @type {string}
* @memberof ADVBatchControl
*/
'achOperatorData': string;
/**
* The routing number is used to identify the DFI originating entries within a given branch.
* @type {string}
* @memberof ADVBatchControl
*/
'ODFIIdentification': string;
/**
* BatchNumber is assigned in ascending sequence to each batch by the ODFI or its Sending Point in a given file of entries. Since the batch number in the Batch Header Record and the Batch Control Record is the same, the ascending sequence number should be assigned by batch and not by record.
* @type {number}
* @memberof ADVBatchControl
*/
'batchNumber': number;
}
/**
*
* @export
* @interface ADVEntryDetail
*/
export interface ADVEntryDetail {
/**
* Entry Detail ID
* @type {string}
* @memberof ADVEntryDetail
*/
'id'?: string;
/**
* TransactionCode representing Accounting Entries: 81 - Credit for ACH debits originated | 82 - Debit for ACH credits originated | 83 - Credit for ACH credits received | 84 - Debit for ACH debits received | 85 - Credit for ACH credits in rejected batches | 86 - Debit for ACH debits in rejected batches | 87 - Summary credit for respondent ACH activity | 88 - Summary debit for respondent ACH activity
* @type {number}
* @memberof ADVEntryDetail
*/
'transactionCode': number;
/**
* RDFI\'s routing number without the last digit.
* @type {string}
* @memberof ADVEntryDetail
*/
'RDFIIdentification': string;
/**
* Last digit in RDFI routing number.
* @type {string}
* @memberof ADVEntryDetail
*/
'checkDigit': string;
/**
* The receiver\'s bank account number you are crediting/debiting. It important to note that this is an alphanumeric field, so it\'s space padded, not zero padded
* @type {string}
* @memberof ADVEntryDetail
*/
'DFIAccountNumber': string;
/**
* Number of cents you are debiting/crediting this account
* @type {number}
* @memberof ADVEntryDetail
*/
'amount': number;
/**
* Suggested routing number to use
* @type {string}
* @memberof ADVEntryDetail
*/
'adviceRoutingNumber': string;
/**
* Unique identifier for the File
* @type {string}
* @memberof ADVEntryDetail
*/
'fileIdentification'?: string;
/**
* Information related to the ACH opreator
* @type {string}
* @memberof ADVEntryDetail
*/
'achOperatorData'?: string;
/**
* The name of the receiver, usually the name on the bank account
* @type {string}
* @memberof ADVEntryDetail
*/
'individualName': string;
/**
* DiscretionaryData allows ODFIs to include codes, of significance only to them, to enable specialized handling of the entry. There will be no standardized interpretation for the value of this field. It can either be a single two-character code, or two distinct one-character codes, according to the needs of the ODFI and/or Originator involved. This field must be returned intact for any returned entry. WEB uses the Discretionary Data Field as the Payment Type Code.
* @type {string}
* @memberof ADVEntryDetail
*/
'discretionaryData'?: string;
/**
* AddendaRecordIndicator indicates the existence of an Addenda Record. A value of \"1\" indicates that one or more addenda records follow, and \"0\" means no such record is present.
* @type {number}
* @memberof ADVEntryDetail
*/
'addendaRecordIndicator'?: number;
/**
* Routing number for ACH Operator
* @type {string}
* @memberof ADVEntryDetail
*/
'achOperatorRoutingNumber': string;
/**
* Julian Day of the year
* @type {number}
* @memberof ADVEntryDetail
*/
'julianDay'?: number;
/**
* SequenceNumber is consecutively assigned to each Addenda05 Record following an Entry Detail Record. The first Addenda05 sequence number must always be a 1.
* @type {number}
* @memberof ADVEntryDetail
*/
'sequenceNumber': number;
/**
* Addenda99 record for the ADV Entry Detail
* @type {Array<Addenda99>}
* @memberof ADVEntryDetail
*/
'addenda99'?: Array<Addenda99>;
/**
* Category defines if the entry is a Forward, Return, or NOC
* @type {string}
* @memberof ADVEntryDetail
*/
'category'?: string;
}
/**
*
* @export
* @interface ADVFileControl
*/
export interface ADVFileControl {
/**
* ADV File Control Record
* @type {string}
* @memberof ADVFileControl
*/
'id'?: string;
/**
* Count of Batches in the File
* @type {number}
* @memberof ADVFileControl
*/
'batchCount': number;
/**
* Total number of records in the file (include all headers and trailer) divided by 10 (This number must be evenly divisible by 10. If not, additional records consisting of all 9\'s are added to the file after the initial \'9\' record to fill out the block 10.)
* @type {number}
* @memberof ADVFileControl
*/
'blockCount': number;
/**
* Total detail and addenda records in the file
* @type {number}
* @memberof ADVFileControl
*/
'entryAddendaCount': number;
/**
* Calculated in the same manner as the batch total but includes total from entire file
* @type {number}
* @memberof ADVFileControl
*/
'entryHash': number;
/**
* Accumulated Batch debit totals within the file.
* @type {number}
* @memberof ADVFileControl
*/
'totalDebit': number;
/**
* Accumulated Batch credit totals within the file.
* @type {number}
* @memberof ADVFileControl
*/
'totalCredit': number;
}
/**
*
* @export
* @interface Addenda02
*/
export interface Addenda02 {
/**
* Client-defined string used as a reference to this record.
* @type {string}
* @memberof Addenda02
*/
'id'?: string;
/**
* 02 - NACHA regulations
* @type {string}
* @memberof Addenda02
*/
'typeCode': string;
/**
* ReferenceInformationOne may be used for additional reference numbers, identification numbers, or codes that the merchant needs to identify the particular transaction or customer.
* @type {string}
* @memberof Addenda02
*/
'referenceInformationOne'?: string;
/**
* ReferenceInformationTwo may be used for additional reference numbers, identification numbers, or codes that the merchant needs to identify the particular transaction or customer.
* @type {string}
* @memberof Addenda02
*/
'referenceInformationTwo'?: string;
/**
* TerminalIdentificationCode identifies an Electronic terminal with a unique code that allows a terminal owner and/or switching network to identify the terminal at which an Entry originated.
* @type {string}
* @memberof Addenda02
*/
'terminalIdentificationCode': string;
/**
* TransactionSerialNumber is assigned by the terminal at the time the transaction is originated. The number, with the Terminal Identification Code, serves as an audit trail for the transaction and is usually assigned in ascending sequence.
* @type {string}
* @memberof Addenda02
*/
'transactionSerialNumber': string;
/**
* Timestamp identifies the date on which the transaction occurred. (Format MMDD - M=Month, D=Day)
* @type {string}
* @memberof Addenda02
*/
'transactionDate': string;
/**
* Indicates the code that a card authorization center has furnished to the merchant.
* @type {string}
* @memberof Addenda02
*/
'authorizationCodeOrExpireDate'?: string;
/**
* Identifies the specific location of a terminal (i.e., street names of an intersection, address, etc.) in accordance with the requirements of Regulation E.
* @type {string}
* @memberof Addenda02
*/
'terminalLocation': string;
/**
* Identifies the city in which the electronic terminal is located.
* @type {string}
* @memberof Addenda02
*/
'terminalCity': string;
/**
* Identifies the state in which the electronic terminal is located.
* @type {string}
* @memberof Addenda02
*/
'terminalState': string;
/**
* Entry Detail Trace Number
* @type {string}
* @memberof Addenda02
*/
'traceNumber'?: string;
}
/**
*
* @export
* @interface Addenda05
*/
export interface Addenda05 {
/**
* Client-defined string used as a reference to this record.
* @type {string}
* @memberof Addenda05
*/
'id'?: string;
/**
* 05 - NACHA regulations
* @type {string}
* @memberof Addenda05
*/
'typeCode': string;
/**
* Text for describing the related payment
* @type {string}
* @memberof Addenda05
*/
'paymentRelatedInformation': string;
/**
* SequenceNumber is consecutively assigned to each Addenda05 Record following an Entry Detail Record. The first Addenda05 sequence number must always be a 1.
* @type {number}
* @memberof Addenda05
*/
'sequenceNumber': number;
/**
* EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record\'s trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.
* @type {number}
* @memberof Addenda05
*/
'entryDetailSequenceNumber': number;
}
/**
*
* @export
* @interface Addenda10
*/
export interface Addenda10 {
/**
* Client-defined string used as a reference to this record.
* @type {string}
* @memberof Addenda10
*/
'id'?: string;
/**
* 10 - NACHA regulations
* @type {string}
* @memberof Addenda10
*/
'typeCode': string;
/**
* Describes the type of payment: \'ANN\' = Annuity | \'BUS\' = Business/Commercial | \'DEP\' = Deposit | \'LOA\' = Loan | \'MIS\' = Miscellaneous | \'MOR\' = Mortgage | \'PEN\' = Pension | \'RLS\' = Rent/Lease | \'REM\' = Remittance2 | \'SAL\' = Salary/Payroll | \'TAX\' = Tax | \'TEL\' = Telephone-Initiated Transaction | \'WEB\' = Internet-Initiated Transaction | \'ARC\' = Accounts Receivable Entry | \'BOC\' = Back Office Conversion Entry | \'POP\' = Point of Purchase Entry | \'RCK\' = Re-presented Check Entry
* @type {string}
* @memberof Addenda10
*/
'transactionTypeCode'?: string;
/**
* For inbound IAT payments this field should contain the USD amount or may be blank.
* @type {number}
* @memberof Addenda10
*/
'foreignPaymentAmount': number;
/**
* Trace number
* @type {string}
* @memberof Addenda10
*/
'foreignTraceNumber'?: string;
/**
* Receiving Company Name/Individual Name
* @type {string}
* @memberof Addenda10
*/
'name': string;
/**
* EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record\'s trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.
* @type {number}
* @memberof Addenda10
*/
'entryDetailSequenceNumber': number;
}
/**
*
* @export
* @interface Addenda11
*/
export interface Addenda11 {
/**
* Client-defined string used as a reference to this record.
* @type {string}
* @memberof Addenda11
*/
'id'?: string;
/**
* 11 - NACHA regulations
* @type {string}
* @memberof Addenda11
*/
'typeCode': string;
/**
* Originator\'s name (your company name / name)
* @type {string}
* @memberof Addenda11
*/
'originatorName': string;
/**
* Originator\'s street address
* @type {string}
* @memberof Addenda11
*/
'originatorStreetAddress': string;
/**
* EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record\'s trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.
* @type {number}
* @memberof Addenda11
*/
'entryDetailSequenceNumber': number;
}
/**
*
* @export
* @interface Addenda12
*/
export interface Addenda12 {
/**
* Client-defined string used as a reference to this record.
* @type {string}
* @memberof Addenda12
*/
'id'?: string;
/**
* 12 - NACHA regulations
* @type {string}
* @memberof Addenda12
*/
'typeCode': string;
/**
* Originator City & State / Province Data elements City and State / Province should be separated with an asterisk (*) as a delimiter and the field should end with a backslash (\\\\).
* @type {string}
* @memberof Addenda12
*/
'originatorCityStateProvince': string;
/**
* Originator Country & Postal Code Data elements must be separated by an asterisk (*) and must end with a backslash (\\\\).
* @type {string}
* @memberof Addenda12
*/
'originatorCountryPostalCode': string;
/**
* EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record\'s trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.
* @type {number}
* @memberof Addenda12
*/
'entryDetailSequenceNumber': number;
}
/**
*
* @export
* @interface Addenda13
*/
export interface Addenda13 {
/**
* Client-defined string used as a reference to this record.
* @type {string}
* @memberof Addenda13
*/
'id'?: string;
/**
* 13 - NACHA regulations
* @type {string}
* @memberof Addenda13
*/
'typeCode': string;
/**
* Originating DFI Name For Outbound IAT Entries, this field must contain the name of the U.S. ODFI. For Inbound IATs: Name of the foreign bank providing funding for the payment transaction
* @type {string}
* @memberof Addenda13
*/
'ODFIName': string;
/**
* Originating DFI Identification Number Qualifier. For Inbound IATs: The 2-digit code that identifies the numbering scheme used in the Foreign DFI Identification Number field: \'01\' = National Clearing System | \'02\' = BIC Code | \'03\' = IBAN Code
* @type {string}
* @memberof Addenda13
*/
'ODFIIDNumberQualifier': string;
/**
* Originating DFI Identification. This field contains the routing number that identifies the U.S. ODFI initiating the entry. For Inbound IATs: This field contains the bank ID number of the Foreign Bank providing funding for the payment transaction.
* @type {string}
* @memberof Addenda13
*/
'ODFIIdentification'?: string;
/**
* Originating DFI Branch Country Code: USb = United States //(\"b\" indicates a blank space) For Inbound IATs: This 3 position field contains a 2-character code as approved by the International Organization for Standardization (ISO) used to identify the country in which the branch of the bank that originated the entry is located. Values for other countries can be found on the International Organization for Standardization website: www.iso.org.
* @type {string}
* @memberof Addenda13
*/
'ODFIBranchCountryCode': string;
/**
* EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record\'s trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.
* @type {number}
* @memberof Addenda13
*/
'entryDetailSequenceNumber': number;
}
/**
*
* @export
* @interface Addenda14
*/
export interface Addenda14 {
/**
* Client-defined string used as a reference to this record.
* @type {string}
* @memberof Addenda14
*/
'id'?: string;
/**
* 14 - NACHA regulations
* @type {string}
* @memberof Addenda14
*/
'typeCode': string;
/**
* Name of the Receiver bank
* @type {string}
* @memberof Addenda14
*/
'RDFIName': string;
/**
* Receiving DFI Identification Number Qualifier. The 2-digit code that identifies the numbering scheme used in the Receiving DFI Identification Number field: \'01\' = National Clearing System | \'02\' = BIC Code | \'03\' = IBAN Code
* @type {string}
* @memberof Addenda14
*/
'RDFIIDNumberQualifier': string;
/**
* This field contains the bank identification number of the DFI at which the Receiver maintains his account.
* @type {string}
* @memberof Addenda14
*/
'RDFIIdentification': string;
/**
* Receiving DFI Branch Country Code USb\" = United States (\"b\" indicates a blank space) This 3 position field contains a 2-character code as approved by the International Organization for Standardization (ISO) used to identify the country in which the branch of the bank that receives the entry is located. Values for other countries can be found on the International Organization for Standardization website: www.iso.org
* @type {string}
* @memberof Addenda14
*/
'RDFIBranchCountryCode': string;
/**
* EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record\'s trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.
* @type {number}
* @memberof Addenda14
*/
'entryDetailSequenceNumber': number;
}
/**
*
* @export
* @interface Addenda15
*/
export interface Addenda15 {
/**
* Client-defined string used as a reference to this record.
* @type {string}
* @memberof Addenda15
*/
'id'?: string;
/**
* 15 - NACHA regulations
* @type {string}
* @memberof Addenda15
*/
'typeCode': string;
/**
* Receiver Identification Number contains the accounting number by which the Originator is known to the Receiver for descriptive purposes. NACHA Rules recommend but do not require the RDFI to print the contents of this field on the receiver\'s statement.
* @type {string}
* @memberof Addenda15
*/
'receiverIDNumber'?: string;
/**
* Receiver\'s physical address
* @type {string}
* @memberof Addenda15
*/
'receiverStreetAddress': string;
/**
* EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record\'s trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.
* @type {number}
* @memberof Addenda15
*/
'entryDetailSequenceNumber': number;
}
/**
*
* @export
* @interface Addenda16
*/
export interface Addenda16 {
/**
* Client-defined string used as a reference to this record.
* @type {string}
* @memberof Addenda16
*/
'id'?: string;
/**
* 16 - NACHA regulations
* @type {string}
* @memberof Addenda16
*/
'typeCode': string;
/**
* Receiver City & State / Province Data elements City and State / Province should be separated with an asterisk (*) as a delimiter and the field should end with a backslash (\\\\).
* @type {string}
* @memberof Addenda16
*/
'receiverCityStateProvince': string;
/**
* Receiver Country & Postal Code Data elements must be separated by an asterisk (*) and must end with a backslash (\\\\).
* @type {string}
* @memberof Addenda16
*/
'receiverCountryPostalCode': string;
/**
* EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record\'s trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.
* @type {number}
* @memberof Addenda16
*/
'entryDetailSequenceNumber': number;
}
/**
*
* @export
* @interface Addenda17
*/
export interface Addenda17 {
/**
* Client-defined string used as a reference to this record.
* @type {string}
* @memberof Addenda17
*/
'id'?: string;
/**
* 17 - NACHA regulations
* @type {string}
* @memberof Addenda17
*/
'typeCode': string;
/**
* Additional information related to the payment
* @type {string}
* @memberof Addenda17
*/
'paymentRelatedInformation': string;
/**
* SequenceNumber is consecutively assigned to each Addenda17 Record following an Entry Detail Record. The first Addenda17 sequence number must always be a 1.
* @type {number}
* @memberof Addenda17
*/
'sequenceNumber': number;
/**
* EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record\'s trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.
* @type {number}
* @memberof Addenda17
*/
'entryDetailSequenceNumber': number;
}
/**
*
* @export
* @interface Addenda18
*/
export interface Addenda18 {
/**
* Client-defined string used as a reference to this record.
* @type {string}
* @memberof Addenda18
*/
'id'?: string;
/**
* 18 - NACHA regulations
* @type {string}
* @memberof Addenda18
*/
'typeCode': string;
/**
* Name of the Foreign Correspondent Bank
* @type {string}
* @memberof Addenda18
*/
'foreignCorrespondentBankName': string;
/**
* Foreign Correspondent Bank Identification Number Qualifier contains a 2-digit code that identifies the numbering scheme used in the Foreign Correspondent Bank Identification Number field. Code values for this field are: \"01\" = National Clearing System | \"02\" = BIC Code | \"03\" = IBAN Code
* @type {string}
* @memberof Addenda18
*/
'foreignCorrespondentBankIDNumberQualifier'?: string;
/**
* Foreign Correspondent Bank Identification Number contains the bank ID number of the Foreign Correspondent Bank
* @type {string}
* @memberof Addenda18
*/
'foreignCorrespondentBankIDNumber': string;
/**
* Foreign Correspondent Bank Branch Country Code contains the two-character code, as approved by the International Organization for Standardization (ISO), to identify the country in which the branch of the Foreign Correspondent Bank is located. Values can be found on the International Organization for Standardization website: www.iso.org
* @type {string}
* @memberof Addenda18
*/
'foreignCorrespondentBankBranchCountryCode': string;
/**
* SequenceNumber is consecutively assigned to each Addenda17 Record following an Entry Detail Record. The first Addenda17 sequence number must always be a 1.
* @type {number}
* @memberof Addenda18
*/
'sequenceNumber': number;
/**
* EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record\'s trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.
* @type {number}
* @memberof Addenda18
*/
'entryDetailSequenceNumber': number;
}
/**
*
* @export
* @interface Addenda98
*/
export interface Addenda98 {
/**
* Client-defined string used as a reference to this record.
* @type {string}
* @memberof Addenda98
*/
'id'?: string;
/**
* 98 - NACHA regulations
* @type {string}
* @memberof Addenda98
*/
'typeCode': string;
/**
* ChangeCode field contains a standard code used by an ACH Operator or RDFI to describe the reason for a change Entry.
* @type {string}
* @memberof Addenda98
*/
'changeCode': string;
/**
* OriginalTrace This field contains the Trace Number as originally included on the forward Entry or Prenotification. The RDFI must include the Original Entry Trace Number in the Addenda Record of an Entry being returned to an ODFI, in the Addenda Record of an 98, within an Acknowledgment Entry, or with an RDFI request for a copy of an authorization.
* @type {string}
* @memberof Addenda98
*/
'originalTrace': string;
/**
* The Receiving DFI Identification (addenda.RDFIIdentification) as originally included on the forward Entry or Prenotification that the RDFI is returning or correcting.
* @type {string}
* @memberof Addenda98
*/
'originalDFI': string;
/**
* Correct field value of what changeCode references
* @type {string}
* @memberof Addenda98
*/
'correctedData': string;
/**
* Entry Detail Trace Number
* @type {string}
* @memberof Addenda98
*/
'traceNumber'?: string;
}
/**
*
* @export
* @interface Addenda98Refused
*/
export interface Addenda98Refused {
/**
* Client-defined string used as a reference to this record.
* @type {string}
* @memberof Addenda98Refused
*/
'id'?: string;
/**
* 98 - NACHA regulations
* @type {string}
* @memberof Addenda98Refused
*/
'typeCode': string;
/**
* The code specifying why the Notification of Change is being refused.
* @type {string}
* @memberof Addenda98Refused
*/
'refusedChangeCode': string;
/**
* OriginalTrace This field contains the Trace Number as originally included on the forward Entry or Prenotification. The RDFI must include the Original Entry Trace Number in the Addenda Record of an Entry being returned to an ODFI, in the Addenda Record of an 98, within an Acknowledgment Entry, or with an RDFI request for a copy of an authorization.
* @type {string}
* @memberof Addenda98Refused
*/
'originalTrace': string;
/**
* The Receiving DFI Identification (addenda.RDFIIdentification) as originally included on the forward Entry or Prenotification that the RDFI is returning or correcting.
* @type {string}
* @memberof Addenda98Refused
*/
'originalDFI': string;
/**
* Correct field value of what changeCode references
* @type {string}
* @memberof Addenda98Refused
*/
'correctedData': string;
/**
* ChangeCode field contains a standard code used by an ACH Operator or RDFI to describe the reason for a change Entry.
* @type {string}
* @memberof Addenda98Refused
*/
'changeCode': string;
/**
* The last seven digits of the TraceNumber in the original Notification of Change.
* @type {string}
* @memberof Addenda98Refused
*/
'traceSequenceNumber': string;
/**
* Entry Detail Trace Number
* @type {string}
* @memberof Addenda98Refused
*/
'traceNumber': string;
}
/**
*
* @export
* @interface Addenda99
*/
export interface Addenda99 {
/**
* Client-defined string used as a reference to this record.
* @type {string}
* @memberof Addenda99
*/
'id'?: string;
/**
* 99 - NACHA regulations
* @type {string}
* @memberof Addenda99
*/
'typeCode': string;
/**
* Standard code used by an ACH Operator or RDFI to describe the reason for returning an Entry.
* @type {string}
* @memberof Addenda99
*/
'returnCode': string;
/**
* OriginalTrace This field contains the Trace Number as originally included on the forward Entry or Prenotification. The RDFI must include the Original Entry Trace Number in the Addenda Record of an Entry being returned to an ODFI, in the Addenda Record of an 98, within an Acknowledgment Entry, or with an RDFI request for a copy of an authorization.
* @type {string}
* @memberof Addenda99
*/
'originalTrace': string;
/**
* The field date of death is to be supplied on Entries being returned for reason of death (return reason codes R14 and R15). (Format YYMMDD - Y=Year, M=Month, D=Day)
* @type {string}
* @memberof Addenda99
*/
'dateOfDeath': string;
/**
* Contains the Receiving DFI Identification (addenda.RDFIIdentification) as originally included on the forward Entry or Prenotification that the RDFI is returning or correcting.
* @type {string}
* @memberof Addenda99
*/
'originalDFI': string;
/**
* Information related to the return
* @type {string}
* @memberof Addenda99
*/
'addendaInformation'?: string;
/**
* Matches the Entry Detail Trace Number of the entry being returned.
* @type {string}
* @memberof Addenda99
*/
'traceNumber'?: string;
}
/**
*
* @export
* @interface Addenda99Contested
*/
export interface Addenda99Contested {
/**
* Client-defined string used as a reference to this record.
* @type {string}
* @memberof Addenda99Contested
*/
'id'?: string;
/**
* 99 - NACHA regulations
* @type {string}
* @memberof Addenda99Contested
*/
'typeCode': string;
/**
* return code explaining the contested dishonorment
* @type {string}
* @memberof Addenda99Contested
*/
'contestedReturnCode': string;
/**
* Date original entry was returned
* @type {string}
* @memberof Addenda99Contested
*/
'dateOriginalEntryReturned': string;
/**
* Return reason code of the Dishonored Return
* @type {string}
* @memberof Addenda99Contested
*/
'dishonoredReturnReasonCode': string;
/**
* Trace number from Dishonored Return
* @type {string}
* @memberof Addenda99Contested
*/
'dishonoredReturnTraceNumber': string;
/**
* Settlement date of the Dishonored Return
* @type {string}
* @memberof Addenda99Contested
*/
'dishonoredReturnSettlementDate': string;
/**
* Trace Number of the original entry being returned.
* @type {string}
* @memberof Addenda99Contested
*/
'originalEntryTraceNumber': string;
/**
* Identification of the Original Receiving Depository Institution (ODFI)
* @type {string}
* @memberof Addenda99Contested
*/
'originalReceivingDFIIdentification': string;
/**
* Original date of settlement
* @type {string}
* @memberof Addenda99Contested
*/
'originalSettlementDate': string;
/**
* Return trace number
* @type {string}
* @memberof Addenda99Contested
*/
'returnTraceNumber': string;
/**
* Return settlement date
* @type {string}
* @memberof Addenda99Contested
*/
'returnSettlementDate': string;
/**
* Return reason code
* @type {string}
* @memberof Addenda99Contested
*/
'returnReasonCode': string;
/**
* Unique Trace Number for the contested dishonored return
* @type {string}
* @memberof Addenda99Contested