@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.
@@ -4,300 +4,288 @@
4
4
  */
5
5
  export interface paths {
6
6
  "/interface": {
7
- /** Essential path to include schema components 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 components 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["Interface"];
9
9
  };
10
10
  "/participants/{Type}/{ID}": {
11
- /** 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. */
11
+ /**
12
+ * Look up participant information
13
+ * @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.
14
+ */
12
15
  get: operations["ParticipantsByTypeAndID"];
13
- /** 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. */
16
+ /**
17
+ * Return participant information
18
+ * @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.
19
+ */
14
20
  put: operations["ParticipantsByTypeAndID3"];
15
- /** 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`). */
21
+ /**
22
+ * Create participant information
23
+ * @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`).
24
+ */
16
25
  post: operations["ParticipantsByIDAndType"];
17
26
  /**
18
- * 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.
27
+ * Delete participant information
28
+ * @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.
19
29
  *
20
30
  * **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.
21
31
  */
22
32
  delete: operations["ParticipantsByTypeAndID2"];
23
33
  parameters: {
24
- path: {
25
- /** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
26
- Type: components["parameters"]["Type"];
27
- /** The identifier value. */
28
- ID: components["parameters"]["ID"];
29
- };
30
34
  header: {
31
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
32
35
  "Content-Type": components["parameters"]["Content-Type"];
33
- /** The `Date` header field indicates the date when the request was sent. */
34
36
  Date: components["parameters"]["Date"];
35
- /**
36
- * 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.
37
- *
38
- * **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`.
39
- */
40
37
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
41
- /** 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`). */
42
38
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
43
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
44
39
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
45
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
46
40
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
47
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
48
41
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
49
- /** 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). */
50
42
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
51
- /** 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). */
52
43
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
53
44
  };
45
+ path: {
46
+ Type: components["parameters"]["Type"];
47
+ ID: components["parameters"]["ID"];
48
+ };
54
49
  };
55
50
  };
56
51
  "/participants/{Type}/{ID}/error": {
57
- /** 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. */
52
+ /**
53
+ * Return participant information error
54
+ * @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.
55
+ */
58
56
  put: operations["ParticipantsErrorByTypeAndID"];
59
57
  };
60
58
  "/participants/{Type}/{ID}/{SubId}": {
61
- /** 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. */
59
+ /**
60
+ * Look up participant information
61
+ * @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.
62
+ */
62
63
  get: operations["ParticipantsSubIdByTypeAndID"];
63
- /** 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. */
64
+ /**
65
+ * Return participant information
66
+ * @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.
67
+ */
64
68
  put: operations["ParticipantsSubIdByTypeAndID3"];
65
- /** 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`). */
69
+ /**
70
+ * Create participant information
71
+ * @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`).
72
+ */
66
73
  post: operations["ParticipantsSubIdByTypeAndIDPost"];
67
74
  /**
68
- * 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.
75
+ * Delete participant information
76
+ * @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.
69
77
  *
70
78
  * **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.
71
79
  */
72
80
  delete: operations["ParticipantsSubIdByTypeAndID2"];
73
81
  parameters: {
74
- path: {
75
- /** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
76
- Type: components["parameters"]["Type"];
77
- /** The identifier value. */
78
- ID: components["parameters"]["ID"];
79
- /** A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
80
- SubId: components["parameters"]["SubId"];
81
- };
82
82
  header: {
83
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
84
83
  "Content-Type": components["parameters"]["Content-Type"];
85
- /** The `Date` header field indicates the date when the request was sent. */
86
84
  Date: components["parameters"]["Date"];
87
- /**
88
- * 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.
89
- *
90
- * **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`.
91
- */
92
85
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
93
- /** 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`). */
94
86
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
95
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
96
87
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
97
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
98
88
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
99
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
100
89
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
101
- /** 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). */
102
90
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
103
- /** 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). */
104
91
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
105
92
  };
93
+ path: {
94
+ Type: components["parameters"]["Type"];
95
+ ID: components["parameters"]["ID"];
96
+ SubId: components["parameters"]["SubId"];
97
+ };
106
98
  };
107
99
  };
108
100
  "/participants/{Type}/{ID}/{SubId}/error": {
109
- /** 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. */
101
+ /**
102
+ * Return participant information error
103
+ * @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.
104
+ */
110
105
  put: operations["ParticipantsSubIdErrorByTypeAndID"];
111
106
  };
112
107
  "/participants": {
113
- /** 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. */
108
+ /**
109
+ * Create bulk participant information
110
+ * @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.
111
+ */
114
112
  post: operations["Participants1"];
115
113
  };
116
114
  "/participants/{ID}": {
117
- /** The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities. */
115
+ /**
116
+ * Return bulk participant information
117
+ * @description The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities.
118
+ */
118
119
  put: operations["putParticipantsByID"];
119
120
  };
120
121
  "/participants/{ID}/error": {
121
- /** 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. */
122
+ /**
123
+ * Return bulk participant information error
124
+ * @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.
125
+ */
122
126
  put: operations["ParticipantsByIDAndError"];
123
127
  };
124
128
  "/parties/{Type}/{ID}": {
125
- /** The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`). */
129
+ /**
130
+ * Look up party information
131
+ * @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`).
132
+ */
126
133
  get: operations["PartiesByTypeAndID"];
127
- /** The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup. */
134
+ /**
135
+ * Return party information
136
+ * @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup.
137
+ */
128
138
  put: operations["PartiesByTypeAndID2"];
129
139
  parameters: {
130
- path: {
131
- /** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
132
- Type: components["parameters"]["Type"];
133
- /** The identifier value. */
134
- ID: components["parameters"]["ID"];
135
- };
136
140
  header: {
137
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
138
141
  "Content-Type": components["parameters"]["Content-Type"];
139
- /** The `Date` header field indicates the date when the request was sent. */
140
142
  Date: components["parameters"]["Date"];
141
- /**
142
- * 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.
143
- *
144
- * **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`.
145
- */
146
143
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
147
- /** 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`). */
148
144
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
149
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
150
145
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
151
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
152
146
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
153
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
154
147
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
155
- /** 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). */
156
148
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
157
- /** 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). */
158
149
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
159
150
  };
151
+ path: {
152
+ Type: components["parameters"]["Type"];
153
+ ID: components["parameters"]["ID"];
154
+ };
160
155
  };
161
156
  };
162
157
  "/parties/{Type}/{ID}/error": {
163
- /** If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubI}/error`) is used. */
158
+ /**
159
+ * Return party information error
160
+ * @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubI}/error`) is used.
161
+ */
164
162
  put: operations["PartiesErrorByTypeAndID"];
165
163
  };
166
164
  "/parties/{Type}/{ID}/{SubId}": {
167
- /** The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`). */
165
+ /**
166
+ * Look up party information
167
+ * @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`).
168
+ */
168
169
  get: operations["PartiesSubIdByTypeAndID"];
169
- /** The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup. */
170
+ /**
171
+ * Return party information
172
+ * @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup.
173
+ */
170
174
  put: operations["PartiesSubIdByTypeAndIDPut"];
171
175
  parameters: {
172
- path: {
173
- /** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
174
- Type: components["parameters"]["Type"];
175
- /** The identifier value. */
176
- ID: components["parameters"]["ID"];
177
- /** A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
178
- SubId: components["parameters"]["SubId"];
179
- };
180
176
  header: {
181
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
182
177
  "Content-Type": components["parameters"]["Content-Type"];
183
- /** The `Date` header field indicates the date when the request was sent. */
184
178
  Date: components["parameters"]["Date"];
185
- /**
186
- * 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.
187
- *
188
- * **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`.
189
- */
190
179
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
191
- /** 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`). */
192
180
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
193
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
194
181
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
195
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
196
182
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
197
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
198
183
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
199
- /** 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). */
200
184
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
201
- /** 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). */
202
185
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
203
186
  };
187
+ path: {
188
+ Type: components["parameters"]["Type"];
189
+ ID: components["parameters"]["ID"];
190
+ SubId: components["parameters"]["SubId"];
191
+ };
204
192
  };
205
193
  };
206
194
  "/parties/{Type}/{ID}/{SubId}/error": {
207
- /** If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubId}/error`) is used. */
195
+ /**
196
+ * Return party information error
197
+ * @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubId}/error`) is used.
198
+ */
208
199
  put: operations["PartiesSubIdErrorByTypeAndID"];
209
200
  };
210
201
  "/transactionRequests": {
211
- /** The HTTP request `POST /transactionRequests` is used to request the creation of a transaction request for the provided financial transaction in the server. */
202
+ /**
203
+ * Perform transaction request
204
+ * @description The HTTP request `POST /transactionRequests` is used to request the creation of a transaction request for the provided financial transaction in the server.
205
+ */
212
206
  post: operations["TransactionRequests"];
213
207
  };
214
208
  "/transactionRequests/{ID}": {
215
- /** The HTTP request `GET /transactionRequests/{ID}` is used to get information regarding a transaction request created or requested earlier. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request. */
209
+ /**
210
+ * Retrieve transaction request information
211
+ * @description The HTTP request `GET /transactionRequests/{ID}` is used to get information regarding a transaction request created or requested earlier. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request.
212
+ */
216
213
  get: operations["TransactionRequestsByID"];
217
- /** The callback `PUT /transactionRequests/{ID}` is used to inform the client of a requested or created transaction request. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`. */
214
+ /**
215
+ * Return transaction request information
216
+ * @description The callback `PUT /transactionRequests/{ID}` is used to inform the client of a requested or created transaction request. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`.
217
+ */
218
218
  put: operations["TransactionRequestsByIDPut"];
219
219
  parameters: {
220
- path: {
221
- /** The identifier value. */
222
- ID: components["parameters"]["ID"];
223
- };
224
220
  header: {
225
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
226
221
  "Content-Type": components["parameters"]["Content-Type"];
227
- /** The `Date` header field indicates the date when the request was sent. */
228
222
  Date: components["parameters"]["Date"];
229
- /**
230
- * 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.
231
- *
232
- * **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`.
233
- */
234
223
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
235
- /** 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`). */
236
224
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
237
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
238
225
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
239
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
240
226
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
241
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
242
227
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
243
- /** 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). */
244
228
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
245
- /** 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). */
246
229
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
247
230
  };
231
+ path: {
232
+ ID: components["parameters"]["ID"];
233
+ };
248
234
  };
249
235
  };
250
236
  "/transactionRequests/{ID}/error": {
251
- /** If the server is unable to find or create a transaction request, or another processing error occurs, the error callback `PUT /transactionRequests/{ID}/error` is used. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`. */
237
+ /**
238
+ * Return transaction request information error
239
+ * @description If the server is unable to find or create a transaction request, or another processing error occurs, the error callback `PUT /transactionRequests/{ID}/error` is used. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`.
240
+ */
252
241
  put: operations["TransactionRequestsErrorByID"];
253
242
  };
254
243
  "/quotes": {
255
- /** The HTTP request `POST /quotes` is used to request the creation of a quote for the provided financial transaction in the server. */
244
+ /**
245
+ * Calculate quote
246
+ * @description The HTTP request `POST /quotes` is used to request the creation of a quote for the provided financial transaction in the server.
247
+ */
256
248
  post: operations["Quotes"];
257
249
  };
258
250
  "/quotes/{ID}": {
259
- /** The HTTP request `GET /quotes/{ID}` is used to get information regarding a quote created or requested earlier. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote. */
251
+ /**
252
+ * Retrieve quote information
253
+ * @description The HTTP request `GET /quotes/{ID}` is used to get information regarding a quote created or requested earlier. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote.
254
+ */
260
255
  get: operations["QuotesByID"];
261
- /** The callback `PUT /quotes/{ID}` is used to inform the client of a requested or created quote. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request. */
256
+ /**
257
+ * Return quote information
258
+ * @description The callback `PUT /quotes/{ID}` is used to inform the client of a requested or created quote. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request.
259
+ */
262
260
  put: operations["QuotesByID1"];
263
261
  parameters: {
264
- path: {
265
- /** The identifier value. */
266
- ID: components["parameters"]["ID"];
267
- };
268
262
  header: {
269
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
270
263
  "Content-Type": components["parameters"]["Content-Type"];
271
- /** The `Date` header field indicates the date when the request was sent. */
272
264
  Date: components["parameters"]["Date"];
273
- /**
274
- * 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.
275
- *
276
- * **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`.
277
- */
278
265
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
279
- /** 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`). */
280
266
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
281
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
282
267
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
283
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
284
268
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
285
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
286
269
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
287
- /** 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). */
288
270
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
289
- /** 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). */
290
271
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
291
272
  };
273
+ path: {
274
+ ID: components["parameters"]["ID"];
275
+ };
292
276
  };
293
277
  };
294
278
  "/quotes/{ID}/error": {
295
- /** If the server is unable to find or create a quote, or some other processing error occurs, the error callback `PUT /quotes/{ID}/error` is used. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request. */
279
+ /**
280
+ * Return quote information error
281
+ * @description If the server is unable to find or create a quote, or some other processing error occurs, the error callback `PUT /quotes/{ID}/error` is used. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request.
282
+ */
296
283
  put: operations["QuotesByIDAndError"];
297
284
  };
298
285
  "/authorizations/{ID}": {
299
286
  /**
300
- * The HTTP request `GET /authorizations/{ID}` is used to request the Payer to enter the applicable credentials in the Payee FSP system. The `{ID}` in the URI should contain the `transactionRequestID`, received from the `POST /transactionRequests` service earlier in the process. This request requires a query string to be included in the URI, with the following key-value pairs*:*
287
+ * Perform authorization
288
+ * @description The HTTP request `GET /authorizations/{ID}` is used to request the Payer to enter the applicable credentials in the Payee FSP system. The `{ID}` in the URI should contain the `transactionRequestID`, received from the `POST /transactionRequests` service earlier in the process. This request requires a query string to be included in the URI, with the following key-value pairs*:*
301
289
  *
302
290
  * - `authenticationType={Type}`, where `{Type}` value is a valid authentication type from the enumeration `AuthenticationType`.
303
291
  *
@@ -312,216 +300,198 @@ export interface paths {
312
300
  * `GET /authorization/3d492671-b7af-4f3f-88de-76169b1bdf88?authenticationType=OTP&retriesLeft=2&amount=102&currency=USD`
313
301
  */
314
302
  get: operations["AuthorizationsByIDGet"];
315
- /** The callback `PUT /authorizations/{ID}` is used to inform the client of the result of a previously-requested authorization. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}` request. */
303
+ /**
304
+ * Return authorization result
305
+ * @description The callback `PUT /authorizations/{ID}` is used to inform the client of the result of a previously-requested authorization. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}` request.
306
+ */
316
307
  put: operations["AuthorizationsByIDPut"];
317
308
  parameters: {
318
- path: {
319
- /** The identifier value. */
320
- ID: components["parameters"]["ID"];
321
- };
322
309
  header: {
323
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
324
310
  "Content-Type": components["parameters"]["Content-Type"];
325
- /** The `Date` header field indicates the date when the request was sent. */
326
311
  Date: components["parameters"]["Date"];
327
- /**
328
- * 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.
329
- *
330
- * **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`.
331
- */
332
312
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
333
- /** 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`). */
334
313
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
335
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
336
314
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
337
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
338
315
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
339
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
340
316
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
341
- /** 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). */
342
317
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
343
- /** 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). */
344
318
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
345
319
  };
320
+ path: {
321
+ ID: components["parameters"]["ID"];
322
+ };
346
323
  };
347
324
  };
348
325
  "/authorizations/{ID}/error": {
349
- /** If the server is unable to find the transaction request, or another processing error occurs, the error callback `PUT /authorizations/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}`. */
326
+ /**
327
+ * Return authorization error
328
+ * @description If the server is unable to find the transaction request, or another processing error occurs, the error callback `PUT /authorizations/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}`.
329
+ */
350
330
  put: operations["AuthorizationsByIDAndError"];
351
331
  };
352
332
  "/transfers": {
353
- /** The HTTP request `POST /transfers` is used to request the creation of a transfer for the next ledger, and a financial transaction for the Payee FSP. */
333
+ /**
334
+ * Perform transfer
335
+ * @description The HTTP request `POST /transfers` is used to request the creation of a transfer for the next ledger, and a financial transaction for the Payee FSP.
336
+ */
354
337
  post: operations["transfers"];
355
338
  };
356
339
  "/transfers/{ID}": {
357
- /** The HTTP request `GET /transfers/{ID}` is used to get information regarding a transfer created or requested earlier. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer. */
340
+ /**
341
+ * Retrieve transfer information
342
+ * @description The HTTP request `GET /transfers/{ID}` is used to get information regarding a transfer created or requested earlier. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer.
343
+ */
358
344
  get: operations["TransfersByIDGet"];
359
- /** The callback `PUT /transfers/{ID}` is used to inform the client of a requested or created transfer. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}` request. */
345
+ /**
346
+ * Return transfer information
347
+ * @description The callback `PUT /transfers/{ID}` is used to inform the client of a requested or created transfer. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}` request.
348
+ */
360
349
  put: operations["TransfersByIDPut"];
361
350
  parameters: {
362
- path: {
363
- /** The identifier value. */
364
- ID: components["parameters"]["ID"];
365
- };
366
351
  header: {
367
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
368
352
  "Content-Type": components["parameters"]["Content-Type"];
369
- /** The `Date` header field indicates the date when the request was sent. */
370
353
  Date: components["parameters"]["Date"];
371
- /**
372
- * 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.
373
- *
374
- * **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`.
375
- */
376
354
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
377
- /** 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`). */
378
355
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
379
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
380
356
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
381
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
382
357
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
383
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
384
358
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
385
- /** 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). */
386
359
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
387
- /** 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). */
388
360
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
389
361
  };
362
+ path: {
363
+ ID: components["parameters"]["ID"];
364
+ };
390
365
  };
391
366
  };
392
367
  "/transfers/{ID}/error": {
393
- /** If the server is unable to find or create a transfer, or another processing error occurs, the error callback `PUT /transfers/{ID}/error` is used. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}`. */
368
+ /**
369
+ * Return transfer information error
370
+ * @description If the server is unable to find or create a transfer, or another processing error occurs, the error callback `PUT /transfers/{ID}/error` is used. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}`.
371
+ */
394
372
  put: operations["TransfersByIDAndError"];
395
373
  };
396
374
  "/transactions/{ID}": {
397
- /** The HTTP request `GET /transactions/{ID}` is used to get transaction information regarding a financial transaction created earlier. The `{ID}` in the URI should contain the `transactionId` that was used for the creation of the quote, as the transaction is created as part of another process (the transfer process). */
375
+ /**
376
+ * Retrieve transaction information
377
+ * @description The HTTP request `GET /transactions/{ID}` is used to get transaction information regarding a financial transaction created earlier. The `{ID}` in the URI should contain the `transactionId` that was used for the creation of the quote, as the transaction is created as part of another process (the transfer process).
378
+ */
398
379
  get: operations["TransactionsByID"];
399
- /** The callback `PUT /transactions/{ID}` is used to inform the client of a requested transaction. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request. */
380
+ /**
381
+ * Return transaction information
382
+ * @description The callback `PUT /transactions/{ID}` is used to inform the client of a requested transaction. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request.
383
+ */
400
384
  put: operations["TransactionsByID1"];
401
385
  parameters: {
402
- path: {
403
- /** The identifier value. */
404
- ID: components["parameters"]["ID"];
405
- };
406
386
  header: {
407
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
408
387
  "Content-Type": components["parameters"]["Content-Type"];
409
- /** The `Date` header field indicates the date when the request was sent. */
410
388
  Date: components["parameters"]["Date"];
411
- /**
412
- * 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.
413
- *
414
- * **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`.
415
- */
416
389
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
417
- /** 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`). */
418
390
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
419
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
420
391
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
421
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
422
392
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
423
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
424
393
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
425
- /** 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). */
426
394
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
427
- /** 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). */
428
395
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
429
396
  };
397
+ path: {
398
+ ID: components["parameters"]["ID"];
399
+ };
430
400
  };
431
401
  };
432
402
  "/transactions/{ID}/error": {
433
- /** If the server is unable to find or create a transaction, or another processing error occurs, the error callback `PUT /transactions/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request. */
403
+ /**
404
+ * Return transaction information error
405
+ * @description If the server is unable to find or create a transaction, or another processing error occurs, the error callback `PUT /transactions/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request.
406
+ */
434
407
  put: operations["TransactionsErrorByID"];
435
408
  };
436
409
  "/bulkQuotes": {
437
- /** The HTTP request `POST /bulkQuotes` is used to request the creation of a bulk quote for the provided financial transactions in the server. */
410
+ /**
411
+ * Calculate bulk quote
412
+ * @description The HTTP request `POST /bulkQuotes` is used to request the creation of a bulk quote for the provided financial transactions in the server.
413
+ */
438
414
  post: operations["BulkQuotes"];
439
415
  };
440
416
  "/bulkQuotes/{ID}": {
441
- /** The HTTP request `GET /bulkQuotes/{ID}` is used to get information regarding a bulk quote created or requested earlier. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote. */
417
+ /**
418
+ * Retrieve bulk quote information
419
+ * @description The HTTP request `GET /bulkQuotes/{ID}` is used to get information regarding a bulk quote created or requested earlier. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote.
420
+ */
442
421
  get: operations["BulkQuotesByID"];
443
- /** The callback `PUT /bulkQuotes/{ID}` is used to inform the client of a requested or created bulk quote. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request. */
422
+ /**
423
+ * Return bulk quote information
424
+ * @description The callback `PUT /bulkQuotes/{ID}` is used to inform the client of a requested or created bulk quote. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request.
425
+ */
444
426
  put: operations["BulkQuotesByID1"];
445
427
  parameters: {
446
- path: {
447
- /** The identifier value. */
448
- ID: components["parameters"]["ID"];
449
- };
450
428
  header: {
451
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
452
429
  "Content-Type": components["parameters"]["Content-Type"];
453
- /** The `Date` header field indicates the date when the request was sent. */
454
430
  Date: components["parameters"]["Date"];
455
- /**
456
- * 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.
457
- *
458
- * **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`.
459
- */
460
431
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
461
- /** 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`). */
462
432
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
463
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
464
433
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
465
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
466
434
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
467
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
468
435
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
469
- /** 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). */
470
436
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
471
- /** 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). */
472
437
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
473
438
  };
439
+ path: {
440
+ ID: components["parameters"]["ID"];
441
+ };
474
442
  };
475
443
  };
476
444
  "/bulkQuotes/{ID}/error": {
477
- /** If the server is unable to find or create a bulk quote, or another processing error occurs, the error callback `PUT /bulkQuotes/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request. */
445
+ /**
446
+ * Return bulk quote information error
447
+ * @description If the server is unable to find or create a bulk quote, or another processing error occurs, the error callback `PUT /bulkQuotes/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request.
448
+ */
478
449
  put: operations["BulkQuotesErrorByID"];
479
450
  };
480
451
  "/bulkTransfers": {
481
- /** The HTTP request `POST /bulkTransfers` is used to request the creation of a bulk transfer in the server. */
452
+ /**
453
+ * Perform bulk transfer
454
+ * @description The HTTP request `POST /bulkTransfers` is used to request the creation of a bulk transfer in the server.
455
+ */
482
456
  post: operations["BulkTransfers"];
483
457
  };
484
458
  "/bulkTransfers/{ID}": {
485
- /** The HTTP request `GET /bulkTransfers/{ID}` is used to get information regarding a bulk transfer created or requested earlier. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer. */
459
+ /**
460
+ * Retrieve bulk transfer information
461
+ * @description The HTTP request `GET /bulkTransfers/{ID}` is used to get information regarding a bulk transfer created or requested earlier. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer.
462
+ */
486
463
  get: operations["BulkTransferByID"];
487
- /** The callback `PUT /bulkTransfers/{ID}` is used to inform the client of a requested or created bulk transfer. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request. */
464
+ /**
465
+ * Return bulk transfer information
466
+ * @description The callback `PUT /bulkTransfers/{ID}` is used to inform the client of a requested or created bulk transfer. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request.
467
+ */
488
468
  put: operations["BulkTransfersByIDPut"];
489
469
  parameters: {
490
- path: {
491
- /** The identifier value. */
492
- ID: components["parameters"]["ID"];
493
- };
494
470
  header: {
495
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
496
471
  "Content-Type": components["parameters"]["Content-Type"];
497
- /** The `Date` header field indicates the date when the request was sent. */
498
472
  Date: components["parameters"]["Date"];
499
- /**
500
- * 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.
501
- *
502
- * **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`.
503
- */
504
473
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
505
- /** 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`). */
506
474
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
507
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
508
475
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
509
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
510
476
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
511
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
512
477
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
513
- /** 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). */
514
478
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
515
- /** 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). */
516
479
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
517
480
  };
481
+ path: {
482
+ ID: components["parameters"]["ID"];
483
+ };
518
484
  };
519
485
  };
520
486
  "/bulkTransfers/{ID}/error": {
521
- /** If the server is unable to find or create a bulk transfer, or another processing error occurs, the error callback `PUT /bulkTransfers/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request. */
487
+ /**
488
+ * Return bulk transfer information error
489
+ * @description If the server is unable to find or create a bulk transfer, or another processing error occurs, the error callback `PUT /bulkTransfers/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request.
490
+ */
522
491
  put: operations["BulkTransfersErrorByID"];
523
492
  };
524
493
  }
494
+ export type webhooks = Record<string, never>;
525
495
  export interface components {
526
496
  schemas: {
527
497
  /**
@@ -1866,62 +1836,90 @@ export interface components {
1866
1836
  };
1867
1837
  };
1868
1838
  responses: {
1869
- /** OK */
1870
- 200: unknown;
1871
- /** Accepted */
1872
- 202: unknown;
1873
- /** Bad Request */
1839
+ /** @description OK */
1840
+ 200: {
1841
+ content: never;
1842
+ };
1843
+ /** @description Accepted */
1844
+ 202: {
1845
+ content: never;
1846
+ };
1847
+ /** @description Bad Request */
1874
1848
  400: {
1875
- headers: {};
1849
+ headers: {
1850
+ "Content-Length": components["headers"]["Content-Length"];
1851
+ "Content-Type": components["headers"]["Content-Type"];
1852
+ };
1876
1853
  content: {
1877
1854
  "application/json": components["schemas"]["ErrorInformationResponse"];
1878
1855
  };
1879
1856
  };
1880
- /** Unauthorized */
1857
+ /** @description Unauthorized */
1881
1858
  401: {
1882
- headers: {};
1859
+ headers: {
1860
+ "Content-Length": components["headers"]["Content-Length"];
1861
+ "Content-Type": components["headers"]["Content-Type"];
1862
+ };
1883
1863
  content: {
1884
1864
  "application/json": components["schemas"]["ErrorInformationResponse"];
1885
1865
  };
1886
1866
  };
1887
- /** Forbidden */
1867
+ /** @description Forbidden */
1888
1868
  403: {
1889
- headers: {};
1869
+ headers: {
1870
+ "Content-Length": components["headers"]["Content-Length"];
1871
+ "Content-Type": components["headers"]["Content-Type"];
1872
+ };
1890
1873
  content: {
1891
1874
  "application/json": components["schemas"]["ErrorInformationResponse"];
1892
1875
  };
1893
1876
  };
1894
- /** Not Found */
1877
+ /** @description Not Found */
1895
1878
  404: {
1896
- headers: {};
1879
+ headers: {
1880
+ "Content-Length": components["headers"]["Content-Length"];
1881
+ "Content-Type": components["headers"]["Content-Type"];
1882
+ };
1897
1883
  content: {
1898
1884
  "application/json": components["schemas"]["ErrorInformationResponse"];
1899
1885
  };
1900
1886
  };
1901
- /** Method Not Allowed */
1887
+ /** @description Method Not Allowed */
1902
1888
  405: {
1903
- headers: {};
1889
+ headers: {
1890
+ "Content-Length": components["headers"]["Content-Length"];
1891
+ "Content-Type": components["headers"]["Content-Type"];
1892
+ };
1904
1893
  content: {
1905
1894
  "application/json": components["schemas"]["ErrorInformationResponse"];
1906
1895
  };
1907
1896
  };
1908
- /** Not Acceptable */
1897
+ /** @description Not Acceptable */
1909
1898
  406: {
1910
- headers: {};
1899
+ headers: {
1900
+ "Content-Length": components["headers"]["Content-Length"];
1901
+ "Content-Type": components["headers"]["Content-Type"];
1902
+ };
1911
1903
  content: {
1912
1904
  "application/json": components["schemas"]["ErrorInformationResponse"];
1913
1905
  };
1914
1906
  };
1915
- /** Not Implemented */
1907
+ /** @description Not Implemented */
1916
1908
  501: {
1917
- headers: {};
1909
+ headers: {
1910
+ "Content-Length": components["headers"]["Content-Length"];
1911
+ "Content-Type": components["headers"]["Content-Type"];
1912
+ };
1918
1913
  content: {
1919
1914
  "application/json": components["schemas"]["ErrorInformationResponse"];
1920
1915
  };
1921
1916
  };
1922
- /** Service Unavailable */
1917
+ /** @description Service Unavailable */
1923
1918
  503: {
1924
- headers: {};
1919
+ headers: {
1920
+ "Content-Length": components["headers"]["Content-Length"];
1921
+ "Content-Type": components["headers"]["Content-Type"];
1922
+ };
1925
1923
  content: {
1926
1924
  "application/json": components["schemas"]["ErrorInformationResponse"];
1927
1925
  };
@@ -1941,19 +1939,19 @@ export interface components {
1941
1939
  *
1942
1940
  * **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`.
1943
1941
  */
1944
- "X-Forwarded-For": string;
1942
+ "X-Forwarded-For"?: string;
1945
1943
  /** @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`). */
1946
1944
  "FSPIOP-Source": string;
1947
1945
  /** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
1948
- "FSPIOP-Destination": string;
1946
+ "FSPIOP-Destination"?: string;
1949
1947
  /** @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. */
1950
- "FSPIOP-Encryption": string;
1948
+ "FSPIOP-Encryption"?: string;
1951
1949
  /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
1952
- "FSPIOP-Signature": string;
1950
+ "FSPIOP-Signature"?: string;
1953
1951
  /** @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). */
1954
- "FSPIOP-URI": string;
1952
+ "FSPIOP-URI"?: string;
1955
1953
  /** @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). */
1956
- "FSPIOP-HTTP-Method": string;
1954
+ "FSPIOP-HTTP-Method"?: string;
1957
1955
  /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
1958
1956
  Accept: string;
1959
1957
  /**
@@ -1961,69 +1959,61 @@ export interface components {
1961
1959
  *
1962
1960
  * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
1963
1961
  */
1964
- "Content-Length": number;
1962
+ "Content-Length"?: number;
1965
1963
  /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
1966
1964
  SubId: string;
1967
1965
  };
1966
+ requestBodies: never;
1968
1967
  headers: {
1969
1968
  /**
1970
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
1969
+ * @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
1971
1970
  *
1972
1971
  * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
1973
1972
  */
1974
- "Content-Length"?: number;
1975
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
1973
+ "Content-Length": number;
1974
+ /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
1976
1975
  "Content-Type": string;
1977
1976
  };
1977
+ pathItems: never;
1978
1978
  }
1979
+ export type external = Record<string, never>;
1979
1980
  export interface operations {
1980
- /** Essential path to include schema components 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. */
1981
+ /** @description Essential path to include schema components 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. */
1981
1982
  Interface: {
1982
- responses: {
1983
- /** Ok */
1984
- 200: unknown;
1985
- };
1986
- requestBody: {
1983
+ requestBody?: {
1987
1984
  content: {
1988
1985
  "application/json": components["schemas"]["Amount"] | components["schemas"]["AmountType"] | components["schemas"]["AuthenticationInfo"] | components["schemas"]["AuthenticationType"] | components["schemas"]["AuthenticationValue"] | components["schemas"]["AuthorizationResponse"] | components["schemas"]["BalanceOfPayments"] | components["schemas"]["BinaryString"] | components["schemas"]["BinaryString32"] | components["schemas"]["BulkTransferState"] | components["schemas"]["Code"] | components["schemas"]["CorrelationId"] | components["schemas"]["Currency"] | components["schemas"]["Date"] | components["schemas"]["DateOfBirth"] | components["schemas"]["DateTime"] | components["schemas"]["ErrorCode"] | components["schemas"]["ErrorDescription"] | components["schemas"]["ExtensionKey"] | components["schemas"]["ExtensionValue"] | components["schemas"]["FirstName"] | components["schemas"]["FspId"] | components["schemas"]["IlpCondition"] | components["schemas"]["IlpFulfilment"] | components["schemas"]["IlpPacket"] | components["schemas"]["IndividualQuote"] | components["schemas"]["Integer"] | components["schemas"]["LastName"] | components["schemas"]["Latitude"] | components["schemas"]["Longitude"] | components["schemas"]["MerchantClassificationCode"] | components["schemas"]["MiddleName"] | components["schemas"]["Name"] | components["schemas"]["Note"] | components["schemas"]["OtpValue"] | components["schemas"]["PartyIdentifier"] | components["schemas"]["PartyIdType"] | components["schemas"]["PartyName"] | components["schemas"]["PartySubIdOrType"] | components["schemas"]["PersonalIdentifierType"] | components["schemas"]["RefundReason"] | components["schemas"]["QRCODE"] | components["schemas"]["TokenCode"] | components["schemas"]["Transaction"] | components["schemas"]["TransactionInitiator"] | components["schemas"]["TransactionInitiatorType"] | components["schemas"]["TransactionRequestState"] | components["schemas"]["TransactionScenario"] | components["schemas"]["TransactionState"] | components["schemas"]["TransactionSubScenario"] | components["schemas"]["TransferState"] | components["schemas"]["UndefinedEnum"];
1989
1986
  };
1990
1987
  };
1988
+ responses: {
1989
+ /** @description Ok */
1990
+ 200: {
1991
+ content: never;
1992
+ };
1993
+ };
1991
1994
  };
1992
- /** 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. */
1995
+ /**
1996
+ * Look up participant information
1997
+ * @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.
1998
+ */
1993
1999
  ParticipantsByTypeAndID: {
1994
2000
  parameters: {
1995
- path: {
1996
- /** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
1997
- Type: components["parameters"]["Type"];
1998
- /** The identifier value. */
1999
- ID: components["parameters"]["ID"];
2000
- };
2001
2001
  header: {
2002
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
2003
2002
  "Content-Type": components["parameters"]["Content-Type"];
2004
- /** The `Date` header field indicates the date when the request was sent. */
2005
2003
  Date: components["parameters"]["Date"];
2006
- /**
2007
- * 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.
2008
- *
2009
- * **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`.
2010
- */
2011
2004
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
2012
- /** 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`). */
2013
2005
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
2014
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
2015
2006
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
2016
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
2017
2007
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
2018
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
2019
2008
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
2020
- /** 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). */
2021
2009
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
2022
- /** 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). */
2023
2010
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
2024
- /** The `Accept` header field indicates the version of the API the client would like the server to use. */
2025
2011
  Accept: components["parameters"]["Accept"];
2026
2012
  };
2013
+ path: {
2014
+ Type: components["parameters"]["Type"];
2015
+ ID: components["parameters"]["ID"];
2016
+ };
2027
2017
  };
2028
2018
  responses: {
2029
2019
  202: components["responses"]["202"];
@@ -2037,45 +2027,34 @@ export interface operations {
2037
2027
  503: components["responses"]["503"];
2038
2028
  };
2039
2029
  };
2040
- /** 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. */
2030
+ /**
2031
+ * Return participant information
2032
+ * @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.
2033
+ */
2041
2034
  ParticipantsByTypeAndID3: {
2042
2035
  parameters: {
2043
- path: {
2044
- /** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
2045
- Type: components["parameters"]["Type"];
2046
- /** The identifier value. */
2047
- ID: components["parameters"]["ID"];
2048
- };
2049
2036
  header: {
2050
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
2051
2037
  "Content-Type": components["parameters"]["Content-Type"];
2052
- /** The `Date` header field indicates the date when the request was sent. */
2053
2038
  Date: components["parameters"]["Date"];
2054
- /**
2055
- * 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.
2056
- *
2057
- * **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`.
2058
- */
2059
2039
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
2060
- /** 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`). */
2061
2040
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
2062
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
2063
2041
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
2064
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
2065
2042
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
2066
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
2067
2043
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
2068
- /** 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). */
2069
2044
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
2070
- /** 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). */
2071
2045
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
2072
- /**
2073
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
2074
- *
2075
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
2076
- */
2077
2046
  "Content-Length"?: components["parameters"]["Content-Length"];
2078
2047
  };
2048
+ path: {
2049
+ Type: components["parameters"]["Type"];
2050
+ ID: components["parameters"]["ID"];
2051
+ };
2052
+ };
2053
+ /** @description Participant information returned. */
2054
+ requestBody: {
2055
+ content: {
2056
+ "application/json": components["schemas"]["ParticipantsTypeIDPutResponse"];
2057
+ };
2079
2058
  };
2080
2059
  responses: {
2081
2060
  200: components["responses"]["200"];
@@ -2088,54 +2067,36 @@ export interface operations {
2088
2067
  501: components["responses"]["501"];
2089
2068
  503: components["responses"]["503"];
2090
2069
  };
2091
- /** Participant information returned. */
2092
- requestBody: {
2093
- content: {
2094
- "application/json": components["schemas"]["ParticipantsTypeIDPutResponse"];
2095
- };
2096
- };
2097
2070
  };
2098
- /** 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`). */
2071
+ /**
2072
+ * Create participant information
2073
+ * @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`).
2074
+ */
2099
2075
  ParticipantsByIDAndType: {
2100
2076
  parameters: {
2101
- path: {
2102
- /** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
2103
- Type: components["parameters"]["Type"];
2104
- /** The identifier value. */
2105
- ID: components["parameters"]["ID"];
2106
- };
2107
2077
  header: {
2108
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
2109
2078
  "Content-Type": components["parameters"]["Content-Type"];
2110
- /** The `Date` header field indicates the date when the request was sent. */
2111
2079
  Date: components["parameters"]["Date"];
2112
- /**
2113
- * 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.
2114
- *
2115
- * **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`.
2116
- */
2117
2080
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
2118
- /** 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`). */
2119
2081
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
2120
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
2121
2082
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
2122
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
2123
2083
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
2124
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
2125
2084
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
2126
- /** 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). */
2127
2085
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
2128
- /** 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). */
2129
2086
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
2130
- /** The `Accept` header field indicates the version of the API the client would like the server to use. */
2131
2087
  Accept: components["parameters"]["Accept"];
2132
- /**
2133
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
2134
- *
2135
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
2136
- */
2137
2088
  "Content-Length"?: components["parameters"]["Content-Length"];
2138
2089
  };
2090
+ path: {
2091
+ Type: components["parameters"]["Type"];
2092
+ ID: components["parameters"]["ID"];
2093
+ };
2094
+ };
2095
+ /** @description Participant information to be created. */
2096
+ requestBody: {
2097
+ content: {
2098
+ "application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"];
2099
+ };
2139
2100
  };
2140
2101
  responses: {
2141
2102
  202: components["responses"]["202"];
@@ -2148,52 +2109,31 @@ export interface operations {
2148
2109
  501: components["responses"]["501"];
2149
2110
  503: components["responses"]["503"];
2150
2111
  };
2151
- /** Participant information to be created. */
2152
- requestBody: {
2153
- content: {
2154
- "application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"];
2155
- };
2156
- };
2157
2112
  };
2158
2113
  /**
2159
- * 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.
2114
+ * Delete participant information
2115
+ * @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.
2160
2116
  *
2161
2117
  * **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.
2162
2118
  */
2163
2119
  ParticipantsByTypeAndID2: {
2164
2120
  parameters: {
2165
- path: {
2166
- /** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
2167
- Type: components["parameters"]["Type"];
2168
- /** The identifier value. */
2169
- ID: components["parameters"]["ID"];
2170
- };
2171
2121
  header: {
2172
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
2173
2122
  "Content-Type": components["parameters"]["Content-Type"];
2174
- /** The `Date` header field indicates the date when the request was sent. */
2175
2123
  Date: components["parameters"]["Date"];
2176
- /**
2177
- * 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.
2178
- *
2179
- * **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`.
2180
- */
2181
2124
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
2182
- /** 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`). */
2183
2125
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
2184
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
2185
2126
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
2186
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
2187
2127
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
2188
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
2189
2128
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
2190
- /** 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). */
2191
2129
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
2192
- /** 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). */
2193
2130
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
2194
- /** The `Accept` header field indicates the version of the API the client would like the server to use. */
2195
2131
  Accept: components["parameters"]["Accept"];
2196
2132
  };
2133
+ path: {
2134
+ Type: components["parameters"]["Type"];
2135
+ ID: components["parameters"]["ID"];
2136
+ };
2197
2137
  };
2198
2138
  responses: {
2199
2139
  202: components["responses"]["202"];
@@ -2207,45 +2147,34 @@ export interface operations {
2207
2147
  503: components["responses"]["503"];
2208
2148
  };
2209
2149
  };
2210
- /** 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. */
2150
+ /**
2151
+ * Return participant information error
2152
+ * @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.
2153
+ */
2211
2154
  ParticipantsErrorByTypeAndID: {
2212
2155
  parameters: {
2213
- path: {
2214
- /** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
2215
- Type: components["parameters"]["Type"];
2216
- /** The identifier value. */
2217
- ID: components["parameters"]["ID"];
2218
- };
2219
2156
  header: {
2220
- /**
2221
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
2222
- *
2223
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
2224
- */
2225
2157
  "Content-Length"?: components["parameters"]["Content-Length"];
2226
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
2227
2158
  "Content-Type": components["parameters"]["Content-Type"];
2228
- /** The `Date` header field indicates the date when the request was sent. */
2229
2159
  Date: components["parameters"]["Date"];
2230
- /**
2231
- * 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.
2232
- *
2233
- * **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`.
2234
- */
2235
2160
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
2236
- /** 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`). */
2237
2161
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
2238
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
2239
2162
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
2240
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
2241
2163
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
2242
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
2243
2164
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
2244
- /** 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). */
2245
2165
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
2246
- /** 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). */
2247
2166
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
2248
2167
  };
2168
+ path: {
2169
+ Type: components["parameters"]["Type"];
2170
+ ID: components["parameters"]["ID"];
2171
+ };
2172
+ };
2173
+ /** @description Details of the error returned. */
2174
+ requestBody: {
2175
+ content: {
2176
+ "application/json": components["schemas"]["ErrorInformationObject"];
2177
+ };
2249
2178
  };
2250
2179
  responses: {
2251
2180
  200: components["responses"]["200"];
@@ -2258,50 +2187,30 @@ export interface operations {
2258
2187
  501: components["responses"]["501"];
2259
2188
  503: components["responses"]["503"];
2260
2189
  };
2261
- /** Details of the error returned. */
2262
- requestBody: {
2263
- content: {
2264
- "application/json": components["schemas"]["ErrorInformationObject"];
2265
- };
2266
- };
2267
2190
  };
2268
- /** 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. */
2191
+ /**
2192
+ * Look up participant information
2193
+ * @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.
2194
+ */
2269
2195
  ParticipantsSubIdByTypeAndID: {
2270
2196
  parameters: {
2271
- path: {
2272
- /** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
2273
- Type: components["parameters"]["Type"];
2274
- /** The identifier value. */
2275
- ID: components["parameters"]["ID"];
2276
- /** A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
2277
- SubId: components["parameters"]["SubId"];
2278
- };
2279
2197
  header: {
2280
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
2281
2198
  "Content-Type": components["parameters"]["Content-Type"];
2282
- /** The `Date` header field indicates the date when the request was sent. */
2283
2199
  Date: components["parameters"]["Date"];
2284
- /**
2285
- * 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.
2286
- *
2287
- * **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`.
2288
- */
2289
2200
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
2290
- /** 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`). */
2291
2201
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
2292
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
2293
2202
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
2294
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
2295
2203
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
2296
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
2297
2204
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
2298
- /** 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). */
2299
2205
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
2300
- /** 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). */
2301
2206
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
2302
- /** The `Accept` header field indicates the version of the API the client would like the server to use. */
2303
2207
  Accept: components["parameters"]["Accept"];
2304
2208
  };
2209
+ path: {
2210
+ Type: components["parameters"]["Type"];
2211
+ ID: components["parameters"]["ID"];
2212
+ SubId: components["parameters"]["SubId"];
2213
+ };
2305
2214
  };
2306
2215
  responses: {
2307
2216
  202: components["responses"]["202"];
@@ -2315,47 +2224,35 @@ export interface operations {
2315
2224
  503: components["responses"]["503"];
2316
2225
  };
2317
2226
  };
2318
- /** 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. */
2227
+ /**
2228
+ * Return participant information
2229
+ * @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.
2230
+ */
2319
2231
  ParticipantsSubIdByTypeAndID3: {
2320
2232
  parameters: {
2321
- path: {
2322
- /** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
2323
- Type: components["parameters"]["Type"];
2324
- /** The identifier value. */
2325
- ID: components["parameters"]["ID"];
2326
- /** A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
2327
- SubId: components["parameters"]["SubId"];
2328
- };
2329
2233
  header: {
2330
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
2331
2234
  "Content-Type": components["parameters"]["Content-Type"];
2332
- /** The `Date` header field indicates the date when the request was sent. */
2333
2235
  Date: components["parameters"]["Date"];
2334
- /**
2335
- * 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.
2336
- *
2337
- * **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`.
2338
- */
2339
2236
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
2340
- /** 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`). */
2341
2237
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
2342
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
2343
2238
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
2344
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
2345
2239
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
2346
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
2347
2240
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
2348
- /** 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). */
2349
2241
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
2350
- /** 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). */
2351
2242
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
2352
- /**
2353
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
2354
- *
2355
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
2356
- */
2357
2243
  "Content-Length"?: components["parameters"]["Content-Length"];
2358
2244
  };
2245
+ path: {
2246
+ Type: components["parameters"]["Type"];
2247
+ ID: components["parameters"]["ID"];
2248
+ SubId: components["parameters"]["SubId"];
2249
+ };
2250
+ };
2251
+ /** @description Participant information returned. */
2252
+ requestBody: {
2253
+ content: {
2254
+ "application/json": components["schemas"]["ParticipantsTypeIDPutResponse"];
2255
+ };
2359
2256
  };
2360
2257
  responses: {
2361
2258
  200: components["responses"]["200"];
@@ -2368,56 +2265,37 @@ export interface operations {
2368
2265
  501: components["responses"]["501"];
2369
2266
  503: components["responses"]["503"];
2370
2267
  };
2371
- /** Participant information returned. */
2372
- requestBody: {
2373
- content: {
2374
- "application/json": components["schemas"]["ParticipantsTypeIDPutResponse"];
2375
- };
2376
- };
2377
2268
  };
2378
- /** 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`). */
2269
+ /**
2270
+ * Create participant information
2271
+ * @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`).
2272
+ */
2379
2273
  ParticipantsSubIdByTypeAndIDPost: {
2380
2274
  parameters: {
2381
- path: {
2382
- /** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
2383
- Type: components["parameters"]["Type"];
2384
- /** The identifier value. */
2385
- ID: components["parameters"]["ID"];
2386
- /** A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
2387
- SubId: components["parameters"]["SubId"];
2388
- };
2389
2275
  header: {
2390
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
2391
2276
  "Content-Type": components["parameters"]["Content-Type"];
2392
- /** The `Date` header field indicates the date when the request was sent. */
2393
2277
  Date: components["parameters"]["Date"];
2394
- /**
2395
- * 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.
2396
- *
2397
- * **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`.
2398
- */
2399
2278
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
2400
- /** 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`). */
2401
2279
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
2402
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
2403
2280
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
2404
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
2405
2281
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
2406
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
2407
2282
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
2408
- /** 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). */
2409
2283
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
2410
- /** 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). */
2411
2284
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
2412
- /** The `Accept` header field indicates the version of the API the client would like the server to use. */
2413
2285
  Accept: components["parameters"]["Accept"];
2414
- /**
2415
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
2416
- *
2417
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
2418
- */
2419
2286
  "Content-Length"?: components["parameters"]["Content-Length"];
2420
2287
  };
2288
+ path: {
2289
+ Type: components["parameters"]["Type"];
2290
+ ID: components["parameters"]["ID"];
2291
+ SubId: components["parameters"]["SubId"];
2292
+ };
2293
+ };
2294
+ /** @description Participant information to be created. */
2295
+ requestBody: {
2296
+ content: {
2297
+ "application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"];
2298
+ };
2421
2299
  };
2422
2300
  responses: {
2423
2301
  202: components["responses"]["202"];
@@ -2430,54 +2308,32 @@ export interface operations {
2430
2308
  501: components["responses"]["501"];
2431
2309
  503: components["responses"]["503"];
2432
2310
  };
2433
- /** Participant information to be created. */
2434
- requestBody: {
2435
- content: {
2436
- "application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"];
2437
- };
2438
- };
2439
2311
  };
2440
2312
  /**
2441
- * 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.
2313
+ * Delete participant information
2314
+ * @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.
2442
2315
  *
2443
2316
  * **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.
2444
2317
  */
2445
2318
  ParticipantsSubIdByTypeAndID2: {
2446
2319
  parameters: {
2447
- path: {
2448
- /** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
2449
- Type: components["parameters"]["Type"];
2450
- /** The identifier value. */
2451
- ID: components["parameters"]["ID"];
2452
- /** A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
2453
- SubId: components["parameters"]["SubId"];
2454
- };
2455
2320
  header: {
2456
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
2457
2321
  "Content-Type": components["parameters"]["Content-Type"];
2458
- /** The `Date` header field indicates the date when the request was sent. */
2459
2322
  Date: components["parameters"]["Date"];
2460
- /**
2461
- * 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.
2462
- *
2463
- * **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`.
2464
- */
2465
2323
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
2466
- /** 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`). */
2467
2324
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
2468
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
2469
2325
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
2470
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
2471
2326
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
2472
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
2473
2327
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
2474
- /** 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). */
2475
2328
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
2476
- /** 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). */
2477
2329
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
2478
- /** The `Accept` header field indicates the version of the API the client would like the server to use. */
2479
2330
  Accept: components["parameters"]["Accept"];
2480
2331
  };
2332
+ path: {
2333
+ Type: components["parameters"]["Type"];
2334
+ ID: components["parameters"]["ID"];
2335
+ SubId: components["parameters"]["SubId"];
2336
+ };
2481
2337
  };
2482
2338
  responses: {
2483
2339
  202: components["responses"]["202"];
@@ -2491,47 +2347,35 @@ export interface operations {
2491
2347
  503: components["responses"]["503"];
2492
2348
  };
2493
2349
  };
2494
- /** 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. */
2350
+ /**
2351
+ * Return participant information error
2352
+ * @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.
2353
+ */
2495
2354
  ParticipantsSubIdErrorByTypeAndID: {
2496
2355
  parameters: {
2497
- path: {
2498
- /** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
2499
- Type: components["parameters"]["Type"];
2500
- /** The identifier value. */
2501
- ID: components["parameters"]["ID"];
2502
- /** A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
2503
- SubId: components["parameters"]["SubId"];
2504
- };
2505
2356
  header: {
2506
- /**
2507
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
2508
- *
2509
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
2510
- */
2511
2357
  "Content-Length"?: components["parameters"]["Content-Length"];
2512
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
2513
2358
  "Content-Type": components["parameters"]["Content-Type"];
2514
- /** The `Date` header field indicates the date when the request was sent. */
2515
2359
  Date: components["parameters"]["Date"];
2516
- /**
2517
- * 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.
2518
- *
2519
- * **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`.
2520
- */
2521
2360
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
2522
- /** 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`). */
2523
2361
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
2524
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
2525
2362
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
2526
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
2527
2363
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
2528
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
2529
2364
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
2530
- /** 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). */
2531
2365
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
2532
- /** 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). */
2533
2366
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
2534
2367
  };
2368
+ path: {
2369
+ Type: components["parameters"]["Type"];
2370
+ ID: components["parameters"]["ID"];
2371
+ SubId: components["parameters"]["SubId"];
2372
+ };
2373
+ };
2374
+ /** @description Details of the error returned. */
2375
+ requestBody: {
2376
+ content: {
2377
+ "application/json": components["schemas"]["ErrorInformationObject"];
2378
+ };
2535
2379
  };
2536
2380
  responses: {
2537
2381
  200: components["responses"]["200"];
@@ -2544,49 +2388,33 @@ export interface operations {
2544
2388
  501: components["responses"]["501"];
2545
2389
  503: components["responses"]["503"];
2546
2390
  };
2547
- /** Details of the error returned. */
2548
- requestBody: {
2549
- content: {
2550
- "application/json": components["schemas"]["ErrorInformationObject"];
2551
- };
2552
- };
2553
2391
  };
2554
- /** 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. */
2392
+ /**
2393
+ * Create bulk participant information
2394
+ * @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.
2395
+ */
2555
2396
  Participants1: {
2556
2397
  parameters: {
2557
2398
  header: {
2558
- /** The `Accept` header field indicates the version of the API the client would like the server to use. */
2559
2399
  Accept: components["parameters"]["Accept"];
2560
- /**
2561
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
2562
- *
2563
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
2564
- */
2565
2400
  "Content-Length"?: components["parameters"]["Content-Length"];
2566
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
2567
2401
  "Content-Type": components["parameters"]["Content-Type"];
2568
- /** The `Date` header field indicates the date when the request was sent. */
2569
2402
  Date: components["parameters"]["Date"];
2570
- /**
2571
- * 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.
2572
- *
2573
- * **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`.
2574
- */
2575
2403
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
2576
- /** 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`). */
2577
2404
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
2578
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
2579
2405
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
2580
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
2581
2406
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
2582
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
2583
2407
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
2584
- /** 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). */
2585
2408
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
2586
- /** 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). */
2587
2409
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
2588
2410
  };
2589
2411
  };
2412
+ /** @description Participant information to be created. */
2413
+ requestBody: {
2414
+ content: {
2415
+ "application/json": components["schemas"]["ParticipantsPostRequest"];
2416
+ };
2417
+ };
2590
2418
  responses: {
2591
2419
  202: components["responses"]["202"];
2592
2420
  400: components["responses"]["400"];
@@ -2598,50 +2426,34 @@ export interface operations {
2598
2426
  501: components["responses"]["501"];
2599
2427
  503: components["responses"]["503"];
2600
2428
  };
2601
- /** Participant information to be created. */
2602
- requestBody: {
2603
- content: {
2604
- "application/json": components["schemas"]["ParticipantsPostRequest"];
2605
- };
2606
- };
2607
2429
  };
2608
- /** The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities. */
2430
+ /**
2431
+ * Return bulk participant information
2432
+ * @description The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities.
2433
+ */
2609
2434
  putParticipantsByID: {
2610
2435
  parameters: {
2611
- path: {
2612
- /** The identifier value. */
2613
- ID: components["parameters"]["ID"];
2614
- };
2615
2436
  header: {
2616
- /**
2617
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
2618
- *
2619
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
2620
- */
2621
2437
  "Content-Length"?: components["parameters"]["Content-Length"];
2622
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
2623
2438
  "Content-Type": components["parameters"]["Content-Type"];
2624
- /** The `Date` header field indicates the date when the request was sent. */
2625
2439
  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
2440
  "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
2441
  "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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
2635
2442
  "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
2443
  "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
2444
  "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
2445
  "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
2446
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
2644
2447
  };
2448
+ path: {
2449
+ ID: components["parameters"]["ID"];
2450
+ };
2451
+ };
2452
+ /** @description Participant information returned. */
2453
+ requestBody: {
2454
+ content: {
2455
+ "application/json": components["schemas"]["ParticipantsIDPutResponse"];
2456
+ };
2645
2457
  };
2646
2458
  responses: {
2647
2459
  200: components["responses"]["200"];
@@ -2654,50 +2466,34 @@ export interface operations {
2654
2466
  501: components["responses"]["501"];
2655
2467
  503: components["responses"]["503"];
2656
2468
  };
2657
- /** Participant information returned. */
2658
- requestBody: {
2659
- content: {
2660
- "application/json": components["schemas"]["ParticipantsIDPutResponse"];
2661
- };
2662
- };
2663
2469
  };
2664
- /** 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. */
2470
+ /**
2471
+ * Return bulk participant information error
2472
+ * @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.
2473
+ */
2665
2474
  ParticipantsByIDAndError: {
2666
2475
  parameters: {
2667
- path: {
2668
- /** The identifier value. */
2669
- ID: components["parameters"]["ID"];
2670
- };
2671
2476
  header: {
2672
- /**
2673
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
2674
- *
2675
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
2676
- */
2677
2477
  "Content-Length"?: components["parameters"]["Content-Length"];
2678
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
2679
2478
  "Content-Type": components["parameters"]["Content-Type"];
2680
- /** The `Date` header field indicates the date when the request was sent. */
2681
2479
  Date: components["parameters"]["Date"];
2682
- /**
2683
- * 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.
2684
- *
2685
- * **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`.
2686
- */
2687
2480
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
2688
- /** 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`). */
2689
2481
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
2690
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
2691
2482
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
2692
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
2693
2483
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
2694
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
2695
2484
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
2696
- /** 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). */
2697
2485
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
2698
- /** 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). */
2699
2486
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
2700
2487
  };
2488
+ path: {
2489
+ ID: components["parameters"]["ID"];
2490
+ };
2491
+ };
2492
+ /** @description Details of the error returned. */
2493
+ requestBody: {
2494
+ content: {
2495
+ "application/json": components["schemas"]["ErrorInformationObject"];
2496
+ };
2701
2497
  };
2702
2498
  responses: {
2703
2499
  200: components["responses"]["200"];
@@ -2710,48 +2506,29 @@ export interface operations {
2710
2506
  501: components["responses"]["501"];
2711
2507
  503: components["responses"]["503"];
2712
2508
  };
2713
- /** Details of the error returned. */
2714
- requestBody: {
2715
- content: {
2716
- "application/json": components["schemas"]["ErrorInformationObject"];
2717
- };
2718
- };
2719
2509
  };
2720
- /** The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`). */
2510
+ /**
2511
+ * Look up party information
2512
+ * @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`).
2513
+ */
2721
2514
  PartiesByTypeAndID: {
2722
2515
  parameters: {
2723
- path: {
2724
- /** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
2725
- Type: components["parameters"]["Type"];
2726
- /** The identifier value. */
2727
- ID: components["parameters"]["ID"];
2728
- };
2729
2516
  header: {
2730
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
2731
2517
  "Content-Type": components["parameters"]["Content-Type"];
2732
- /** The `Date` header field indicates the date when the request was sent. */
2733
2518
  Date: components["parameters"]["Date"];
2734
- /**
2735
- * 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.
2736
- *
2737
- * **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`.
2738
- */
2739
2519
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
2740
- /** 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`). */
2741
2520
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
2742
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
2743
2521
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
2744
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
2745
2522
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
2746
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
2747
2523
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
2748
- /** 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). */
2749
2524
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
2750
- /** 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). */
2751
2525
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
2752
- /** The `Accept` header field indicates the version of the API the client would like the server to use. */
2753
2526
  Accept: components["parameters"]["Accept"];
2754
2527
  };
2528
+ path: {
2529
+ Type: components["parameters"]["Type"];
2530
+ ID: components["parameters"]["ID"];
2531
+ };
2755
2532
  };
2756
2533
  responses: {
2757
2534
  202: components["responses"]["202"];
@@ -2765,45 +2542,34 @@ export interface operations {
2765
2542
  503: components["responses"]["503"];
2766
2543
  };
2767
2544
  };
2768
- /** The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup. */
2545
+ /**
2546
+ * Return party information
2547
+ * @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup.
2548
+ */
2769
2549
  PartiesByTypeAndID2: {
2770
2550
  parameters: {
2771
- path: {
2772
- /** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
2773
- Type: components["parameters"]["Type"];
2774
- /** The identifier value. */
2775
- ID: components["parameters"]["ID"];
2776
- };
2777
2551
  header: {
2778
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
2779
2552
  "Content-Type": components["parameters"]["Content-Type"];
2780
- /** The `Date` header field indicates the date when the request was sent. */
2781
2553
  Date: components["parameters"]["Date"];
2782
- /**
2783
- * 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.
2784
- *
2785
- * **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`.
2786
- */
2787
2554
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
2788
- /** 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`). */
2789
2555
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
2790
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
2791
2556
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
2792
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
2793
2557
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
2794
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
2795
2558
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
2796
- /** 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). */
2797
2559
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
2798
- /** 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). */
2799
2560
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
2800
- /**
2801
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
2802
- *
2803
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
2804
- */
2805
2561
  "Content-Length"?: components["parameters"]["Content-Length"];
2806
2562
  };
2563
+ path: {
2564
+ Type: components["parameters"]["Type"];
2565
+ ID: components["parameters"]["ID"];
2566
+ };
2567
+ };
2568
+ /** @description Party information returned. */
2569
+ requestBody: {
2570
+ content: {
2571
+ "application/json": components["schemas"]["PartiesTypeIDPutResponse"];
2572
+ };
2807
2573
  };
2808
2574
  responses: {
2809
2575
  200: components["responses"]["200"];
@@ -2816,52 +2582,35 @@ export interface operations {
2816
2582
  501: components["responses"]["501"];
2817
2583
  503: components["responses"]["503"];
2818
2584
  };
2819
- /** Party information returned. */
2820
- requestBody: {
2821
- content: {
2822
- "application/json": components["schemas"]["PartiesTypeIDPutResponse"];
2823
- };
2824
- };
2825
2585
  };
2826
- /** If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubI}/error`) is used. */
2586
+ /**
2587
+ * Return party information error
2588
+ * @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubI}/error`) is used.
2589
+ */
2827
2590
  PartiesErrorByTypeAndID: {
2828
2591
  parameters: {
2829
- path: {
2830
- /** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
2831
- Type: components["parameters"]["Type"];
2832
- /** The identifier value. */
2833
- ID: components["parameters"]["ID"];
2834
- };
2835
2592
  header: {
2836
- /**
2837
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
2838
- *
2839
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
2840
- */
2841
2593
  "Content-Length"?: components["parameters"]["Content-Length"];
2842
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
2843
2594
  "Content-Type": components["parameters"]["Content-Type"];
2844
- /** The `Date` header field indicates the date when the request was sent. */
2845
2595
  Date: components["parameters"]["Date"];
2846
- /**
2847
- * 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.
2848
- *
2849
- * **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`.
2850
- */
2851
2596
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
2852
- /** 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`). */
2853
2597
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
2854
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
2855
2598
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
2856
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
2857
2599
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
2858
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
2859
2600
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
2860
- /** 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). */
2861
2601
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
2862
- /** 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). */
2863
2602
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
2864
2603
  };
2604
+ path: {
2605
+ Type: components["parameters"]["Type"];
2606
+ ID: components["parameters"]["ID"];
2607
+ };
2608
+ };
2609
+ /** @description Details of the error returned. */
2610
+ requestBody: {
2611
+ content: {
2612
+ "application/json": components["schemas"]["ErrorInformationObject"];
2613
+ };
2865
2614
  };
2866
2615
  responses: {
2867
2616
  200: components["responses"]["200"];
@@ -2874,50 +2623,30 @@ export interface operations {
2874
2623
  501: components["responses"]["501"];
2875
2624
  503: components["responses"]["503"];
2876
2625
  };
2877
- /** Details of the error returned. */
2878
- requestBody: {
2879
- content: {
2880
- "application/json": components["schemas"]["ErrorInformationObject"];
2881
- };
2882
- };
2883
2626
  };
2884
- /** The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`). */
2627
+ /**
2628
+ * Look up party information
2629
+ * @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`).
2630
+ */
2885
2631
  PartiesSubIdByTypeAndID: {
2886
2632
  parameters: {
2887
- path: {
2888
- /** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
2889
- Type: components["parameters"]["Type"];
2890
- /** The identifier value. */
2891
- ID: components["parameters"]["ID"];
2892
- /** A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
2893
- SubId: components["parameters"]["SubId"];
2894
- };
2895
2633
  header: {
2896
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
2897
2634
  "Content-Type": components["parameters"]["Content-Type"];
2898
- /** The `Date` header field indicates the date when the request was sent. */
2899
2635
  Date: components["parameters"]["Date"];
2900
- /**
2901
- * 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.
2902
- *
2903
- * **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`.
2904
- */
2905
2636
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
2906
- /** 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`). */
2907
2637
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
2908
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
2909
2638
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
2910
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
2911
2639
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
2912
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
2913
2640
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
2914
- /** 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). */
2915
2641
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
2916
- /** 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). */
2917
2642
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
2918
- /** The `Accept` header field indicates the version of the API the client would like the server to use. */
2919
2643
  Accept: components["parameters"]["Accept"];
2920
2644
  };
2645
+ path: {
2646
+ Type: components["parameters"]["Type"];
2647
+ ID: components["parameters"]["ID"];
2648
+ SubId: components["parameters"]["SubId"];
2649
+ };
2921
2650
  };
2922
2651
  responses: {
2923
2652
  202: components["responses"]["202"];
@@ -2931,47 +2660,35 @@ export interface operations {
2931
2660
  503: components["responses"]["503"];
2932
2661
  };
2933
2662
  };
2934
- /** The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup. */
2663
+ /**
2664
+ * Return party information
2665
+ * @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup.
2666
+ */
2935
2667
  PartiesSubIdByTypeAndIDPut: {
2936
2668
  parameters: {
2937
- path: {
2938
- /** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
2939
- Type: components["parameters"]["Type"];
2940
- /** The identifier value. */
2941
- ID: components["parameters"]["ID"];
2942
- /** A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
2943
- SubId: components["parameters"]["SubId"];
2944
- };
2945
2669
  header: {
2946
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
2947
2670
  "Content-Type": components["parameters"]["Content-Type"];
2948
- /** The `Date` header field indicates the date when the request was sent. */
2949
2671
  Date: components["parameters"]["Date"];
2950
- /**
2951
- * 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.
2952
- *
2953
- * **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`.
2954
- */
2955
2672
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
2956
- /** 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`). */
2957
2673
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
2958
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
2959
2674
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
2960
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
2961
2675
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
2962
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
2963
2676
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
2964
- /** 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). */
2965
2677
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
2966
- /** 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). */
2967
2678
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
2968
- /**
2969
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
2970
- *
2971
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
2972
- */
2973
2679
  "Content-Length"?: components["parameters"]["Content-Length"];
2974
2680
  };
2681
+ path: {
2682
+ Type: components["parameters"]["Type"];
2683
+ ID: components["parameters"]["ID"];
2684
+ SubId: components["parameters"]["SubId"];
2685
+ };
2686
+ };
2687
+ /** @description Party information returned. */
2688
+ requestBody: {
2689
+ content: {
2690
+ "application/json": components["schemas"]["PartiesTypeIDPutResponse"];
2691
+ };
2975
2692
  };
2976
2693
  responses: {
2977
2694
  200: components["responses"]["200"];
@@ -2984,54 +2701,36 @@ export interface operations {
2984
2701
  501: components["responses"]["501"];
2985
2702
  503: components["responses"]["503"];
2986
2703
  };
2987
- /** Party information returned. */
2988
- requestBody: {
2989
- content: {
2990
- "application/json": components["schemas"]["PartiesTypeIDPutResponse"];
2991
- };
2992
- };
2993
2704
  };
2994
- /** If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubId}/error`) is used. */
2705
+ /**
2706
+ * Return party information error
2707
+ * @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubId}/error`) is used.
2708
+ */
2995
2709
  PartiesSubIdErrorByTypeAndID: {
2996
2710
  parameters: {
2997
- path: {
2998
- /** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
2999
- Type: components["parameters"]["Type"];
3000
- /** The identifier value. */
3001
- ID: components["parameters"]["ID"];
3002
- /** A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
3003
- SubId: components["parameters"]["SubId"];
3004
- };
3005
2711
  header: {
3006
- /**
3007
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
3008
- *
3009
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
3010
- */
3011
2712
  "Content-Length"?: components["parameters"]["Content-Length"];
3012
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
3013
2713
  "Content-Type": components["parameters"]["Content-Type"];
3014
- /** The `Date` header field indicates the date when the request was sent. */
3015
2714
  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
2715
  "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
2716
  "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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
3025
2717
  "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
2718
  "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
2719
  "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
2720
  "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
2721
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
3034
2722
  };
2723
+ path: {
2724
+ Type: components["parameters"]["Type"];
2725
+ ID: components["parameters"]["ID"];
2726
+ SubId: components["parameters"]["SubId"];
2727
+ };
2728
+ };
2729
+ /** @description Details of the error returned. */
2730
+ requestBody: {
2731
+ content: {
2732
+ "application/json": components["schemas"]["ErrorInformationObject"];
2733
+ };
3035
2734
  };
3036
2735
  responses: {
3037
2736
  200: components["responses"]["200"];
@@ -3044,49 +2743,33 @@ export interface operations {
3044
2743
  501: components["responses"]["501"];
3045
2744
  503: components["responses"]["503"];
3046
2745
  };
3047
- /** Details of the error returned. */
3048
- requestBody: {
3049
- content: {
3050
- "application/json": components["schemas"]["ErrorInformationObject"];
3051
- };
3052
- };
3053
2746
  };
3054
- /** The HTTP request `POST /transactionRequests` is used to request the creation of a transaction request for the provided financial transaction in the server. */
2747
+ /**
2748
+ * Perform transaction request
2749
+ * @description The HTTP request `POST /transactionRequests` is used to request the creation of a transaction request for the provided financial transaction in the server.
2750
+ */
3055
2751
  TransactionRequests: {
3056
2752
  parameters: {
3057
2753
  header: {
3058
- /** The `Accept` header field indicates the version of the API the client would like the server to use. */
3059
2754
  Accept: components["parameters"]["Accept"];
3060
- /**
3061
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
3062
- *
3063
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
3064
- */
3065
2755
  "Content-Length"?: components["parameters"]["Content-Length"];
3066
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
3067
2756
  "Content-Type": components["parameters"]["Content-Type"];
3068
- /** The `Date` header field indicates the date when the request was sent. */
3069
2757
  Date: components["parameters"]["Date"];
3070
- /**
3071
- * 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.
3072
- *
3073
- * **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`.
3074
- */
3075
2758
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
3076
- /** 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`). */
3077
2759
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
3078
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
3079
2760
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
3080
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
3081
2761
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
3082
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
3083
2762
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
3084
- /** 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). */
3085
2763
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
3086
- /** 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). */
3087
2764
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
3088
2765
  };
3089
2766
  };
2767
+ /** @description Transaction request to be created. */
2768
+ requestBody: {
2769
+ content: {
2770
+ "application/json": components["schemas"]["TransactionRequestsPostRequest"];
2771
+ };
2772
+ };
3090
2773
  responses: {
3091
2774
  202: components["responses"]["202"];
3092
2775
  400: components["responses"]["400"];
@@ -3098,46 +2781,28 @@ export interface operations {
3098
2781
  501: components["responses"]["501"];
3099
2782
  503: components["responses"]["503"];
3100
2783
  };
3101
- /** Transaction request to be created. */
3102
- requestBody: {
3103
- content: {
3104
- "application/json": components["schemas"]["TransactionRequestsPostRequest"];
3105
- };
3106
- };
3107
2784
  };
3108
- /** The HTTP request `GET /transactionRequests/{ID}` is used to get information regarding a transaction request created or requested earlier. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request. */
2785
+ /**
2786
+ * Retrieve transaction request information
2787
+ * @description The HTTP request `GET /transactionRequests/{ID}` is used to get information regarding a transaction request created or requested earlier. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request.
2788
+ */
3109
2789
  TransactionRequestsByID: {
3110
2790
  parameters: {
3111
- path: {
3112
- /** The identifier value. */
3113
- ID: components["parameters"]["ID"];
3114
- };
3115
2791
  header: {
3116
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
3117
2792
  "Content-Type": components["parameters"]["Content-Type"];
3118
- /** The `Date` header field indicates the date when the request was sent. */
3119
2793
  Date: components["parameters"]["Date"];
3120
- /**
3121
- * 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.
3122
- *
3123
- * **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`.
3124
- */
3125
2794
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
3126
- /** 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`). */
3127
2795
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
3128
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
3129
2796
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
3130
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
3131
2797
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
3132
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
3133
2798
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
3134
- /** 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). */
3135
2799
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
3136
- /** 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). */
3137
2800
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
3138
- /** The `Accept` header field indicates the version of the API the client would like the server to use. */
3139
2801
  Accept: components["parameters"]["Accept"];
3140
2802
  };
2803
+ path: {
2804
+ ID: components["parameters"]["ID"];
2805
+ };
3141
2806
  };
3142
2807
  responses: {
3143
2808
  202: components["responses"]["202"];
@@ -3151,43 +2816,33 @@ export interface operations {
3151
2816
  503: components["responses"]["503"];
3152
2817
  };
3153
2818
  };
3154
- /** The callback `PUT /transactionRequests/{ID}` is used to inform the client of a requested or created transaction request. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`. */
2819
+ /**
2820
+ * Return transaction request information
2821
+ * @description The callback `PUT /transactionRequests/{ID}` is used to inform the client of a requested or created transaction request. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`.
2822
+ */
3155
2823
  TransactionRequestsByIDPut: {
3156
2824
  parameters: {
3157
- path: {
3158
- /** The identifier value. */
3159
- ID: components["parameters"]["ID"];
3160
- };
3161
2825
  header: {
3162
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
3163
2826
  "Content-Type": components["parameters"]["Content-Type"];
3164
- /** The `Date` header field indicates the date when the request was sent. */
3165
2827
  Date: components["parameters"]["Date"];
3166
- /**
3167
- * 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.
3168
- *
3169
- * **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`.
3170
- */
3171
2828
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
3172
- /** 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`). */
3173
2829
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
3174
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
3175
2830
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
3176
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
3177
2831
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
3178
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
3179
2832
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
3180
- /** 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). */
3181
2833
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
3182
- /** 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). */
3183
2834
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
3184
- /**
3185
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
3186
- *
3187
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
3188
- */
3189
2835
  "Content-Length"?: components["parameters"]["Content-Length"];
3190
2836
  };
2837
+ path: {
2838
+ ID: components["parameters"]["ID"];
2839
+ };
2840
+ };
2841
+ /** @description Transaction request information returned. */
2842
+ requestBody: {
2843
+ content: {
2844
+ "application/json": components["schemas"]["TransactionRequestsIDPutResponse"];
2845
+ };
3191
2846
  };
3192
2847
  responses: {
3193
2848
  200: components["responses"]["200"];
@@ -3200,50 +2855,34 @@ export interface operations {
3200
2855
  501: components["responses"]["501"];
3201
2856
  503: components["responses"]["503"];
3202
2857
  };
3203
- /** Transaction request information returned. */
3204
- requestBody: {
3205
- content: {
3206
- "application/json": components["schemas"]["TransactionRequestsIDPutResponse"];
3207
- };
3208
- };
3209
2858
  };
3210
- /** If the server is unable to find or create a transaction request, or another processing error occurs, the error callback `PUT /transactionRequests/{ID}/error` is used. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`. */
2859
+ /**
2860
+ * Return transaction request information error
2861
+ * @description If the server is unable to find or create a transaction request, or another processing error occurs, the error callback `PUT /transactionRequests/{ID}/error` is used. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`.
2862
+ */
3211
2863
  TransactionRequestsErrorByID: {
3212
2864
  parameters: {
3213
- path: {
3214
- /** The identifier value. */
3215
- ID: components["parameters"]["ID"];
3216
- };
3217
2865
  header: {
3218
- /**
3219
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
3220
- *
3221
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
3222
- */
3223
2866
  "Content-Length"?: components["parameters"]["Content-Length"];
3224
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
3225
2867
  "Content-Type": components["parameters"]["Content-Type"];
3226
- /** The `Date` header field indicates the date when the request was sent. */
3227
2868
  Date: components["parameters"]["Date"];
3228
- /**
3229
- * 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.
3230
- *
3231
- * **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`.
3232
- */
3233
2869
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
3234
- /** 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`). */
3235
2870
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
3236
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
3237
2871
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
3238
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
3239
2872
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
3240
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
3241
2873
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
3242
- /** 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). */
3243
2874
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
3244
- /** 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). */
3245
2875
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
3246
2876
  };
2877
+ path: {
2878
+ ID: components["parameters"]["ID"];
2879
+ };
2880
+ };
2881
+ /** @description Details of the error returned. */
2882
+ requestBody: {
2883
+ content: {
2884
+ "application/json": components["schemas"]["ErrorInformationObject"];
2885
+ };
3247
2886
  };
3248
2887
  responses: {
3249
2888
  200: components["responses"]["200"];
@@ -3256,49 +2895,33 @@ export interface operations {
3256
2895
  501: components["responses"]["501"];
3257
2896
  503: components["responses"]["503"];
3258
2897
  };
3259
- /** Details of the error returned. */
3260
- requestBody: {
3261
- content: {
3262
- "application/json": components["schemas"]["ErrorInformationObject"];
3263
- };
3264
- };
3265
2898
  };
3266
- /** The HTTP request `POST /quotes` is used to request the creation of a quote for the provided financial transaction in the server. */
2899
+ /**
2900
+ * Calculate quote
2901
+ * @description The HTTP request `POST /quotes` is used to request the creation of a quote for the provided financial transaction in the server.
2902
+ */
3267
2903
  Quotes: {
3268
2904
  parameters: {
3269
2905
  header: {
3270
- /** The `Accept` header field indicates the version of the API the client would like the server to use. */
3271
2906
  Accept: components["parameters"]["Accept"];
3272
- /**
3273
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
3274
- *
3275
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
3276
- */
3277
2907
  "Content-Length"?: components["parameters"]["Content-Length"];
3278
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
3279
2908
  "Content-Type": components["parameters"]["Content-Type"];
3280
- /** The `Date` header field indicates the date when the request was sent. */
3281
2909
  Date: components["parameters"]["Date"];
3282
- /**
3283
- * 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.
3284
- *
3285
- * **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`.
3286
- */
3287
2910
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
3288
- /** 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`). */
3289
2911
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
3290
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
3291
2912
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
3292
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
3293
2913
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
3294
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
3295
2914
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
3296
- /** 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). */
3297
2915
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
3298
- /** 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). */
3299
2916
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
3300
2917
  };
3301
2918
  };
2919
+ /** @description Details of the quote to be created. */
2920
+ requestBody: {
2921
+ content: {
2922
+ "application/json": components["schemas"]["QuotesPostRequest"];
2923
+ };
2924
+ };
3302
2925
  responses: {
3303
2926
  202: components["responses"]["202"];
3304
2927
  400: components["responses"]["400"];
@@ -3310,46 +2933,28 @@ export interface operations {
3310
2933
  501: components["responses"]["501"];
3311
2934
  503: components["responses"]["503"];
3312
2935
  };
3313
- /** Details of the quote to be created. */
3314
- requestBody: {
3315
- content: {
3316
- "application/json": components["schemas"]["QuotesPostRequest"];
3317
- };
3318
- };
3319
2936
  };
3320
- /** The HTTP request `GET /quotes/{ID}` is used to get information regarding a quote created or requested earlier. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote. */
2937
+ /**
2938
+ * Retrieve quote information
2939
+ * @description The HTTP request `GET /quotes/{ID}` is used to get information regarding a quote created or requested earlier. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote.
2940
+ */
3321
2941
  QuotesByID: {
3322
2942
  parameters: {
3323
- path: {
3324
- /** The identifier value. */
3325
- ID: components["parameters"]["ID"];
3326
- };
3327
2943
  header: {
3328
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
3329
2944
  "Content-Type": components["parameters"]["Content-Type"];
3330
- /** The `Date` header field indicates the date when the request was sent. */
3331
2945
  Date: components["parameters"]["Date"];
3332
- /**
3333
- * 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.
3334
- *
3335
- * **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`.
3336
- */
3337
2946
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
3338
- /** 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`). */
3339
2947
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
3340
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
3341
2948
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
3342
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
3343
2949
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
3344
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
3345
2950
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
3346
- /** 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). */
3347
2951
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
3348
- /** 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). */
3349
2952
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
3350
- /** The `Accept` header field indicates the version of the API the client would like the server to use. */
3351
2953
  Accept: components["parameters"]["Accept"];
3352
2954
  };
2955
+ path: {
2956
+ ID: components["parameters"]["ID"];
2957
+ };
3353
2958
  };
3354
2959
  responses: {
3355
2960
  202: components["responses"]["202"];
@@ -3363,43 +2968,33 @@ export interface operations {
3363
2968
  503: components["responses"]["503"];
3364
2969
  };
3365
2970
  };
3366
- /** The callback `PUT /quotes/{ID}` is used to inform the client of a requested or created quote. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request. */
2971
+ /**
2972
+ * Return quote information
2973
+ * @description The callback `PUT /quotes/{ID}` is used to inform the client of a requested or created quote. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request.
2974
+ */
3367
2975
  QuotesByID1: {
3368
2976
  parameters: {
3369
- path: {
3370
- /** The identifier value. */
3371
- ID: components["parameters"]["ID"];
3372
- };
3373
2977
  header: {
3374
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
3375
2978
  "Content-Type": components["parameters"]["Content-Type"];
3376
- /** The `Date` header field indicates the date when the request was sent. */
3377
2979
  Date: components["parameters"]["Date"];
3378
- /**
3379
- * 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.
3380
- *
3381
- * **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`.
3382
- */
3383
2980
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
3384
- /** 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`). */
3385
2981
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
3386
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
3387
2982
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
3388
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
3389
2983
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
3390
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
3391
2984
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
3392
- /** 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). */
3393
2985
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
3394
- /** 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). */
3395
2986
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
3396
- /**
3397
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
3398
- *
3399
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
3400
- */
3401
2987
  "Content-Length"?: components["parameters"]["Content-Length"];
3402
2988
  };
2989
+ path: {
2990
+ ID: components["parameters"]["ID"];
2991
+ };
2992
+ };
2993
+ /** @description Quote information returned. */
2994
+ requestBody: {
2995
+ content: {
2996
+ "application/json": components["schemas"]["QuotesIDPutResponse"];
2997
+ };
3403
2998
  };
3404
2999
  responses: {
3405
3000
  200: components["responses"]["200"];
@@ -3412,50 +3007,34 @@ export interface operations {
3412
3007
  501: components["responses"]["501"];
3413
3008
  503: components["responses"]["503"];
3414
3009
  };
3415
- /** Quote information returned. */
3416
- requestBody: {
3417
- content: {
3418
- "application/json": components["schemas"]["QuotesIDPutResponse"];
3419
- };
3420
- };
3421
3010
  };
3422
- /** If the server is unable to find or create a quote, or some other processing error occurs, the error callback `PUT /quotes/{ID}/error` is used. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request. */
3011
+ /**
3012
+ * Return quote information error
3013
+ * @description If the server is unable to find or create a quote, or some other processing error occurs, the error callback `PUT /quotes/{ID}/error` is used. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request.
3014
+ */
3423
3015
  QuotesByIDAndError: {
3424
3016
  parameters: {
3425
- path: {
3426
- /** The identifier value. */
3427
- ID: components["parameters"]["ID"];
3428
- };
3429
3017
  header: {
3430
- /**
3431
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
3432
- *
3433
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
3434
- */
3435
3018
  "Content-Length"?: components["parameters"]["Content-Length"];
3436
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
3437
3019
  "Content-Type": components["parameters"]["Content-Type"];
3438
- /** The `Date` header field indicates the date when the request was sent. */
3439
3020
  Date: components["parameters"]["Date"];
3440
- /**
3441
- * 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.
3442
- *
3443
- * **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`.
3444
- */
3445
3021
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
3446
- /** 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`). */
3447
3022
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
3448
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
3449
3023
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
3450
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
3451
3024
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
3452
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
3453
3025
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
3454
- /** 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). */
3455
3026
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
3456
- /** 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). */
3457
3027
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
3458
3028
  };
3029
+ path: {
3030
+ ID: components["parameters"]["ID"];
3031
+ };
3032
+ };
3033
+ /** @description Details of the error returned. */
3034
+ requestBody: {
3035
+ content: {
3036
+ "application/json": components["schemas"]["ErrorInformationObject"];
3037
+ };
3459
3038
  };
3460
3039
  responses: {
3461
3040
  200: components["responses"]["200"];
@@ -3468,15 +3047,10 @@ export interface operations {
3468
3047
  501: components["responses"]["501"];
3469
3048
  503: components["responses"]["503"];
3470
3049
  };
3471
- /** Details of the error returned. */
3472
- requestBody: {
3473
- content: {
3474
- "application/json": components["schemas"]["ErrorInformationObject"];
3475
- };
3476
- };
3477
3050
  };
3478
3051
  /**
3479
- * The HTTP request `GET /authorizations/{ID}` is used to request the Payer to enter the applicable credentials in the Payee FSP system. The `{ID}` in the URI should contain the `transactionRequestID`, received from the `POST /transactionRequests` service earlier in the process. This request requires a query string to be included in the URI, with the following key-value pairs*:*
3052
+ * Perform authorization
3053
+ * @description The HTTP request `GET /authorizations/{ID}` is used to request the Payer to enter the applicable credentials in the Payee FSP system. The `{ID}` in the URI should contain the `transactionRequestID`, received from the `POST /transactionRequests` service earlier in the process. This request requires a query string to be included in the URI, with the following key-value pairs*:*
3480
3054
  *
3481
3055
  * - `authenticationType={Type}`, where `{Type}` value is a valid authentication type from the enumeration `AuthenticationType`.
3482
3056
  *
@@ -3492,36 +3066,21 @@ export interface operations {
3492
3066
  */
3493
3067
  AuthorizationsByIDGet: {
3494
3068
  parameters: {
3495
- path: {
3496
- /** The identifier value. */
3497
- ID: components["parameters"]["ID"];
3498
- };
3499
3069
  header: {
3500
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
3501
3070
  "Content-Type": components["parameters"]["Content-Type"];
3502
- /** The `Date` header field indicates the date when the request was sent. */
3503
3071
  Date: components["parameters"]["Date"];
3504
- /**
3505
- * 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.
3506
- *
3507
- * **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`.
3508
- */
3509
3072
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
3510
- /** 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`). */
3511
3073
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
3512
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
3513
3074
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
3514
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
3515
3075
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
3516
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
3517
3076
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
3518
- /** 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). */
3519
3077
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
3520
- /** 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). */
3521
3078
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
3522
- /** The `Accept` header field indicates the version of the API the client would like the server to use. */
3523
3079
  Accept: components["parameters"]["Accept"];
3524
3080
  };
3081
+ path: {
3082
+ ID: components["parameters"]["ID"];
3083
+ };
3525
3084
  };
3526
3085
  responses: {
3527
3086
  202: components["responses"]["202"];
@@ -3535,43 +3094,33 @@ export interface operations {
3535
3094
  503: components["responses"]["503"];
3536
3095
  };
3537
3096
  };
3538
- /** The callback `PUT /authorizations/{ID}` is used to inform the client of the result of a previously-requested authorization. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}` request. */
3097
+ /**
3098
+ * Return authorization result
3099
+ * @description The callback `PUT /authorizations/{ID}` is used to inform the client of the result of a previously-requested authorization. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}` request.
3100
+ */
3539
3101
  AuthorizationsByIDPut: {
3540
3102
  parameters: {
3541
- path: {
3542
- /** The identifier value. */
3543
- ID: components["parameters"]["ID"];
3544
- };
3545
3103
  header: {
3546
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
3547
3104
  "Content-Type": components["parameters"]["Content-Type"];
3548
- /** The `Date` header field indicates the date when the request was sent. */
3549
3105
  Date: components["parameters"]["Date"];
3550
- /**
3551
- * 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.
3552
- *
3553
- * **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`.
3554
- */
3555
3106
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
3556
- /** 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`). */
3557
3107
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
3558
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
3559
3108
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
3560
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
3561
3109
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
3562
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
3563
3110
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
3564
- /** 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). */
3565
3111
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
3566
- /** 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). */
3567
3112
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
3568
- /**
3569
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
3570
- *
3571
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
3572
- */
3573
3113
  "Content-Length"?: components["parameters"]["Content-Length"];
3574
3114
  };
3115
+ path: {
3116
+ ID: components["parameters"]["ID"];
3117
+ };
3118
+ };
3119
+ /** @description Authorization result returned. */
3120
+ requestBody: {
3121
+ content: {
3122
+ "application/json": components["schemas"]["AuthorizationsIDPutResponse"];
3123
+ };
3575
3124
  };
3576
3125
  responses: {
3577
3126
  200: components["responses"]["200"];
@@ -3584,50 +3133,34 @@ export interface operations {
3584
3133
  501: components["responses"]["501"];
3585
3134
  503: components["responses"]["503"];
3586
3135
  };
3587
- /** Authorization result returned. */
3588
- requestBody: {
3589
- content: {
3590
- "application/json": components["schemas"]["AuthorizationsIDPutResponse"];
3591
- };
3592
- };
3593
3136
  };
3594
- /** If the server is unable to find the transaction request, or another processing error occurs, the error callback `PUT /authorizations/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}`. */
3137
+ /**
3138
+ * Return authorization error
3139
+ * @description If the server is unable to find the transaction request, or another processing error occurs, the error callback `PUT /authorizations/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}`.
3140
+ */
3595
3141
  AuthorizationsByIDAndError: {
3596
3142
  parameters: {
3597
- path: {
3598
- /** The identifier value. */
3599
- ID: components["parameters"]["ID"];
3600
- };
3601
3143
  header: {
3602
- /**
3603
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
3604
- *
3605
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
3606
- */
3607
3144
  "Content-Length"?: components["parameters"]["Content-Length"];
3608
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
3609
3145
  "Content-Type": components["parameters"]["Content-Type"];
3610
- /** The `Date` header field indicates the date when the request was sent. */
3611
3146
  Date: components["parameters"]["Date"];
3612
- /**
3613
- * 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.
3614
- *
3615
- * **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`.
3616
- */
3617
3147
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
3618
- /** 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`). */
3619
3148
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
3620
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
3621
3149
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
3622
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
3623
3150
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
3624
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
3625
3151
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
3626
- /** 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). */
3627
3152
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
3628
- /** 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). */
3629
3153
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
3630
3154
  };
3155
+ path: {
3156
+ ID: components["parameters"]["ID"];
3157
+ };
3158
+ };
3159
+ /** @description Details of the error returned. */
3160
+ requestBody: {
3161
+ content: {
3162
+ "application/json": components["schemas"]["ErrorInformationObject"];
3163
+ };
3631
3164
  };
3632
3165
  responses: {
3633
3166
  200: components["responses"]["200"];
@@ -3640,49 +3173,33 @@ export interface operations {
3640
3173
  501: components["responses"]["501"];
3641
3174
  503: components["responses"]["503"];
3642
3175
  };
3643
- /** Details of the error returned. */
3644
- requestBody: {
3645
- content: {
3646
- "application/json": components["schemas"]["ErrorInformationObject"];
3647
- };
3648
- };
3649
3176
  };
3650
- /** The HTTP request `POST /transfers` is used to request the creation of a transfer for the next ledger, and a financial transaction for the Payee FSP. */
3177
+ /**
3178
+ * Perform transfer
3179
+ * @description The HTTP request `POST /transfers` is used to request the creation of a transfer for the next ledger, and a financial transaction for the Payee FSP.
3180
+ */
3651
3181
  transfers: {
3652
3182
  parameters: {
3653
3183
  header: {
3654
- /** The `Accept` header field indicates the version of the API the client would like the server to use. */
3655
3184
  Accept: components["parameters"]["Accept"];
3656
- /**
3657
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
3658
- *
3659
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
3660
- */
3661
3185
  "Content-Length"?: components["parameters"]["Content-Length"];
3662
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
3663
3186
  "Content-Type": components["parameters"]["Content-Type"];
3664
- /** The `Date` header field indicates the date when the request was sent. */
3665
3187
  Date: components["parameters"]["Date"];
3666
- /**
3667
- * 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.
3668
- *
3669
- * **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`.
3670
- */
3671
3188
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
3672
- /** 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`). */
3673
3189
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
3674
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
3675
3190
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
3676
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
3677
3191
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
3678
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
3679
3192
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
3680
- /** 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). */
3681
3193
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
3682
- /** 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). */
3683
3194
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
3684
3195
  };
3685
3196
  };
3197
+ /** @description Details of the transfer to be created. */
3198
+ requestBody: {
3199
+ content: {
3200
+ "application/json": components["schemas"]["TransfersPostRequest"];
3201
+ };
3202
+ };
3686
3203
  responses: {
3687
3204
  202: components["responses"]["202"];
3688
3205
  400: components["responses"]["400"];
@@ -3694,46 +3211,28 @@ export interface operations {
3694
3211
  501: components["responses"]["501"];
3695
3212
  503: components["responses"]["503"];
3696
3213
  };
3697
- /** Details of the transfer to be created. */
3698
- requestBody: {
3699
- content: {
3700
- "application/json": components["schemas"]["TransfersPostRequest"];
3701
- };
3702
- };
3703
3214
  };
3704
- /** The HTTP request `GET /transfers/{ID}` is used to get information regarding a transfer created or requested earlier. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer. */
3215
+ /**
3216
+ * Retrieve transfer information
3217
+ * @description The HTTP request `GET /transfers/{ID}` is used to get information regarding a transfer created or requested earlier. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer.
3218
+ */
3705
3219
  TransfersByIDGet: {
3706
3220
  parameters: {
3707
- path: {
3708
- /** The identifier value. */
3709
- ID: components["parameters"]["ID"];
3710
- };
3711
3221
  header: {
3712
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
3713
3222
  "Content-Type": components["parameters"]["Content-Type"];
3714
- /** The `Date` header field indicates the date when the request was sent. */
3715
3223
  Date: components["parameters"]["Date"];
3716
- /**
3717
- * 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.
3718
- *
3719
- * **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`.
3720
- */
3721
3224
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
3722
- /** 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`). */
3723
3225
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
3724
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
3725
3226
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
3726
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
3727
3227
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
3728
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
3729
3228
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
3730
- /** 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). */
3731
3229
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
3732
- /** 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). */
3733
3230
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
3734
- /** The `Accept` header field indicates the version of the API the client would like the server to use. */
3735
3231
  Accept: components["parameters"]["Accept"];
3736
3232
  };
3233
+ path: {
3234
+ ID: components["parameters"]["ID"];
3235
+ };
3737
3236
  };
3738
3237
  responses: {
3739
3238
  202: components["responses"]["202"];
@@ -3747,43 +3246,33 @@ export interface operations {
3747
3246
  503: components["responses"]["503"];
3748
3247
  };
3749
3248
  };
3750
- /** The callback `PUT /transfers/{ID}` is used to inform the client of a requested or created transfer. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}` request. */
3249
+ /**
3250
+ * Return transfer information
3251
+ * @description The callback `PUT /transfers/{ID}` is used to inform the client of a requested or created transfer. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}` request.
3252
+ */
3751
3253
  TransfersByIDPut: {
3752
3254
  parameters: {
3753
- path: {
3754
- /** The identifier value. */
3755
- ID: components["parameters"]["ID"];
3756
- };
3757
3255
  header: {
3758
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
3759
3256
  "Content-Type": components["parameters"]["Content-Type"];
3760
- /** The `Date` header field indicates the date when the request was sent. */
3761
3257
  Date: components["parameters"]["Date"];
3762
- /**
3763
- * 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.
3764
- *
3765
- * **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`.
3766
- */
3767
3258
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
3768
- /** 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`). */
3769
3259
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
3770
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
3771
3260
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
3772
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
3773
3261
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
3774
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
3775
3262
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
3776
- /** 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). */
3777
3263
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
3778
- /** 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). */
3779
3264
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
3780
- /**
3781
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
3782
- *
3783
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
3784
- */
3785
3265
  "Content-Length"?: components["parameters"]["Content-Length"];
3786
3266
  };
3267
+ path: {
3268
+ ID: components["parameters"]["ID"];
3269
+ };
3270
+ };
3271
+ /** @description Transfer information returned. */
3272
+ requestBody: {
3273
+ content: {
3274
+ "application/json": components["schemas"]["TransfersIDPutResponse"];
3275
+ };
3787
3276
  };
3788
3277
  responses: {
3789
3278
  200: components["responses"]["200"];
@@ -3796,50 +3285,34 @@ export interface operations {
3796
3285
  501: components["responses"]["501"];
3797
3286
  503: components["responses"]["503"];
3798
3287
  };
3799
- /** Transfer information returned. */
3800
- requestBody: {
3801
- content: {
3802
- "application/json": components["schemas"]["TransfersIDPutResponse"];
3803
- };
3804
- };
3805
3288
  };
3806
- /** If the server is unable to find or create a transfer, or another processing error occurs, the error callback `PUT /transfers/{ID}/error` is used. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}`. */
3289
+ /**
3290
+ * Return transfer information error
3291
+ * @description If the server is unable to find or create a transfer, or another processing error occurs, the error callback `PUT /transfers/{ID}/error` is used. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}`.
3292
+ */
3807
3293
  TransfersByIDAndError: {
3808
3294
  parameters: {
3809
- path: {
3810
- /** The identifier value. */
3811
- ID: components["parameters"]["ID"];
3812
- };
3813
3295
  header: {
3814
- /**
3815
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
3816
- *
3817
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
3818
- */
3819
3296
  "Content-Length"?: components["parameters"]["Content-Length"];
3820
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
3821
3297
  "Content-Type": components["parameters"]["Content-Type"];
3822
- /** The `Date` header field indicates the date when the request was sent. */
3823
3298
  Date: components["parameters"]["Date"];
3824
- /**
3825
- * 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.
3826
- *
3827
- * **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`.
3828
- */
3829
3299
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
3830
- /** 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`). */
3831
3300
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
3832
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
3833
3301
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
3834
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
3835
3302
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
3836
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
3837
3303
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
3838
- /** 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). */
3839
3304
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
3840
- /** 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). */
3841
3305
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
3842
3306
  };
3307
+ path: {
3308
+ ID: components["parameters"]["ID"];
3309
+ };
3310
+ };
3311
+ /** @description Details of the error returned. */
3312
+ requestBody: {
3313
+ content: {
3314
+ "application/json": components["schemas"]["ErrorInformationObject"];
3315
+ };
3843
3316
  };
3844
3317
  responses: {
3845
3318
  200: components["responses"]["200"];
@@ -3852,46 +3325,28 @@ export interface operations {
3852
3325
  501: components["responses"]["501"];
3853
3326
  503: components["responses"]["503"];
3854
3327
  };
3855
- /** Details of the error returned. */
3856
- requestBody: {
3857
- content: {
3858
- "application/json": components["schemas"]["ErrorInformationObject"];
3859
- };
3860
- };
3861
3328
  };
3862
- /** The HTTP request `GET /transactions/{ID}` is used to get transaction information regarding a financial transaction created earlier. The `{ID}` in the URI should contain the `transactionId` that was used for the creation of the quote, as the transaction is created as part of another process (the transfer process). */
3329
+ /**
3330
+ * Retrieve transaction information
3331
+ * @description The HTTP request `GET /transactions/{ID}` is used to get transaction information regarding a financial transaction created earlier. The `{ID}` in the URI should contain the `transactionId` that was used for the creation of the quote, as the transaction is created as part of another process (the transfer process).
3332
+ */
3863
3333
  TransactionsByID: {
3864
3334
  parameters: {
3865
- path: {
3866
- /** The identifier value. */
3867
- ID: components["parameters"]["ID"];
3868
- };
3869
3335
  header: {
3870
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
3871
3336
  "Content-Type": components["parameters"]["Content-Type"];
3872
- /** The `Date` header field indicates the date when the request was sent. */
3873
3337
  Date: components["parameters"]["Date"];
3874
- /**
3875
- * 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.
3876
- *
3877
- * **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`.
3878
- */
3879
3338
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
3880
- /** 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`). */
3881
3339
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
3882
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
3883
3340
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
3884
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
3885
3341
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
3886
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
3887
3342
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
3888
- /** 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). */
3889
3343
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
3890
- /** 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). */
3891
3344
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
3892
- /** The `Accept` header field indicates the version of the API the client would like the server to use. */
3893
3345
  Accept: components["parameters"]["Accept"];
3894
3346
  };
3347
+ path: {
3348
+ ID: components["parameters"]["ID"];
3349
+ };
3895
3350
  };
3896
3351
  responses: {
3897
3352
  202: components["responses"]["202"];
@@ -3905,43 +3360,33 @@ export interface operations {
3905
3360
  503: components["responses"]["503"];
3906
3361
  };
3907
3362
  };
3908
- /** The callback `PUT /transactions/{ID}` is used to inform the client of a requested transaction. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request. */
3363
+ /**
3364
+ * Return transaction information
3365
+ * @description The callback `PUT /transactions/{ID}` is used to inform the client of a requested transaction. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request.
3366
+ */
3909
3367
  TransactionsByID1: {
3910
3368
  parameters: {
3911
- path: {
3912
- /** The identifier value. */
3913
- ID: components["parameters"]["ID"];
3914
- };
3915
3369
  header: {
3916
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
3917
3370
  "Content-Type": components["parameters"]["Content-Type"];
3918
- /** The `Date` header field indicates the date when the request was sent. */
3919
3371
  Date: components["parameters"]["Date"];
3920
- /**
3921
- * 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.
3922
- *
3923
- * **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`.
3924
- */
3925
3372
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
3926
- /** 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`). */
3927
3373
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
3928
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
3929
3374
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
3930
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
3931
3375
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
3932
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
3933
3376
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
3934
- /** 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). */
3935
3377
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
3936
- /** 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). */
3937
3378
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
3938
- /**
3939
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
3940
- *
3941
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
3942
- */
3943
3379
  "Content-Length"?: components["parameters"]["Content-Length"];
3944
3380
  };
3381
+ path: {
3382
+ ID: components["parameters"]["ID"];
3383
+ };
3384
+ };
3385
+ /** @description Transaction information returned. */
3386
+ requestBody: {
3387
+ content: {
3388
+ "application/json": components["schemas"]["TransactionsIDPutResponse"];
3389
+ };
3945
3390
  };
3946
3391
  responses: {
3947
3392
  200: components["responses"]["200"];
@@ -3954,50 +3399,34 @@ export interface operations {
3954
3399
  501: components["responses"]["501"];
3955
3400
  503: components["responses"]["503"];
3956
3401
  };
3957
- /** Transaction information returned. */
3958
- requestBody: {
3959
- content: {
3960
- "application/json": components["schemas"]["TransactionsIDPutResponse"];
3961
- };
3962
- };
3963
3402
  };
3964
- /** If the server is unable to find or create a transaction, or another processing error occurs, the error callback `PUT /transactions/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request. */
3403
+ /**
3404
+ * Return transaction information error
3405
+ * @description If the server is unable to find or create a transaction, or another processing error occurs, the error callback `PUT /transactions/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request.
3406
+ */
3965
3407
  TransactionsErrorByID: {
3966
3408
  parameters: {
3967
- path: {
3968
- /** The identifier value. */
3969
- ID: components["parameters"]["ID"];
3970
- };
3971
3409
  header: {
3972
- /**
3973
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
3974
- *
3975
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
3976
- */
3977
3410
  "Content-Length"?: components["parameters"]["Content-Length"];
3978
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
3979
3411
  "Content-Type": components["parameters"]["Content-Type"];
3980
- /** The `Date` header field indicates the date when the request was sent. */
3981
3412
  Date: components["parameters"]["Date"];
3982
- /**
3983
- * 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.
3984
- *
3985
- * **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`.
3986
- */
3987
3413
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
3988
- /** 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`). */
3989
3414
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
3990
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
3991
3415
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
3992
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
3993
3416
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
3994
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
3995
3417
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
3996
- /** 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). */
3997
3418
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
3998
- /** 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). */
3999
3419
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
4000
3420
  };
3421
+ path: {
3422
+ ID: components["parameters"]["ID"];
3423
+ };
3424
+ };
3425
+ /** @description Details of the error returned. */
3426
+ requestBody: {
3427
+ content: {
3428
+ "application/json": components["schemas"]["ErrorInformationObject"];
3429
+ };
4001
3430
  };
4002
3431
  responses: {
4003
3432
  200: components["responses"]["200"];
@@ -4010,49 +3439,33 @@ export interface operations {
4010
3439
  501: components["responses"]["501"];
4011
3440
  503: components["responses"]["503"];
4012
3441
  };
4013
- /** Details of the error returned. */
4014
- requestBody: {
4015
- content: {
4016
- "application/json": components["schemas"]["ErrorInformationObject"];
4017
- };
4018
- };
4019
3442
  };
4020
- /** The HTTP request `POST /bulkQuotes` is used to request the creation of a bulk quote for the provided financial transactions in the server. */
3443
+ /**
3444
+ * Calculate bulk quote
3445
+ * @description The HTTP request `POST /bulkQuotes` is used to request the creation of a bulk quote for the provided financial transactions in the server.
3446
+ */
4021
3447
  BulkQuotes: {
4022
3448
  parameters: {
4023
3449
  header: {
4024
- /** The `Accept` header field indicates the version of the API the client would like the server to use. */
4025
3450
  Accept: components["parameters"]["Accept"];
4026
- /**
4027
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
4028
- *
4029
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
4030
- */
4031
3451
  "Content-Length"?: components["parameters"]["Content-Length"];
4032
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
4033
3452
  "Content-Type": components["parameters"]["Content-Type"];
4034
- /** The `Date` header field indicates the date when the request was sent. */
4035
3453
  Date: components["parameters"]["Date"];
4036
- /**
4037
- * 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.
4038
- *
4039
- * **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`.
4040
- */
4041
3454
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
4042
- /** 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`). */
4043
3455
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
4044
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
4045
3456
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
4046
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
4047
3457
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
4048
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
4049
3458
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
4050
- /** 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). */
4051
3459
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
4052
- /** 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). */
4053
3460
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
4054
3461
  };
4055
3462
  };
3463
+ /** @description Details of the bulk quote to be created. */
3464
+ requestBody: {
3465
+ content: {
3466
+ "application/json": components["schemas"]["BulkQuotesPostRequest"];
3467
+ };
3468
+ };
4056
3469
  responses: {
4057
3470
  202: components["responses"]["202"];
4058
3471
  400: components["responses"]["400"];
@@ -4064,46 +3477,28 @@ export interface operations {
4064
3477
  501: components["responses"]["501"];
4065
3478
  503: components["responses"]["503"];
4066
3479
  };
4067
- /** Details of the bulk quote to be created. */
4068
- requestBody: {
4069
- content: {
4070
- "application/json": components["schemas"]["BulkQuotesPostRequest"];
4071
- };
4072
- };
4073
3480
  };
4074
- /** The HTTP request `GET /bulkQuotes/{ID}` is used to get information regarding a bulk quote created or requested earlier. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote. */
3481
+ /**
3482
+ * Retrieve bulk quote information
3483
+ * @description The HTTP request `GET /bulkQuotes/{ID}` is used to get information regarding a bulk quote created or requested earlier. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote.
3484
+ */
4075
3485
  BulkQuotesByID: {
4076
3486
  parameters: {
4077
- path: {
4078
- /** The identifier value. */
4079
- ID: components["parameters"]["ID"];
4080
- };
4081
3487
  header: {
4082
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
4083
3488
  "Content-Type": components["parameters"]["Content-Type"];
4084
- /** The `Date` header field indicates the date when the request was sent. */
4085
3489
  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
3490
  "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
3491
  "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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
4095
3492
  "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
3493
  "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
3494
  "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
3495
  "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
3496
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
4104
- /** The `Accept` header field indicates the version of the API the client would like the server to use. */
4105
3497
  Accept: components["parameters"]["Accept"];
4106
3498
  };
3499
+ path: {
3500
+ ID: components["parameters"]["ID"];
3501
+ };
4107
3502
  };
4108
3503
  responses: {
4109
3504
  202: components["responses"]["202"];
@@ -4117,43 +3512,33 @@ export interface operations {
4117
3512
  503: components["responses"]["503"];
4118
3513
  };
4119
3514
  };
4120
- /** The callback `PUT /bulkQuotes/{ID}` is used to inform the client of a requested or created bulk quote. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request. */
3515
+ /**
3516
+ * Return bulk quote information
3517
+ * @description The callback `PUT /bulkQuotes/{ID}` is used to inform the client of a requested or created bulk quote. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request.
3518
+ */
4121
3519
  BulkQuotesByID1: {
4122
3520
  parameters: {
4123
- path: {
4124
- /** The identifier value. */
4125
- ID: components["parameters"]["ID"];
4126
- };
4127
3521
  header: {
4128
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
4129
3522
  "Content-Type": components["parameters"]["Content-Type"];
4130
- /** The `Date` header field indicates the date when the request was sent. */
4131
3523
  Date: components["parameters"]["Date"];
4132
- /**
4133
- * 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.
4134
- *
4135
- * **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`.
4136
- */
4137
3524
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
4138
- /** 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`). */
4139
3525
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
4140
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
4141
3526
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
4142
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
4143
3527
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
4144
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
4145
3528
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
4146
- /** 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). */
4147
3529
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
4148
- /** 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). */
4149
3530
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
4150
- /**
4151
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
4152
- *
4153
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
4154
- */
4155
3531
  "Content-Length"?: components["parameters"]["Content-Length"];
4156
3532
  };
3533
+ path: {
3534
+ ID: components["parameters"]["ID"];
3535
+ };
3536
+ };
3537
+ /** @description Bulk quote information returned. */
3538
+ requestBody: {
3539
+ content: {
3540
+ "application/json": components["schemas"]["BulkQuotesIDPutResponse"];
3541
+ };
4157
3542
  };
4158
3543
  responses: {
4159
3544
  200: components["responses"]["200"];
@@ -4166,50 +3551,34 @@ export interface operations {
4166
3551
  501: components["responses"]["501"];
4167
3552
  503: components["responses"]["503"];
4168
3553
  };
4169
- /** Bulk quote information returned. */
4170
- requestBody: {
4171
- content: {
4172
- "application/json": components["schemas"]["BulkQuotesIDPutResponse"];
4173
- };
4174
- };
4175
3554
  };
4176
- /** If the server is unable to find or create a bulk quote, or another processing error occurs, the error callback `PUT /bulkQuotes/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request. */
3555
+ /**
3556
+ * Return bulk quote information error
3557
+ * @description If the server is unable to find or create a bulk quote, or another processing error occurs, the error callback `PUT /bulkQuotes/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request.
3558
+ */
4177
3559
  BulkQuotesErrorByID: {
4178
3560
  parameters: {
4179
- path: {
4180
- /** The identifier value. */
4181
- ID: components["parameters"]["ID"];
4182
- };
4183
3561
  header: {
4184
- /**
4185
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
4186
- *
4187
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
4188
- */
4189
3562
  "Content-Length"?: components["parameters"]["Content-Length"];
4190
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
4191
3563
  "Content-Type": components["parameters"]["Content-Type"];
4192
- /** The `Date` header field indicates the date when the request was sent. */
4193
3564
  Date: components["parameters"]["Date"];
4194
- /**
4195
- * 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.
4196
- *
4197
- * **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`.
4198
- */
4199
3565
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
4200
- /** 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`). */
4201
3566
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
4202
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
4203
3567
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
4204
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
4205
3568
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
4206
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
4207
3569
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
4208
- /** 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). */
4209
3570
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
4210
- /** 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). */
4211
3571
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
4212
3572
  };
3573
+ path: {
3574
+ ID: components["parameters"]["ID"];
3575
+ };
3576
+ };
3577
+ /** @description Details of the error returned. */
3578
+ requestBody: {
3579
+ content: {
3580
+ "application/json": components["schemas"]["ErrorInformationObject"];
3581
+ };
4213
3582
  };
4214
3583
  responses: {
4215
3584
  200: components["responses"]["200"];
@@ -4222,49 +3591,33 @@ export interface operations {
4222
3591
  501: components["responses"]["501"];
4223
3592
  503: components["responses"]["503"];
4224
3593
  };
4225
- /** Details of the error returned. */
4226
- requestBody: {
4227
- content: {
4228
- "application/json": components["schemas"]["ErrorInformationObject"];
4229
- };
4230
- };
4231
3594
  };
4232
- /** The HTTP request `POST /bulkTransfers` is used to request the creation of a bulk transfer in the server. */
3595
+ /**
3596
+ * Perform bulk transfer
3597
+ * @description The HTTP request `POST /bulkTransfers` is used to request the creation of a bulk transfer in the server.
3598
+ */
4233
3599
  BulkTransfers: {
4234
3600
  parameters: {
4235
3601
  header: {
4236
- /** The `Accept` header field indicates the version of the API the client would like the server to use. */
4237
3602
  Accept: components["parameters"]["Accept"];
4238
- /**
4239
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
4240
- *
4241
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
4242
- */
4243
3603
  "Content-Length"?: components["parameters"]["Content-Length"];
4244
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
4245
3604
  "Content-Type": components["parameters"]["Content-Type"];
4246
- /** The `Date` header field indicates the date when the request was sent. */
4247
3605
  Date: components["parameters"]["Date"];
4248
- /**
4249
- * 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.
4250
- *
4251
- * **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`.
4252
- */
4253
3606
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
4254
- /** 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`). */
4255
3607
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
4256
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
4257
3608
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
4258
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
4259
3609
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
4260
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
4261
3610
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
4262
- /** 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). */
4263
3611
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
4264
- /** 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). */
4265
3612
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
4266
3613
  };
4267
3614
  };
3615
+ /** @description Details of the bulk transfer to be created. */
3616
+ requestBody: {
3617
+ content: {
3618
+ "application/json": components["schemas"]["BulkTransfersPostRequest"];
3619
+ };
3620
+ };
4268
3621
  responses: {
4269
3622
  202: components["responses"]["202"];
4270
3623
  400: components["responses"]["400"];
@@ -4276,46 +3629,28 @@ export interface operations {
4276
3629
  501: components["responses"]["501"];
4277
3630
  503: components["responses"]["503"];
4278
3631
  };
4279
- /** Details of the bulk transfer to be created. */
4280
- requestBody: {
4281
- content: {
4282
- "application/json": components["schemas"]["BulkTransfersPostRequest"];
4283
- };
4284
- };
4285
3632
  };
4286
- /** The HTTP request `GET /bulkTransfers/{ID}` is used to get information regarding a bulk transfer created or requested earlier. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer. */
3633
+ /**
3634
+ * Retrieve bulk transfer information
3635
+ * @description The HTTP request `GET /bulkTransfers/{ID}` is used to get information regarding a bulk transfer created or requested earlier. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer.
3636
+ */
4287
3637
  BulkTransferByID: {
4288
3638
  parameters: {
4289
- path: {
4290
- /** The identifier value. */
4291
- ID: components["parameters"]["ID"];
4292
- };
4293
3639
  header: {
4294
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
4295
3640
  "Content-Type": components["parameters"]["Content-Type"];
4296
- /** The `Date` header field indicates the date when the request was sent. */
4297
3641
  Date: components["parameters"]["Date"];
4298
- /**
4299
- * 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.
4300
- *
4301
- * **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`.
4302
- */
4303
3642
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
4304
- /** 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`). */
4305
3643
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
4306
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
4307
3644
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
4308
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
4309
3645
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
4310
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
4311
3646
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
4312
- /** 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). */
4313
3647
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
4314
- /** 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). */
4315
3648
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
4316
- /** The `Accept` header field indicates the version of the API the client would like the server to use. */
4317
3649
  Accept: components["parameters"]["Accept"];
4318
3650
  };
3651
+ path: {
3652
+ ID: components["parameters"]["ID"];
3653
+ };
4319
3654
  };
4320
3655
  responses: {
4321
3656
  202: components["responses"]["202"];
@@ -4329,43 +3664,33 @@ export interface operations {
4329
3664
  503: components["responses"]["503"];
4330
3665
  };
4331
3666
  };
4332
- /** The callback `PUT /bulkTransfers/{ID}` is used to inform the client of a requested or created bulk transfer. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request. */
3667
+ /**
3668
+ * Return bulk transfer information
3669
+ * @description The callback `PUT /bulkTransfers/{ID}` is used to inform the client of a requested or created bulk transfer. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request.
3670
+ */
4333
3671
  BulkTransfersByIDPut: {
4334
3672
  parameters: {
4335
- path: {
4336
- /** The identifier value. */
4337
- ID: components["parameters"]["ID"];
4338
- };
4339
3673
  header: {
4340
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
4341
3674
  "Content-Type": components["parameters"]["Content-Type"];
4342
- /** The `Date` header field indicates the date when the request was sent. */
4343
3675
  Date: components["parameters"]["Date"];
4344
- /**
4345
- * 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.
4346
- *
4347
- * **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`.
4348
- */
4349
3676
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
4350
- /** 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`). */
4351
3677
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
4352
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
4353
3678
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
4354
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
4355
3679
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
4356
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
4357
3680
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
4358
- /** 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). */
4359
3681
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
4360
- /** 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). */
4361
3682
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
4362
- /**
4363
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
4364
- *
4365
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
4366
- */
4367
3683
  "Content-Length"?: components["parameters"]["Content-Length"];
4368
3684
  };
3685
+ path: {
3686
+ ID: components["parameters"]["ID"];
3687
+ };
3688
+ };
3689
+ /** @description Bulk transfer information returned. */
3690
+ requestBody: {
3691
+ content: {
3692
+ "application/json": components["schemas"]["BulkTransfersIDPutResponse"];
3693
+ };
4369
3694
  };
4370
3695
  responses: {
4371
3696
  200: components["responses"]["200"];
@@ -4378,50 +3703,34 @@ export interface operations {
4378
3703
  501: components["responses"]["501"];
4379
3704
  503: components["responses"]["503"];
4380
3705
  };
4381
- /** Bulk transfer information returned. */
4382
- requestBody: {
4383
- content: {
4384
- "application/json": components["schemas"]["BulkTransfersIDPutResponse"];
4385
- };
4386
- };
4387
3706
  };
4388
- /** If the server is unable to find or create a bulk transfer, or another processing error occurs, the error callback `PUT /bulkTransfers/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request. */
3707
+ /**
3708
+ * Return bulk transfer information error
3709
+ * @description If the server is unable to find or create a bulk transfer, or another processing error occurs, the error callback `PUT /bulkTransfers/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request.
3710
+ */
4389
3711
  BulkTransfersErrorByID: {
4390
3712
  parameters: {
4391
- path: {
4392
- /** The identifier value. */
4393
- ID: components["parameters"]["ID"];
4394
- };
4395
3713
  header: {
4396
- /**
4397
- * The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
4398
- *
4399
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
4400
- */
4401
3714
  "Content-Length"?: components["parameters"]["Content-Length"];
4402
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
4403
3715
  "Content-Type": components["parameters"]["Content-Type"];
4404
- /** The `Date` header field indicates the date when the request was sent. */
4405
3716
  Date: components["parameters"]["Date"];
4406
- /**
4407
- * 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.
4408
- *
4409
- * **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`.
4410
- */
4411
3717
  "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
4412
- /** 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`). */
4413
3718
  "FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
4414
- /** 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
4415
3719
  "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
4416
- /** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
4417
3720
  "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
4418
- /** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
4419
3721
  "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
4420
- /** 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). */
4421
3722
  "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
4422
- /** 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). */
4423
3723
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
4424
3724
  };
3725
+ path: {
3726
+ ID: components["parameters"]["ID"];
3727
+ };
3728
+ };
3729
+ /** @description Details of the error returned. */
3730
+ requestBody: {
3731
+ content: {
3732
+ "application/json": components["schemas"]["ErrorInformationObject"];
3733
+ };
4425
3734
  };
4426
3735
  responses: {
4427
3736
  200: components["responses"]["200"];
@@ -4434,13 +3743,5 @@ export interface operations {
4434
3743
  501: components["responses"]["501"];
4435
3744
  503: components["responses"]["503"];
4436
3745
  };
4437
- /** Details of the error returned. */
4438
- requestBody: {
4439
- content: {
4440
- "application/json": components["schemas"]["ErrorInformationObject"];
4441
- };
4442
- };
4443
3746
  };
4444
3747
  }
4445
- export interface external {
4446
- }