@mojaloop/api-snippets 17.7.7 → 17.7.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +10 -0
- package/LICENSE.md +4 -5
- package/docs/fspiop-rest-v2.0-openapi3-snippets.yaml +146 -146
- package/fspiop/v2_0/openapi3/openapi.yaml +7 -7
- package/lib/fspiop/v2_0/openapi.d.ts +158 -158
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,4 +1,14 @@
|
|
|
1
1
|
# Changelog: [mojaloop/api-snippets](https://github.com/mojaloop/api-snippets)
|
|
2
|
+
### [17.7.9](https://github.com/mojaloop/api-snippets/compare/v17.7.8...v17.7.9) (2025-01-23)
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
### Maintenance
|
|
6
|
+
|
|
7
|
+
* audit ([daa2960](https://github.com/mojaloop/api-snippets/commit/daa2960f1ee9f67d46e3f0e32ba9828ce7fd6f94))
|
|
8
|
+
* reorder endpoints ([e0ea485](https://github.com/mojaloop/api-snippets/commit/e0ea485827ba9843f43f05f99b2ec421d9b822ed))
|
|
9
|
+
|
|
10
|
+
### [17.7.8](https://github.com/mojaloop/api-snippets/compare/v17.7.7...v17.7.8) (2024-12-16)
|
|
11
|
+
|
|
2
12
|
### [17.7.7](https://github.com/mojaloop/api-snippets/compare/v17.7.6...v17.7.7) (2024-12-13)
|
|
3
13
|
|
|
4
14
|
|
package/LICENSE.md
CHANGED
|
@@ -1,10 +1,9 @@
|
|
|
1
1
|
# LICENSE
|
|
2
2
|
|
|
3
|
-
Copyright © 2020 Mojaloop Foundation
|
|
3
|
+
Copyright © 2020-2024 Mojaloop Foundation
|
|
4
4
|
|
|
5
|
-
The Mojaloop files are made available by the Mojaloop Foundation under the Apache License, Version 2.0
|
|
6
|
-
(the "License") and you may not use these files except in compliance with the [License](http://www.apache.org/licenses/LICENSE-2.0).
|
|
5
|
+
The Mojaloop files are made available by the Mojaloop Foundation under the Apache License, Version 2.0 (the "License") and you may not use these files except in compliance with the License.
|
|
7
6
|
|
|
8
|
-
You may obtain a copy of the License at
|
|
7
|
+
You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
|
|
9
8
|
|
|
10
|
-
Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the
|
|
9
|
+
Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
|
|
@@ -34,6 +34,152 @@ servers:
|
|
|
34
34
|
- https
|
|
35
35
|
default: https
|
|
36
36
|
paths:
|
|
37
|
+
/participants:
|
|
38
|
+
post:
|
|
39
|
+
description: >-
|
|
40
|
+
The HTTP request `POST /participants` is used to create information in
|
|
41
|
+
the server regarding the provided list of identities. This request
|
|
42
|
+
should be used for bulk creation of FSP information for more than one
|
|
43
|
+
Party. The optional currency parameter should indicate that each
|
|
44
|
+
provided Party supports the currency.
|
|
45
|
+
summary: Create bulk participant information
|
|
46
|
+
tags:
|
|
47
|
+
- participants
|
|
48
|
+
operationId: Participants1
|
|
49
|
+
parameters:
|
|
50
|
+
- $ref: "#/components/parameters/Accept"
|
|
51
|
+
- $ref: "#/components/parameters/Content-Length"
|
|
52
|
+
- $ref: "#/components/parameters/Content-Type"
|
|
53
|
+
- $ref: "#/components/parameters/Date"
|
|
54
|
+
- $ref: "#/components/parameters/X-Forwarded-For"
|
|
55
|
+
- $ref: "#/components/parameters/FSPIOP-Source"
|
|
56
|
+
- $ref: "#/components/parameters/FSPIOP-Destination"
|
|
57
|
+
- $ref: "#/components/parameters/FSPIOP-Encryption"
|
|
58
|
+
- $ref: "#/components/parameters/FSPIOP-Signature"
|
|
59
|
+
- $ref: "#/components/parameters/FSPIOP-URI"
|
|
60
|
+
- $ref: "#/components/parameters/FSPIOP-HTTP-Method"
|
|
61
|
+
requestBody:
|
|
62
|
+
description: Participant information to be created.
|
|
63
|
+
required: true
|
|
64
|
+
content:
|
|
65
|
+
application/json:
|
|
66
|
+
schema:
|
|
67
|
+
$ref: "#/components/schemas/ParticipantsPostRequest"
|
|
68
|
+
responses:
|
|
69
|
+
"202":
|
|
70
|
+
$ref: "#/components/responses/202"
|
|
71
|
+
"400":
|
|
72
|
+
$ref: "#/components/responses/400"
|
|
73
|
+
"401":
|
|
74
|
+
$ref: "#/components/responses/401"
|
|
75
|
+
"403":
|
|
76
|
+
$ref: "#/components/responses/403"
|
|
77
|
+
"404":
|
|
78
|
+
$ref: "#/components/responses/404"
|
|
79
|
+
"405":
|
|
80
|
+
$ref: "#/components/responses/405"
|
|
81
|
+
"406":
|
|
82
|
+
$ref: "#/components/responses/406"
|
|
83
|
+
"501":
|
|
84
|
+
$ref: "#/components/responses/501"
|
|
85
|
+
"503":
|
|
86
|
+
$ref: "#/components/responses/503"
|
|
87
|
+
/participants/{ID}:
|
|
88
|
+
put:
|
|
89
|
+
description: >-
|
|
90
|
+
The callback `PUT /participants/{ID}` is used to inform the client of
|
|
91
|
+
the result of the creation of the provided list of identities.
|
|
92
|
+
summary: Return bulk participant information
|
|
93
|
+
tags:
|
|
94
|
+
- participants
|
|
95
|
+
operationId: putParticipantsByID
|
|
96
|
+
parameters:
|
|
97
|
+
- $ref: "#/components/parameters/ID"
|
|
98
|
+
- $ref: "#/components/parameters/Content-Length"
|
|
99
|
+
- $ref: "#/components/parameters/Content-Type"
|
|
100
|
+
- $ref: "#/components/parameters/Date"
|
|
101
|
+
- $ref: "#/components/parameters/X-Forwarded-For"
|
|
102
|
+
- $ref: "#/components/parameters/FSPIOP-Source"
|
|
103
|
+
- $ref: "#/components/parameters/FSPIOP-Destination"
|
|
104
|
+
- $ref: "#/components/parameters/FSPIOP-Encryption"
|
|
105
|
+
- $ref: "#/components/parameters/FSPIOP-Signature"
|
|
106
|
+
- $ref: "#/components/parameters/FSPIOP-URI"
|
|
107
|
+
- $ref: "#/components/parameters/FSPIOP-HTTP-Method"
|
|
108
|
+
requestBody:
|
|
109
|
+
description: Participant information returned.
|
|
110
|
+
required: true
|
|
111
|
+
content:
|
|
112
|
+
application/json:
|
|
113
|
+
schema:
|
|
114
|
+
$ref: "#/components/schemas/ParticipantsIDPutResponse"
|
|
115
|
+
responses:
|
|
116
|
+
"200":
|
|
117
|
+
$ref: "#/components/responses/200"
|
|
118
|
+
"400":
|
|
119
|
+
$ref: "#/components/responses/400"
|
|
120
|
+
"401":
|
|
121
|
+
$ref: "#/components/responses/401"
|
|
122
|
+
"403":
|
|
123
|
+
$ref: "#/components/responses/403"
|
|
124
|
+
"404":
|
|
125
|
+
$ref: "#/components/responses/404"
|
|
126
|
+
"405":
|
|
127
|
+
$ref: "#/components/responses/405"
|
|
128
|
+
"406":
|
|
129
|
+
$ref: "#/components/responses/406"
|
|
130
|
+
"501":
|
|
131
|
+
$ref: "#/components/responses/501"
|
|
132
|
+
"503":
|
|
133
|
+
$ref: "#/components/responses/503"
|
|
134
|
+
/participants/{ID}/error:
|
|
135
|
+
put:
|
|
136
|
+
description: >-
|
|
137
|
+
If there is an error during FSP information creation in the server, the
|
|
138
|
+
error callback `PUT /participants/{ID}/error` is used. The `{ID}` in the
|
|
139
|
+
URI should contain the requestId that was used for the creation of the
|
|
140
|
+
participant information.
|
|
141
|
+
summary: Return bulk participant information error
|
|
142
|
+
tags:
|
|
143
|
+
- participants
|
|
144
|
+
operationId: ParticipantsByIDAndError
|
|
145
|
+
parameters:
|
|
146
|
+
- $ref: "#/components/parameters/ID"
|
|
147
|
+
- $ref: "#/components/parameters/Content-Length"
|
|
148
|
+
- $ref: "#/components/parameters/Content-Type"
|
|
149
|
+
- $ref: "#/components/parameters/Date"
|
|
150
|
+
- $ref: "#/components/parameters/X-Forwarded-For"
|
|
151
|
+
- $ref: "#/components/parameters/FSPIOP-Source"
|
|
152
|
+
- $ref: "#/components/parameters/FSPIOP-Destination"
|
|
153
|
+
- $ref: "#/components/parameters/FSPIOP-Encryption"
|
|
154
|
+
- $ref: "#/components/parameters/FSPIOP-Signature"
|
|
155
|
+
- $ref: "#/components/parameters/FSPIOP-URI"
|
|
156
|
+
- $ref: "#/components/parameters/FSPIOP-HTTP-Method"
|
|
157
|
+
requestBody:
|
|
158
|
+
description: Details of the error returned.
|
|
159
|
+
required: true
|
|
160
|
+
content:
|
|
161
|
+
application/json:
|
|
162
|
+
schema:
|
|
163
|
+
$ref: "#/components/schemas/ErrorInformationObject"
|
|
164
|
+
responses:
|
|
165
|
+
"200":
|
|
166
|
+
$ref: "#/components/responses/200"
|
|
167
|
+
"400":
|
|
168
|
+
$ref: "#/components/responses/400"
|
|
169
|
+
"401":
|
|
170
|
+
$ref: "#/components/responses/401"
|
|
171
|
+
"403":
|
|
172
|
+
$ref: "#/components/responses/403"
|
|
173
|
+
"404":
|
|
174
|
+
$ref: "#/components/responses/404"
|
|
175
|
+
"405":
|
|
176
|
+
$ref: "#/components/responses/405"
|
|
177
|
+
"406":
|
|
178
|
+
$ref: "#/components/responses/406"
|
|
179
|
+
"501":
|
|
180
|
+
$ref: "#/components/responses/501"
|
|
181
|
+
"503":
|
|
182
|
+
$ref: "#/components/responses/503"
|
|
37
183
|
/participants/{Type}/{ID}:
|
|
38
184
|
parameters:
|
|
39
185
|
- $ref: "#/components/parameters/Type"
|
|
@@ -474,152 +620,6 @@ paths:
|
|
|
474
620
|
$ref: "#/components/responses/501"
|
|
475
621
|
"503":
|
|
476
622
|
$ref: "#/components/responses/503"
|
|
477
|
-
/participants:
|
|
478
|
-
post:
|
|
479
|
-
description: >-
|
|
480
|
-
The HTTP request `POST /participants` is used to create information in
|
|
481
|
-
the server regarding the provided list of identities. This request
|
|
482
|
-
should be used for bulk creation of FSP information for more than one
|
|
483
|
-
Party. The optional currency parameter should indicate that each
|
|
484
|
-
provided Party supports the currency.
|
|
485
|
-
summary: Create bulk participant information
|
|
486
|
-
tags:
|
|
487
|
-
- participants
|
|
488
|
-
operationId: Participants1
|
|
489
|
-
parameters:
|
|
490
|
-
- $ref: "#/components/parameters/Accept"
|
|
491
|
-
- $ref: "#/components/parameters/Content-Length"
|
|
492
|
-
- $ref: "#/components/parameters/Content-Type"
|
|
493
|
-
- $ref: "#/components/parameters/Date"
|
|
494
|
-
- $ref: "#/components/parameters/X-Forwarded-For"
|
|
495
|
-
- $ref: "#/components/parameters/FSPIOP-Source"
|
|
496
|
-
- $ref: "#/components/parameters/FSPIOP-Destination"
|
|
497
|
-
- $ref: "#/components/parameters/FSPIOP-Encryption"
|
|
498
|
-
- $ref: "#/components/parameters/FSPIOP-Signature"
|
|
499
|
-
- $ref: "#/components/parameters/FSPIOP-URI"
|
|
500
|
-
- $ref: "#/components/parameters/FSPIOP-HTTP-Method"
|
|
501
|
-
requestBody:
|
|
502
|
-
description: Participant information to be created.
|
|
503
|
-
required: true
|
|
504
|
-
content:
|
|
505
|
-
application/json:
|
|
506
|
-
schema:
|
|
507
|
-
$ref: "#/components/schemas/ParticipantsPostRequest"
|
|
508
|
-
responses:
|
|
509
|
-
"202":
|
|
510
|
-
$ref: "#/components/responses/202"
|
|
511
|
-
"400":
|
|
512
|
-
$ref: "#/components/responses/400"
|
|
513
|
-
"401":
|
|
514
|
-
$ref: "#/components/responses/401"
|
|
515
|
-
"403":
|
|
516
|
-
$ref: "#/components/responses/403"
|
|
517
|
-
"404":
|
|
518
|
-
$ref: "#/components/responses/404"
|
|
519
|
-
"405":
|
|
520
|
-
$ref: "#/components/responses/405"
|
|
521
|
-
"406":
|
|
522
|
-
$ref: "#/components/responses/406"
|
|
523
|
-
"501":
|
|
524
|
-
$ref: "#/components/responses/501"
|
|
525
|
-
"503":
|
|
526
|
-
$ref: "#/components/responses/503"
|
|
527
|
-
/participants/{ID}:
|
|
528
|
-
put:
|
|
529
|
-
description: >-
|
|
530
|
-
The callback `PUT /participants/{ID}` is used to inform the client of
|
|
531
|
-
the result of the creation of the provided list of identities.
|
|
532
|
-
summary: Return bulk participant information
|
|
533
|
-
tags:
|
|
534
|
-
- participants
|
|
535
|
-
operationId: putParticipantsByID
|
|
536
|
-
parameters:
|
|
537
|
-
- $ref: "#/components/parameters/ID"
|
|
538
|
-
- $ref: "#/components/parameters/Content-Length"
|
|
539
|
-
- $ref: "#/components/parameters/Content-Type"
|
|
540
|
-
- $ref: "#/components/parameters/Date"
|
|
541
|
-
- $ref: "#/components/parameters/X-Forwarded-For"
|
|
542
|
-
- $ref: "#/components/parameters/FSPIOP-Source"
|
|
543
|
-
- $ref: "#/components/parameters/FSPIOP-Destination"
|
|
544
|
-
- $ref: "#/components/parameters/FSPIOP-Encryption"
|
|
545
|
-
- $ref: "#/components/parameters/FSPIOP-Signature"
|
|
546
|
-
- $ref: "#/components/parameters/FSPIOP-URI"
|
|
547
|
-
- $ref: "#/components/parameters/FSPIOP-HTTP-Method"
|
|
548
|
-
requestBody:
|
|
549
|
-
description: Participant information returned.
|
|
550
|
-
required: true
|
|
551
|
-
content:
|
|
552
|
-
application/json:
|
|
553
|
-
schema:
|
|
554
|
-
$ref: "#/components/schemas/ParticipantsIDPutResponse"
|
|
555
|
-
responses:
|
|
556
|
-
"200":
|
|
557
|
-
$ref: "#/components/responses/200"
|
|
558
|
-
"400":
|
|
559
|
-
$ref: "#/components/responses/400"
|
|
560
|
-
"401":
|
|
561
|
-
$ref: "#/components/responses/401"
|
|
562
|
-
"403":
|
|
563
|
-
$ref: "#/components/responses/403"
|
|
564
|
-
"404":
|
|
565
|
-
$ref: "#/components/responses/404"
|
|
566
|
-
"405":
|
|
567
|
-
$ref: "#/components/responses/405"
|
|
568
|
-
"406":
|
|
569
|
-
$ref: "#/components/responses/406"
|
|
570
|
-
"501":
|
|
571
|
-
$ref: "#/components/responses/501"
|
|
572
|
-
"503":
|
|
573
|
-
$ref: "#/components/responses/503"
|
|
574
|
-
/participants/{ID}/error:
|
|
575
|
-
put:
|
|
576
|
-
description: >-
|
|
577
|
-
If there is an error during FSP information creation in the server, the
|
|
578
|
-
error callback `PUT /participants/{ID}/error` is used. The `{ID}` in the
|
|
579
|
-
URI should contain the requestId that was used for the creation of the
|
|
580
|
-
participant information.
|
|
581
|
-
summary: Return bulk participant information error
|
|
582
|
-
tags:
|
|
583
|
-
- participants
|
|
584
|
-
operationId: ParticipantsByIDAndError
|
|
585
|
-
parameters:
|
|
586
|
-
- $ref: "#/components/parameters/ID"
|
|
587
|
-
- $ref: "#/components/parameters/Content-Length"
|
|
588
|
-
- $ref: "#/components/parameters/Content-Type"
|
|
589
|
-
- $ref: "#/components/parameters/Date"
|
|
590
|
-
- $ref: "#/components/parameters/X-Forwarded-For"
|
|
591
|
-
- $ref: "#/components/parameters/FSPIOP-Source"
|
|
592
|
-
- $ref: "#/components/parameters/FSPIOP-Destination"
|
|
593
|
-
- $ref: "#/components/parameters/FSPIOP-Encryption"
|
|
594
|
-
- $ref: "#/components/parameters/FSPIOP-Signature"
|
|
595
|
-
- $ref: "#/components/parameters/FSPIOP-URI"
|
|
596
|
-
- $ref: "#/components/parameters/FSPIOP-HTTP-Method"
|
|
597
|
-
requestBody:
|
|
598
|
-
description: Details of the error returned.
|
|
599
|
-
required: true
|
|
600
|
-
content:
|
|
601
|
-
application/json:
|
|
602
|
-
schema:
|
|
603
|
-
$ref: "#/components/schemas/ErrorInformationObject"
|
|
604
|
-
responses:
|
|
605
|
-
"200":
|
|
606
|
-
$ref: "#/components/responses/200"
|
|
607
|
-
"400":
|
|
608
|
-
$ref: "#/components/responses/400"
|
|
609
|
-
"401":
|
|
610
|
-
$ref: "#/components/responses/401"
|
|
611
|
-
"403":
|
|
612
|
-
$ref: "#/components/responses/403"
|
|
613
|
-
"404":
|
|
614
|
-
$ref: "#/components/responses/404"
|
|
615
|
-
"405":
|
|
616
|
-
$ref: "#/components/responses/405"
|
|
617
|
-
"406":
|
|
618
|
-
$ref: "#/components/responses/406"
|
|
619
|
-
"501":
|
|
620
|
-
$ref: "#/components/responses/501"
|
|
621
|
-
"503":
|
|
622
|
-
$ref: "#/components/responses/503"
|
|
623
623
|
/parties/{Type}/{ID}:
|
|
624
624
|
parameters:
|
|
625
625
|
- $ref: "#/components/parameters/Type"
|
|
@@ -58,6 +58,12 @@ paths:
|
|
|
58
58
|
responses:
|
|
59
59
|
200:
|
|
60
60
|
description: Ok
|
|
61
|
+
/participants:
|
|
62
|
+
$ref: 'paths/participants.yaml'
|
|
63
|
+
/participants/{ID}:
|
|
64
|
+
$ref: 'paths/participants_ID.yaml'
|
|
65
|
+
/participants/{ID}/error:
|
|
66
|
+
$ref: 'paths/participants_ID_error.yaml'
|
|
61
67
|
/participants/{Type}/{ID}:
|
|
62
68
|
$ref: 'paths/participants_Type_ID.yaml'
|
|
63
69
|
/participants/{Type}/{ID}/error:
|
|
@@ -66,12 +72,6 @@ paths:
|
|
|
66
72
|
$ref: 'paths/participants_Type_ID_SubId.yaml'
|
|
67
73
|
/participants/{Type}/{ID}/{SubId}/error:
|
|
68
74
|
$ref: 'paths/participants_Type_ID_SubId_error.yaml'
|
|
69
|
-
/participants:
|
|
70
|
-
$ref: 'paths/participants.yaml'
|
|
71
|
-
/participants/{ID}:
|
|
72
|
-
$ref: 'paths/participants_ID.yaml'
|
|
73
|
-
/participants/{ID}/error:
|
|
74
|
-
$ref: 'paths/participants_ID_error.yaml'
|
|
75
75
|
/parties/{Type}/{ID}:
|
|
76
76
|
$ref: 'paths/parties_Type_ID.yaml'
|
|
77
77
|
/parties/{Type}/{ID}/error:
|
|
@@ -133,4 +133,4 @@ paths:
|
|
|
133
133
|
/services/FXP:
|
|
134
134
|
$ref: 'paths/services_FXP.yaml'
|
|
135
135
|
/services/FXP/{SourceCurrency}/{TargetCurrency}:
|
|
136
|
-
$ref: 'paths/services_FXP_SourceCurrency_TargetCurrency.yaml'
|
|
136
|
+
$ref: 'paths/services_FXP_SourceCurrency_TargetCurrency.yaml'
|
|
@@ -3,6 +3,66 @@
|
|
|
3
3
|
* Do not make direct changes to the file.
|
|
4
4
|
*/
|
|
5
5
|
export interface paths {
|
|
6
|
+
"/participants": {
|
|
7
|
+
parameters: {
|
|
8
|
+
query?: never;
|
|
9
|
+
header?: never;
|
|
10
|
+
path?: never;
|
|
11
|
+
cookie?: never;
|
|
12
|
+
};
|
|
13
|
+
get?: never;
|
|
14
|
+
put?: never;
|
|
15
|
+
/**
|
|
16
|
+
* Create bulk participant information
|
|
17
|
+
* @description The HTTP request `POST /participants` is used to create information in the server regarding the provided list of identities. This request should be used for bulk creation of FSP information for more than one Party. The optional currency parameter should indicate that each provided Party supports the currency.
|
|
18
|
+
*/
|
|
19
|
+
post: operations["Participants1"];
|
|
20
|
+
delete?: never;
|
|
21
|
+
options?: never;
|
|
22
|
+
head?: never;
|
|
23
|
+
patch?: never;
|
|
24
|
+
trace?: never;
|
|
25
|
+
};
|
|
26
|
+
"/participants/{ID}": {
|
|
27
|
+
parameters: {
|
|
28
|
+
query?: never;
|
|
29
|
+
header?: never;
|
|
30
|
+
path?: never;
|
|
31
|
+
cookie?: never;
|
|
32
|
+
};
|
|
33
|
+
get?: never;
|
|
34
|
+
/**
|
|
35
|
+
* Return bulk participant information
|
|
36
|
+
* @description The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities.
|
|
37
|
+
*/
|
|
38
|
+
put: operations["putParticipantsByID"];
|
|
39
|
+
post?: never;
|
|
40
|
+
delete?: never;
|
|
41
|
+
options?: never;
|
|
42
|
+
head?: never;
|
|
43
|
+
patch?: never;
|
|
44
|
+
trace?: never;
|
|
45
|
+
};
|
|
46
|
+
"/participants/{ID}/error": {
|
|
47
|
+
parameters: {
|
|
48
|
+
query?: never;
|
|
49
|
+
header?: never;
|
|
50
|
+
path?: never;
|
|
51
|
+
cookie?: never;
|
|
52
|
+
};
|
|
53
|
+
get?: never;
|
|
54
|
+
/**
|
|
55
|
+
* Return bulk participant information error
|
|
56
|
+
* @description If there is an error during FSP information creation in the server, the error callback `PUT /participants/{ID}/error` is used. The `{ID}` in the URI should contain the requestId that was used for the creation of the participant information.
|
|
57
|
+
*/
|
|
58
|
+
put: operations["ParticipantsByIDAndError"];
|
|
59
|
+
post?: never;
|
|
60
|
+
delete?: never;
|
|
61
|
+
options?: never;
|
|
62
|
+
head?: never;
|
|
63
|
+
patch?: never;
|
|
64
|
+
trace?: never;
|
|
65
|
+
};
|
|
6
66
|
"/participants/{Type}/{ID}": {
|
|
7
67
|
parameters: {
|
|
8
68
|
query?: never;
|
|
@@ -165,66 +225,6 @@ export interface paths {
|
|
|
165
225
|
patch?: never;
|
|
166
226
|
trace?: never;
|
|
167
227
|
};
|
|
168
|
-
"/participants": {
|
|
169
|
-
parameters: {
|
|
170
|
-
query?: never;
|
|
171
|
-
header?: never;
|
|
172
|
-
path?: never;
|
|
173
|
-
cookie?: never;
|
|
174
|
-
};
|
|
175
|
-
get?: never;
|
|
176
|
-
put?: never;
|
|
177
|
-
/**
|
|
178
|
-
* Create bulk participant information
|
|
179
|
-
* @description The HTTP request `POST /participants` is used to create information in the server regarding the provided list of identities. This request should be used for bulk creation of FSP information for more than one Party. The optional currency parameter should indicate that each provided Party supports the currency.
|
|
180
|
-
*/
|
|
181
|
-
post: operations["Participants1"];
|
|
182
|
-
delete?: never;
|
|
183
|
-
options?: never;
|
|
184
|
-
head?: never;
|
|
185
|
-
patch?: never;
|
|
186
|
-
trace?: never;
|
|
187
|
-
};
|
|
188
|
-
"/participants/{ID}": {
|
|
189
|
-
parameters: {
|
|
190
|
-
query?: never;
|
|
191
|
-
header?: never;
|
|
192
|
-
path?: never;
|
|
193
|
-
cookie?: never;
|
|
194
|
-
};
|
|
195
|
-
get?: never;
|
|
196
|
-
/**
|
|
197
|
-
* Return bulk participant information
|
|
198
|
-
* @description The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities.
|
|
199
|
-
*/
|
|
200
|
-
put: operations["putParticipantsByID"];
|
|
201
|
-
post?: never;
|
|
202
|
-
delete?: never;
|
|
203
|
-
options?: never;
|
|
204
|
-
head?: never;
|
|
205
|
-
patch?: never;
|
|
206
|
-
trace?: never;
|
|
207
|
-
};
|
|
208
|
-
"/participants/{ID}/error": {
|
|
209
|
-
parameters: {
|
|
210
|
-
query?: never;
|
|
211
|
-
header?: never;
|
|
212
|
-
path?: never;
|
|
213
|
-
cookie?: never;
|
|
214
|
-
};
|
|
215
|
-
get?: never;
|
|
216
|
-
/**
|
|
217
|
-
* Return bulk participant information error
|
|
218
|
-
* @description If there is an error during FSP information creation in the server, the error callback `PUT /participants/{ID}/error` is used. The `{ID}` in the URI should contain the requestId that was used for the creation of the participant information.
|
|
219
|
-
*/
|
|
220
|
-
put: operations["ParticipantsByIDAndError"];
|
|
221
|
-
post?: never;
|
|
222
|
-
delete?: never;
|
|
223
|
-
options?: never;
|
|
224
|
-
head?: never;
|
|
225
|
-
patch?: never;
|
|
226
|
-
trace?: never;
|
|
227
|
-
};
|
|
228
228
|
"/parties/{Type}/{ID}": {
|
|
229
229
|
parameters: {
|
|
230
230
|
query?: never;
|
|
@@ -2296,10 +2296,16 @@ export interface components {
|
|
|
2296
2296
|
}
|
|
2297
2297
|
export type $defs = Record<string, never>;
|
|
2298
2298
|
export interface operations {
|
|
2299
|
-
|
|
2299
|
+
Participants1: {
|
|
2300
2300
|
parameters: {
|
|
2301
2301
|
query?: never;
|
|
2302
2302
|
header: {
|
|
2303
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
|
2304
|
+
Accept: components["parameters"]["Accept"];
|
|
2305
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
|
2306
|
+
*
|
|
2307
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
|
2308
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
|
2303
2309
|
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
|
2304
2310
|
"Content-Type": components["parameters"]["Content-Type"];
|
|
2305
2311
|
/** @description The `Date` header field indicates the date when the request was sent. */
|
|
@@ -2320,18 +2326,16 @@ export interface operations {
|
|
|
2320
2326
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
|
2321
2327
|
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
|
2322
2328
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
|
2323
|
-
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
|
2324
|
-
Accept: components["parameters"]["Accept"];
|
|
2325
|
-
};
|
|
2326
|
-
path: {
|
|
2327
|
-
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
|
2328
|
-
Type: components["parameters"]["Type"];
|
|
2329
|
-
/** @description The identifier value. */
|
|
2330
|
-
ID: components["parameters"]["ID"];
|
|
2331
2329
|
};
|
|
2330
|
+
path?: never;
|
|
2332
2331
|
cookie?: never;
|
|
2333
2332
|
};
|
|
2334
|
-
|
|
2333
|
+
/** @description Participant information to be created. */
|
|
2334
|
+
requestBody: {
|
|
2335
|
+
content: {
|
|
2336
|
+
"application/json": components["schemas"]["ParticipantsPostRequest"];
|
|
2337
|
+
};
|
|
2338
|
+
};
|
|
2335
2339
|
responses: {
|
|
2336
2340
|
202: components["responses"]["202"];
|
|
2337
2341
|
400: components["responses"]["400"];
|
|
@@ -2344,10 +2348,14 @@ export interface operations {
|
|
|
2344
2348
|
503: components["responses"]["503"];
|
|
2345
2349
|
};
|
|
2346
2350
|
};
|
|
2347
|
-
|
|
2351
|
+
putParticipantsByID: {
|
|
2348
2352
|
parameters: {
|
|
2349
2353
|
query?: never;
|
|
2350
2354
|
header: {
|
|
2355
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
|
2356
|
+
*
|
|
2357
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
|
2358
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
|
2351
2359
|
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
|
2352
2360
|
"Content-Type": components["parameters"]["Content-Type"];
|
|
2353
2361
|
/** @description The `Date` header field indicates the date when the request was sent. */
|
|
@@ -2368,14 +2376,8 @@ export interface operations {
|
|
|
2368
2376
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
|
2369
2377
|
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
|
2370
2378
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
|
2371
|
-
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
|
2372
|
-
*
|
|
2373
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
|
2374
|
-
"Content-Length"?: components["parameters"]["Content-Length"];
|
|
2375
2379
|
};
|
|
2376
2380
|
path: {
|
|
2377
|
-
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
|
2378
|
-
Type: components["parameters"]["Type"];
|
|
2379
2381
|
/** @description The identifier value. */
|
|
2380
2382
|
ID: components["parameters"]["ID"];
|
|
2381
2383
|
};
|
|
@@ -2384,7 +2386,7 @@ export interface operations {
|
|
|
2384
2386
|
/** @description Participant information returned. */
|
|
2385
2387
|
requestBody: {
|
|
2386
2388
|
content: {
|
|
2387
|
-
"application/json": components["schemas"]["
|
|
2389
|
+
"application/json": components["schemas"]["ParticipantsIDPutResponse"];
|
|
2388
2390
|
};
|
|
2389
2391
|
};
|
|
2390
2392
|
responses: {
|
|
@@ -2399,10 +2401,14 @@ export interface operations {
|
|
|
2399
2401
|
503: components["responses"]["503"];
|
|
2400
2402
|
};
|
|
2401
2403
|
};
|
|
2402
|
-
|
|
2404
|
+
ParticipantsByIDAndError: {
|
|
2403
2405
|
parameters: {
|
|
2404
2406
|
query?: never;
|
|
2405
2407
|
header: {
|
|
2408
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
|
2409
|
+
*
|
|
2410
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
|
2411
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
|
2406
2412
|
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
|
2407
2413
|
"Content-Type": components["parameters"]["Content-Type"];
|
|
2408
2414
|
/** @description The `Date` header field indicates the date when the request was sent. */
|
|
@@ -2423,29 +2429,21 @@ export interface operations {
|
|
|
2423
2429
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
|
2424
2430
|
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
|
2425
2431
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
|
2426
|
-
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
|
2427
|
-
Accept: components["parameters"]["Accept"];
|
|
2428
|
-
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
|
2429
|
-
*
|
|
2430
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
|
2431
|
-
"Content-Length"?: components["parameters"]["Content-Length"];
|
|
2432
2432
|
};
|
|
2433
2433
|
path: {
|
|
2434
|
-
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
|
2435
|
-
Type: components["parameters"]["Type"];
|
|
2436
2434
|
/** @description The identifier value. */
|
|
2437
2435
|
ID: components["parameters"]["ID"];
|
|
2438
2436
|
};
|
|
2439
2437
|
cookie?: never;
|
|
2440
2438
|
};
|
|
2441
|
-
/** @description
|
|
2439
|
+
/** @description Details of the error returned. */
|
|
2442
2440
|
requestBody: {
|
|
2443
2441
|
content: {
|
|
2444
|
-
"application/json": components["schemas"]["
|
|
2442
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
|
2445
2443
|
};
|
|
2446
2444
|
};
|
|
2447
2445
|
responses: {
|
|
2448
|
-
|
|
2446
|
+
200: components["responses"]["200"];
|
|
2449
2447
|
400: components["responses"]["400"];
|
|
2450
2448
|
401: components["responses"]["401"];
|
|
2451
2449
|
403: components["responses"]["403"];
|
|
@@ -2456,7 +2454,7 @@ export interface operations {
|
|
|
2456
2454
|
503: components["responses"]["503"];
|
|
2457
2455
|
};
|
|
2458
2456
|
};
|
|
2459
|
-
|
|
2457
|
+
ParticipantsByTypeAndID: {
|
|
2460
2458
|
parameters: {
|
|
2461
2459
|
query?: never;
|
|
2462
2460
|
header: {
|
|
@@ -2504,14 +2502,10 @@ export interface operations {
|
|
|
2504
2502
|
503: components["responses"]["503"];
|
|
2505
2503
|
};
|
|
2506
2504
|
};
|
|
2507
|
-
|
|
2505
|
+
ParticipantsByTypeAndID3: {
|
|
2508
2506
|
parameters: {
|
|
2509
2507
|
query?: never;
|
|
2510
2508
|
header: {
|
|
2511
|
-
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
|
2512
|
-
*
|
|
2513
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
|
2514
|
-
"Content-Length"?: components["parameters"]["Content-Length"];
|
|
2515
2509
|
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
|
2516
2510
|
"Content-Type": components["parameters"]["Content-Type"];
|
|
2517
2511
|
/** @description The `Date` header field indicates the date when the request was sent. */
|
|
@@ -2532,6 +2526,10 @@ export interface operations {
|
|
|
2532
2526
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
|
2533
2527
|
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
|
2534
2528
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
|
2529
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
|
2530
|
+
*
|
|
2531
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
|
2532
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
|
2535
2533
|
};
|
|
2536
2534
|
path: {
|
|
2537
2535
|
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
|
@@ -2541,10 +2539,10 @@ export interface operations {
|
|
|
2541
2539
|
};
|
|
2542
2540
|
cookie?: never;
|
|
2543
2541
|
};
|
|
2544
|
-
/** @description
|
|
2542
|
+
/** @description Participant information returned. */
|
|
2545
2543
|
requestBody: {
|
|
2546
2544
|
content: {
|
|
2547
|
-
"application/json": components["schemas"]["
|
|
2545
|
+
"application/json": components["schemas"]["ParticipantsTypeIDPutResponse"];
|
|
2548
2546
|
};
|
|
2549
2547
|
};
|
|
2550
2548
|
responses: {
|
|
@@ -2559,7 +2557,7 @@ export interface operations {
|
|
|
2559
2557
|
503: components["responses"]["503"];
|
|
2560
2558
|
};
|
|
2561
2559
|
};
|
|
2562
|
-
|
|
2560
|
+
ParticipantsByIDAndType: {
|
|
2563
2561
|
parameters: {
|
|
2564
2562
|
query?: never;
|
|
2565
2563
|
header: {
|
|
@@ -2585,18 +2583,25 @@ export interface operations {
|
|
|
2585
2583
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
|
2586
2584
|
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
|
2587
2585
|
Accept: components["parameters"]["Accept"];
|
|
2586
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
|
2587
|
+
*
|
|
2588
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
|
2589
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
|
2588
2590
|
};
|
|
2589
2591
|
path: {
|
|
2590
2592
|
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
|
2591
2593
|
Type: components["parameters"]["Type"];
|
|
2592
2594
|
/** @description The identifier value. */
|
|
2593
2595
|
ID: components["parameters"]["ID"];
|
|
2594
|
-
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
|
2595
|
-
SubId: components["parameters"]["SubId"];
|
|
2596
2596
|
};
|
|
2597
2597
|
cookie?: never;
|
|
2598
2598
|
};
|
|
2599
|
-
|
|
2599
|
+
/** @description Participant information to be created. */
|
|
2600
|
+
requestBody: {
|
|
2601
|
+
content: {
|
|
2602
|
+
"application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"];
|
|
2603
|
+
};
|
|
2604
|
+
};
|
|
2600
2605
|
responses: {
|
|
2601
2606
|
202: components["responses"]["202"];
|
|
2602
2607
|
400: components["responses"]["400"];
|
|
@@ -2609,7 +2614,7 @@ export interface operations {
|
|
|
2609
2614
|
503: components["responses"]["503"];
|
|
2610
2615
|
};
|
|
2611
2616
|
};
|
|
2612
|
-
|
|
2617
|
+
ParticipantsByTypeAndID2: {
|
|
2613
2618
|
parameters: {
|
|
2614
2619
|
query?: never;
|
|
2615
2620
|
header: {
|
|
@@ -2633,29 +2638,20 @@ export interface operations {
|
|
|
2633
2638
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
|
2634
2639
|
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
|
2635
2640
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
|
2636
|
-
/** @description The `
|
|
2637
|
-
|
|
2638
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
|
2639
|
-
"Content-Length"?: components["parameters"]["Content-Length"];
|
|
2641
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
|
2642
|
+
Accept: components["parameters"]["Accept"];
|
|
2640
2643
|
};
|
|
2641
2644
|
path: {
|
|
2642
2645
|
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
|
2643
2646
|
Type: components["parameters"]["Type"];
|
|
2644
2647
|
/** @description The identifier value. */
|
|
2645
2648
|
ID: components["parameters"]["ID"];
|
|
2646
|
-
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
|
2647
|
-
SubId: components["parameters"]["SubId"];
|
|
2648
2649
|
};
|
|
2649
2650
|
cookie?: never;
|
|
2650
2651
|
};
|
|
2651
|
-
|
|
2652
|
-
requestBody: {
|
|
2653
|
-
content: {
|
|
2654
|
-
"application/json": components["schemas"]["ParticipantsTypeIDPutResponse"];
|
|
2655
|
-
};
|
|
2656
|
-
};
|
|
2652
|
+
requestBody?: never;
|
|
2657
2653
|
responses: {
|
|
2658
|
-
|
|
2654
|
+
202: components["responses"]["202"];
|
|
2659
2655
|
400: components["responses"]["400"];
|
|
2660
2656
|
401: components["responses"]["401"];
|
|
2661
2657
|
403: components["responses"]["403"];
|
|
@@ -2666,10 +2662,14 @@ export interface operations {
|
|
|
2666
2662
|
503: components["responses"]["503"];
|
|
2667
2663
|
};
|
|
2668
2664
|
};
|
|
2669
|
-
|
|
2665
|
+
ParticipantsErrorByTypeAndID: {
|
|
2670
2666
|
parameters: {
|
|
2671
2667
|
query?: never;
|
|
2672
2668
|
header: {
|
|
2669
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
|
2670
|
+
*
|
|
2671
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
|
2672
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
|
2673
2673
|
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
|
2674
2674
|
"Content-Type": components["parameters"]["Content-Type"];
|
|
2675
2675
|
/** @description The `Date` header field indicates the date when the request was sent. */
|
|
@@ -2690,31 +2690,23 @@ export interface operations {
|
|
|
2690
2690
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
|
2691
2691
|
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
|
2692
2692
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
|
2693
|
-
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
|
2694
|
-
Accept: components["parameters"]["Accept"];
|
|
2695
|
-
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
|
2696
|
-
*
|
|
2697
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
|
2698
|
-
"Content-Length"?: components["parameters"]["Content-Length"];
|
|
2699
2693
|
};
|
|
2700
2694
|
path: {
|
|
2701
2695
|
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
|
2702
2696
|
Type: components["parameters"]["Type"];
|
|
2703
2697
|
/** @description The identifier value. */
|
|
2704
2698
|
ID: components["parameters"]["ID"];
|
|
2705
|
-
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
|
2706
|
-
SubId: components["parameters"]["SubId"];
|
|
2707
2699
|
};
|
|
2708
2700
|
cookie?: never;
|
|
2709
2701
|
};
|
|
2710
|
-
/** @description
|
|
2702
|
+
/** @description Details of the error returned. */
|
|
2711
2703
|
requestBody: {
|
|
2712
2704
|
content: {
|
|
2713
|
-
"application/json": components["schemas"]["
|
|
2705
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
|
2714
2706
|
};
|
|
2715
2707
|
};
|
|
2716
2708
|
responses: {
|
|
2717
|
-
|
|
2709
|
+
200: components["responses"]["200"];
|
|
2718
2710
|
400: components["responses"]["400"];
|
|
2719
2711
|
401: components["responses"]["401"];
|
|
2720
2712
|
403: components["responses"]["403"];
|
|
@@ -2725,7 +2717,7 @@ export interface operations {
|
|
|
2725
2717
|
503: components["responses"]["503"];
|
|
2726
2718
|
};
|
|
2727
2719
|
};
|
|
2728
|
-
|
|
2720
|
+
ParticipantsSubIdByTypeAndID: {
|
|
2729
2721
|
parameters: {
|
|
2730
2722
|
query?: never;
|
|
2731
2723
|
header: {
|
|
@@ -2775,14 +2767,10 @@ export interface operations {
|
|
|
2775
2767
|
503: components["responses"]["503"];
|
|
2776
2768
|
};
|
|
2777
2769
|
};
|
|
2778
|
-
|
|
2770
|
+
ParticipantsSubIdByTypeAndID3: {
|
|
2779
2771
|
parameters: {
|
|
2780
2772
|
query?: never;
|
|
2781
2773
|
header: {
|
|
2782
|
-
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
|
2783
|
-
*
|
|
2784
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
|
2785
|
-
"Content-Length"?: components["parameters"]["Content-Length"];
|
|
2786
2774
|
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
|
2787
2775
|
"Content-Type": components["parameters"]["Content-Type"];
|
|
2788
2776
|
/** @description The `Date` header field indicates the date when the request was sent. */
|
|
@@ -2803,6 +2791,10 @@ export interface operations {
|
|
|
2803
2791
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
|
2804
2792
|
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
|
2805
2793
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
|
2794
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
|
2795
|
+
*
|
|
2796
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
|
2797
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
|
2806
2798
|
};
|
|
2807
2799
|
path: {
|
|
2808
2800
|
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
|
@@ -2814,10 +2806,10 @@ export interface operations {
|
|
|
2814
2806
|
};
|
|
2815
2807
|
cookie?: never;
|
|
2816
2808
|
};
|
|
2817
|
-
/** @description
|
|
2809
|
+
/** @description Participant information returned. */
|
|
2818
2810
|
requestBody: {
|
|
2819
2811
|
content: {
|
|
2820
|
-
"application/json": components["schemas"]["
|
|
2812
|
+
"application/json": components["schemas"]["ParticipantsTypeIDPutResponse"];
|
|
2821
2813
|
};
|
|
2822
2814
|
};
|
|
2823
2815
|
responses: {
|
|
@@ -2832,16 +2824,10 @@ export interface operations {
|
|
|
2832
2824
|
503: components["responses"]["503"];
|
|
2833
2825
|
};
|
|
2834
2826
|
};
|
|
2835
|
-
|
|
2827
|
+
ParticipantsSubIdByTypeAndIDPost: {
|
|
2836
2828
|
parameters: {
|
|
2837
2829
|
query?: never;
|
|
2838
2830
|
header: {
|
|
2839
|
-
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
|
2840
|
-
Accept: components["parameters"]["Accept"];
|
|
2841
|
-
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
|
2842
|
-
*
|
|
2843
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
|
2844
|
-
"Content-Length"?: components["parameters"]["Content-Length"];
|
|
2845
2831
|
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
|
2846
2832
|
"Content-Type": components["parameters"]["Content-Type"];
|
|
2847
2833
|
/** @description The `Date` header field indicates the date when the request was sent. */
|
|
@@ -2862,14 +2848,27 @@ export interface operations {
|
|
|
2862
2848
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
|
2863
2849
|
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
|
2864
2850
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
|
2851
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
|
2852
|
+
Accept: components["parameters"]["Accept"];
|
|
2853
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
|
2854
|
+
*
|
|
2855
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
|
2856
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
|
2857
|
+
};
|
|
2858
|
+
path: {
|
|
2859
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
|
2860
|
+
Type: components["parameters"]["Type"];
|
|
2861
|
+
/** @description The identifier value. */
|
|
2862
|
+
ID: components["parameters"]["ID"];
|
|
2863
|
+
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
|
2864
|
+
SubId: components["parameters"]["SubId"];
|
|
2865
2865
|
};
|
|
2866
|
-
path?: never;
|
|
2867
2866
|
cookie?: never;
|
|
2868
2867
|
};
|
|
2869
2868
|
/** @description Participant information to be created. */
|
|
2870
2869
|
requestBody: {
|
|
2871
2870
|
content: {
|
|
2872
|
-
"application/json": components["schemas"]["
|
|
2871
|
+
"application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"];
|
|
2873
2872
|
};
|
|
2874
2873
|
};
|
|
2875
2874
|
responses: {
|
|
@@ -2884,14 +2883,10 @@ export interface operations {
|
|
|
2884
2883
|
503: components["responses"]["503"];
|
|
2885
2884
|
};
|
|
2886
2885
|
};
|
|
2887
|
-
|
|
2886
|
+
ParticipantsSubIdByTypeAndID2: {
|
|
2888
2887
|
parameters: {
|
|
2889
2888
|
query?: never;
|
|
2890
2889
|
header: {
|
|
2891
|
-
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
|
2892
|
-
*
|
|
2893
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
|
2894
|
-
"Content-Length"?: components["parameters"]["Content-Length"];
|
|
2895
2890
|
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
|
2896
2891
|
"Content-Type": components["parameters"]["Content-Type"];
|
|
2897
2892
|
/** @description The `Date` header field indicates the date when the request was sent. */
|
|
@@ -2912,21 +2907,22 @@ export interface operations {
|
|
|
2912
2907
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
|
2913
2908
|
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
|
2914
2909
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
|
2910
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
|
2911
|
+
Accept: components["parameters"]["Accept"];
|
|
2915
2912
|
};
|
|
2916
2913
|
path: {
|
|
2914
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
|
2915
|
+
Type: components["parameters"]["Type"];
|
|
2917
2916
|
/** @description The identifier value. */
|
|
2918
2917
|
ID: components["parameters"]["ID"];
|
|
2918
|
+
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
|
2919
|
+
SubId: components["parameters"]["SubId"];
|
|
2919
2920
|
};
|
|
2920
2921
|
cookie?: never;
|
|
2921
2922
|
};
|
|
2922
|
-
|
|
2923
|
-
requestBody: {
|
|
2924
|
-
content: {
|
|
2925
|
-
"application/json": components["schemas"]["ParticipantsIDPutResponse"];
|
|
2926
|
-
};
|
|
2927
|
-
};
|
|
2923
|
+
requestBody?: never;
|
|
2928
2924
|
responses: {
|
|
2929
|
-
|
|
2925
|
+
202: components["responses"]["202"];
|
|
2930
2926
|
400: components["responses"]["400"];
|
|
2931
2927
|
401: components["responses"]["401"];
|
|
2932
2928
|
403: components["responses"]["403"];
|
|
@@ -2937,7 +2933,7 @@ export interface operations {
|
|
|
2937
2933
|
503: components["responses"]["503"];
|
|
2938
2934
|
};
|
|
2939
2935
|
};
|
|
2940
|
-
|
|
2936
|
+
ParticipantsSubIdErrorByTypeAndID: {
|
|
2941
2937
|
parameters: {
|
|
2942
2938
|
query?: never;
|
|
2943
2939
|
header: {
|
|
@@ -2967,8 +2963,12 @@ export interface operations {
|
|
|
2967
2963
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
|
2968
2964
|
};
|
|
2969
2965
|
path: {
|
|
2966
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
|
2967
|
+
Type: components["parameters"]["Type"];
|
|
2970
2968
|
/** @description The identifier value. */
|
|
2971
2969
|
ID: components["parameters"]["ID"];
|
|
2970
|
+
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
|
2971
|
+
SubId: components["parameters"]["SubId"];
|
|
2972
2972
|
};
|
|
2973
2973
|
cookie?: never;
|
|
2974
2974
|
};
|