-
Notifications
You must be signed in to change notification settings - Fork 24
/
QuotingService-swagger.yaml
1677 lines (1677 loc) · 61.6 KB
/
QuotingService-swagger.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.1
info:
title: Quoting related parts of Open API for FSP Interoperability (FSPIOP) (Implementation
Friendly Version)
description: Based on API Definition.docx updated on 2018-03-13 Version 1.0. Note
- The API supports a maximum size of 65536 bytes (64 Kilobytes) in the HTTP header.
license:
name: Open API for FSP Interoperability (FSPIOP) (Implementation Friendly Version)
version: "1.1"
servers:
- url: /
paths:
/quotes/{id}/error:
put:
tags:
- quotes
- sampled
summary: QuotesByIdAndError
description: If the server is unable to find or create a quote, or some other
processing error occurs, the error callback PUT /quotes/<id>/error is used.
The <id> in the URI should contain the quoteId that was used for the creation
of the quote, or the <id> that was used in the GET /quotes/<id>.
operationId: QuotesErrorByIDPut
parameters:
- $ref: '#/components/parameters/ID'
- $ref: '#/components/parameters/Content-Length'
- $ref: '#/components/parameters/Content-Type'
- $ref: '#/components/parameters/Date'
- $ref: '#/components/parameters/X-Forwarded-For'
- $ref: '#/components/parameters/FSPIOP-Source'
- $ref: '#/components/parameters/FSPIOP-Destination'
- $ref: '#/components/parameters/FSPIOP-Encryption'
- $ref: '#/components/parameters/FSPIOP-Signature'
- $ref: '#/components/parameters/FSPIOP-URI'
- $ref: '#/components/parameters/FSPIOP-HTTP-Method'
x-examples:
application/json:
errorInformation:
errorCode: “5100”
errorDescription: “This is an error description”
extensionList:
extension:
- “key”: “errorDescription”
“value”: “This is a more detailed error description”
- “key”: “errorDescription”
“value”: “This is a more detailed error description”
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorInformationObject'
required: true
responses:
'200':
$ref: '#/components/responses/Response200'
'400':
$ref: '#/components/responses/ErrorResponse400'
'401':
$ref: '#/components/responses/ErrorResponse401'
'403':
$ref: '#/components/responses/ErrorResponse403'
'404':
$ref: '#/components/responses/ErrorResponse404'
'405':
$ref: '#/components/responses/ErrorResponse405'
'406':
$ref: '#/components/responses/ErrorResponse406'
'501':
$ref: '#/components/responses/ErrorResponse501'
'503':
$ref: '#/components/responses/ErrorResponse503'
/quotes/{id}:
parameters:
- $ref: '#/components/parameters/ID'
- $ref: '#/components/parameters/Content-Type'
- $ref: '#/components/parameters/Date'
- $ref: '#/components/parameters/X-Forwarded-For'
- $ref: '#/components/parameters/FSPIOP-Source'
- $ref: '#/components/parameters/FSPIOP-Destination'
- $ref: '#/components/parameters/FSPIOP-Encryption'
- $ref: '#/components/parameters/FSPIOP-Signature'
- $ref: '#/components/parameters/FSPIOP-URI'
- $ref: '#/components/parameters/FSPIOP-HTTP-Method'
get:
tags:
- quotes
- sampled
summary: QuotesById
description: The HTTP request GET /quotes/<id> is used to get information regarding
an earlier created or requested quote. The <id> in the URI should contain
the quoteId that was used for the creation of the quote.
operationId: QuotesByIdGet
parameters:
- $ref: '#/components/parameters/Accept'
responses:
'202':
$ref: '#/components/responses/Response202'
'400':
$ref: '#/components/responses/ErrorResponse400'
'401':
$ref: '#/components/responses/ErrorResponse401'
'403':
$ref: '#/components/responses/ErrorResponse403'
'404':
$ref: '#/components/responses/ErrorResponse404'
'405':
$ref: '#/components/responses/ErrorResponse405'
'406':
$ref: '#/components/responses/ErrorResponse406'
'501':
$ref: '#/components/responses/ErrorResponse501'
'503':
$ref: '#/components/responses/ErrorResponse503'
put:
tags:
- quotes
- sampled
summary: QuotesById
description: The callback PUT /quotes/<id> is used to inform the client of a
requested or created quote. The <id> in the URI should contain the quoteId
that was used for the creation of the quote, or the <id> that was used in
the GET /quotes/<id>GET /quotes/<id>.
operationId: QuotesByIdPut
parameters:
- $ref: '#/components/parameters/Content-Length'
x-examples:
application/json:
transferAmount:
currency: “USD”
amount: “124.45”
payeeReceiveAmount:
currency: “USD”
amount: “123.45”
payeeFspFee:
currency: “USD”
amount: “1.45”
payeeFspCommission:
currency: “USD”
amount: 0
expiration: “2016-05-24T08:38:08.699-04:00”
geoCode:
latitude: “+45.4215”
longitude: “+75.6972”
ilpPacket: “AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA”
condition: f5sqb7tBTWPd5Y8BDFdMm9BJR_MNI4isf8p8n4D5pHA
extensionList:
extension:
- “key”: “errorDescription”
“value”: “This is a more detailed error description”
- “key”: “errorDescription”
“value”: “This is a more detailed error description”
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/QuotesIDPutResponse'
required: true
responses:
'200':
$ref: '#/components/responses/Response200'
'400':
$ref: '#/components/responses/ErrorResponse400'
'401':
$ref: '#/components/responses/ErrorResponse401'
'403':
$ref: '#/components/responses/ErrorResponse403'
'404':
$ref: '#/components/responses/ErrorResponse404'
'405':
$ref: '#/components/responses/ErrorResponse405'
'406':
$ref: '#/components/responses/ErrorResponse406'
'501':
$ref: '#/components/responses/ErrorResponse501'
'503':
$ref: '#/components/responses/ErrorResponse503'
/quotes:
post:
tags:
- quotes
- sampled
summary: Quotes
description: The HTTP request POST /quotes is used to request the creation of
a quote for the provided financial transaction in the server.
operationId: QuotesPost
parameters:
- $ref: '#/components/parameters/Accept'
- $ref: '#/components/parameters/Content-Length'
- $ref: '#/components/parameters/Content-Type'
- $ref: '#/components/parameters/Date'
- $ref: '#/components/parameters/X-Forwarded-For'
- $ref: '#/components/parameters/FSPIOP-Source'
- $ref: '#/components/parameters/FSPIOP-Destination'
- $ref: '#/components/parameters/FSPIOP-Encryption'
- $ref: '#/components/parameters/FSPIOP-Signature'
- $ref: '#/components/parameters/FSPIOP-URI'
- $ref: '#/components/parameters/FSPIOP-HTTP-Method'
x-examples:
application/json:
quoteId: “b51ec534-ee48-4575-b6a9-ead2955b8069”
transactionId: “a8323bc6-c228-4df2-ae82-e5a997baf899”
transactionRequestId: “a8323bc6-c228-4df2-ae82-e5a997baf890”
payee:
partyIdInfo:
partyIdType: “PERSONAL_ID”
partyIdentifier: “16135551212”
partySubIdOrType: “DRIVING_LICENSE”
fspId: “1234”
extensionList:
extension:
- “key”: “errorDescription”
“value”: “This is a more detailed error description”
- “key”: “errorDescription”
“value”: “This is a more detailed error description”
merchantClassificationCode: 4321
name: “Justin Trudeau”
personalInfo:
complexName:
firstName: “Justin”
middleName: “Pierre”
lastName: “Trudeau”
dateOfBirth: “1971-12-25”
payer:
partyIdInfo:
partyIdType: “PERSONAL_ID”
partyIdentifier: “16135551212”
partySubIdOrType: “PASSPORT”
fspId: “1234”
extensionList:
extension:
- “key”: “errorDescription”
“value”: “This is a more detailed error description”
- “key”: “errorDescription”
“value”: “This is a more detailed error description”
merchantClassificationCode: 1234
name: “Donald Trump”
personalInfo:
complexName:
firstName: “Donald”
middleName: “John”
lastName: “Trump”
dateOfBirth: “1946-06-14”
amountType: SEND
amount:
currency: “USD”
amount: “123.45”
fees:
currency: “USD”
amount: “1.25”
transactionType:
scenario: “DEPOSIT”
subScenario: “locally defined sub-scenario”
initiator: “PAYEE”
initiatorType: “CONSUMER”
refundInfo:
originalTransactionId: “b51ec534-ee48-4575-b6a9-ead2955b8069”
refundReason: “free text indicating reason for the refund”
balanceOfPayments: “123”
geoCode:
latitude: “+45.4215”
longitude: “+75.6972”
note: “Free-text memo”
expiration: “2016-05-24T08:38:08.699-04:00”
extensionList:
extension:
- “key”: “errorDescription”
“value”: “This is a more detailed error description”
- “key”: “errorDescription”
“value”: “This is a more detailed error description”
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/QuotesPostRequest'
required: true
responses:
'202':
$ref: '#/components/responses/Response202'
'400':
$ref: '#/components/responses/ErrorResponse400'
'401':
$ref: '#/components/responses/ErrorResponse401'
'403':
$ref: '#/components/responses/ErrorResponse403'
'404':
$ref: '#/components/responses/ErrorResponse404'
'405':
$ref: '#/components/responses/ErrorResponse405'
'406':
$ref: '#/components/responses/ErrorResponse406'
'501':
$ref: '#/components/responses/ErrorResponse501'
'503':
$ref: '#/components/responses/ErrorResponse503'
/bulkQuotes/{id}/error:
put:
tags:
- bulkQuotes
- sampled
summary: BulkQuotesErrorById
description: If the server is unable to find or create a bulk quote, or another
processing error occurs, the error callback PUT /bulkQuotes/<id>/error is
used. The <id> in the URI should contain the bulkQuoteId that was used for
the creation of the bulk quote, or the <id> that was used in the GET /bulkQuotes/<id>.
operationId: BulkQuotesErrorByIdPut
parameters:
- $ref: '#/components/parameters/ID'
- $ref: '#/components/parameters/Content-Length'
- $ref: '#/components/parameters/Content-Type'
- $ref: '#/components/parameters/Date'
- $ref: '#/components/parameters/X-Forwarded-For'
- $ref: '#/components/parameters/FSPIOP-Source'
- $ref: '#/components/parameters/FSPIOP-Destination'
- $ref: '#/components/parameters/FSPIOP-Encryption'
- $ref: '#/components/parameters/FSPIOP-Signature'
- $ref: '#/components/parameters/FSPIOP-URI'
- $ref: '#/components/parameters/FSPIOP-HTTP-Method'
x-examples:
application/json:
errorInformation:
errorCode: “5100”
errorDescription: “This is an error description”
extensionList:
extension:
- “key”: “errorDescription”
“value”: “This is a more detailed error description”
- “key”: “errorDescription”
“value”: “This is a more detailed error description”
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorInformationObject'
required: true
responses:
'200':
$ref: '#/components/responses/Response200'
'400':
$ref: '#/components/responses/ErrorResponse400'
'401':
$ref: '#/components/responses/ErrorResponse401'
'403':
$ref: '#/components/responses/ErrorResponse403'
'404':
$ref: '#/components/responses/ErrorResponse404'
'405':
$ref: '#/components/responses/ErrorResponse405'
'406':
$ref: '#/components/responses/ErrorResponse406'
'501':
$ref: '#/components/responses/ErrorResponse501'
'503':
$ref: '#/components/responses/ErrorResponse503'
/bulkQuotes/{id}:
parameters:
- $ref: '#/components/parameters/ID'
- $ref: '#/components/parameters/Content-Type'
- $ref: '#/components/parameters/Date'
- $ref: '#/components/parameters/X-Forwarded-For'
- $ref: '#/components/parameters/FSPIOP-Source'
- $ref: '#/components/parameters/FSPIOP-Destination'
- $ref: '#/components/parameters/FSPIOP-Encryption'
- $ref: '#/components/parameters/FSPIOP-Signature'
- $ref: '#/components/parameters/FSPIOP-URI'
- $ref: '#/components/parameters/FSPIOP-HTTP-Method'
get:
tags:
- bulkQuotes
- sampled
summary: BulkQuotesById
description: The HTTP request GET /bulkQuotes/<id> is used to get information
regarding an earlier created or requested bulk quote. The <id> in the URI
should contain the bulkQuoteId that was used for the creation of the bulk
quote.
operationId: BulkQuotesByIdGet
parameters:
- $ref: '#/components/parameters/Accept'
responses:
'202':
$ref: '#/components/responses/Response202'
'400':
$ref: '#/components/responses/ErrorResponse400'
'401':
$ref: '#/components/responses/ErrorResponse401'
'403':
$ref: '#/components/responses/ErrorResponse403'
'404':
$ref: '#/components/responses/ErrorResponse404'
'405':
$ref: '#/components/responses/ErrorResponse405'
'406':
$ref: '#/components/responses/ErrorResponse406'
'501':
$ref: '#/components/responses/ErrorResponse501'
'503':
$ref: '#/components/responses/ErrorResponse503'
put:
tags:
- bulkQuotes
- sampled
summary: BulkQuotesById
description: The callback PUT /bulkQuotes/<id> is used to inform the client
of a requested or created bulk quote. The <id> in the URI should contain the
bulkQuoteId that was used for the creation of the bulk quote, or the <id>
that was used in the GET /bulkQuotes/<id>.
operationId: BulkQuotesByIdPut
parameters:
- $ref: '#/components/parameters/Content-Length'
x-examples:
application/json:
individualQuoteResults:
- quoteId: b51ec534-ee48-4575-b6a9-ead2955b8069,
- receiveAmount:
currency: USD
amount: 123.45
- payeeFspFee:
currency: USD
amount: 1.45
- payeeFspCommission:
currency: USD
amount: 1.45
- ilpPacket: AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA,
- condition: f5sqb7tBTWPd5Y8BDFdMm9BJR_MNI4isf8p8n4D5pHA,
- errorInformation:
errorCode: 5100
errorDescription: This is an error description
extensionList:
extension:
- “key”: “errorDescription”
“value”: “This is a more detailed error description”
- “key”: “errorDescription”
“value”: “This is a more detailed error description”
- extensionList:
extension:
- “key”: “errorDescription”
“value”: “This is a more detailed error description”
- “key”: “errorDescription”
“value”: “This is a more detailed error description”
expiration: “2016-05-24T08:38:08.699-04:00”
extensionList:
extension:
- “key”: “errorDescription”
“value”: “This is a more detailed error description”
- “key”: “errorDescription”
“value”: “This is a more detailed error description”
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkQuotesIDPutResponse'
required: true
responses:
'200':
$ref: '#/components/responses/Response200'
'400':
$ref: '#/components/responses/ErrorResponse400'
'401':
$ref: '#/components/responses/ErrorResponse401'
'403':
$ref: '#/components/responses/ErrorResponse403'
'404':
$ref: '#/components/responses/ErrorResponse404'
'405':
$ref: '#/components/responses/ErrorResponse405'
'406':
$ref: '#/components/responses/ErrorResponse406'
'501':
$ref: '#/components/responses/ErrorResponse501'
'503':
$ref: '#/components/responses/ErrorResponse503'
/bulkQuotes:
post:
tags:
- bulkQuotes
- sampled
summary: BulkQuotes
description: The HTTP request POST /bulkQuotes is used to request the creation
of a bulk quote for the provided financial transactions in the server.
operationId: BulkQuotesPost
parameters:
- $ref: '#/components/parameters/Accept'
- $ref: '#/components/parameters/Content-Length'
- $ref: '#/components/parameters/Content-Type'
- $ref: '#/components/parameters/Date'
- $ref: '#/components/parameters/X-Forwarded-For'
- $ref: '#/components/parameters/FSPIOP-Source'
- $ref: '#/components/parameters/FSPIOP-Destination'
- $ref: '#/components/parameters/FSPIOP-Encryption'
- $ref: '#/components/parameters/FSPIOP-Signature'
- $ref: '#/components/parameters/FSPIOP-URI'
- $ref: '#/components/parameters/FSPIOP-HTTP-Method'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkQuotesPostRequest'
required: true
responses:
'202':
$ref: '#/components/responses/Response202'
'400':
$ref: '#/components/responses/ErrorResponse400'
'401':
$ref: '#/components/responses/ErrorResponse401'
'403':
$ref: '#/components/responses/ErrorResponse403'
'404':
$ref: '#/components/responses/ErrorResponse404'
'405':
$ref: '#/components/responses/ErrorResponse405'
'406':
$ref: '#/components/responses/ErrorResponse406'
'501':
$ref: '#/components/responses/ErrorResponse501'
'503':
$ref: '#/components/responses/ErrorResponse503'
/health:
get:
tags:
- health
summary: Get Server
description: The HTTP request GET /health is used to return the current status
of the API.
operationId: HealthGet
responses:
'200':
$ref: '#/components/responses/ResponseHealth200'
'400':
$ref: '#/components/responses/ErrorResponse400'
'401':
$ref: '#/components/responses/ErrorResponse401'
'403':
$ref: '#/components/responses/ErrorResponse403'
'404':
$ref: '#/components/responses/ErrorResponse404'
'405':
$ref: '#/components/responses/ErrorResponse405'
'406':
$ref: '#/components/responses/ErrorResponse406'
'501':
$ref: '#/components/responses/ErrorResponse501'
'503':
$ref: '#/components/responses/ErrorResponse503'
components:
schemas:
Amount:
title: Amount
pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
type: string
description: The API data type Amount is a JSON String in a canonical format
that is restricted by a regular expression for interoperability reasons. This
pattern does not allow any trailing zeroes at all, but allows an amount without
a minor currency unit. It also only allows four digits in the minor currency
unit; a negative value is not allowed. Using more than 18 digits in the major
currency unit is not allowed.
AmountType:
title: AmountType
type: string
description: Below are the allowed values for the enumeration AmountType - SEND
Amount the Payer would like to send, that is, the amount that should be withdrawn
from the Payer account including any fees. - RECEIVE Amount the Payer would
like the Payee to receive, that is, the amount that should be sent to the
receiver exclusive fees.
enum:
- SEND
- RECEIVE
BalanceOfPayments:
title: BalanceOfPayments
pattern: ^[1-9]\d{2}$
type: string
description: (BopCode) The API data type BopCode is a JSON String of 3 characters,
consisting of digits only. Negative numbers are not allowed. A leading zero
is not allowed. https://www.imf.org/external/np/sta/bopcode/
CorrelationId:
title: CorrelationId
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
type: string
description: Identifier that correlates all messages of the same sequence. The
API data type UUID (Universally Unique Identifier) is a JSON String in canonical
format, conforming to RFC 4122, that is restricted by a regular expression
for interoperability reasons. An UUID is always 36 characters long, 32 hexadecimal
symbols and 4 dashes (‘-‘).
Currency:
title: CurrencyEnum
maxLength: 3
minLength: 3
type: string
description: The currency codes defined in ISO 4217 as three-letter alphabetic
codes are used as the standard naming representation for currencies.
enum:
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BRL
- BSD
- BTN
- BWP
- BYN
- BZD
- CAD
- CDF
- CHF
- CLP
- CNY
- COP
- CRC
- CUC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GGP
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- ILS
- IMP
- INR
- IQD
- IRR
- ISK
- JEP
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRO
- MUR
- MVR
- MWK
- MXN
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLL
- SOS
- SPL
- SRD
- STD
- SVC
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TVD
- TWD
- TZS
- UAH
- UGX
- USD
- UYU
- UZS
- VEF
- VND
- VUV
- WST
- XAF
- XCD
- XDR
- XOF
- XPF
- XTS
- XXX
- YER
- ZAR
- ZMW
- ZWD
Date:
title: Date
pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
type: string
description: The API data type Date is a JSON String in a lexical format that
is restricted by a regular expression for interoperability reasons. This format,
as specified in ISO 8601, contains a date only. A more readable version of
the format is yyyy-MM-dd. Examples - "1982-05-23", "1987-08-05”
DateOfBirth:
title: DateofBirth (type Date)
pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
type: string
description: Date of Birth of the Party.
DateTime:
title: DateTime
pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:(\.\d{3}))(?:Z|[+-][01]\d:[0-5]\d)$
type: string
description: The API data type DateTime is a JSON String in a lexical format
that is restricted by a regular expression for interoperability reasons. The
format is according to ISO 8601, expressed in a combined date, time and time
zone format. A more readable version of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM].
Examples - "2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where
Z indicates Zulu time zone, same as UTC).
ErrorCode:
title: ErrorCode
pattern: ^(10|20|3[0-4]|4[0-4]|5[0-4])[0-9]{2}$
type: string
description: The API data type ErrorCode is a JSON String of four characters,
consisting of digits only. Negative numbers are not allowed. A leading zero
is not allowed. Each error code in the API is a four-digit number, for example,
1234, where the first number (1 in the example) represents the high-level
error category, the second number (2 in the example) represents the low-level
error category, and the last two numbers (34 in the example) represents the
specific error.
ErrorDescription:
title: ErrorDescription
maxLength: 128
minLength: 1
type: string
description: Error description string.
ExtensionKey:
title: ExtensionKey
maxLength: 32
minLength: 1
type: string
description: Extension key.
ExtensionValue:
title: ExtensionValue
maxLength: 128
minLength: 1
type: string
description: Extension value.
FirstName:
title: FirstName
maxLength: 128
minLength: 1
pattern: '^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$'
type: string
description: First name of the Party (Name Type).
FspId:
title: FspId
maxLength: 32
minLength: 1
type: string
description: FSP identifier.
IlpCondition:
title: IlpCondition
maxLength: 48
pattern: ^[A-Za-z0-9-_]{43}$
type: string
description: Condition that must be attached to the transfer by the Payer.
IlpFulfilment:
title: IlpFulfilment
maxLength: 48
pattern: ^[A-Za-z0-9-_]{43}$
type: string
description: Fulfilment that must be attached to the transfer by the Payee.
IlpPacket:
title: IlpPacket
maxLength: 32768
minLength: 1
pattern: ^[A-Za-z0-9-_]+[=]{0,2}$
type: string
description: Information for recipient (transport layer information).
LastName:
title: LastName
maxLength: 128
minLength: 1
pattern: '^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$'
type: string
description: Last name of the Party (Name Type).
Latitude:
title: Latitude
pattern: ^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$
type: string
description: The API data type Latitude is a JSON String in a lexical format
that is restricted by a regular expression for interoperability reasons.
Longitude:
title: Longitude
pattern: ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
type: string
description: The API data type Longitude is a JSON String in a lexical format
that is restricted by a regular expression for interoperability reasons.
MerchantClassificationCode:
title: MerchantClassificationCode
pattern: ^[\d]{1,4}$
type: string
description: A limited set of pre-defined numbers. This list would be a limited
set of numbers identifying a set of popular merchant types like School Fees,
Pubs and Restaurants, Groceries, etc.
MiddleName:
title: MiddleName
maxLength: 128
minLength: 1
pattern: '^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$'
type: string
description: Middle name of the Party (Name Type).
Note:
title: Note
maxLength: 128
minLength: 1
type: string
description: Memo assigned to transaction
PartyIdentifier:
title: PartyIdentifier
maxLength: 128
minLength: 1
type: string
description: Identifier of the Party.
PartyIdType:
title: PartyIdTypeEnum
type: string
description: Below are the allowed values for the enumeration - MSISDN An MSISDN
(Mobile Station International Subscriber Directory Number, that is, the phone
number) is used as reference to a participant. The MSISDN identifier should
be in international format according to the ITU-T E.164 standard. Optionally,
the MSISDN may be prefixed by a single plus sign, indicating the international
prefix. - EMAIL An email is used as reference to a participant. The format
of the email should be according to the informational RFC 3696. - PERSONAL_ID
A personal identifier is used as reference to a participant. Examples of personal
identification are passport number, birth certificate number, and national
registration number. The identifier number is added in the PartyIdentifier
element. The personal identifier type is added in the PartySubIdOrType element.
- BUSINESS A specific Business (for example, an organization or a company)
is used as reference to a participant. The BUSINESS identifier can be in any
format. To make a transaction connected to a specific username or bill number
in a Business, the PartySubIdOrType element should be used. - DEVICE A specific
device (for example, a POS or ATM) id connected to a specific business or
organization is used as reference to a Party. For referencing a specific device
under a specific business or organization, use the PartySubIdOrType element.
- ACCOUNT_ID A bank account number or FSP account id should be used as reference
to a participant. The ACCOUNT_ID identifier can be in any format, as formats
can greatly differ depending on country and FSP. - IBAN A bank account number
or FSP account id is used as reference to a participant. The IBAN identifier
can consist of up to 34 alphanumeric characters and should be entered without
whitespace. - ALIAS An alias is used as reference to a participant. The alias
should be created in the FSP as an alternative reference to an account owner.
Another example of an alias is a username in the FSP system. The ALIAS identifier
can be in any format. It is also possible to use the PartySubIdOrType element
for identifying an account under an Alias defined by the PartyIdentifier.
enum:
- MSISDN
- EMAIL
- PERSONAL_ID
- BUSINESS
- DEVICE
- ACCOUNT_ID
- IBAN
- ALIAS
PartyName:
title: PartyName
maxLength: 128
minLength: 1
type: string
description: Name of the Party. Could be a real name or a nickname.
PartySubIdOrType:
title: PartySubIdOrType
maxLength: 128
minLength: 1
type: string
description: Either a sub-identifier of a PartyIdentifier, or a sub-type of
the PartyIdType, normally a PersonalIdentifierType.
PersonalIdentifierType:
title: PersonalIdentifierType
type: string
description: Below are the allowed values for the enumeration - PASSPORT A passport
number is used as reference to a Party. - NATIONAL_REGISTRATION A national
registration number is used as reference to a Party. - DRIVING_LICENSE A driving
license is used as reference to a Party. - ALIEN_REGISTRATION An alien registration
number is used as reference to a Party. - NATIONAL_ID_CARD A national id card
number is used as reference to a Party. - EMPLOYER_ID A tax identification
number is used as reference to a Party. - TAX_ID_NUMBER A tax identification
number is used as reference to a Party. - SENIOR_CITIZENS_CARD A senior citizens
card number is used as reference to a Party. - MARRIAGE_CERTIFICATE A marriage
certificate number is used as reference to a Party. - HEALTH_CARD A health
card number is used as reference to a Party. - VOTERS_ID A voter’s identification
number is used as reference to a Party. - UNITED_NATIONS An UN (United Nations)
number is used as reference to a Party. - OTHER_ID Any other type of identification
type number is used as reference to a Party.
enum:
- PASSPORT
- NATIONAL_REGISTRATION
- DRIVING_LICENSE
- ALIEN_REGISTRATION
- NATIONAL_ID_CARD
- EMPLOYER_ID
- TAX_ID_NUMBER
- SENIOR_CITIZENS_CARD
- MARRIAGE_CERTIFICATE
- HEALTH_CARD
- VOTERS_ID
- UNITED_NATIONS
- OTHER_ID
QuoteId:
title: QuoteId
minLength: 1
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
type: string
description: Quote Identifier. The API data type UUID (Universally Unique Identifier)
is a JSON String in canonical format, conforming to RFC 4122, that is restricted
by a regular expression for interoperability reasons. An UUID is always 36
characters long, 32 hexadecimal symbols and 4 dashes (‘-‘). A minLength of
1 has been specified due to the regex not being validated on empty strings,
this should be removed once the enjoi module has been fixed.
RefundReason:
title: RefundReason
maxLength: 128
minLength: 1
type: string
description: Reason for the refund.
TransactionId:
title: TransactionId
minLength: 1
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
type: string
description: Transaction Identifier. The API data type UUID (Universally Unique
Identifier) is a JSON String in canonical format, conforming to RFC 4122,
that is restricted by a regular expression for interoperability reasons. An
UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
A minLength of 1 has been specified due to the regex not being validated on
empty strings, this should be removed once the enjoi module has been fixed.
TransactionInitiator:
title: TransactionInitiatorEnum
type: string
description: Below are the allowed values for the enumeration - PAYER Sender
of funds is initiating the transaction. The account to send from is either