@mojaloop/api-snippets 17.2.0 → 17.2.3
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 +14 -0
- package/jest.config.js +2 -4
- package/lib/fspiop/v1_0/openapi.d.ts +791 -1490
- package/lib/fspiop/v1_1/openapi.d.ts +811 -1523
- package/lib/sdk-scheme-adapter/v2_0_0/backend/openapi.d.ts +189 -141
- package/lib/sdk-scheme-adapter/v2_0_0/backend/schemas.js +1 -1
- package/lib/sdk-scheme-adapter/v2_0_0/backend/schemas.js.map +1 -1
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/openapi.d.ts +218 -207
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/schemas.js +1 -1
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/schemas.js.map +1 -1
- package/lib/thirdparty/openapi.d.ts +655 -1454
- package/package.json +23 -33
@@ -4,129 +4,106 @@
|
|
4
4
|
*/
|
5
5
|
export interface paths {
|
6
6
|
"/interface": {
|
7
|
-
/** Essential path to include schema definitions that are not used so that these definitions get included into the openapi-cli bundle api definition so that they get converted into typescript definitions. */
|
7
|
+
/** @description Essential path to include schema definitions that are not used so that these definitions get included into the openapi-cli bundle api definition so that they get converted into typescript definitions. */
|
8
8
|
post: operations["test"];
|
9
9
|
};
|
10
10
|
"/accounts/{ID}": {
|
11
|
-
/**
|
11
|
+
/**
|
12
|
+
* GetAccountsByUserId
|
13
|
+
* @description The HTTP request `GET /accounts/{ID}` is used to retrieve the list of potential accounts available for linking.
|
14
|
+
*/
|
12
15
|
get: operations["GetAccountsByUserId"];
|
13
|
-
/**
|
16
|
+
/**
|
17
|
+
* UpdateAccountsByUserId
|
18
|
+
* @description The HTTP request `PUT /accounts/{ID}` is used to return the list of potential accounts available for linking
|
19
|
+
*/
|
14
20
|
put: operations["UpdateAccountsByUserId"];
|
15
21
|
parameters: {
|
16
|
-
path: {
|
17
|
-
/** The identifier value. */
|
18
|
-
ID: components["parameters"]["ID"];
|
19
|
-
};
|
20
22
|
header: {
|
21
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
22
23
|
"Content-Type": components["parameters"]["Content-Type"];
|
23
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
24
24
|
Date: components["parameters"]["Date"];
|
25
|
-
/**
|
26
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
27
|
-
*
|
28
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
29
|
-
*/
|
30
25
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
31
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
32
26
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
33
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
34
27
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
35
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
36
28
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
37
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
38
29
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
39
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
40
30
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
41
|
-
/** 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/master/Specification%20Document%20Set). */
|
42
31
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
43
32
|
};
|
33
|
+
path: {
|
34
|
+
ID: components["parameters"]["ID"];
|
35
|
+
};
|
44
36
|
};
|
45
37
|
};
|
46
38
|
"/accounts/{ID}/error": {
|
47
|
-
/**
|
39
|
+
/**
|
40
|
+
* UpdateAccountsByUserIdError
|
41
|
+
* @description The HTTP request `PUT /accounts/{ID}/error` is used to return error information
|
42
|
+
*/
|
48
43
|
put: operations["UpdateAccountsByUserIdError"];
|
49
44
|
parameters: {
|
50
|
-
path: {
|
51
|
-
/** The identifier value. */
|
52
|
-
ID: components["parameters"]["ID"];
|
53
|
-
};
|
54
45
|
header: {
|
55
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
56
46
|
"Content-Type": components["parameters"]["Content-Type"];
|
57
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
58
47
|
Date: components["parameters"]["Date"];
|
59
|
-
/**
|
60
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
61
|
-
*
|
62
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
63
|
-
*/
|
64
48
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
65
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
66
49
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
67
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
68
50
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
69
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
70
51
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
71
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
72
52
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
73
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
74
53
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
75
|
-
/** 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/master/Specification%20Document%20Set). */
|
76
54
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
77
55
|
};
|
56
|
+
path: {
|
57
|
+
ID: components["parameters"]["ID"];
|
58
|
+
};
|
78
59
|
};
|
79
60
|
};
|
80
61
|
"/health": {
|
81
|
-
/**
|
62
|
+
/**
|
63
|
+
* Health check endpoint
|
64
|
+
* @description The HTTP request GET /health is used to return the current status of the API.
|
65
|
+
*/
|
82
66
|
get: operations["HealthGet"];
|
83
67
|
};
|
84
68
|
"/metrics": {
|
85
|
-
/**
|
69
|
+
/**
|
70
|
+
* Prometheus metrics endpoint
|
71
|
+
* @description The HTTP request GET /metrics is used to return metrics for the API.
|
72
|
+
*/
|
86
73
|
get: operations["MetricsGet"];
|
87
74
|
};
|
88
75
|
"/consentRequests": {
|
89
76
|
/**
|
90
|
-
*
|
77
|
+
* CreateConsentRequest
|
78
|
+
* @description The HTTP request **POST /consentRequests** is used to request a DFSP to grant access to one or more
|
91
79
|
* accounts owned by a customer of the DFSP for the PISP who sends the request.
|
92
80
|
*/
|
93
81
|
post: operations["CreateConsentRequest"];
|
94
82
|
parameters: {
|
95
83
|
header: {
|
96
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
97
84
|
"Content-Type": components["parameters"]["Content-Type"];
|
98
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
99
85
|
Date: components["parameters"]["Date"];
|
100
|
-
/**
|
101
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
102
|
-
*
|
103
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
104
|
-
*/
|
105
86
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
106
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
107
87
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
108
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
109
88
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
110
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
111
89
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
112
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
113
90
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
114
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
115
91
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
116
|
-
/** 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/master/Specification%20Document%20Set). */
|
117
92
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
118
93
|
};
|
119
94
|
};
|
120
95
|
};
|
121
96
|
"/consentRequests/{ID}": {
|
122
97
|
/**
|
123
|
-
*
|
98
|
+
* GetConsentRequestsById
|
99
|
+
* @description The HTTP request `GET /consentRequests/{ID}` is used to get information about a previously
|
124
100
|
* requested consent. The *{ID}* in the URI should contain the consentRequestId that was assigned to the
|
125
101
|
* request by the PISP when the PISP originated the request.
|
126
102
|
*/
|
127
103
|
get: operations["GetConsentRequestsById"];
|
128
104
|
/**
|
129
|
-
*
|
105
|
+
* UpdateConsentRequest
|
106
|
+
* @description A DFSP uses this callback to (1) inform the PISP that the consentRequest has been accepted,
|
130
107
|
* and (2) communicate to the PISP which `authChannel` it should use to authenticate their user
|
131
108
|
* with.
|
132
109
|
*
|
@@ -137,115 +114,87 @@ export interface paths {
|
|
137
114
|
* particular authorization request.
|
138
115
|
*/
|
139
116
|
put: operations["UpdateConsentRequest"];
|
140
|
-
/**
|
117
|
+
/**
|
118
|
+
* PatchConsentRequest
|
119
|
+
* @description After the user completes an out-of-band authorization with the DFSP, the PISP will receive a token which they can use to prove to the DFSP that the user trusts this PISP.
|
120
|
+
*/
|
141
121
|
patch: operations["PatchConsentRequest"];
|
142
122
|
parameters: {
|
143
|
-
path: {
|
144
|
-
/** The identifier value. */
|
145
|
-
ID: components["parameters"]["ID"];
|
146
|
-
};
|
147
123
|
header: {
|
148
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
149
124
|
"Content-Type": components["parameters"]["Content-Type"];
|
150
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
151
125
|
Date: components["parameters"]["Date"];
|
152
|
-
/**
|
153
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
154
|
-
*
|
155
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
156
|
-
*/
|
157
126
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
158
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
159
127
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
160
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
161
128
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
162
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
163
129
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
164
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
165
130
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
166
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
167
131
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
168
|
-
/** 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/master/Specification%20Document%20Set). */
|
169
132
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
170
133
|
};
|
134
|
+
path: {
|
135
|
+
ID: components["parameters"]["ID"];
|
136
|
+
};
|
171
137
|
};
|
172
138
|
};
|
173
139
|
"/consentRequests/{ID}/error": {
|
174
|
-
/**
|
140
|
+
/**
|
141
|
+
* NotifyErrorConsentRequests
|
142
|
+
* @description DFSP responds to the PISP if something went wrong with validating an OTP or secret.
|
143
|
+
*/
|
175
144
|
put: operations["NotifyErrorConsentRequests"];
|
176
145
|
parameters: {
|
177
|
-
path: {
|
178
|
-
/** The identifier value. */
|
179
|
-
ID: components["parameters"]["ID"];
|
180
|
-
};
|
181
146
|
header: {
|
182
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
183
147
|
"Content-Type": components["parameters"]["Content-Type"];
|
184
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
185
148
|
Date: components["parameters"]["Date"];
|
186
|
-
/**
|
187
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
188
|
-
*
|
189
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
190
|
-
*/
|
191
149
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
192
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
193
150
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
194
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
195
151
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
196
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
197
152
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
198
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
199
153
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
200
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
201
154
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
202
|
-
/** 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/master/Specification%20Document%20Set). */
|
203
155
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
204
156
|
};
|
157
|
+
path: {
|
158
|
+
ID: components["parameters"]["ID"];
|
159
|
+
};
|
205
160
|
};
|
206
161
|
};
|
207
162
|
"/consents": {
|
208
|
-
/**
|
163
|
+
/**
|
164
|
+
* PostConsents
|
165
|
+
* @description The **POST /consents** request is used to request the creation of a consent for interactions between a PISP and the DFSP who owns the account which a PISP’s customer wants to allow the PISP access to.
|
166
|
+
*/
|
209
167
|
post: operations["PostConsents"];
|
210
168
|
parameters: {
|
211
169
|
header: {
|
212
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
213
170
|
"Content-Type": components["parameters"]["Content-Type"];
|
214
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
215
171
|
Date: components["parameters"]["Date"];
|
216
|
-
/**
|
217
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
218
|
-
*
|
219
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
220
|
-
*/
|
221
172
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
222
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
223
173
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
224
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
225
174
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
226
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
227
175
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
228
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
229
176
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
230
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
231
177
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
232
|
-
/** 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/master/Specification%20Document%20Set). */
|
233
178
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
234
179
|
};
|
235
180
|
};
|
236
181
|
};
|
237
182
|
"/consents/{ID}": {
|
238
|
-
/**
|
183
|
+
/**
|
184
|
+
* GetConsent
|
185
|
+
* @description The **GET /consents/**_{ID}_ resource allows a party to enquire after the status of a consent. The *{ID}* used in the URI of the request should be the consent request ID which was used to identify the consent when it was created.
|
186
|
+
*/
|
239
187
|
get: operations["GetConsent"];
|
240
188
|
/**
|
241
|
-
*
|
189
|
+
* PutConsentByID
|
190
|
+
* @description The HTTP request `PUT /consents/{ID}` is used by the PISP and Auth Service.
|
242
191
|
*
|
243
192
|
* - Called by a `PISP` to after signing a challenge. Sent to an DFSP for verification.
|
244
193
|
* - Called by a `auth-service` to notify a DFSP that a credential has been verified and registered.
|
245
194
|
*/
|
246
195
|
put: operations["PutConsentByID"];
|
247
196
|
/**
|
248
|
-
* Used by PISP, DFSP
|
197
|
+
* @description Used by PISP, DFSP
|
249
198
|
*
|
250
199
|
* The **DELETE /consents/**_{ID}_ request is used to request the revocation of a previously agreed consent.
|
251
200
|
* For tracing and auditing purposes, the switch should be sure not to delete the consent physically;
|
@@ -254,7 +203,8 @@ export interface paths {
|
|
254
203
|
*/
|
255
204
|
delete: operations["DeleteConsentByID"];
|
256
205
|
/**
|
257
|
-
*
|
206
|
+
* PatchConsentByID
|
207
|
+
* @description The HTTP request `PATCH /consents/{ID}` is used
|
258
208
|
*
|
259
209
|
* - In account linking in the Credential Registration phase. Used by a DFSP
|
260
210
|
* to notify a PISP a credential has been verified and registered with an
|
@@ -268,485 +218,346 @@ export interface paths {
|
|
268
218
|
*/
|
269
219
|
patch: operations["PatchConsentByID"];
|
270
220
|
parameters: {
|
271
|
-
path: {
|
272
|
-
/** The identifier value. */
|
273
|
-
ID: components["parameters"]["ID"];
|
274
|
-
};
|
275
221
|
header: {
|
276
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
277
222
|
"Content-Type": components["parameters"]["Content-Type"];
|
278
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
279
223
|
Date: components["parameters"]["Date"];
|
280
|
-
/**
|
281
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
282
|
-
*
|
283
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
284
|
-
*/
|
285
224
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
286
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
287
225
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
288
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
289
226
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
290
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
291
227
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
292
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
293
228
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
294
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
295
229
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
296
|
-
/** 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/master/Specification%20Document%20Set). */
|
297
230
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
298
231
|
};
|
232
|
+
path: {
|
233
|
+
ID: components["parameters"]["ID"];
|
234
|
+
};
|
299
235
|
};
|
300
236
|
};
|
301
237
|
"/consents/{ID}/error": {
|
302
|
-
/**
|
238
|
+
/**
|
239
|
+
* NotifyErrorConsents
|
240
|
+
* @description DFSP responds to the PISP if something went wrong with validating or storing consent.
|
241
|
+
*/
|
303
242
|
put: operations["NotifyErrorConsents"];
|
304
243
|
parameters: {
|
305
|
-
path: {
|
306
|
-
/** The identifier value. */
|
307
|
-
ID: components["parameters"]["ID"];
|
308
|
-
};
|
309
244
|
header: {
|
310
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
311
245
|
"Content-Type": components["parameters"]["Content-Type"];
|
312
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
313
246
|
Date: components["parameters"]["Date"];
|
314
|
-
/**
|
315
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
316
|
-
*
|
317
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
318
|
-
*/
|
319
247
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
320
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
321
248
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
322
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
323
249
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
324
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
325
250
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
326
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
327
251
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
328
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
329
252
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
330
|
-
/** 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/master/Specification%20Document%20Set). */
|
331
253
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
332
254
|
};
|
255
|
+
path: {
|
256
|
+
ID: components["parameters"]["ID"];
|
257
|
+
};
|
333
258
|
};
|
334
259
|
};
|
335
260
|
"/participants": {
|
336
|
-
/**
|
261
|
+
/**
|
262
|
+
* Create bulk participant information
|
263
|
+
* @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.
|
264
|
+
*/
|
337
265
|
post: operations["Participants1"];
|
338
266
|
parameters: {
|
339
267
|
header: {
|
340
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
341
268
|
"Content-Type": components["parameters"]["Content-Type"];
|
342
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
343
269
|
Date: components["parameters"]["Date"];
|
344
|
-
/**
|
345
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
346
|
-
*
|
347
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
348
|
-
*/
|
349
270
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
350
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
351
271
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
352
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
353
272
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
354
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
355
273
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
356
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
357
274
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
358
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
359
275
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
360
|
-
/** 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/master/Specification%20Document%20Set). */
|
361
276
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
362
277
|
};
|
363
278
|
};
|
364
279
|
};
|
365
280
|
"/participants/{ID}": {
|
366
|
-
/**
|
281
|
+
/**
|
282
|
+
* Return bulk participant information
|
283
|
+
* @description The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities.
|
284
|
+
*/
|
367
285
|
put: operations["PutParticipantsByID"];
|
368
286
|
parameters: {
|
369
|
-
path: {
|
370
|
-
/** The identifier value. */
|
371
|
-
ID: components["parameters"]["ID"];
|
372
|
-
};
|
373
287
|
header: {
|
374
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
375
288
|
"Content-Type": components["parameters"]["Content-Type"];
|
376
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
377
289
|
Date: components["parameters"]["Date"];
|
378
|
-
/**
|
379
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
380
|
-
*
|
381
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
382
|
-
*/
|
383
290
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
384
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
385
291
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
386
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
387
292
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
388
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
389
293
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
390
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
391
294
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
392
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
393
295
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
394
|
-
/** 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/master/Specification%20Document%20Set). */
|
395
296
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
396
297
|
};
|
298
|
+
path: {
|
299
|
+
ID: components["parameters"]["ID"];
|
300
|
+
};
|
397
301
|
};
|
398
302
|
};
|
399
303
|
"/participants/{ID}/error": {
|
400
|
-
/**
|
304
|
+
/**
|
305
|
+
* Return bulk participant information error
|
306
|
+
* @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.
|
307
|
+
*/
|
401
308
|
put: operations["PutParticipantsByIDAndError"];
|
402
309
|
parameters: {
|
403
|
-
path: {
|
404
|
-
/** The identifier value. */
|
405
|
-
ID: components["parameters"]["ID"];
|
406
|
-
};
|
407
310
|
header: {
|
408
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
409
311
|
"Content-Type": components["parameters"]["Content-Type"];
|
410
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
411
312
|
Date: components["parameters"]["Date"];
|
412
|
-
/**
|
413
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
414
|
-
*
|
415
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
416
|
-
*/
|
417
313
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
418
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
419
314
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
420
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
421
315
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
422
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
423
316
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
424
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
425
317
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
426
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
427
318
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
428
|
-
/** 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/master/Specification%20Document%20Set). */
|
429
319
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
430
320
|
};
|
321
|
+
path: {
|
322
|
+
ID: components["parameters"]["ID"];
|
323
|
+
};
|
431
324
|
};
|
432
325
|
};
|
433
326
|
"/participants/{Type}/{ID}": {
|
434
|
-
/**
|
327
|
+
/**
|
328
|
+
* Look up participant information
|
329
|
+
* @description The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency.
|
330
|
+
*/
|
435
331
|
get: operations["ParticipantsByTypeAndID"];
|
436
|
-
/**
|
332
|
+
/**
|
333
|
+
* Return participant information
|
334
|
+
* @description The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party.
|
335
|
+
*/
|
437
336
|
put: operations["ParticipantsByTypeAndID3"];
|
438
|
-
/**
|
337
|
+
/**
|
338
|
+
* Create participant information
|
339
|
+
* @description The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). An ExtensionList element has been added to this reqeust in version v1.1
|
340
|
+
*/
|
439
341
|
post: operations["ParticipantsByIDAndType"];
|
440
342
|
/**
|
441
|
-
*
|
343
|
+
* Delete participant information
|
344
|
+
* @description The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency.
|
442
345
|
*
|
443
346
|
* **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.
|
444
347
|
*/
|
445
348
|
delete: operations["ParticipantsByTypeAndID2"];
|
446
349
|
parameters: {
|
447
|
-
path: {
|
448
|
-
/** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
449
|
-
Type: components["parameters"]["Type"];
|
450
|
-
/** The identifier value. */
|
451
|
-
ID: components["parameters"]["ID"];
|
452
|
-
};
|
453
350
|
header: {
|
454
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
455
351
|
"Content-Type": components["parameters"]["Content-Type"];
|
456
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
457
352
|
Date: components["parameters"]["Date"];
|
458
|
-
/**
|
459
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
460
|
-
*
|
461
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
462
|
-
*/
|
463
353
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
464
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
465
354
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
466
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
467
355
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
468
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
469
356
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
470
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
471
357
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
472
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
473
358
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
474
|
-
/** 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/master/Specification%20Document%20Set). */
|
475
359
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
476
360
|
};
|
361
|
+
path: {
|
362
|
+
Type: components["parameters"]["Type"];
|
363
|
+
ID: components["parameters"]["ID"];
|
364
|
+
};
|
477
365
|
};
|
478
366
|
};
|
479
367
|
"/participants/{Type}/{ID}/error": {
|
480
|
-
/**
|
368
|
+
/**
|
369
|
+
* Return participant information error
|
370
|
+
* @description If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used.
|
371
|
+
*/
|
481
372
|
put: operations["ParticipantsErrorByTypeAndID"];
|
482
373
|
parameters: {
|
483
|
-
path: {
|
484
|
-
/** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
485
|
-
Type: components["parameters"]["Type"];
|
486
|
-
/** The identifier value. */
|
487
|
-
ID: components["parameters"]["ID"];
|
488
|
-
};
|
489
374
|
header: {
|
490
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
491
375
|
"Content-Type": components["parameters"]["Content-Type"];
|
492
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
493
376
|
Date: components["parameters"]["Date"];
|
494
|
-
/**
|
495
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
496
|
-
*
|
497
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
498
|
-
*/
|
499
377
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
500
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
501
378
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
502
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
503
379
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
504
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
505
380
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
506
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
507
381
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
508
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
509
382
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
510
|
-
/** 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/master/Specification%20Document%20Set). */
|
511
383
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
512
384
|
};
|
385
|
+
path: {
|
386
|
+
Type: components["parameters"]["Type"];
|
387
|
+
ID: components["parameters"]["ID"];
|
388
|
+
};
|
513
389
|
};
|
514
390
|
};
|
515
391
|
"/services/{ServiceType}": {
|
516
392
|
/**
|
517
|
-
*
|
393
|
+
* GetServicesByServiceType
|
394
|
+
* @description The HTTP request `GET /services/{ServiceType}` is used to retrieve the list of participants
|
518
395
|
* that support a specified service.
|
519
396
|
*/
|
520
397
|
get: operations["GetServicesByServiceType"];
|
521
398
|
/**
|
522
|
-
*
|
399
|
+
* PutServicesByServiceType
|
400
|
+
* @description The HTTP request `PUT /services/{ServiceType}` is used to return list of participants
|
523
401
|
* that support a specified service.
|
524
402
|
*/
|
525
403
|
put: operations["PutServicesByServiceType"];
|
526
404
|
parameters: {
|
527
|
-
path: {
|
528
|
-
/** The type of the service identifier. For example, `THIRD_PARTY_DFSP` */
|
529
|
-
ServiceType: components["parameters"]["ServiceType"];
|
530
|
-
};
|
531
405
|
header: {
|
532
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
533
406
|
"Content-Type": components["parameters"]["Content-Type"];
|
534
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
535
407
|
Date: components["parameters"]["Date"];
|
536
|
-
/**
|
537
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
538
|
-
*
|
539
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
540
|
-
*/
|
541
408
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
542
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
543
409
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
544
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
545
410
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
546
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
547
411
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
548
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
549
412
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
550
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
551
413
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
552
|
-
/** 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/master/Specification%20Document%20Set). */
|
553
414
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
554
415
|
};
|
416
|
+
path: {
|
417
|
+
ServiceType: components["parameters"]["ServiceType"];
|
418
|
+
};
|
555
419
|
};
|
556
420
|
};
|
557
421
|
"/services/{ServiceType}/error": {
|
558
|
-
/**
|
422
|
+
/**
|
423
|
+
* PutServicesByServiceTypeAndError
|
424
|
+
* @description The HTTP request `PUT /services/{ServiceType}/error` is used to return error information
|
425
|
+
*/
|
559
426
|
put: operations["PutServicesByServiceTypeAndError"];
|
560
427
|
parameters: {
|
561
|
-
path: {
|
562
|
-
/** The type of the service identifier. For example, `THIRD_PARTY_DFSP` */
|
563
|
-
ServiceType: components["parameters"]["ServiceType"];
|
564
|
-
};
|
565
428
|
header: {
|
566
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
567
429
|
"Content-Type": components["parameters"]["Content-Type"];
|
568
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
569
430
|
Date: components["parameters"]["Date"];
|
570
|
-
/**
|
571
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
572
|
-
*
|
573
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
574
|
-
*/
|
575
431
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
576
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
577
432
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
578
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
579
433
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
580
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
581
434
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
582
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
583
435
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
584
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
585
436
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
586
|
-
/** 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/master/Specification%20Document%20Set). */
|
587
437
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
588
438
|
};
|
439
|
+
path: {
|
440
|
+
ServiceType: components["parameters"]["ServiceType"];
|
441
|
+
};
|
589
442
|
};
|
590
443
|
};
|
591
444
|
"/thirdpartyRequests/transactions": {
|
592
|
-
/**
|
445
|
+
/**
|
446
|
+
* ThirdpartyRequestsTransactionsPost
|
447
|
+
* @description The HTTP request POST `/thirdpartyRequests/transactions` is used by a PISP to initiate a 3rd party Transaction request with a DFSP
|
448
|
+
*/
|
593
449
|
post: operations["ThirdpartyRequestsTransactionsPost"];
|
594
450
|
parameters: {
|
595
451
|
header: {
|
596
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
597
452
|
"Content-Type": components["parameters"]["Content-Type"];
|
598
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
599
453
|
Date: components["parameters"]["Date"];
|
600
|
-
/**
|
601
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
602
|
-
*
|
603
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
604
|
-
*/
|
605
454
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
606
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
607
455
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
608
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
609
456
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
610
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
611
457
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
612
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
613
458
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
614
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
615
459
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
616
|
-
/** 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/master/Specification%20Document%20Set). */
|
617
460
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
618
461
|
};
|
619
462
|
};
|
620
463
|
};
|
621
464
|
"/thirdpartyRequests/transactions/{ID}": {
|
622
465
|
/**
|
623
|
-
*
|
466
|
+
* GetThirdpartyTransactionRequests
|
467
|
+
* @description The HTTP request `GET /thirdpartyRequests/transactions/{ID}` is used to request the
|
624
468
|
* retrieval of a third party transaction request.
|
625
469
|
*/
|
626
470
|
get: operations["GetThirdpartyTransactionRequests"];
|
627
471
|
/**
|
628
|
-
*
|
472
|
+
* UpdateThirdPartyTransactionRequests
|
473
|
+
* @description The HTTP request `PUT /thirdpartyRequests/transactions/{ID}` is used by the DFSP to inform the client about
|
629
474
|
* the status of a previously requested thirdparty transaction request.
|
630
475
|
*
|
631
476
|
* Switch(Thirdparty API Adapter) -> PISP
|
632
477
|
*/
|
633
478
|
put: operations["UpdateThirdPartyTransactionRequests"];
|
634
479
|
/**
|
635
|
-
*
|
480
|
+
* NotifyThirdpartyTransactionRequests
|
481
|
+
* @description The HTTP request `PATCH /thirdpartyRequests/transactions/{ID}` is used to
|
636
482
|
* notify a thirdparty of the outcome of a transaction request.
|
637
483
|
*
|
638
484
|
* Switch(Thirdparty API Adapter) -> PISP
|
639
485
|
*/
|
640
486
|
patch: operations["NotifyThirdpartyTransactionRequests"];
|
641
487
|
parameters: {
|
642
|
-
path: {
|
643
|
-
/** The identifier value. */
|
644
|
-
ID: components["parameters"]["ID"];
|
645
|
-
};
|
646
488
|
header: {
|
647
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
648
489
|
"Content-Type": components["parameters"]["Content-Type"];
|
649
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
650
490
|
Date: components["parameters"]["Date"];
|
651
|
-
/**
|
652
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
653
|
-
*
|
654
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
655
|
-
*/
|
656
491
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
657
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
658
492
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
659
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
660
493
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
661
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
662
494
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
663
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
664
495
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
665
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
666
496
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
667
|
-
/** 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/master/Specification%20Document%20Set). */
|
668
497
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
669
498
|
};
|
499
|
+
path: {
|
500
|
+
ID: components["parameters"]["ID"];
|
501
|
+
};
|
670
502
|
};
|
671
503
|
};
|
672
504
|
"/thirdpartyRequests/transactions/{ID}/error": {
|
673
505
|
/**
|
674
|
-
*
|
506
|
+
* ThirdpartyTransactionRequestsError
|
507
|
+
* @description If the server is unable to find the transaction request, or another processing error occurs,
|
675
508
|
* the error callback `PUT /thirdpartyRequests/transactions/{ID}/error` is used.
|
676
509
|
* The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of
|
677
510
|
* the thirdparty transaction request.
|
678
511
|
*/
|
679
512
|
put: operations["ThirdpartyTransactionRequestsError"];
|
680
513
|
parameters: {
|
681
|
-
path: {
|
682
|
-
/** The identifier value. */
|
683
|
-
ID: components["parameters"]["ID"];
|
684
|
-
};
|
685
514
|
header: {
|
686
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
687
515
|
"Content-Type": components["parameters"]["Content-Type"];
|
688
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
689
516
|
Date: components["parameters"]["Date"];
|
690
|
-
/**
|
691
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
692
|
-
*
|
693
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
694
|
-
*/
|
695
517
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
696
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
697
518
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
698
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
699
519
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
700
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
701
520
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
702
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
703
521
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
704
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
705
522
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
706
|
-
/** 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/master/Specification%20Document%20Set). */
|
707
523
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
708
524
|
};
|
525
|
+
path: {
|
526
|
+
ID: components["parameters"]["ID"];
|
527
|
+
};
|
709
528
|
};
|
710
529
|
};
|
711
530
|
"/thirdpartyRequests/authorizations": {
|
712
|
-
/**
|
531
|
+
/**
|
532
|
+
* PostThirdpartyRequestsAuthorizations
|
533
|
+
* @description The HTTP request **POST /thirdpartyRequests/authorizations** is used to request the validation by a customer for the transfer described in the request.
|
534
|
+
*/
|
713
535
|
post: operations["PostThirdpartyRequestsAuthorizations"];
|
714
536
|
parameters: {
|
715
537
|
header: {
|
716
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
717
538
|
"Content-Type": components["parameters"]["Content-Type"];
|
718
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
719
539
|
Date: components["parameters"]["Date"];
|
720
|
-
/**
|
721
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
722
|
-
*
|
723
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
724
|
-
*/
|
725
540
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
726
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
727
541
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
728
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
729
542
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
730
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
731
543
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
732
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
733
544
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
734
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
735
545
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
736
|
-
/** 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/master/Specification%20Document%20Set). */
|
737
546
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
738
547
|
};
|
739
548
|
};
|
740
549
|
};
|
741
550
|
"/thirdpartyRequests/authorizations/{ID}": {
|
742
551
|
/**
|
743
|
-
*
|
552
|
+
* GetThirdpartyRequestsAuthorizationsById
|
553
|
+
* @description The HTTP request **GET /thirdpartyRequests/authorizations/**_{ID}_ is used to get information relating
|
744
554
|
* to a previously issued authorization request. The *{ID}* in the request should match the
|
745
555
|
* `authorizationRequestId` which was given when the authorization request was created.
|
746
556
|
*/
|
747
557
|
get: operations["GetThirdpartyRequestsAuthorizationsById"];
|
748
558
|
/**
|
749
|
-
*
|
559
|
+
* PutThirdpartyRequestsAuthorizationsById
|
560
|
+
* @description After receiving the **POST /thirdpartyRequests/authorizations**, the PISP will present the details of the
|
750
561
|
* transaction to their user, and request that the client sign the `challenge` field using the credential
|
751
562
|
* they previously registered.
|
752
563
|
*
|
@@ -754,39 +565,26 @@ export interface paths {
|
|
754
565
|
*/
|
755
566
|
put: operations["PutThirdpartyRequestsAuthorizationsById"];
|
756
567
|
parameters: {
|
757
|
-
path: {
|
758
|
-
/** The identifier value. */
|
759
|
-
ID: components["parameters"]["ID"];
|
760
|
-
};
|
761
568
|
header: {
|
762
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
763
569
|
"Content-Type": components["parameters"]["Content-Type"];
|
764
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
765
570
|
Date: components["parameters"]["Date"];
|
766
|
-
/**
|
767
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
768
|
-
*
|
769
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
770
|
-
*/
|
771
571
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
772
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
773
572
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
774
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
775
573
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
776
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
777
574
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
778
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
779
575
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
780
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
781
576
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
782
|
-
/** 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/master/Specification%20Document%20Set). */
|
783
577
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
784
578
|
};
|
579
|
+
path: {
|
580
|
+
ID: components["parameters"]["ID"];
|
581
|
+
};
|
785
582
|
};
|
786
583
|
};
|
787
584
|
"/thirdpartyRequests/authorizations/{ID}/error": {
|
788
585
|
/**
|
789
|
-
*
|
586
|
+
* PutThirdpartyRequestsAuthorizationsByIdAndError
|
587
|
+
* @description The HTTP request `PUT /thirdpartyRequests/authorizations/{ID}/error` is used by the DFSP or PISP to inform
|
790
588
|
* the other party that something went wrong with a Thirdparty Transaction Authorization Request.
|
791
589
|
*
|
792
590
|
* The PISP may use this to tell the DFSP that the Thirdparty Transaction Authorization Request is invalid or doesn't
|
@@ -797,148 +595,100 @@ export interface paths {
|
|
797
595
|
*/
|
798
596
|
put: operations["PutThirdpartyRequestsAuthorizationsByIdAndError"];
|
799
597
|
parameters: {
|
800
|
-
path: {
|
801
|
-
/** The identifier value. */
|
802
|
-
ID: components["parameters"]["ID"];
|
803
|
-
};
|
804
598
|
header: {
|
805
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
806
599
|
"Content-Type": components["parameters"]["Content-Type"];
|
807
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
808
600
|
Date: components["parameters"]["Date"];
|
809
|
-
/**
|
810
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
811
|
-
*
|
812
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
813
|
-
*/
|
814
601
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
815
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
816
602
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
817
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
818
603
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
819
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
820
604
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
821
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
822
605
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
823
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
824
606
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
825
|
-
/** 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/master/Specification%20Document%20Set). */
|
826
607
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
827
608
|
};
|
609
|
+
path: {
|
610
|
+
ID: components["parameters"]["ID"];
|
611
|
+
};
|
828
612
|
};
|
829
613
|
};
|
830
614
|
"/thirdpartyRequests/verifications": {
|
831
|
-
/**
|
615
|
+
/**
|
616
|
+
* PostThirdpartyRequestsVerifications
|
617
|
+
* @description The HTTP request `POST /thirdpartyRequests/verifications` is used by the DFSP to verify a third party authorization.
|
618
|
+
*/
|
832
619
|
post: operations["PostThirdpartyRequestsVerifications"];
|
833
620
|
parameters: {
|
834
621
|
header: {
|
835
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
836
622
|
"Content-Type": components["parameters"]["Content-Type"];
|
837
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
838
623
|
Date: components["parameters"]["Date"];
|
839
|
-
/**
|
840
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
841
|
-
*
|
842
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
843
|
-
*/
|
844
624
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
845
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
846
625
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
847
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
848
626
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
849
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
850
627
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
851
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
852
628
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
853
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
854
629
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
855
|
-
/** 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/master/Specification%20Document%20Set). */
|
856
630
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
857
631
|
};
|
858
632
|
};
|
859
633
|
};
|
860
634
|
"/thirdpartyRequests/verifications/{ID}": {
|
861
635
|
/**
|
862
|
-
*
|
636
|
+
* GetThirdpartyRequestsVerificationsById
|
637
|
+
* @description The HTTP request `/thirdpartyRequests/verifications/{ID}` is used to get
|
863
638
|
* information regarding a previously created or requested authorization. The *{ID}*
|
864
639
|
* in the URI should contain the verification request ID
|
865
640
|
*/
|
866
641
|
get: operations["GetThirdpartyRequestsVerificationsById"];
|
867
642
|
/**
|
868
|
-
*
|
643
|
+
* PutThirdpartyRequestsVerificationsById
|
644
|
+
* @description The HTTP request `PUT /thirdpartyRequests/verifications/{ID}` is used by the Auth-Service to inform the DFSP of a successful result in validating the verification of a Thirdparty Transaction Request.
|
869
645
|
* If the validation fails, the auth-service will send back `PUT /thirdpartyRequests/verifications/{ID}` with `authenticationResponse: 'REJECTED'`.
|
870
646
|
* In unplanned error cases the Auth-Service MUST use `PUT /thirdpartyRequests/verifications/{ID}/error`.
|
871
647
|
*/
|
872
648
|
put: operations["PutThirdpartyRequestsVerificationsById"];
|
873
649
|
parameters: {
|
874
|
-
path: {
|
875
|
-
/** The identifier value. */
|
876
|
-
ID: components["parameters"]["ID"];
|
877
|
-
};
|
878
650
|
header: {
|
879
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
880
651
|
"Content-Type": components["parameters"]["Content-Type"];
|
881
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
882
652
|
Date: components["parameters"]["Date"];
|
883
|
-
/**
|
884
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
885
|
-
*
|
886
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
887
|
-
*/
|
888
653
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
889
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
890
654
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
891
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
892
655
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
893
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
894
656
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
895
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
896
657
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
897
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
898
658
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
899
|
-
/** 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/master/Specification%20Document%20Set). */
|
900
659
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
901
660
|
};
|
661
|
+
path: {
|
662
|
+
ID: components["parameters"]["ID"];
|
663
|
+
};
|
902
664
|
};
|
903
665
|
};
|
904
666
|
"/thirdpartyRequests/verifications/{ID}/error": {
|
905
667
|
/**
|
906
|
-
*
|
668
|
+
* PutThirdpartyRequestsVerificationsByIdAndError
|
669
|
+
* @description The HTTP request `PUT /thirdpartyRequests/verifications/{ID}/error` is used by the Auth-Service to inform
|
907
670
|
* the DFSP of a failure in validating or looking up the verification of a Thirdparty Transaction Request.
|
908
671
|
*/
|
909
672
|
put: operations["PutThirdpartyRequestsVerificationsByIdAndError"];
|
910
673
|
parameters: {
|
911
|
-
path: {
|
912
|
-
/** The identifier value. */
|
913
|
-
ID: components["parameters"]["ID"];
|
914
|
-
};
|
915
674
|
header: {
|
916
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
917
675
|
"Content-Type": components["parameters"]["Content-Type"];
|
918
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
919
676
|
Date: components["parameters"]["Date"];
|
920
|
-
/**
|
921
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
922
|
-
*
|
923
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
924
|
-
*/
|
925
677
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
926
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
927
678
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
928
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
929
679
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
930
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
931
680
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
932
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
933
681
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
934
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
935
682
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
936
|
-
/** 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/master/Specification%20Document%20Set). */
|
937
683
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
938
684
|
};
|
685
|
+
path: {
|
686
|
+
ID: components["parameters"]["ID"];
|
687
|
+
};
|
939
688
|
};
|
940
689
|
};
|
941
690
|
}
|
691
|
+
export type webhooks = Record<string, never>;
|
942
692
|
export interface components {
|
943
693
|
schemas: {
|
944
694
|
/**
|
@@ -2074,62 +1824,90 @@ export interface components {
|
|
2074
1824
|
};
|
2075
1825
|
};
|
2076
1826
|
responses: {
|
2077
|
-
/** OK */
|
2078
|
-
200:
|
2079
|
-
|
2080
|
-
|
2081
|
-
/**
|
1827
|
+
/** @description OK */
|
1828
|
+
200: {
|
1829
|
+
content: never;
|
1830
|
+
};
|
1831
|
+
/** @description Accepted */
|
1832
|
+
202: {
|
1833
|
+
content: never;
|
1834
|
+
};
|
1835
|
+
/** @description Bad Request */
|
2082
1836
|
400: {
|
2083
|
-
headers: {
|
1837
|
+
headers: {
|
1838
|
+
"Content-Length": components["headers"]["Content-Length"];
|
1839
|
+
"Content-Type": components["headers"]["Content-Type"];
|
1840
|
+
};
|
2084
1841
|
content: {
|
2085
1842
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
2086
1843
|
};
|
2087
1844
|
};
|
2088
|
-
/** Unauthorized */
|
1845
|
+
/** @description Unauthorized */
|
2089
1846
|
401: {
|
2090
|
-
headers: {
|
1847
|
+
headers: {
|
1848
|
+
"Content-Length": components["headers"]["Content-Length"];
|
1849
|
+
"Content-Type": components["headers"]["Content-Type"];
|
1850
|
+
};
|
2091
1851
|
content: {
|
2092
1852
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
2093
1853
|
};
|
2094
1854
|
};
|
2095
|
-
/** Forbidden */
|
1855
|
+
/** @description Forbidden */
|
2096
1856
|
403: {
|
2097
|
-
headers: {
|
1857
|
+
headers: {
|
1858
|
+
"Content-Length": components["headers"]["Content-Length"];
|
1859
|
+
"Content-Type": components["headers"]["Content-Type"];
|
1860
|
+
};
|
2098
1861
|
content: {
|
2099
1862
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
2100
1863
|
};
|
2101
1864
|
};
|
2102
|
-
/** Not Found */
|
1865
|
+
/** @description Not Found */
|
2103
1866
|
404: {
|
2104
|
-
headers: {
|
1867
|
+
headers: {
|
1868
|
+
"Content-Length": components["headers"]["Content-Length"];
|
1869
|
+
"Content-Type": components["headers"]["Content-Type"];
|
1870
|
+
};
|
2105
1871
|
content: {
|
2106
1872
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
2107
1873
|
};
|
2108
1874
|
};
|
2109
|
-
/** Method Not Allowed */
|
1875
|
+
/** @description Method Not Allowed */
|
2110
1876
|
405: {
|
2111
|
-
headers: {
|
1877
|
+
headers: {
|
1878
|
+
"Content-Length": components["headers"]["Content-Length"];
|
1879
|
+
"Content-Type": components["headers"]["Content-Type"];
|
1880
|
+
};
|
2112
1881
|
content: {
|
2113
1882
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
2114
1883
|
};
|
2115
1884
|
};
|
2116
|
-
/** Not Acceptable */
|
1885
|
+
/** @description Not Acceptable */
|
2117
1886
|
406: {
|
2118
|
-
headers: {
|
1887
|
+
headers: {
|
1888
|
+
"Content-Length": components["headers"]["Content-Length"];
|
1889
|
+
"Content-Type": components["headers"]["Content-Type"];
|
1890
|
+
};
|
2119
1891
|
content: {
|
2120
1892
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
2121
1893
|
};
|
2122
1894
|
};
|
2123
|
-
/** Not Implemented */
|
1895
|
+
/** @description Not Implemented */
|
2124
1896
|
501: {
|
2125
|
-
headers: {
|
1897
|
+
headers: {
|
1898
|
+
"Content-Length": components["headers"]["Content-Length"];
|
1899
|
+
"Content-Type": components["headers"]["Content-Type"];
|
1900
|
+
};
|
2126
1901
|
content: {
|
2127
1902
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
2128
1903
|
};
|
2129
1904
|
};
|
2130
|
-
/** Service Unavailable */
|
1905
|
+
/** @description Service Unavailable */
|
2131
1906
|
503: {
|
2132
|
-
headers: {
|
1907
|
+
headers: {
|
1908
|
+
"Content-Length": components["headers"]["Content-Length"];
|
1909
|
+
"Content-Type": components["headers"]["Content-Type"];
|
1910
|
+
};
|
2133
1911
|
content: {
|
2134
1912
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
2135
1913
|
};
|
@@ -2147,19 +1925,19 @@ export interface components {
|
|
2147
1925
|
*
|
2148
1926
|
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
2149
1927
|
*/
|
2150
|
-
"X-Forwarded-For"
|
1928
|
+
"X-Forwarded-For"?: string;
|
2151
1929
|
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2152
1930
|
"FSPIOP-Source": string;
|
2153
1931
|
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2154
|
-
"FSPIOP-Destination"
|
1932
|
+
"FSPIOP-Destination"?: string;
|
2155
1933
|
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2156
|
-
"FSPIOP-Encryption"
|
1934
|
+
"FSPIOP-Encryption"?: string;
|
2157
1935
|
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2158
|
-
"FSPIOP-Signature"
|
1936
|
+
"FSPIOP-Signature"?: string;
|
2159
1937
|
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
2160
|
-
"FSPIOP-URI"
|
1938
|
+
"FSPIOP-URI"?: string;
|
2161
1939
|
/** @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/master/Specification%20Document%20Set). */
|
2162
|
-
"FSPIOP-HTTP-Method"
|
1940
|
+
"FSPIOP-HTTP-Method"?: string;
|
2163
1941
|
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2164
1942
|
Accept: string;
|
2165
1943
|
/**
|
@@ -2167,69 +1945,62 @@ export interface components {
|
|
2167
1945
|
*
|
2168
1946
|
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
2169
1947
|
*/
|
2170
|
-
"Content-Length"
|
1948
|
+
"Content-Length"?: number;
|
2171
1949
|
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2172
1950
|
Type: string;
|
2173
1951
|
/** @description The type of the service identifier. For example, `THIRD_PARTY_DFSP` */
|
2174
1952
|
ServiceType: string;
|
2175
1953
|
};
|
1954
|
+
requestBodies: never;
|
2176
1955
|
headers: {
|
2177
1956
|
/**
|
2178
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
1957
|
+
* @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2179
1958
|
*
|
2180
1959
|
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
2181
1960
|
*/
|
2182
|
-
"Content-Length"
|
2183
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1961
|
+
"Content-Length": number;
|
1962
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2184
1963
|
"Content-Type": string;
|
2185
1964
|
};
|
1965
|
+
pathItems: never;
|
2186
1966
|
}
|
1967
|
+
export type external = Record<string, never>;
|
2187
1968
|
export interface operations {
|
2188
|
-
/** Essential path to include schema definitions that are not used so that these definitions get included into the openapi-cli bundle api definition so that they get converted into typescript definitions. */
|
1969
|
+
/** @description Essential path to include schema definitions that are not used so that these definitions get included into the openapi-cli bundle api definition so that they get converted into typescript definitions. */
|
2189
1970
|
test: {
|
2190
|
-
|
2191
|
-
/** Ok */
|
2192
|
-
200: unknown;
|
2193
|
-
};
|
2194
|
-
requestBody: {
|
1971
|
+
requestBody?: {
|
2195
1972
|
content: {
|
2196
1973
|
"application/json": components["schemas"]["ParticipantsIDPutResponse"] | components["schemas"]["PartiesTypeIDPutResponse"] | components["schemas"]["QuotesIDPutResponse"] | components["schemas"]["ThirdpartyRequestsTransactionsIDPatchResponse"] | components["schemas"]["AuthorizationResponseType"] | components["schemas"]["ConsentStatusIssued"] | components["schemas"]["IlpFulfilment"] | components["schemas"]["Integer"] | components["schemas"]["Note"] | components["schemas"]["PartyIdInfoTPLink"] | components["schemas"]["PartyResult"] | components["schemas"]["ServiceType"] | components["schemas"]["ParticipantsPostRequest"] | components["schemas"]["QuotesPostRequest"];
|
2197
1974
|
};
|
2198
1975
|
};
|
1976
|
+
responses: {
|
1977
|
+
/** @description Ok */
|
1978
|
+
200: {
|
1979
|
+
content: never;
|
1980
|
+
};
|
1981
|
+
};
|
2199
1982
|
};
|
2200
|
-
/**
|
1983
|
+
/**
|
1984
|
+
* GetAccountsByUserId
|
1985
|
+
* @description The HTTP request `GET /accounts/{ID}` is used to retrieve the list of potential accounts available for linking.
|
1986
|
+
*/
|
2201
1987
|
GetAccountsByUserId: {
|
2202
1988
|
parameters: {
|
2203
|
-
path: {
|
2204
|
-
/** The identifier value. */
|
2205
|
-
ID: components["parameters"]["ID"];
|
2206
|
-
};
|
2207
1989
|
header: {
|
2208
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2209
1990
|
"Content-Type": components["parameters"]["Content-Type"];
|
2210
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2211
1991
|
Date: components["parameters"]["Date"];
|
2212
|
-
/**
|
2213
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
2214
|
-
*
|
2215
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
2216
|
-
*/
|
2217
1992
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2218
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2219
1993
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2220
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2221
1994
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2222
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2223
1995
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2224
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2225
1996
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2226
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
2227
1997
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2228
|
-
/** 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/master/Specification%20Document%20Set). */
|
2229
1998
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2230
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2231
1999
|
Accept: components["parameters"]["Accept"];
|
2232
2000
|
};
|
2001
|
+
path: {
|
2002
|
+
ID: components["parameters"]["ID"];
|
2003
|
+
};
|
2233
2004
|
};
|
2234
2005
|
responses: {
|
2235
2006
|
202: components["responses"]["202"];
|
@@ -2243,42 +2014,45 @@ export interface operations {
|
|
2243
2014
|
503: components["responses"]["503"];
|
2244
2015
|
};
|
2245
2016
|
};
|
2246
|
-
/**
|
2017
|
+
/**
|
2018
|
+
* UpdateAccountsByUserId
|
2019
|
+
* @description The HTTP request `PUT /accounts/{ID}` is used to return the list of potential accounts available for linking
|
2020
|
+
*/
|
2247
2021
|
UpdateAccountsByUserId: {
|
2248
2022
|
parameters: {
|
2249
|
-
path: {
|
2250
|
-
/** The identifier value. */
|
2251
|
-
ID: components["parameters"]["ID"];
|
2252
|
-
};
|
2253
2023
|
header: {
|
2254
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2255
2024
|
"Content-Type": components["parameters"]["Content-Type"];
|
2256
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2257
2025
|
Date: components["parameters"]["Date"];
|
2258
|
-
/**
|
2259
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
2260
|
-
*
|
2261
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
2262
|
-
*/
|
2263
2026
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2264
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2265
2027
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2266
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2267
2028
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2268
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2269
2029
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2270
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2271
2030
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2272
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
2273
2031
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2274
|
-
/** 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/master/Specification%20Document%20Set). */
|
2275
2032
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2033
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
2034
|
+
};
|
2035
|
+
path: {
|
2036
|
+
ID: components["parameters"]["ID"];
|
2037
|
+
};
|
2038
|
+
};
|
2039
|
+
requestBody: {
|
2040
|
+
content: {
|
2276
2041
|
/**
|
2277
|
-
*
|
2278
|
-
*
|
2279
|
-
*
|
2042
|
+
* @example [
|
2043
|
+
* {
|
2044
|
+
* "accountNickname": "dfspa.user.nickname1",
|
2045
|
+
* "id": "dfspa.username.1234",
|
2046
|
+
* "currency": "ZAR"
|
2047
|
+
* },
|
2048
|
+
* {
|
2049
|
+
* "accountNickname": "dfspa.user.nickname2",
|
2050
|
+
* "id": "dfspa.username.5678",
|
2051
|
+
* "currency": "USD"
|
2052
|
+
* }
|
2053
|
+
* ]
|
2280
2054
|
*/
|
2281
|
-
"
|
2055
|
+
"application/json": components["schemas"]["AccountsIDPutResponse"];
|
2282
2056
|
};
|
2283
2057
|
};
|
2284
2058
|
responses: {
|
@@ -2292,49 +2066,34 @@ export interface operations {
|
|
2292
2066
|
501: components["responses"]["501"];
|
2293
2067
|
503: components["responses"]["503"];
|
2294
2068
|
};
|
2295
|
-
requestBody: {
|
2296
|
-
content: {
|
2297
|
-
"application/json": components["schemas"]["AccountsIDPutResponse"];
|
2298
|
-
};
|
2299
|
-
};
|
2300
2069
|
};
|
2301
|
-
/**
|
2070
|
+
/**
|
2071
|
+
* UpdateAccountsByUserIdError
|
2072
|
+
* @description The HTTP request `PUT /accounts/{ID}/error` is used to return error information
|
2073
|
+
*/
|
2302
2074
|
UpdateAccountsByUserIdError: {
|
2303
2075
|
parameters: {
|
2304
|
-
path: {
|
2305
|
-
/** The identifier value. */
|
2306
|
-
ID: components["parameters"]["ID"];
|
2307
|
-
};
|
2308
2076
|
header: {
|
2309
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2310
2077
|
"Content-Type": components["parameters"]["Content-Type"];
|
2311
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2312
2078
|
Date: components["parameters"]["Date"];
|
2313
|
-
/**
|
2314
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
2315
|
-
*
|
2316
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
2317
|
-
*/
|
2318
2079
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2319
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2320
2080
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2321
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2322
2081
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2323
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2324
2082
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2325
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2326
2083
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2327
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
2328
2084
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2329
|
-
/** 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/master/Specification%20Document%20Set). */
|
2330
2085
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2331
|
-
/**
|
2332
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2333
|
-
*
|
2334
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
2335
|
-
*/
|
2336
2086
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2337
2087
|
};
|
2088
|
+
path: {
|
2089
|
+
ID: components["parameters"]["ID"];
|
2090
|
+
};
|
2091
|
+
};
|
2092
|
+
/** @description Details of the error returned. */
|
2093
|
+
requestBody: {
|
2094
|
+
content: {
|
2095
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
2096
|
+
};
|
2338
2097
|
};
|
2339
2098
|
responses: {
|
2340
2099
|
200: components["responses"]["200"];
|
@@ -2347,14 +2106,11 @@ export interface operations {
|
|
2347
2106
|
501: components["responses"]["501"];
|
2348
2107
|
503: components["responses"]["503"];
|
2349
2108
|
};
|
2350
|
-
/** Details of the error returned. */
|
2351
|
-
requestBody: {
|
2352
|
-
content: {
|
2353
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
2354
|
-
};
|
2355
|
-
};
|
2356
2109
|
};
|
2357
|
-
/**
|
2110
|
+
/**
|
2111
|
+
* Health check endpoint
|
2112
|
+
* @description The HTTP request GET /health is used to return the current status of the API.
|
2113
|
+
*/
|
2358
2114
|
HealthGet: {
|
2359
2115
|
responses: {
|
2360
2116
|
200: components["responses"]["200"];
|
@@ -2368,7 +2124,10 @@ export interface operations {
|
|
2368
2124
|
503: components["responses"]["503"];
|
2369
2125
|
};
|
2370
2126
|
};
|
2371
|
-
/**
|
2127
|
+
/**
|
2128
|
+
* Prometheus metrics endpoint
|
2129
|
+
* @description The HTTP request GET /metrics is used to return metrics for the API.
|
2130
|
+
*/
|
2372
2131
|
MetricsGet: {
|
2373
2132
|
responses: {
|
2374
2133
|
200: components["responses"]["200"];
|
@@ -2383,44 +2142,32 @@ export interface operations {
|
|
2383
2142
|
};
|
2384
2143
|
};
|
2385
2144
|
/**
|
2386
|
-
*
|
2145
|
+
* CreateConsentRequest
|
2146
|
+
* @description The HTTP request **POST /consentRequests** is used to request a DFSP to grant access to one or more
|
2387
2147
|
* accounts owned by a customer of the DFSP for the PISP who sends the request.
|
2388
2148
|
*/
|
2389
2149
|
CreateConsentRequest: {
|
2390
2150
|
parameters: {
|
2391
2151
|
header: {
|
2392
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2393
2152
|
"Content-Type": components["parameters"]["Content-Type"];
|
2394
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2395
2153
|
Date: components["parameters"]["Date"];
|
2396
|
-
/**
|
2397
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
2398
|
-
*
|
2399
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
2400
|
-
*/
|
2401
2154
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2402
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2403
2155
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2404
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2405
2156
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2406
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2407
2157
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2408
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2409
2158
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2410
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
2411
2159
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2412
|
-
/** 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/master/Specification%20Document%20Set). */
|
2413
2160
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2414
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2415
2161
|
Accept: components["parameters"]["Accept"];
|
2416
|
-
/**
|
2417
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2418
|
-
*
|
2419
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
2420
|
-
*/
|
2421
2162
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2422
2163
|
};
|
2423
2164
|
};
|
2165
|
+
/** @description The consentRequest to create */
|
2166
|
+
requestBody: {
|
2167
|
+
content: {
|
2168
|
+
"application/json": components["schemas"]["ConsentRequestsPostRequest"];
|
2169
|
+
};
|
2170
|
+
};
|
2424
2171
|
responses: {
|
2425
2172
|
202: components["responses"]["202"];
|
2426
2173
|
400: components["responses"]["400"];
|
@@ -2432,50 +2179,30 @@ export interface operations {
|
|
2432
2179
|
501: components["responses"]["501"];
|
2433
2180
|
503: components["responses"]["503"];
|
2434
2181
|
};
|
2435
|
-
/** The consentRequest to create */
|
2436
|
-
requestBody: {
|
2437
|
-
content: {
|
2438
|
-
"application/json": components["schemas"]["ConsentRequestsPostRequest"];
|
2439
|
-
};
|
2440
|
-
};
|
2441
2182
|
};
|
2442
2183
|
/**
|
2443
|
-
*
|
2184
|
+
* GetConsentRequestsById
|
2185
|
+
* @description The HTTP request `GET /consentRequests/{ID}` is used to get information about a previously
|
2444
2186
|
* requested consent. The *{ID}* in the URI should contain the consentRequestId that was assigned to the
|
2445
2187
|
* request by the PISP when the PISP originated the request.
|
2446
2188
|
*/
|
2447
2189
|
GetConsentRequestsById: {
|
2448
2190
|
parameters: {
|
2449
|
-
path: {
|
2450
|
-
/** The identifier value. */
|
2451
|
-
ID: components["parameters"]["ID"];
|
2452
|
-
};
|
2453
2191
|
header: {
|
2454
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2455
2192
|
"Content-Type": components["parameters"]["Content-Type"];
|
2456
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2457
2193
|
Date: components["parameters"]["Date"];
|
2458
|
-
/**
|
2459
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
2460
|
-
*
|
2461
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
2462
|
-
*/
|
2463
2194
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2464
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2465
2195
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2466
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2467
2196
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2468
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2469
2197
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2470
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2471
2198
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2472
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
2473
2199
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2474
|
-
/** 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/master/Specification%20Document%20Set). */
|
2475
2200
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2476
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2477
2201
|
Accept: components["parameters"]["Accept"];
|
2478
2202
|
};
|
2203
|
+
path: {
|
2204
|
+
ID: components["parameters"]["ID"];
|
2205
|
+
};
|
2479
2206
|
};
|
2480
2207
|
responses: {
|
2481
2208
|
202: components["responses"]["202"];
|
@@ -2490,7 +2217,8 @@ export interface operations {
|
|
2490
2217
|
};
|
2491
2218
|
};
|
2492
2219
|
/**
|
2493
|
-
*
|
2220
|
+
* UpdateConsentRequest
|
2221
|
+
* @description A DFSP uses this callback to (1) inform the PISP that the consentRequest has been accepted,
|
2494
2222
|
* and (2) communicate to the PISP which `authChannel` it should use to authenticate their user
|
2495
2223
|
* with.
|
2496
2224
|
*
|
@@ -2502,40 +2230,26 @@ export interface operations {
|
|
2502
2230
|
*/
|
2503
2231
|
UpdateConsentRequest: {
|
2504
2232
|
parameters: {
|
2505
|
-
path: {
|
2506
|
-
/** The identifier value. */
|
2507
|
-
ID: components["parameters"]["ID"];
|
2508
|
-
};
|
2509
2233
|
header: {
|
2510
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2511
2234
|
"Content-Type": components["parameters"]["Content-Type"];
|
2512
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2513
2235
|
Date: components["parameters"]["Date"];
|
2514
|
-
/**
|
2515
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
2516
|
-
*
|
2517
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
2518
|
-
*/
|
2519
2236
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2520
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2521
2237
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2522
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2523
2238
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2524
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2525
2239
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2526
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2527
2240
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2528
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
2529
2241
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2530
|
-
/** 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/master/Specification%20Document%20Set). */
|
2531
2242
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2532
|
-
/**
|
2533
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2534
|
-
*
|
2535
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
2536
|
-
*/
|
2537
2243
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2538
2244
|
};
|
2245
|
+
path: {
|
2246
|
+
ID: components["parameters"]["ID"];
|
2247
|
+
};
|
2248
|
+
};
|
2249
|
+
requestBody: {
|
2250
|
+
content: {
|
2251
|
+
"application/json": components["schemas"]["ConsentRequestsIDPutResponseWeb"] | components["schemas"]["ConsentRequestsIDPutResponseOTP"];
|
2252
|
+
};
|
2539
2253
|
};
|
2540
2254
|
responses: {
|
2541
2255
|
202: components["responses"]["202"];
|
@@ -2548,51 +2262,34 @@ export interface operations {
|
|
2548
2262
|
501: components["responses"]["501"];
|
2549
2263
|
503: components["responses"]["503"];
|
2550
2264
|
};
|
2551
|
-
requestBody: {
|
2552
|
-
content: {
|
2553
|
-
"application/json": components["schemas"]["ConsentRequestsIDPutResponseWeb"] | components["schemas"]["ConsentRequestsIDPutResponseOTP"];
|
2554
|
-
};
|
2555
|
-
};
|
2556
2265
|
};
|
2557
|
-
/**
|
2266
|
+
/**
|
2267
|
+
* PatchConsentRequest
|
2268
|
+
* @description After the user completes an out-of-band authorization with the DFSP, the PISP will receive a token which they can use to prove to the DFSP that the user trusts this PISP.
|
2269
|
+
*/
|
2558
2270
|
PatchConsentRequest: {
|
2559
2271
|
parameters: {
|
2560
|
-
path: {
|
2561
|
-
/** The identifier value. */
|
2562
|
-
ID: components["parameters"]["ID"];
|
2563
|
-
};
|
2564
2272
|
header: {
|
2565
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2566
2273
|
"Content-Type": components["parameters"]["Content-Type"];
|
2567
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2568
2274
|
Date: components["parameters"]["Date"];
|
2569
|
-
/**
|
2570
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
2571
|
-
*
|
2572
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
2573
|
-
*/
|
2574
2275
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2575
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2576
2276
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2577
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2578
2277
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2579
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2580
2278
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2581
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2582
2279
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2583
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
2584
2280
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2585
|
-
/** 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/master/Specification%20Document%20Set). */
|
2586
2281
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2587
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2588
2282
|
Accept: components["parameters"]["Accept"];
|
2589
|
-
/**
|
2590
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2591
|
-
*
|
2592
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
2593
|
-
*/
|
2594
2283
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2595
2284
|
};
|
2285
|
+
path: {
|
2286
|
+
ID: components["parameters"]["ID"];
|
2287
|
+
};
|
2288
|
+
};
|
2289
|
+
requestBody: {
|
2290
|
+
content: {
|
2291
|
+
"application/json": components["schemas"]["ConsentRequestsIDPatchRequest"];
|
2292
|
+
};
|
2596
2293
|
};
|
2597
2294
|
responses: {
|
2598
2295
|
202: components["responses"]["202"];
|
@@ -2605,49 +2302,34 @@ export interface operations {
|
|
2605
2302
|
501: components["responses"]["501"];
|
2606
2303
|
503: components["responses"]["503"];
|
2607
2304
|
};
|
2608
|
-
requestBody: {
|
2609
|
-
content: {
|
2610
|
-
"application/json": components["schemas"]["ConsentRequestsIDPatchRequest"];
|
2611
|
-
};
|
2612
|
-
};
|
2613
2305
|
};
|
2614
|
-
/**
|
2306
|
+
/**
|
2307
|
+
* NotifyErrorConsentRequests
|
2308
|
+
* @description DFSP responds to the PISP if something went wrong with validating an OTP or secret.
|
2309
|
+
*/
|
2615
2310
|
NotifyErrorConsentRequests: {
|
2616
2311
|
parameters: {
|
2617
|
-
path: {
|
2618
|
-
/** The identifier value. */
|
2619
|
-
ID: components["parameters"]["ID"];
|
2620
|
-
};
|
2621
2312
|
header: {
|
2622
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2623
2313
|
"Content-Type": components["parameters"]["Content-Type"];
|
2624
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2625
2314
|
Date: components["parameters"]["Date"];
|
2626
|
-
/**
|
2627
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
2628
|
-
*
|
2629
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
2630
|
-
*/
|
2631
2315
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2632
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2633
2316
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2634
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2635
2317
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2636
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2637
2318
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2638
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2639
2319
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2640
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
2641
2320
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2642
|
-
/** 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/master/Specification%20Document%20Set). */
|
2643
2321
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2644
|
-
/**
|
2645
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2646
|
-
*
|
2647
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
2648
|
-
*/
|
2649
2322
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2650
2323
|
};
|
2324
|
+
path: {
|
2325
|
+
ID: components["parameters"]["ID"];
|
2326
|
+
};
|
2327
|
+
};
|
2328
|
+
/** @description Error information returned. */
|
2329
|
+
requestBody: {
|
2330
|
+
content: {
|
2331
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
2332
|
+
};
|
2651
2333
|
};
|
2652
2334
|
responses: {
|
2653
2335
|
200: components["responses"]["200"];
|
@@ -2660,49 +2342,32 @@ export interface operations {
|
|
2660
2342
|
501: components["responses"]["501"];
|
2661
2343
|
503: components["responses"]["503"];
|
2662
2344
|
};
|
2663
|
-
/** Error information returned. */
|
2664
|
-
requestBody: {
|
2665
|
-
content: {
|
2666
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
2667
|
-
};
|
2668
|
-
};
|
2669
2345
|
};
|
2670
|
-
/**
|
2346
|
+
/**
|
2347
|
+
* PostConsents
|
2348
|
+
* @description The **POST /consents** request is used to request the creation of a consent for interactions between a PISP and the DFSP who owns the account which a PISP’s customer wants to allow the PISP access to.
|
2349
|
+
*/
|
2671
2350
|
PostConsents: {
|
2672
2351
|
parameters: {
|
2673
2352
|
header: {
|
2674
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2675
2353
|
"Content-Type": components["parameters"]["Content-Type"];
|
2676
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2677
2354
|
Date: components["parameters"]["Date"];
|
2678
|
-
/**
|
2679
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
2680
|
-
*
|
2681
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
2682
|
-
*/
|
2683
2355
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2684
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2685
2356
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2686
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2687
2357
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2688
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2689
2358
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2690
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2691
2359
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2692
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
2693
2360
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2694
|
-
/** 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/master/Specification%20Document%20Set). */
|
2695
2361
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2696
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2697
2362
|
Accept: components["parameters"]["Accept"];
|
2698
|
-
/**
|
2699
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2700
|
-
*
|
2701
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
2702
|
-
*/
|
2703
2363
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2704
2364
|
};
|
2705
2365
|
};
|
2366
|
+
requestBody: {
|
2367
|
+
content: {
|
2368
|
+
"application/json": components["schemas"]["ConsentsPostRequestAUTH"] | components["schemas"]["ConsentsPostRequestPISP"];
|
2369
|
+
};
|
2370
|
+
};
|
2706
2371
|
responses: {
|
2707
2372
|
202: components["responses"]["202"];
|
2708
2373
|
400: components["responses"]["400"];
|
@@ -2714,45 +2379,28 @@ export interface operations {
|
|
2714
2379
|
501: components["responses"]["501"];
|
2715
2380
|
503: components["responses"]["503"];
|
2716
2381
|
};
|
2717
|
-
requestBody: {
|
2718
|
-
content: {
|
2719
|
-
"application/json": components["schemas"]["ConsentsPostRequestAUTH"] | components["schemas"]["ConsentsPostRequestPISP"];
|
2720
|
-
};
|
2721
|
-
};
|
2722
2382
|
};
|
2723
|
-
/**
|
2383
|
+
/**
|
2384
|
+
* GetConsent
|
2385
|
+
* @description The **GET /consents/**_{ID}_ resource allows a party to enquire after the status of a consent. The *{ID}* used in the URI of the request should be the consent request ID which was used to identify the consent when it was created.
|
2386
|
+
*/
|
2724
2387
|
GetConsent: {
|
2725
2388
|
parameters: {
|
2726
|
-
path: {
|
2727
|
-
/** The identifier value. */
|
2728
|
-
ID: components["parameters"]["ID"];
|
2729
|
-
};
|
2730
2389
|
header: {
|
2731
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2732
2390
|
"Content-Type": components["parameters"]["Content-Type"];
|
2733
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2734
2391
|
Date: components["parameters"]["Date"];
|
2735
|
-
/**
|
2736
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
2737
|
-
*
|
2738
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
2739
|
-
*/
|
2740
2392
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2741
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2742
2393
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2743
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2744
2394
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2745
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2746
2395
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2747
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2748
2396
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2749
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
2750
2397
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2751
|
-
/** 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/master/Specification%20Document%20Set). */
|
2752
2398
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2753
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2754
2399
|
Accept: components["parameters"]["Accept"];
|
2755
2400
|
};
|
2401
|
+
path: {
|
2402
|
+
ID: components["parameters"]["ID"];
|
2403
|
+
};
|
2756
2404
|
};
|
2757
2405
|
responses: {
|
2758
2406
|
202: components["responses"]["202"];
|
@@ -2767,47 +2415,34 @@ export interface operations {
|
|
2767
2415
|
};
|
2768
2416
|
};
|
2769
2417
|
/**
|
2770
|
-
*
|
2418
|
+
* PutConsentByID
|
2419
|
+
* @description The HTTP request `PUT /consents/{ID}` is used by the PISP and Auth Service.
|
2771
2420
|
*
|
2772
2421
|
* - Called by a `PISP` to after signing a challenge. Sent to an DFSP for verification.
|
2773
2422
|
* - Called by a `auth-service` to notify a DFSP that a credential has been verified and registered.
|
2774
2423
|
*/
|
2775
2424
|
PutConsentByID: {
|
2776
2425
|
parameters: {
|
2777
|
-
path: {
|
2778
|
-
/** The identifier value. */
|
2779
|
-
ID: components["parameters"]["ID"];
|
2780
|
-
};
|
2781
2426
|
header: {
|
2782
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2783
2427
|
"Content-Type": components["parameters"]["Content-Type"];
|
2784
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2785
2428
|
Date: components["parameters"]["Date"];
|
2786
|
-
/**
|
2787
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
2788
|
-
*
|
2789
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
2790
|
-
*/
|
2791
2429
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2792
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2793
2430
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2794
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2795
2431
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2796
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2797
2432
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2798
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2799
2433
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2800
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
2801
2434
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2802
|
-
/** 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/master/Specification%20Document%20Set). */
|
2803
2435
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2804
|
-
/**
|
2805
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2806
|
-
*
|
2807
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
2808
|
-
*/
|
2809
2436
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2810
2437
|
};
|
2438
|
+
path: {
|
2439
|
+
ID: components["parameters"]["ID"];
|
2440
|
+
};
|
2441
|
+
};
|
2442
|
+
requestBody: {
|
2443
|
+
content: {
|
2444
|
+
"application/json": components["schemas"]["ConsentsIDPutResponseSigned"] | components["schemas"]["ConsentsIDPutResponseVerified"];
|
2445
|
+
};
|
2811
2446
|
};
|
2812
2447
|
responses: {
|
2813
2448
|
200: components["responses"]["200"];
|
@@ -2821,14 +2456,9 @@ export interface operations {
|
|
2821
2456
|
501: components["responses"]["501"];
|
2822
2457
|
503: components["responses"]["503"];
|
2823
2458
|
};
|
2824
|
-
requestBody: {
|
2825
|
-
content: {
|
2826
|
-
"application/json": components["schemas"]["ConsentsIDPutResponseSigned"] | components["schemas"]["ConsentsIDPutResponseVerified"];
|
2827
|
-
};
|
2828
|
-
};
|
2829
2459
|
};
|
2830
2460
|
/**
|
2831
|
-
* Used by PISP, DFSP
|
2461
|
+
* @description Used by PISP, DFSP
|
2832
2462
|
*
|
2833
2463
|
* The **DELETE /consents/**_{ID}_ request is used to request the revocation of a previously agreed consent.
|
2834
2464
|
* For tracing and auditing purposes, the switch should be sure not to delete the consent physically;
|
@@ -2837,36 +2467,21 @@ export interface operations {
|
|
2837
2467
|
*/
|
2838
2468
|
DeleteConsentByID: {
|
2839
2469
|
parameters: {
|
2840
|
-
path: {
|
2841
|
-
/** The identifier value. */
|
2842
|
-
ID: components["parameters"]["ID"];
|
2843
|
-
};
|
2844
2470
|
header: {
|
2845
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2846
2471
|
"Content-Type": components["parameters"]["Content-Type"];
|
2847
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2848
2472
|
Date: components["parameters"]["Date"];
|
2849
|
-
/**
|
2850
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
2851
|
-
*
|
2852
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
2853
|
-
*/
|
2854
2473
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2855
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2856
2474
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2857
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2858
2475
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2859
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2860
2476
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2861
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2862
2477
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2863
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
2864
2478
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2865
|
-
/** 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/master/Specification%20Document%20Set). */
|
2866
2479
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2867
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2868
2480
|
Accept: components["parameters"]["Accept"];
|
2869
2481
|
};
|
2482
|
+
path: {
|
2483
|
+
ID: components["parameters"]["ID"];
|
2484
|
+
};
|
2870
2485
|
};
|
2871
2486
|
responses: {
|
2872
2487
|
202: components["responses"]["202"];
|
@@ -2881,7 +2496,8 @@ export interface operations {
|
|
2881
2496
|
};
|
2882
2497
|
};
|
2883
2498
|
/**
|
2884
|
-
*
|
2499
|
+
* PatchConsentByID
|
2500
|
+
* @description The HTTP request `PATCH /consents/{ID}` is used
|
2885
2501
|
*
|
2886
2502
|
* - In account linking in the Credential Registration phase. Used by a DFSP
|
2887
2503
|
* to notify a PISP a credential has been verified and registered with an
|
@@ -2895,42 +2511,27 @@ export interface operations {
|
|
2895
2511
|
*/
|
2896
2512
|
PatchConsentByID: {
|
2897
2513
|
parameters: {
|
2898
|
-
path: {
|
2899
|
-
/** The identifier value. */
|
2900
|
-
ID: components["parameters"]["ID"];
|
2901
|
-
};
|
2902
2514
|
header: {
|
2903
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2904
2515
|
"Content-Type": components["parameters"]["Content-Type"];
|
2905
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2906
2516
|
Date: components["parameters"]["Date"];
|
2907
|
-
/**
|
2908
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
2909
|
-
*
|
2910
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
2911
|
-
*/
|
2912
2517
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2913
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2914
2518
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2915
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2916
2519
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2917
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2918
2520
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2919
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2920
2521
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2921
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
2922
2522
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2923
|
-
/** 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/master/Specification%20Document%20Set). */
|
2924
2523
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2925
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2926
2524
|
Accept: components["parameters"]["Accept"];
|
2927
|
-
/**
|
2928
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2929
|
-
*
|
2930
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
2931
|
-
*/
|
2932
2525
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2933
2526
|
};
|
2527
|
+
path: {
|
2528
|
+
ID: components["parameters"]["ID"];
|
2529
|
+
};
|
2530
|
+
};
|
2531
|
+
requestBody: {
|
2532
|
+
content: {
|
2533
|
+
"application/json": components["schemas"]["ConsentsIDPatchResponseVerified"] | components["schemas"]["ConsentsIDPatchResponseRevoked"];
|
2534
|
+
};
|
2934
2535
|
};
|
2935
2536
|
responses: {
|
2936
2537
|
200: components["responses"]["200"];
|
@@ -2943,49 +2544,34 @@ export interface operations {
|
|
2943
2544
|
501: components["responses"]["501"];
|
2944
2545
|
503: components["responses"]["503"];
|
2945
2546
|
};
|
2946
|
-
requestBody: {
|
2947
|
-
content: {
|
2948
|
-
"application/json": components["schemas"]["ConsentsIDPatchResponseVerified"] | components["schemas"]["ConsentsIDPatchResponseRevoked"];
|
2949
|
-
};
|
2950
|
-
};
|
2951
2547
|
};
|
2952
|
-
/**
|
2548
|
+
/**
|
2549
|
+
* NotifyErrorConsents
|
2550
|
+
* @description DFSP responds to the PISP if something went wrong with validating or storing consent.
|
2551
|
+
*/
|
2953
2552
|
NotifyErrorConsents: {
|
2954
2553
|
parameters: {
|
2955
|
-
path: {
|
2956
|
-
/** The identifier value. */
|
2957
|
-
ID: components["parameters"]["ID"];
|
2958
|
-
};
|
2959
2554
|
header: {
|
2960
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2961
2555
|
"Content-Type": components["parameters"]["Content-Type"];
|
2962
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2963
2556
|
Date: components["parameters"]["Date"];
|
2964
|
-
/**
|
2965
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
2966
|
-
*
|
2967
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
2968
|
-
*/
|
2969
2557
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2970
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2971
2558
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2972
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2973
2559
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2974
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2975
2560
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2976
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2977
2561
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2978
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
2979
2562
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2980
|
-
/** 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/master/Specification%20Document%20Set). */
|
2981
2563
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2982
|
-
/**
|
2983
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2984
|
-
*
|
2985
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
2986
|
-
*/
|
2987
2564
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2988
2565
|
};
|
2566
|
+
path: {
|
2567
|
+
ID: components["parameters"]["ID"];
|
2568
|
+
};
|
2569
|
+
};
|
2570
|
+
/** @description Error information returned. */
|
2571
|
+
requestBody: {
|
2572
|
+
content: {
|
2573
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
2574
|
+
};
|
2989
2575
|
};
|
2990
2576
|
responses: {
|
2991
2577
|
200: components["responses"]["200"];
|
@@ -2998,49 +2584,33 @@ export interface operations {
|
|
2998
2584
|
501: components["responses"]["501"];
|
2999
2585
|
503: components["responses"]["503"];
|
3000
2586
|
};
|
3001
|
-
/** Error information returned. */
|
3002
|
-
requestBody: {
|
3003
|
-
content: {
|
3004
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
3005
|
-
};
|
3006
|
-
};
|
3007
2587
|
};
|
3008
|
-
/**
|
2588
|
+
/**
|
2589
|
+
* Create bulk participant information
|
2590
|
+
* @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.
|
2591
|
+
*/
|
3009
2592
|
Participants1: {
|
3010
2593
|
parameters: {
|
3011
2594
|
header: {
|
3012
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3013
2595
|
"Content-Type": components["parameters"]["Content-Type"];
|
3014
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3015
2596
|
Date: components["parameters"]["Date"];
|
3016
|
-
/**
|
3017
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3018
|
-
*
|
3019
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
3020
|
-
*/
|
3021
2597
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3022
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3023
2598
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3024
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3025
2599
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3026
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3027
2600
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3028
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3029
2601
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3030
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
3031
2602
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3032
|
-
/** 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/master/Specification%20Document%20Set). */
|
3033
2603
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3034
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3035
2604
|
Accept: components["parameters"]["Accept"];
|
3036
|
-
/**
|
3037
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3038
|
-
*
|
3039
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
3040
|
-
*/
|
3041
2605
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3042
2606
|
};
|
3043
2607
|
};
|
2608
|
+
/** @description Participant information to be created. */
|
2609
|
+
requestBody: {
|
2610
|
+
content: {
|
2611
|
+
"application/json": components["schemas"]["ParticipantsPostRequest"];
|
2612
|
+
};
|
2613
|
+
};
|
3044
2614
|
responses: {
|
3045
2615
|
202: components["responses"]["202"];
|
3046
2616
|
400: components["responses"]["400"];
|
@@ -3052,50 +2622,34 @@ export interface operations {
|
|
3052
2622
|
501: components["responses"]["501"];
|
3053
2623
|
503: components["responses"]["503"];
|
3054
2624
|
};
|
3055
|
-
/** Participant information to be created. */
|
3056
|
-
requestBody: {
|
3057
|
-
content: {
|
3058
|
-
"application/json": components["schemas"]["ParticipantsPostRequest"];
|
3059
|
-
};
|
3060
|
-
};
|
3061
2625
|
};
|
3062
|
-
/**
|
2626
|
+
/**
|
2627
|
+
* Return bulk participant information
|
2628
|
+
* @description The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities.
|
2629
|
+
*/
|
3063
2630
|
PutParticipantsByID: {
|
3064
2631
|
parameters: {
|
3065
|
-
path: {
|
3066
|
-
/** The identifier value. */
|
3067
|
-
ID: components["parameters"]["ID"];
|
3068
|
-
};
|
3069
2632
|
header: {
|
3070
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3071
2633
|
"Content-Type": components["parameters"]["Content-Type"];
|
3072
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3073
2634
|
Date: components["parameters"]["Date"];
|
3074
|
-
/**
|
3075
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3076
|
-
*
|
3077
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
3078
|
-
*/
|
3079
2635
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3080
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3081
2636
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3082
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3083
2637
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3084
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3085
2638
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3086
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3087
2639
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3088
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
3089
2640
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3090
|
-
/** 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/master/Specification%20Document%20Set). */
|
3091
2641
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3092
|
-
/**
|
3093
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3094
|
-
*
|
3095
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
3096
|
-
*/
|
3097
2642
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3098
2643
|
};
|
2644
|
+
path: {
|
2645
|
+
ID: components["parameters"]["ID"];
|
2646
|
+
};
|
2647
|
+
};
|
2648
|
+
/** @description Participant information returned. */
|
2649
|
+
requestBody: {
|
2650
|
+
content: {
|
2651
|
+
"application/json": components["schemas"]["ParticipantsIDPutResponse"];
|
2652
|
+
};
|
3099
2653
|
};
|
3100
2654
|
responses: {
|
3101
2655
|
200: components["responses"]["200"];
|
@@ -3108,50 +2662,34 @@ export interface operations {
|
|
3108
2662
|
501: components["responses"]["501"];
|
3109
2663
|
503: components["responses"]["503"];
|
3110
2664
|
};
|
3111
|
-
/** Participant information returned. */
|
3112
|
-
requestBody: {
|
3113
|
-
content: {
|
3114
|
-
"application/json": components["schemas"]["ParticipantsIDPutResponse"];
|
3115
|
-
};
|
3116
|
-
};
|
3117
2665
|
};
|
3118
|
-
/**
|
2666
|
+
/**
|
2667
|
+
* Return bulk participant information error
|
2668
|
+
* @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.
|
2669
|
+
*/
|
3119
2670
|
PutParticipantsByIDAndError: {
|
3120
2671
|
parameters: {
|
3121
|
-
path: {
|
3122
|
-
/** The identifier value. */
|
3123
|
-
ID: components["parameters"]["ID"];
|
3124
|
-
};
|
3125
2672
|
header: {
|
3126
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3127
2673
|
"Content-Type": components["parameters"]["Content-Type"];
|
3128
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3129
2674
|
Date: components["parameters"]["Date"];
|
3130
|
-
/**
|
3131
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3132
|
-
*
|
3133
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
3134
|
-
*/
|
3135
2675
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3136
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3137
2676
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3138
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3139
2677
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3140
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3141
2678
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3142
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3143
2679
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3144
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
3145
2680
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3146
|
-
/** 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/master/Specification%20Document%20Set). */
|
3147
2681
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3148
|
-
/**
|
3149
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3150
|
-
*
|
3151
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
3152
|
-
*/
|
3153
2682
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3154
2683
|
};
|
2684
|
+
path: {
|
2685
|
+
ID: components["parameters"]["ID"];
|
2686
|
+
};
|
2687
|
+
};
|
2688
|
+
/** @description Details of the error returned. */
|
2689
|
+
requestBody: {
|
2690
|
+
content: {
|
2691
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
2692
|
+
};
|
3155
2693
|
};
|
3156
2694
|
responses: {
|
3157
2695
|
200: components["responses"]["200"];
|
@@ -3164,48 +2702,29 @@ export interface operations {
|
|
3164
2702
|
501: components["responses"]["501"];
|
3165
2703
|
503: components["responses"]["503"];
|
3166
2704
|
};
|
3167
|
-
/** Details of the error returned. */
|
3168
|
-
requestBody: {
|
3169
|
-
content: {
|
3170
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
3171
|
-
};
|
3172
|
-
};
|
3173
2705
|
};
|
3174
|
-
/**
|
2706
|
+
/**
|
2707
|
+
* Look up participant information
|
2708
|
+
* @description The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency.
|
2709
|
+
*/
|
3175
2710
|
ParticipantsByTypeAndID: {
|
3176
2711
|
parameters: {
|
3177
|
-
path: {
|
3178
|
-
/** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
3179
|
-
Type: components["parameters"]["Type"];
|
3180
|
-
/** The identifier value. */
|
3181
|
-
ID: components["parameters"]["ID"];
|
3182
|
-
};
|
3183
2712
|
header: {
|
3184
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3185
2713
|
"Content-Type": components["parameters"]["Content-Type"];
|
3186
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3187
2714
|
Date: components["parameters"]["Date"];
|
3188
|
-
/**
|
3189
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3190
|
-
*
|
3191
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
3192
|
-
*/
|
3193
2715
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3194
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3195
2716
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3196
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3197
2717
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3198
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3199
2718
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3200
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3201
2719
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3202
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
3203
2720
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3204
|
-
/** 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/master/Specification%20Document%20Set). */
|
3205
2721
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3206
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3207
2722
|
Accept: components["parameters"]["Accept"];
|
3208
2723
|
};
|
2724
|
+
path: {
|
2725
|
+
Type: components["parameters"]["Type"];
|
2726
|
+
ID: components["parameters"]["ID"];
|
2727
|
+
};
|
3209
2728
|
};
|
3210
2729
|
responses: {
|
3211
2730
|
202: components["responses"]["202"];
|
@@ -3219,45 +2738,34 @@ export interface operations {
|
|
3219
2738
|
503: components["responses"]["503"];
|
3220
2739
|
};
|
3221
2740
|
};
|
3222
|
-
/**
|
2741
|
+
/**
|
2742
|
+
* Return participant information
|
2743
|
+
* @description The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party.
|
2744
|
+
*/
|
3223
2745
|
ParticipantsByTypeAndID3: {
|
3224
2746
|
parameters: {
|
3225
|
-
path: {
|
3226
|
-
/** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
3227
|
-
Type: components["parameters"]["Type"];
|
3228
|
-
/** The identifier value. */
|
3229
|
-
ID: components["parameters"]["ID"];
|
3230
|
-
};
|
3231
2747
|
header: {
|
3232
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3233
2748
|
"Content-Type": components["parameters"]["Content-Type"];
|
3234
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3235
2749
|
Date: components["parameters"]["Date"];
|
3236
|
-
/**
|
3237
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3238
|
-
*
|
3239
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
3240
|
-
*/
|
3241
2750
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3242
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3243
2751
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3244
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3245
2752
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3246
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3247
2753
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3248
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3249
2754
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3250
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
3251
2755
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3252
|
-
/** 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/master/Specification%20Document%20Set). */
|
3253
2756
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3254
|
-
/**
|
3255
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3256
|
-
*
|
3257
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
3258
|
-
*/
|
3259
2757
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3260
2758
|
};
|
2759
|
+
path: {
|
2760
|
+
Type: components["parameters"]["Type"];
|
2761
|
+
ID: components["parameters"]["ID"];
|
2762
|
+
};
|
2763
|
+
};
|
2764
|
+
/** @description Participant information returned. */
|
2765
|
+
requestBody: {
|
2766
|
+
content: {
|
2767
|
+
"application/json": components["schemas"]["ParticipantsTypeIDPutResponse"];
|
2768
|
+
};
|
3261
2769
|
};
|
3262
2770
|
responses: {
|
3263
2771
|
200: components["responses"]["200"];
|
@@ -3270,54 +2778,36 @@ export interface operations {
|
|
3270
2778
|
501: components["responses"]["501"];
|
3271
2779
|
503: components["responses"]["503"];
|
3272
2780
|
};
|
3273
|
-
/** Participant information returned. */
|
3274
|
-
requestBody: {
|
3275
|
-
content: {
|
3276
|
-
"application/json": components["schemas"]["ParticipantsTypeIDPutResponse"];
|
3277
|
-
};
|
3278
|
-
};
|
3279
2781
|
};
|
3280
|
-
/**
|
2782
|
+
/**
|
2783
|
+
* Create participant information
|
2784
|
+
* @description The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). An ExtensionList element has been added to this reqeust in version v1.1
|
2785
|
+
*/
|
3281
2786
|
ParticipantsByIDAndType: {
|
3282
2787
|
parameters: {
|
3283
|
-
path: {
|
3284
|
-
/** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
3285
|
-
Type: components["parameters"]["Type"];
|
3286
|
-
/** The identifier value. */
|
3287
|
-
ID: components["parameters"]["ID"];
|
3288
|
-
};
|
3289
2788
|
header: {
|
3290
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3291
2789
|
"Content-Type": components["parameters"]["Content-Type"];
|
3292
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3293
2790
|
Date: components["parameters"]["Date"];
|
3294
|
-
/**
|
3295
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3296
|
-
*
|
3297
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
3298
|
-
*/
|
3299
2791
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3300
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3301
2792
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3302
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3303
2793
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3304
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3305
2794
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3306
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3307
2795
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3308
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
3309
2796
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3310
|
-
/** 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/master/Specification%20Document%20Set). */
|
3311
2797
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3312
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3313
2798
|
Accept: components["parameters"]["Accept"];
|
3314
|
-
/**
|
3315
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3316
|
-
*
|
3317
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
3318
|
-
*/
|
3319
2799
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3320
2800
|
};
|
2801
|
+
path: {
|
2802
|
+
Type: components["parameters"]["Type"];
|
2803
|
+
ID: components["parameters"]["ID"];
|
2804
|
+
};
|
2805
|
+
};
|
2806
|
+
/** @description Participant information to be created. */
|
2807
|
+
requestBody: {
|
2808
|
+
content: {
|
2809
|
+
"application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"];
|
2810
|
+
};
|
3321
2811
|
};
|
3322
2812
|
responses: {
|
3323
2813
|
202: components["responses"]["202"];
|
@@ -3330,52 +2820,31 @@ export interface operations {
|
|
3330
2820
|
501: components["responses"]["501"];
|
3331
2821
|
503: components["responses"]["503"];
|
3332
2822
|
};
|
3333
|
-
/** Participant information to be created. */
|
3334
|
-
requestBody: {
|
3335
|
-
content: {
|
3336
|
-
"application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"];
|
3337
|
-
};
|
3338
|
-
};
|
3339
2823
|
};
|
3340
2824
|
/**
|
3341
|
-
*
|
2825
|
+
* Delete participant information
|
2826
|
+
* @description The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency.
|
3342
2827
|
*
|
3343
2828
|
* **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.
|
3344
2829
|
*/
|
3345
2830
|
ParticipantsByTypeAndID2: {
|
3346
2831
|
parameters: {
|
3347
|
-
path: {
|
3348
|
-
/** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
3349
|
-
Type: components["parameters"]["Type"];
|
3350
|
-
/** The identifier value. */
|
3351
|
-
ID: components["parameters"]["ID"];
|
3352
|
-
};
|
3353
2832
|
header: {
|
3354
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3355
2833
|
"Content-Type": components["parameters"]["Content-Type"];
|
3356
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3357
2834
|
Date: components["parameters"]["Date"];
|
3358
|
-
/**
|
3359
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3360
|
-
*
|
3361
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
3362
|
-
*/
|
3363
2835
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3364
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3365
2836
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3366
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3367
2837
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3368
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3369
2838
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3370
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3371
2839
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3372
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
3373
2840
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3374
|
-
/** 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/master/Specification%20Document%20Set). */
|
3375
2841
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3376
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3377
2842
|
Accept: components["parameters"]["Accept"];
|
3378
2843
|
};
|
2844
|
+
path: {
|
2845
|
+
Type: components["parameters"]["Type"];
|
2846
|
+
ID: components["parameters"]["ID"];
|
2847
|
+
};
|
3379
2848
|
};
|
3380
2849
|
responses: {
|
3381
2850
|
202: components["responses"]["202"];
|
@@ -3389,45 +2858,34 @@ export interface operations {
|
|
3389
2858
|
503: components["responses"]["503"];
|
3390
2859
|
};
|
3391
2860
|
};
|
3392
|
-
/**
|
2861
|
+
/**
|
2862
|
+
* Return participant information error
|
2863
|
+
* @description If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used.
|
2864
|
+
*/
|
3393
2865
|
ParticipantsErrorByTypeAndID: {
|
3394
2866
|
parameters: {
|
3395
|
-
path: {
|
3396
|
-
/** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
3397
|
-
Type: components["parameters"]["Type"];
|
3398
|
-
/** The identifier value. */
|
3399
|
-
ID: components["parameters"]["ID"];
|
3400
|
-
};
|
3401
2867
|
header: {
|
3402
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3403
2868
|
"Content-Type": components["parameters"]["Content-Type"];
|
3404
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3405
2869
|
Date: components["parameters"]["Date"];
|
3406
|
-
/**
|
3407
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3408
|
-
*
|
3409
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
3410
|
-
*/
|
3411
2870
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3412
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3413
2871
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3414
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3415
2872
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3416
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3417
2873
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3418
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3419
2874
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3420
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
3421
2875
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3422
|
-
/** 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/master/Specification%20Document%20Set). */
|
3423
2876
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3424
|
-
/**
|
3425
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3426
|
-
*
|
3427
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
3428
|
-
*/
|
3429
2877
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3430
2878
|
};
|
2879
|
+
path: {
|
2880
|
+
Type: components["parameters"]["Type"];
|
2881
|
+
ID: components["parameters"]["ID"];
|
2882
|
+
};
|
2883
|
+
};
|
2884
|
+
/** @description Details of the error returned. */
|
2885
|
+
requestBody: {
|
2886
|
+
content: {
|
2887
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
2888
|
+
};
|
3431
2889
|
};
|
3432
2890
|
responses: {
|
3433
2891
|
200: components["responses"]["200"];
|
@@ -3440,49 +2898,29 @@ export interface operations {
|
|
3440
2898
|
501: components["responses"]["501"];
|
3441
2899
|
503: components["responses"]["503"];
|
3442
2900
|
};
|
3443
|
-
/** Details of the error returned. */
|
3444
|
-
requestBody: {
|
3445
|
-
content: {
|
3446
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
3447
|
-
};
|
3448
|
-
};
|
3449
2901
|
};
|
3450
2902
|
/**
|
3451
|
-
*
|
2903
|
+
* GetServicesByServiceType
|
2904
|
+
* @description The HTTP request `GET /services/{ServiceType}` is used to retrieve the list of participants
|
3452
2905
|
* that support a specified service.
|
3453
2906
|
*/
|
3454
2907
|
GetServicesByServiceType: {
|
3455
2908
|
parameters: {
|
3456
|
-
path: {
|
3457
|
-
/** The type of the service identifier. For example, `THIRD_PARTY_DFSP` */
|
3458
|
-
ServiceType: components["parameters"]["ServiceType"];
|
3459
|
-
};
|
3460
2909
|
header: {
|
3461
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3462
2910
|
"Content-Type": components["parameters"]["Content-Type"];
|
3463
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3464
2911
|
Date: components["parameters"]["Date"];
|
3465
|
-
/**
|
3466
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3467
|
-
*
|
3468
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
3469
|
-
*/
|
3470
2912
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3471
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3472
2913
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3473
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3474
2914
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3475
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3476
2915
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3477
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3478
2916
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3479
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
3480
2917
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3481
|
-
/** 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/master/Specification%20Document%20Set). */
|
3482
2918
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3483
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3484
2919
|
Accept: components["parameters"]["Accept"];
|
3485
2920
|
};
|
2921
|
+
path: {
|
2922
|
+
ServiceType: components["parameters"]["ServiceType"];
|
2923
|
+
};
|
3486
2924
|
};
|
3487
2925
|
responses: {
|
3488
2926
|
202: components["responses"]["202"];
|
@@ -3497,45 +2935,32 @@ export interface operations {
|
|
3497
2935
|
};
|
3498
2936
|
};
|
3499
2937
|
/**
|
3500
|
-
*
|
2938
|
+
* PutServicesByServiceType
|
2939
|
+
* @description The HTTP request `PUT /services/{ServiceType}` is used to return list of participants
|
3501
2940
|
* that support a specified service.
|
3502
2941
|
*/
|
3503
2942
|
PutServicesByServiceType: {
|
3504
2943
|
parameters: {
|
3505
|
-
path: {
|
3506
|
-
/** The type of the service identifier. For example, `THIRD_PARTY_DFSP` */
|
3507
|
-
ServiceType: components["parameters"]["ServiceType"];
|
3508
|
-
};
|
3509
2944
|
header: {
|
3510
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3511
2945
|
"Content-Type": components["parameters"]["Content-Type"];
|
3512
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3513
2946
|
Date: components["parameters"]["Date"];
|
3514
|
-
/**
|
3515
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3516
|
-
*
|
3517
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
3518
|
-
*/
|
3519
2947
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3520
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3521
2948
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3522
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3523
2949
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3524
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3525
2950
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3526
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3527
2951
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3528
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
3529
2952
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3530
|
-
/** 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/master/Specification%20Document%20Set). */
|
3531
2953
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3532
|
-
/**
|
3533
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3534
|
-
*
|
3535
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
3536
|
-
*/
|
3537
2954
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3538
2955
|
};
|
2956
|
+
path: {
|
2957
|
+
ServiceType: components["parameters"]["ServiceType"];
|
2958
|
+
};
|
2959
|
+
};
|
2960
|
+
requestBody: {
|
2961
|
+
content: {
|
2962
|
+
"application/json": components["schemas"]["ServicesServiceTypePutResponse"];
|
2963
|
+
};
|
3539
2964
|
};
|
3540
2965
|
responses: {
|
3541
2966
|
200: components["responses"]["200"];
|
@@ -3548,49 +2973,34 @@ export interface operations {
|
|
3548
2973
|
501: components["responses"]["501"];
|
3549
2974
|
503: components["responses"]["503"];
|
3550
2975
|
};
|
3551
|
-
requestBody: {
|
3552
|
-
content: {
|
3553
|
-
"application/json": components["schemas"]["ServicesServiceTypePutResponse"];
|
3554
|
-
};
|
3555
|
-
};
|
3556
2976
|
};
|
3557
|
-
/**
|
2977
|
+
/**
|
2978
|
+
* PutServicesByServiceTypeAndError
|
2979
|
+
* @description The HTTP request `PUT /services/{ServiceType}/error` is used to return error information
|
2980
|
+
*/
|
3558
2981
|
PutServicesByServiceTypeAndError: {
|
3559
2982
|
parameters: {
|
3560
|
-
path: {
|
3561
|
-
/** The type of the service identifier. For example, `THIRD_PARTY_DFSP` */
|
3562
|
-
ServiceType: components["parameters"]["ServiceType"];
|
3563
|
-
};
|
3564
2983
|
header: {
|
3565
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3566
2984
|
"Content-Type": components["parameters"]["Content-Type"];
|
3567
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3568
2985
|
Date: components["parameters"]["Date"];
|
3569
|
-
/**
|
3570
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3571
|
-
*
|
3572
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
3573
|
-
*/
|
3574
2986
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3575
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3576
2987
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3577
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3578
2988
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3579
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3580
2989
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3581
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3582
2990
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3583
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
3584
2991
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3585
|
-
/** 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/master/Specification%20Document%20Set). */
|
3586
2992
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3587
|
-
/**
|
3588
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3589
|
-
*
|
3590
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
3591
|
-
*/
|
3592
2993
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3593
2994
|
};
|
2995
|
+
path: {
|
2996
|
+
ServiceType: components["parameters"]["ServiceType"];
|
2997
|
+
};
|
2998
|
+
};
|
2999
|
+
/** @description Details of the error returned. */
|
3000
|
+
requestBody: {
|
3001
|
+
content: {
|
3002
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
3003
|
+
};
|
3594
3004
|
};
|
3595
3005
|
responses: {
|
3596
3006
|
200: components["responses"]["200"];
|
@@ -3603,49 +3013,33 @@ export interface operations {
|
|
3603
3013
|
501: components["responses"]["501"];
|
3604
3014
|
503: components["responses"]["503"];
|
3605
3015
|
};
|
3606
|
-
/** Details of the error returned. */
|
3607
|
-
requestBody: {
|
3608
|
-
content: {
|
3609
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
3610
|
-
};
|
3611
|
-
};
|
3612
3016
|
};
|
3613
|
-
/**
|
3017
|
+
/**
|
3018
|
+
* ThirdpartyRequestsTransactionsPost
|
3019
|
+
* @description The HTTP request POST `/thirdpartyRequests/transactions` is used by a PISP to initiate a 3rd party Transaction request with a DFSP
|
3020
|
+
*/
|
3614
3021
|
ThirdpartyRequestsTransactionsPost: {
|
3615
3022
|
parameters: {
|
3616
3023
|
header: {
|
3617
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3618
3024
|
"Content-Type": components["parameters"]["Content-Type"];
|
3619
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3620
3025
|
Date: components["parameters"]["Date"];
|
3621
|
-
/**
|
3622
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3623
|
-
*
|
3624
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
3625
|
-
*/
|
3626
3026
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3627
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3628
3027
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3629
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3630
3028
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3631
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3632
3029
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3633
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3634
3030
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3635
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
3636
3031
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3637
|
-
/** 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/master/Specification%20Document%20Set). */
|
3638
3032
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3639
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3640
3033
|
Accept: components["parameters"]["Accept"];
|
3641
|
-
/**
|
3642
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3643
|
-
*
|
3644
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
3645
|
-
*/
|
3646
3034
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3647
3035
|
};
|
3648
3036
|
};
|
3037
|
+
/** @description Transaction request to be created. */
|
3038
|
+
requestBody: {
|
3039
|
+
content: {
|
3040
|
+
"application/json": components["schemas"]["ThirdpartyRequestsTransactionsPostRequest"];
|
3041
|
+
};
|
3042
|
+
};
|
3649
3043
|
responses: {
|
3650
3044
|
202: components["responses"]["202"];
|
3651
3045
|
400: components["responses"]["400"];
|
@@ -3657,49 +3051,29 @@ export interface operations {
|
|
3657
3051
|
501: components["responses"]["501"];
|
3658
3052
|
503: components["responses"]["503"];
|
3659
3053
|
};
|
3660
|
-
/** Transaction request to be created. */
|
3661
|
-
requestBody: {
|
3662
|
-
content: {
|
3663
|
-
"application/json": components["schemas"]["ThirdpartyRequestsTransactionsPostRequest"];
|
3664
|
-
};
|
3665
|
-
};
|
3666
3054
|
};
|
3667
3055
|
/**
|
3668
|
-
*
|
3056
|
+
* GetThirdpartyTransactionRequests
|
3057
|
+
* @description The HTTP request `GET /thirdpartyRequests/transactions/{ID}` is used to request the
|
3669
3058
|
* retrieval of a third party transaction request.
|
3670
3059
|
*/
|
3671
3060
|
GetThirdpartyTransactionRequests: {
|
3672
3061
|
parameters: {
|
3673
|
-
path: {
|
3674
|
-
/** The identifier value. */
|
3675
|
-
ID: components["parameters"]["ID"];
|
3676
|
-
};
|
3677
3062
|
header: {
|
3678
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3679
3063
|
"Content-Type": components["parameters"]["Content-Type"];
|
3680
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3681
3064
|
Date: components["parameters"]["Date"];
|
3682
|
-
/**
|
3683
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3684
|
-
*
|
3685
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
3686
|
-
*/
|
3687
3065
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3688
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3689
3066
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3690
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3691
3067
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3692
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3693
3068
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3694
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3695
3069
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3696
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
3697
3070
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3698
|
-
/** 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/master/Specification%20Document%20Set). */
|
3699
3071
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3700
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3701
3072
|
Accept: components["parameters"]["Accept"];
|
3702
3073
|
};
|
3074
|
+
path: {
|
3075
|
+
ID: components["parameters"]["ID"];
|
3076
|
+
};
|
3703
3077
|
};
|
3704
3078
|
responses: {
|
3705
3079
|
202: components["responses"]["202"];
|
@@ -3714,46 +3088,38 @@ export interface operations {
|
|
3714
3088
|
};
|
3715
3089
|
};
|
3716
3090
|
/**
|
3717
|
-
*
|
3091
|
+
* UpdateThirdPartyTransactionRequests
|
3092
|
+
* @description The HTTP request `PUT /thirdpartyRequests/transactions/{ID}` is used by the DFSP to inform the client about
|
3718
3093
|
* the status of a previously requested thirdparty transaction request.
|
3719
3094
|
*
|
3720
3095
|
* Switch(Thirdparty API Adapter) -> PISP
|
3721
3096
|
*/
|
3722
3097
|
UpdateThirdPartyTransactionRequests: {
|
3723
3098
|
parameters: {
|
3724
|
-
path: {
|
3725
|
-
/** The identifier value. */
|
3726
|
-
ID: components["parameters"]["ID"];
|
3727
|
-
};
|
3728
3099
|
header: {
|
3729
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3730
3100
|
"Content-Type": components["parameters"]["Content-Type"];
|
3731
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3732
3101
|
Date: components["parameters"]["Date"];
|
3733
|
-
/**
|
3734
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3735
|
-
*
|
3736
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
3737
|
-
*/
|
3738
3102
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3739
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3740
3103
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3741
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3742
3104
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3743
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3744
3105
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3745
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3746
3106
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3747
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
3748
3107
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3749
|
-
/** 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/master/Specification%20Document%20Set). */
|
3750
3108
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3109
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
3110
|
+
};
|
3111
|
+
path: {
|
3112
|
+
ID: components["parameters"]["ID"];
|
3113
|
+
};
|
3114
|
+
};
|
3115
|
+
requestBody: {
|
3116
|
+
content: {
|
3751
3117
|
/**
|
3752
|
-
*
|
3753
|
-
*
|
3754
|
-
*
|
3118
|
+
* @example {
|
3119
|
+
* "transactionRequestState": "RECEIVED"
|
3120
|
+
* }
|
3755
3121
|
*/
|
3756
|
-
"
|
3122
|
+
"application/json": components["schemas"]["ThirdpartyRequestsTransactionsIDPutResponse"];
|
3757
3123
|
};
|
3758
3124
|
};
|
3759
3125
|
responses: {
|
@@ -3767,55 +3133,42 @@ export interface operations {
|
|
3767
3133
|
501: components["responses"]["501"];
|
3768
3134
|
503: components["responses"]["503"];
|
3769
3135
|
};
|
3770
|
-
requestBody: {
|
3771
|
-
content: {
|
3772
|
-
"application/json": components["schemas"]["ThirdpartyRequestsTransactionsIDPutResponse"];
|
3773
|
-
};
|
3774
|
-
};
|
3775
3136
|
};
|
3776
3137
|
/**
|
3777
|
-
*
|
3138
|
+
* NotifyThirdpartyTransactionRequests
|
3139
|
+
* @description The HTTP request `PATCH /thirdpartyRequests/transactions/{ID}` is used to
|
3778
3140
|
* notify a thirdparty of the outcome of a transaction request.
|
3779
3141
|
*
|
3780
3142
|
* Switch(Thirdparty API Adapter) -> PISP
|
3781
3143
|
*/
|
3782
3144
|
NotifyThirdpartyTransactionRequests: {
|
3783
3145
|
parameters: {
|
3784
|
-
path: {
|
3785
|
-
/** The identifier value. */
|
3786
|
-
ID: components["parameters"]["ID"];
|
3787
|
-
};
|
3788
3146
|
header: {
|
3789
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3790
3147
|
"Content-Type": components["parameters"]["Content-Type"];
|
3791
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3792
3148
|
Date: components["parameters"]["Date"];
|
3793
|
-
/**
|
3794
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3795
|
-
*
|
3796
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
3797
|
-
*/
|
3798
3149
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3799
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3800
3150
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3801
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3802
3151
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3803
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3804
3152
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3805
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3806
3153
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3807
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
3808
3154
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3809
|
-
/** 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/master/Specification%20Document%20Set). */
|
3810
3155
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3811
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3812
3156
|
Accept: components["parameters"]["Accept"];
|
3157
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
3158
|
+
};
|
3159
|
+
path: {
|
3160
|
+
ID: components["parameters"]["ID"];
|
3161
|
+
};
|
3162
|
+
};
|
3163
|
+
requestBody: {
|
3164
|
+
content: {
|
3813
3165
|
/**
|
3814
|
-
*
|
3815
|
-
*
|
3816
|
-
*
|
3166
|
+
* @example {
|
3167
|
+
* "transactionRequestState": "ACCEPTED",
|
3168
|
+
* "transactionState": "COMMITTED"
|
3169
|
+
* }
|
3817
3170
|
*/
|
3818
|
-
"
|
3171
|
+
"application/json": components["schemas"]["ThirdpartyRequestsTransactionsIDPatchResponse"];
|
3819
3172
|
};
|
3820
3173
|
};
|
3821
3174
|
responses: {
|
@@ -3829,54 +3182,37 @@ export interface operations {
|
|
3829
3182
|
501: components["responses"]["501"];
|
3830
3183
|
503: components["responses"]["503"];
|
3831
3184
|
};
|
3832
|
-
requestBody: {
|
3833
|
-
content: {
|
3834
|
-
"application/json": components["schemas"]["ThirdpartyRequestsTransactionsIDPatchResponse"];
|
3835
|
-
};
|
3836
|
-
};
|
3837
3185
|
};
|
3838
3186
|
/**
|
3839
|
-
*
|
3187
|
+
* ThirdpartyTransactionRequestsError
|
3188
|
+
* @description If the server is unable to find the transaction request, or another processing error occurs,
|
3840
3189
|
* the error callback `PUT /thirdpartyRequests/transactions/{ID}/error` is used.
|
3841
3190
|
* The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of
|
3842
3191
|
* the thirdparty transaction request.
|
3843
3192
|
*/
|
3844
3193
|
ThirdpartyTransactionRequestsError: {
|
3845
3194
|
parameters: {
|
3846
|
-
path: {
|
3847
|
-
/** The identifier value. */
|
3848
|
-
ID: components["parameters"]["ID"];
|
3849
|
-
};
|
3850
3195
|
header: {
|
3851
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3852
3196
|
"Content-Type": components["parameters"]["Content-Type"];
|
3853
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3854
3197
|
Date: components["parameters"]["Date"];
|
3855
|
-
/**
|
3856
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3857
|
-
*
|
3858
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
3859
|
-
*/
|
3860
3198
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3861
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3862
3199
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3863
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3864
3200
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3865
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3866
3201
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3867
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3868
3202
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3869
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
3870
3203
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3871
|
-
/** 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/master/Specification%20Document%20Set). */
|
3872
3204
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3873
|
-
/**
|
3874
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3875
|
-
*
|
3876
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
3877
|
-
*/
|
3878
3205
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3879
3206
|
};
|
3207
|
+
path: {
|
3208
|
+
ID: components["parameters"]["ID"];
|
3209
|
+
};
|
3210
|
+
};
|
3211
|
+
/** @description Error information returned. */
|
3212
|
+
requestBody: {
|
3213
|
+
content: {
|
3214
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
3215
|
+
};
|
3880
3216
|
};
|
3881
3217
|
responses: {
|
3882
3218
|
200: components["responses"]["200"];
|
@@ -3889,49 +3225,33 @@ export interface operations {
|
|
3889
3225
|
501: components["responses"]["501"];
|
3890
3226
|
503: components["responses"]["503"];
|
3891
3227
|
};
|
3892
|
-
/** Error information returned. */
|
3893
|
-
requestBody: {
|
3894
|
-
content: {
|
3895
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
3896
|
-
};
|
3897
|
-
};
|
3898
3228
|
};
|
3899
|
-
/**
|
3229
|
+
/**
|
3230
|
+
* PostThirdpartyRequestsAuthorizations
|
3231
|
+
* @description The HTTP request **POST /thirdpartyRequests/authorizations** is used to request the validation by a customer for the transfer described in the request.
|
3232
|
+
*/
|
3900
3233
|
PostThirdpartyRequestsAuthorizations: {
|
3901
3234
|
parameters: {
|
3902
3235
|
header: {
|
3903
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3904
3236
|
"Content-Type": components["parameters"]["Content-Type"];
|
3905
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3906
3237
|
Date: components["parameters"]["Date"];
|
3907
|
-
/**
|
3908
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3909
|
-
*
|
3910
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
3911
|
-
*/
|
3912
3238
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3913
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3914
3239
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3915
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3916
3240
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3917
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3918
3241
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3919
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3920
3242
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3921
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
3922
3243
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3923
|
-
/** 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/master/Specification%20Document%20Set). */
|
3924
3244
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3925
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3926
3245
|
Accept: components["parameters"]["Accept"];
|
3927
|
-
/**
|
3928
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3929
|
-
*
|
3930
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
3931
|
-
*/
|
3932
3246
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3933
3247
|
};
|
3934
3248
|
};
|
3249
|
+
/** @description Authorization request details */
|
3250
|
+
requestBody: {
|
3251
|
+
content: {
|
3252
|
+
"application/json": components["schemas"]["ThirdpartyRequestsAuthorizationsPostRequest"];
|
3253
|
+
};
|
3254
|
+
};
|
3935
3255
|
responses: {
|
3936
3256
|
202: components["responses"]["202"];
|
3937
3257
|
400: components["responses"]["400"];
|
@@ -3943,50 +3263,30 @@ export interface operations {
|
|
3943
3263
|
501: components["responses"]["501"];
|
3944
3264
|
503: components["responses"]["503"];
|
3945
3265
|
};
|
3946
|
-
/** Authorization request details */
|
3947
|
-
requestBody: {
|
3948
|
-
content: {
|
3949
|
-
"application/json": components["schemas"]["ThirdpartyRequestsAuthorizationsPostRequest"];
|
3950
|
-
};
|
3951
|
-
};
|
3952
3266
|
};
|
3953
3267
|
/**
|
3954
|
-
*
|
3268
|
+
* GetThirdpartyRequestsAuthorizationsById
|
3269
|
+
* @description The HTTP request **GET /thirdpartyRequests/authorizations/**_{ID}_ is used to get information relating
|
3955
3270
|
* to a previously issued authorization request. The *{ID}* in the request should match the
|
3956
3271
|
* `authorizationRequestId` which was given when the authorization request was created.
|
3957
3272
|
*/
|
3958
3273
|
GetThirdpartyRequestsAuthorizationsById: {
|
3959
3274
|
parameters: {
|
3960
|
-
path: {
|
3961
|
-
/** The identifier value. */
|
3962
|
-
ID: components["parameters"]["ID"];
|
3963
|
-
};
|
3964
3275
|
header: {
|
3965
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3966
3276
|
"Content-Type": components["parameters"]["Content-Type"];
|
3967
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3968
3277
|
Date: components["parameters"]["Date"];
|
3969
|
-
/**
|
3970
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3971
|
-
*
|
3972
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
3973
|
-
*/
|
3974
3278
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3975
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3976
3279
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3977
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3978
3280
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3979
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3980
3281
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3981
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3982
3282
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3983
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
3984
3283
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3985
|
-
/** 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/master/Specification%20Document%20Set). */
|
3986
3284
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3987
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3988
3285
|
Accept: components["parameters"]["Accept"];
|
3989
3286
|
};
|
3287
|
+
path: {
|
3288
|
+
ID: components["parameters"]["ID"];
|
3289
|
+
};
|
3990
3290
|
};
|
3991
3291
|
responses: {
|
3992
3292
|
202: components["responses"]["202"];
|
@@ -4001,7 +3301,8 @@ export interface operations {
|
|
4001
3301
|
};
|
4002
3302
|
};
|
4003
3303
|
/**
|
4004
|
-
*
|
3304
|
+
* PutThirdpartyRequestsAuthorizationsById
|
3305
|
+
* @description After receiving the **POST /thirdpartyRequests/authorizations**, the PISP will present the details of the
|
4005
3306
|
* transaction to their user, and request that the client sign the `challenge` field using the credential
|
4006
3307
|
* they previously registered.
|
4007
3308
|
*
|
@@ -4009,40 +3310,27 @@ export interface operations {
|
|
4009
3310
|
*/
|
4010
3311
|
PutThirdpartyRequestsAuthorizationsById: {
|
4011
3312
|
parameters: {
|
4012
|
-
path: {
|
4013
|
-
/** The identifier value. */
|
4014
|
-
ID: components["parameters"]["ID"];
|
4015
|
-
};
|
4016
3313
|
header: {
|
4017
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
4018
3314
|
"Content-Type": components["parameters"]["Content-Type"];
|
4019
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
4020
3315
|
Date: components["parameters"]["Date"];
|
4021
|
-
/**
|
4022
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
4023
|
-
*
|
4024
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
4025
|
-
*/
|
4026
3316
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4027
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
4028
3317
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4029
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
4030
3318
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4031
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
4032
3319
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4033
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
4034
3320
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4035
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
4036
3321
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4037
|
-
/** 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/master/Specification%20Document%20Set). */
|
4038
3322
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
4039
|
-
/**
|
4040
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
4041
|
-
*
|
4042
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
4043
|
-
*/
|
4044
3323
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
4045
3324
|
};
|
3325
|
+
path: {
|
3326
|
+
ID: components["parameters"]["ID"];
|
3327
|
+
};
|
3328
|
+
};
|
3329
|
+
/** @description Signed authorization object */
|
3330
|
+
requestBody: {
|
3331
|
+
content: {
|
3332
|
+
"application/json": components["schemas"]["ThirdpartyRequestsAuthorizationsIDPutResponseRejected"] | components["schemas"]["ThirdpartyRequestsAuthorizationsIDPutResponseFIDO"] | components["schemas"]["ThirdpartyRequestsAuthorizationsIDPutResponseGeneric"];
|
3333
|
+
};
|
4046
3334
|
};
|
4047
3335
|
responses: {
|
4048
3336
|
200: components["responses"]["200"];
|
@@ -4055,15 +3343,10 @@ export interface operations {
|
|
4055
3343
|
501: components["responses"]["501"];
|
4056
3344
|
503: components["responses"]["503"];
|
4057
3345
|
};
|
4058
|
-
/** Signed authorization object */
|
4059
|
-
requestBody: {
|
4060
|
-
content: {
|
4061
|
-
"application/json": components["schemas"]["ThirdpartyRequestsAuthorizationsIDPutResponseRejected"] | components["schemas"]["ThirdpartyRequestsAuthorizationsIDPutResponseFIDO"] | components["schemas"]["ThirdpartyRequestsAuthorizationsIDPutResponseGeneric"];
|
4062
|
-
};
|
4063
|
-
};
|
4064
3346
|
};
|
4065
3347
|
/**
|
4066
|
-
*
|
3348
|
+
* PutThirdpartyRequestsAuthorizationsByIdAndError
|
3349
|
+
* @description The HTTP request `PUT /thirdpartyRequests/authorizations/{ID}/error` is used by the DFSP or PISP to inform
|
4067
3350
|
* the other party that something went wrong with a Thirdparty Transaction Authorization Request.
|
4068
3351
|
*
|
4069
3352
|
* The PISP may use this to tell the DFSP that the Thirdparty Transaction Authorization Request is invalid or doesn't
|
@@ -4074,40 +3357,27 @@ export interface operations {
|
|
4074
3357
|
*/
|
4075
3358
|
PutThirdpartyRequestsAuthorizationsByIdAndError: {
|
4076
3359
|
parameters: {
|
4077
|
-
path: {
|
4078
|
-
/** The identifier value. */
|
4079
|
-
ID: components["parameters"]["ID"];
|
4080
|
-
};
|
4081
3360
|
header: {
|
4082
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
4083
3361
|
"Content-Type": components["parameters"]["Content-Type"];
|
4084
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
4085
3362
|
Date: components["parameters"]["Date"];
|
4086
|
-
/**
|
4087
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
4088
|
-
*
|
4089
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
4090
|
-
*/
|
4091
3363
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4092
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
4093
3364
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4094
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
4095
3365
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4096
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
4097
3366
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4098
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
4099
3367
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4100
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
4101
3368
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4102
|
-
/** 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/master/Specification%20Document%20Set). */
|
4103
3369
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
4104
|
-
/**
|
4105
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
4106
|
-
*
|
4107
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
4108
|
-
*/
|
4109
3370
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
4110
3371
|
};
|
3372
|
+
path: {
|
3373
|
+
ID: components["parameters"]["ID"];
|
3374
|
+
};
|
3375
|
+
};
|
3376
|
+
/** @description Error information returned. */
|
3377
|
+
requestBody: {
|
3378
|
+
content: {
|
3379
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
3380
|
+
};
|
4111
3381
|
};
|
4112
3382
|
responses: {
|
4113
3383
|
200: components["responses"]["200"];
|
@@ -4120,49 +3390,33 @@ export interface operations {
|
|
4120
3390
|
501: components["responses"]["501"];
|
4121
3391
|
503: components["responses"]["503"];
|
4122
3392
|
};
|
4123
|
-
/** Error information returned. */
|
4124
|
-
requestBody: {
|
4125
|
-
content: {
|
4126
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
4127
|
-
};
|
4128
|
-
};
|
4129
3393
|
};
|
4130
|
-
/**
|
3394
|
+
/**
|
3395
|
+
* PostThirdpartyRequestsVerifications
|
3396
|
+
* @description The HTTP request `POST /thirdpartyRequests/verifications` is used by the DFSP to verify a third party authorization.
|
3397
|
+
*/
|
4131
3398
|
PostThirdpartyRequestsVerifications: {
|
4132
3399
|
parameters: {
|
4133
3400
|
header: {
|
4134
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
4135
3401
|
"Content-Type": components["parameters"]["Content-Type"];
|
4136
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
4137
3402
|
Date: components["parameters"]["Date"];
|
4138
|
-
/**
|
4139
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
4140
|
-
*
|
4141
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
4142
|
-
*/
|
4143
3403
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4144
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
4145
3404
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4146
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
4147
3405
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4148
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
4149
3406
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4150
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
4151
3407
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4152
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
4153
3408
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4154
|
-
/** 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/master/Specification%20Document%20Set). */
|
4155
3409
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
4156
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
4157
3410
|
Accept: components["parameters"]["Accept"];
|
4158
|
-
/**
|
4159
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
4160
|
-
*
|
4161
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
4162
|
-
*/
|
4163
3411
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
4164
3412
|
};
|
4165
3413
|
};
|
3414
|
+
/** @description The thirdparty authorization details to verify */
|
3415
|
+
requestBody: {
|
3416
|
+
content: {
|
3417
|
+
"application/json": components["schemas"]["ThirdpartyRequestsVerificationsPostRequestFIDO"] | components["schemas"]["ThirdpartyRequestsVerificationsPostRequestGeneric"];
|
3418
|
+
};
|
3419
|
+
};
|
4166
3420
|
responses: {
|
4167
3421
|
202: components["responses"]["202"];
|
4168
3422
|
400: components["responses"]["400"];
|
@@ -4174,50 +3428,30 @@ export interface operations {
|
|
4174
3428
|
501: components["responses"]["501"];
|
4175
3429
|
503: components["responses"]["503"];
|
4176
3430
|
};
|
4177
|
-
/** The thirdparty authorization details to verify */
|
4178
|
-
requestBody: {
|
4179
|
-
content: {
|
4180
|
-
"application/json": components["schemas"]["ThirdpartyRequestsVerificationsPostRequestFIDO"] | components["schemas"]["ThirdpartyRequestsVerificationsPostRequestGeneric"];
|
4181
|
-
};
|
4182
|
-
};
|
4183
3431
|
};
|
4184
3432
|
/**
|
4185
|
-
*
|
3433
|
+
* GetThirdpartyRequestsVerificationsById
|
3434
|
+
* @description The HTTP request `/thirdpartyRequests/verifications/{ID}` is used to get
|
4186
3435
|
* information regarding a previously created or requested authorization. The *{ID}*
|
4187
3436
|
* in the URI should contain the verification request ID
|
4188
3437
|
*/
|
4189
3438
|
GetThirdpartyRequestsVerificationsById: {
|
4190
3439
|
parameters: {
|
4191
|
-
path: {
|
4192
|
-
/** The identifier value. */
|
4193
|
-
ID: components["parameters"]["ID"];
|
4194
|
-
};
|
4195
3440
|
header: {
|
4196
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
4197
3441
|
"Content-Type": components["parameters"]["Content-Type"];
|
4198
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
4199
3442
|
Date: components["parameters"]["Date"];
|
4200
|
-
/**
|
4201
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
4202
|
-
*
|
4203
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
4204
|
-
*/
|
4205
3443
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4206
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
4207
3444
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4208
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
4209
3445
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4210
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
4211
3446
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4212
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
4213
3447
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4214
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
4215
3448
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4216
|
-
/** 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/master/Specification%20Document%20Set). */
|
4217
3449
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
4218
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
4219
3450
|
Accept: components["parameters"]["Accept"];
|
4220
3451
|
};
|
3452
|
+
path: {
|
3453
|
+
ID: components["parameters"]["ID"];
|
3454
|
+
};
|
4221
3455
|
};
|
4222
3456
|
responses: {
|
4223
3457
|
202: components["responses"]["202"];
|
@@ -4232,45 +3466,38 @@ export interface operations {
|
|
4232
3466
|
};
|
4233
3467
|
};
|
4234
3468
|
/**
|
4235
|
-
*
|
3469
|
+
* PutThirdpartyRequestsVerificationsById
|
3470
|
+
* @description The HTTP request `PUT /thirdpartyRequests/verifications/{ID}` is used by the Auth-Service to inform the DFSP of a successful result in validating the verification of a Thirdparty Transaction Request.
|
4236
3471
|
* If the validation fails, the auth-service will send back `PUT /thirdpartyRequests/verifications/{ID}` with `authenticationResponse: 'REJECTED'`.
|
4237
3472
|
* In unplanned error cases the Auth-Service MUST use `PUT /thirdpartyRequests/verifications/{ID}/error`.
|
4238
3473
|
*/
|
4239
3474
|
PutThirdpartyRequestsVerificationsById: {
|
4240
3475
|
parameters: {
|
4241
|
-
path: {
|
4242
|
-
/** The identifier value. */
|
4243
|
-
ID: components["parameters"]["ID"];
|
4244
|
-
};
|
4245
3476
|
header: {
|
4246
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
4247
3477
|
"Content-Type": components["parameters"]["Content-Type"];
|
4248
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
4249
3478
|
Date: components["parameters"]["Date"];
|
4250
|
-
/**
|
4251
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
4252
|
-
*
|
4253
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
4254
|
-
*/
|
4255
3479
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4256
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
4257
3480
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4258
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
4259
3481
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4260
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
4261
3482
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4262
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
4263
3483
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4264
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
4265
3484
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4266
|
-
/** 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/master/Specification%20Document%20Set). */
|
4267
3485
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3486
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
3487
|
+
};
|
3488
|
+
path: {
|
3489
|
+
ID: components["parameters"]["ID"];
|
3490
|
+
};
|
3491
|
+
};
|
3492
|
+
/** @description The result of validating the Thirdparty Transaction Request */
|
3493
|
+
requestBody: {
|
3494
|
+
content: {
|
4268
3495
|
/**
|
4269
|
-
*
|
4270
|
-
*
|
4271
|
-
*
|
3496
|
+
* @example {
|
3497
|
+
* "authenticationResponse": "VERIFIED"
|
3498
|
+
* }
|
4272
3499
|
*/
|
4273
|
-
"
|
3500
|
+
"application/json": components["schemas"]["ThirdpartyRequestsVerificationsIDPutResponse"];
|
4274
3501
|
};
|
4275
3502
|
};
|
4276
3503
|
responses: {
|
@@ -4284,53 +3511,35 @@ export interface operations {
|
|
4284
3511
|
501: components["responses"]["501"];
|
4285
3512
|
503: components["responses"]["503"];
|
4286
3513
|
};
|
4287
|
-
/** The result of validating the Thirdparty Transaction Request */
|
4288
|
-
requestBody: {
|
4289
|
-
content: {
|
4290
|
-
"application/json": components["schemas"]["ThirdpartyRequestsVerificationsIDPutResponse"];
|
4291
|
-
};
|
4292
|
-
};
|
4293
3514
|
};
|
4294
3515
|
/**
|
4295
|
-
*
|
3516
|
+
* PutThirdpartyRequestsVerificationsByIdAndError
|
3517
|
+
* @description The HTTP request `PUT /thirdpartyRequests/verifications/{ID}/error` is used by the Auth-Service to inform
|
4296
3518
|
* the DFSP of a failure in validating or looking up the verification of a Thirdparty Transaction Request.
|
4297
3519
|
*/
|
4298
3520
|
PutThirdpartyRequestsVerificationsByIdAndError: {
|
4299
3521
|
parameters: {
|
4300
|
-
path: {
|
4301
|
-
/** The identifier value. */
|
4302
|
-
ID: components["parameters"]["ID"];
|
4303
|
-
};
|
4304
3522
|
header: {
|
4305
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
4306
3523
|
"Content-Type": components["parameters"]["Content-Type"];
|
4307
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
4308
3524
|
Date: components["parameters"]["Date"];
|
4309
|
-
/**
|
4310
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
4311
|
-
*
|
4312
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
4313
|
-
*/
|
4314
3525
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4315
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
4316
3526
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4317
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
4318
3527
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4319
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
4320
3528
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4321
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
4322
3529
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4323
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
4324
3530
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4325
|
-
/** 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/master/Specification%20Document%20Set). */
|
4326
3531
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
4327
|
-
/**
|
4328
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
4329
|
-
*
|
4330
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
4331
|
-
*/
|
4332
3532
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
4333
3533
|
};
|
3534
|
+
path: {
|
3535
|
+
ID: components["parameters"]["ID"];
|
3536
|
+
};
|
3537
|
+
};
|
3538
|
+
/** @description Error information returned. */
|
3539
|
+
requestBody: {
|
3540
|
+
content: {
|
3541
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
3542
|
+
};
|
4334
3543
|
};
|
4335
3544
|
responses: {
|
4336
3545
|
200: components["responses"]["200"];
|
@@ -4343,13 +3552,5 @@ export interface operations {
|
|
4343
3552
|
501: components["responses"]["501"];
|
4344
3553
|
503: components["responses"]["503"];
|
4345
3554
|
};
|
4346
|
-
/** Error information returned. */
|
4347
|
-
requestBody: {
|
4348
|
-
content: {
|
4349
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
4350
|
-
};
|
4351
|
-
};
|
4352
3555
|
};
|
4353
3556
|
}
|
4354
|
-
export interface external {
|
4355
|
-
}
|