-
Notifications
You must be signed in to change notification settings - Fork 40
/
Copy pathopenapi.yaml
2068 lines (2015 loc) · 63.8 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 Wire implements an HTTP API for creating, parsing, and validating Fedwire messages.
version: v1
title: Wire API
contact:
url: https://github.com/moov-io/wire
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: http://localhost:8088
description: Local development
tags:
- name: 'Wire Files'
description: |
File contains Fedwire Messages of a Wire File.
paths:
/ping:
get:
tags: ['Wire Files']
summary: Ping Wire service
description: Check if the Wire service is running.
operationId: ping
responses:
'200':
description: Service is running properly
/files:
get:
tags: ['Wire Files']
summary: List files
description: List all Wire files created with the Wire service. These files are not persisted through multiple runs of the service.
operationId: getWireFiles
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 Wire files
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/WireFiles'
/files/create:
post:
tags: ['Wire Files']
summary: Create file
description: >
Upload a new Wire file, or create one from JSON. When uploading a file, query parameters can be used to
configure the FedWireMessage validation options. For JSON requests, validation options are set in the
request body under fedWireMessage.validateOptions.
operationId: createWireFile
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: skipMandatoryIMAD
in: query
description: Optional flag to skip mandatory IMAD validation
required: false
schema:
type: boolean
default: false
example: true
- name: allowMissingSenderSupplied
in: query
description: Optional flag to allow SenderSupplied to be nil, which is generally the case in incoming files.
required: false
schema:
type: boolean
default: false
example: true
requestBody:
description: Content of the Wire file (in json or raw text)
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WireFile'
text/plain:
schema:
description: A plaintext FED Wire file
type: string
example:
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/WireFile'
'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: ['Wire Files']
summary: Retrieve file
description: Get the details of an existing File using the unique File identifier that was returned upon creation.
operationId: getWireFileByID
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/WireFile'
'404':
description: A resource with the specified ID was not found
# post:
# tags: ['Wire Files']
# summary: Updates the specified FEDWire Message by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
# operationId: updateWireFileByID
# 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/WireFile'
# 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/WireFile'
# '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: ['Wire Files']
summary: Delete file
description: Permanently delete a File and associated message. It cannot be undone.
operationId: deleteWireFileByID
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.
'404':
description: A File with the specified ID was not found.
/files/{fileID}/contents:
get:
tags: ['Wire Files']
summary: Get file contents
description: |
Assembles the existing file, computes sequence numbers and totals. Returns plaintext file.
operationId: getWireFileContents
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: format
in: query
description: Optional file type to get file as fixed length or variable length type
required: false
schema:
type: string
example: variable
- name: newline
in: query
description: Optional new line flag to have new line or no new line
required: false
schema:
type: boolean
example: false
responses:
'200':
description: File built successfully without errors.
content:
text/plain:
schema:
$ref: '#/components/schemas/RawWireFile'
'404':
description: A resource with the specified ID was not found
/files/{fileID}/validate:
get:
tags: ['Wire Files']
summary: Validate file
description: Validates the existing file. You need only supply the unique File identifier that was returned upon creation.
operationId: validateWireFile
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/WireFile'
'400':
description: Validation failed. Check response for errors
'404':
description: A resource with the specified ID was not found
/files/{fileID}/FEDWireMessage:
post:
tags: ['Wire Files']
summary: Add Fedwire message to file
description: Add a Fedwire Message to the specified file.
operationId: addFEDWireMessageToFile
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/FEDWireMessage'
responses:
'200':
description: Fedwire Message added to File
'404':
description: A resource with the specified ID was not found
components:
schemas:
WireFile:
properties:
ID:
type: string
description: File ID
example: 3f2d23ee214
fedWireMessage:
$ref: '#/components/schemas/FEDWireMessage'
required:
- fedWireMessage
WireFiles:
type: array
items:
$ref: '#/components/schemas/WireFile'
RawWireFile:
type: string
description: Plaintext Fedwire file
example: "{3100}121042882Wells Fargo NA"
FEDWireMessage:
properties:
ID:
type: string
description: Fedwire Message ID
example: 3f2d23ee214
# messageDisposition, receiptTimeStamp, outputMessageAccountabilityData, errorWire is information Appended by the FEDWire Funds Service
messageDisposition:
$ref: '#/components/schemas/MessageDisposition'
receiptTimeStamp:
$ref: '#/components/schemas/ReceiptTimeStamp'
outputMessageAccountabilityData:
$ref: '#/components/schemas/OutputMessageAccountabilityData'
errorWire:
$ref: '#/components/schemas/ErrorWire'
senderSupplied:
$ref: '#/components/schemas/SenderSupplied'
typeSubType:
$ref: '#/components/schemas/TypeSubType'
inputMessageAccountabilityData:
$ref: '#/components/schemas/InputMessageAccountabilityData'
amount:
$ref: '#/components/schemas/WireAmount'
senderDepositoryInstitution:
$ref: '#/components/schemas/SenderDepositoryInstitution'
receiverDepositoryInstitution:
$ref: '#/components/schemas/ReceiverDepositoryInstitution'
businessFunctionCode:
$ref: '#/components/schemas/BusinessFunctionCode'
senderReference:
$ref: '#/components/schemas/SenderReference'
previousMessageIdentifier:
$ref: '#/components/schemas/PreviousMessageIdentifier'
localInstrument:
$ref: '#/components/schemas/LocalInstrument'
paymentNotification:
$ref: '#/components/schemas/PaymentNotification'
charges:
$ref: '#/components/schemas/Charges'
instructedAmount:
$ref: '#/components/schemas/InstructedAmount'
exchangeRate:
$ref: '#/components/schemas/ExchangeRate'
beneficiaryIntermediaryFI:
$ref: '#/components/schemas/FinancialInstitution'
beneficiaryFI:
$ref: '#/components/schemas/FinancialInstitution'
beneficiary:
$ref: '#/components/schemas/Beneficiary'
beneficiaryReference:
$ref: '#/components/schemas/BeneficiaryReference'
accountDebitedDrawdown:
$ref: '#/components/schemas/AccountDebitedDrawdown'
originator:
$ref: '#/components/schemas/Beneficiary'
originatorOptionF:
$ref: '#/components/schemas/OriginatorOptionF'
originatorFI:
$ref: '#/components/schemas/FinancialInstitution'
instructingFI:
$ref: '#/components/schemas/FinancialInstitution'
accountCreditedDrawdown:
$ref: '#/components/schemas/AccountCreditedDrawdown'
originatorToBeneficiary:
$ref: '#/components/schemas/OriginatorToBeneficiary'
fiReceiverFI:
$ref: '#/components/schemas/FIToFI'
fiDrawdownDebitAccountAdvice:
$ref: '#/components/schemas/Advice'
fiIntermediaryFI:
$ref: '#/components/schemas/FIToFI'
fiIntermediaryFIAdvice:
$ref: '#/components/schemas/Advice'
fiBeneficiaryFI:
$ref: '#/components/schemas/FIToFI'
fiBeneficiaryFIAdvice:
$ref: '#/components/schemas/Advice'
fiBeneficiary:
$ref: '#/components/schemas/FIToFI'
fiBeneficiaryAdvice:
$ref: '#/components/schemas/Advice'
fiPaymentMethodToBeneficiary:
$ref: '#/components/schemas/FIPaymentMethodToBeneficiary'
fiAdditionalFIToFI:
$ref: '#/components/schemas/AdditionalFIToFI'
currencyInstructedAmount:
$ref: '#/components/schemas/CurrencyInstructedAmount'
orderingCustomer:
$ref: '#/components/schemas/CoverPayment'
orderingInstitution:
$ref: '#/components/schemas/CoverPayment'
intermediaryInstitution:
$ref: '#/components/schemas/CoverPayment'
institutionAccount:
$ref: '#/components/schemas/CoverPayment'
beneficiaryCustomer:
$ref: '#/components/schemas/CoverPayment'
remittance:
$ref: '#/components/schemas/CoverPayment'
senderToReceiver:
$ref: '#/components/schemas/CoverPayment'
unstructuredAddenda:
$ref: '#/components/schemas/UnstructuredAddenda'
relatedRemittance:
$ref: '#/components/schemas/RelatedRemittance'
remittanceOriginator:
$ref: '#/components/schemas/RemittanceOriginator'
remittanceBeneficiary:
$ref: '#/components/schemas/RemittanceBeneficiary'
primaryRemittanceDocument:
$ref: '#/components/schemas/PrimaryRemittanceDocument'
actualAmountPaid:
$ref: '#/components/schemas/RemittanceAmount'
grossAmountRemittanceDocument:
$ref: '#/components/schemas/RemittanceAmount'
amountNegotiatedDiscount:
$ref: '#/components/schemas/RemittanceAmount'
adjustment:
$ref: '#/components/schemas/Adjustment'
dateRemittanceDocument:
$ref: '#/components/schemas/DateRemittanceDocument'
secondaryRemittanceDocument:
$ref: '#/components/schemas/SecondaryRemittanceDocument'
remittanceFreeText:
$ref: '#/components/schemas/RemittanceFreeText'
serviceMessage:
$ref: '#/components/schemas/ServiceMessage'
validateOptions:
$ref: '#/components/schemas/ValidateOptions'
required:
- senderSupplied
- typeSubType
- inputMessageAccountabilityData
- amount
- senderDepositoryInstitution
- receiverDepositoryInstitution
- businessFunctionCode
MessageDisposition:
properties:
formatVersion:
type: string
minLength: 2
maxLength: 2
description: formatVersion identifies the Fedwire message format version 30.
example: '30'
testProductionCode:
type: string
maxLength: 1
description: |
testProductionCode identifies if test or production.
* `T` - Test
* `P` - Production
enum:
- " "
- "T"
- "P"
example: 'T'
messageDuplicationCode:
type: string
description: |
MessageDuplicationCode
* ` ` - Original Message
* `R` - Retrieval of an original message
* `P` - Resend
enum:
- " "
- "R"
- "P"
example: 'R'
messageStatusIndicator:
type: string
description: |
MessageStatusIndicator
Outgoing Messages
* `0` - In process or Intercepted
* `2` - Successful with Accounting (Value)
* `3` - Rejected due to Error Condition
* `7` - Successful without Accounting (Non-Value)
Incoming Messages
* `N` - Successful with Accounting (Value)
* `S` - Successful without Accounting (Non-Value)
enum:
- "0"
- "2"
- "3"
- "7"
- "N"
- "S"
example: '0'
ReceiptTimeStamp:
properties:
receiptDate:
type: string
description: |
ReceiptDate is based on the calendar date. (Format MMDD - M=Month, D=Day)
format: 'MMDD'
example: '0401'
receiptTime:
type: string
format: 'HHmm'
description: |
ReceiptTime is based on a 24-hour clock, Eastern Time. (Format HHmm - H=Hour, m=Minute)
example: '1305'
receiptApplicationIdentification:
type: string
maxLength: 4
description: 'ApplicationIdentification'
example: 'RB11'
OutputMessageAccountabilityData:
properties:
outputCycleDate:
type: string
format: 'CCYYMMDD'
description: OutputCycleDate (Format CCYYMMDD - C=Century, Y=Year, M=Month, D=Day)
example: '20190401'
outputDestinationID:
type: string
maxLength: 8
description: OutputDestinationID
example: '12345678'
outputSequenceNumber:
type: string
maxLength: 6
description: OutputSequenceNumber
example: '000001'
outputDate:
type: string
description: |
Output Date is based on the calendar date. (Format MMDD - M=Month, D=Day)
format: "MMDD"
example: '0401'
outputTime:
type: string
format: "HHmm"
description: |
Output Time is based on a 24-hour clock, Eastern Time. (Format HHmm - H=Hour, m=Minute)
example: '1305'
outputFRBApplicationIdentification:
type: string
maxLength: 4
description: 'OutputFRBApplicationIdentification'
example: 'OB11'
ErrorWire:
properties:
errorCategory:
type: string
description: |
ErrorCategory
* `E` - Data Error
* `F` - Insufficient Balance
* `H` - Accountability Error
* `I` - In Process or Intercepted
* `W` - Cutoff Hour Error
* `X` - Duplicate IMAD
enum:
- E
- F
- H
- I
- W
- X
example: 'E'
errorCode:
type: string
maxLength: 3
description: ErrorCode
example: 'E99'
errorDescription:
type: string
maxLength: 35
description: ErrorDescription
example: 'Data Error'
SenderSupplied:
properties:
formatVersion:
type: string
maxLength: 2
description: |
FormatVersion
30
example: '30'
userRequestCorrelation:
type: string
maxLength: 8
description: UserRequestCorrelation
example: 'TESTDATA'
testProductionCode:
type: string
description: |
Identifies if test or production.
* `T` - Test
* `P` - Production
enum:
- T
- P
example: 'T'
messageDuplicationCode:
type: string
description: |
MessageDuplicationCode
* ` ` - Original Message
* `R` - Retrieval of an original message
* `P` - Resend
enum:
- " "
- R
- P
example: 'R'
required:
- formatVersion
- userRequestCorrelation
- testProductionCode
- messageDuplicationCode
TypeSubType:
properties:
typeCode:
type: string
description: |
TypeCode:
* `10` - Funds Transfer - A funds transfer in which the sender and/or receiver may be a bank or a third party (i.e., customer of a bank).
* `15` - Foreign Transfer - A funds transfer to or from a foreign central bank or government or international organization with an account at the Federal Reserve Bank of New York.
* `16` - Settlement Transfer - A funds transfer between Fedwire Funds Service participants.
enum:
- "10"
- "15"
- "16"
example: '10'
subTypeCode:
type: string
description: |
SubTypeCode:
* `00` - Basic Funds Transfer - A basic value funds transfer.
* `01` - Request for Reversal - A non-value request for reversal of a funds transfer originated on the current business day.
* `02` - Reversal of Transfer - A value reversal of a funds transfer received on the current business day. May be used in response to a subtype code ‘01’ Request for Reversal.
* `07` - Request for Reversal of a Prior Day Transfer - A non-value request for a reversal of a funds transfer originated on a prior business day.
* `08` - Reversal of a Prior Day Transfer - A value reversal of a funds transfer received on a prior business day. May be used in response to a subtype code ‘07’ Request for Reversal of a Prior Day Transfer.
* `31` - Request for Credit (Drawdown) - A non-value request for the receiver to send a funds transfer to a designated party.
* `32` - Funds Transfer Honoring a Request for Credit (Drawdown) - A value funds transfer honoring a subtype 31 request for credit.
* `33` - Refusal to Honor a Request for Credit (Drawdown) - A non-value message indicating refusal to honor a subtype 31 request for credit.
* `90` - Service Message - A non-value message used to communicate questions and information that is not covered by a specific subtype.
enum:
- "00"
- "01"
- "02"
- "07"
- "08"
- "31"
- "32"
- "33"
- "90"
example: '00'
required:
- typeCode
- subTypeCode
InputMessageAccountabilityData:
properties:
inputCycleDate:
type: string
format: 'CCYYMMDD'
description: |
InputCycleDate (Format CCYYMMDD - C=Century, Y=Year, M=Month, D=Day)
example: '20191201'
inputSource:
type: string
minLength: 8
maxLength: 8
description: InputSource
example: 'XYZ ABC '
inputSequenceNumber:
type: string
minLength: 6
maxLength: 6
description: InputSequenceNumber
example: '000001'
required:
- inputCycleDate
- inputSource
- inputSequenceNumber
WireAmount:
description: Maximum amount is a penny less than $10 billion.
properties:
amount:
type: string
minLength: 12
maxLength: 12
description: |
Amount is 12 numeric digits, right-justified with leading zeros.
It has an implied decimal point and no commas (e.g., $12,345.67 becomes 000001234567).
Can be all zeros for subtype 90.
example: '000000100000'
required:
- amount
SenderDepositoryInstitution:
description: SenderDepositoryInstitution is the receiver depository institution
properties:
senderABANumber:
type: string
minLength: 9
maxLength: 9
description: SenderABANumber
example: '091905114'
senderShortName:
type: string
maxLength: 18
description: SenderShortName
example: 'MIDWESTONE B&T'
required:
- senderABANumber
- senderShortName
ReceiverDepositoryInstitution:
description: ReceiverDepositoryInstitution is the receiver depository institution.
properties:
receiverABANumber:
type: string
minLength: 9
maxLength: 9
description: ReceiverABANumber
example: '091905664'
receiverShortName:
type: string
maxLength: 18
description: ReceiverShortName
example: 'PREMIER BANK'
required:
- receiverABANumber
- receiverShortName
BusinessFunctionCode:
properties:
businessFunctionCode:
type: string
description: |
BusinessFunctionCode
* `BTR` - Bank Transfer (Beneficiary is a bank)
* `DRC` - Customer or Corporate Drawdown Request
* `CKS` - Check Same Day Settlement
* `DRW` - Drawdown Payment
* `CTP` - Customer Transfer Plus
* `FFR` - Fed Funds Returned
* `CTR` - Customer Transfer (Beneficiary is a not a bank)
* `FFS` - Fed Funds Sold
* `DEP` - Deposit to Sender’s Account
* `SVC` - Service Message
* `DRB` - Bank-to-Bank Drawdown Request
enum:
- BTR
- DRC
- CKS
- DRW
- CTP
- FFR
- CTR
- FFS
- DEP
- SVC
- DRB
example: 'BTR'
transactionTypeCode:
type: string
minLength: 3
maxLength: 3
description: |
TransactionTypeCode
If {3600} is CTR, an optional Transaction Type Code element is permitted;
however, the Transaction Type Code 'COV' is not permitted.
example: ' '
required:
- businessFunctionCode
LocalInstrument:
properties:
localInstrumentCode:
type: string
description: |
LocalInstrument
* `ANSI` - ANSI X12 format
* `COVS` - Sequence B Cover Payment Structured
* `GXML` - General XML format
* `IXML` - ISO 20022 XML formaT
* `NARR` - Narrative Text
* `PROP` - Proprietary Local Instrument Code
* `RMTS` - Remittance Information Structured
* `RRMT` - Related Remittance Information
* `S820` - STP 820 format
* `SWIF` - SWIFT field 70 (Remittance Information)
* `UEDI` - UN/EDIFACT format
enum:
- ANSI
- COVS
- GXML
- IXML
- NARR
- PROP
- RMTS
- RRMT
- S820
- SWIF
- UEDI
example: 'ANSI'
proprietaryCode:
type: string
maxLength: 35
description: ProprietaryCode
example: 'WJD786363'
PaymentNotification:
properties:
paymentNotificationIndicator:
type: string
description: |
Payment Notification Indicator
* `0 - 6` - Reserved for market practice conventions.
* `7 - 9` - Reserved for bilateral agreements between Fedwire senders and receivers.
enum:
- "0"
- "1"
- "2"
- "3"
- "4"
- "5"
- "6"
- "7"
- "8"
- "9"
example: '1'
contactNotificationElectronicAddress:
type: string
maxLength: 2048
description: ContactNotificationElectronicAddress
example: 'https://moov.io/'
contactName:
type: string
maxLength: 140
description: ContactName
example: 'Wade Arnold'
contactPhoneNumber:
type: string
maxLength: 35
description: ContactPhoneNumber
example: '555-555-5555'
contactMobileNumber:
type: string
maxLength: 35
description: ContactMobileNumber
example: '555.555.5555'
faxNumber:
type: string
maxLength: 35
description: FaxNumber
example: '555.555.5555'
endToEndIdentification:
type: string
maxLength: 35
description: EndToEndIdentification
example: 'WireTransfer 10001'
InstructedAmount:
properties:
currencyCode:
type: string
maxLength: 3
description: CurrencyCode
example: 'USD'
amount:
type: string
maxLength: 15
description: |
Amount
Must begin with at least one numeric character (0-9) and contain only one decimal comma marker
(e.g., $1,234.56 should be entered as 1234,56 and $0.99 should be entered as 0,99).
example: "1234,56"
ExchangeRate:
properties:
exchangeRate:
type: string
maxLength: 12
description: |
ExchangeRate is the exchange rate
Must contain at least one numeric character and only one decimal comma marker
(e.g., an exchange rate of 1.2345 should be entered as 1,2345).
example: '1,2345'
FinancialInstitution:
description: FinancialInstitution is financial institution demographic information.
properties:
identificationCode:
type: string
description: |
Identification Code:
* `B` - SWIFT Bank Identifier Code (BIC)
* `C` - CHIPS Participant
* `D` - Demand Deposit Account (DDA) Number
* `F` - Fed Routing Number
* `T` - SWIFT BIC or Bank Entity Identifier (BEI) and Account Number
* `U` - CHIPS Identifier
enum:
- B
- C
- D
- F
- T
- U
maxLength: 1
example: 'B'
identifier:
type: string
maxLength: 34
description: Identifier
example: "123456789"
name:
type: string
maxLength: 35
description: Name
example: "FI Name"
address :
$ref: '#/components/schemas/WireAddress'
required:
- identificationCode
- identifier
- name
- address
Beneficiary:
properties:
personal:
$ref: '#/components/schemas/Personal'
required:
- personal