@mojaloop/api-snippets 17.2.0 → 17.2.4

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,62 @@ 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 $defs = Record<string, never>;
1980
+ export type external = Record<string, never>;
1979
1981
  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. */
1982
+ /** @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
1983
  Interface: {
1982
- responses: {
1983
- /** Ok */
1984
- 200: unknown;
1985
- };
1986
- requestBody: {
1984
+ requestBody?: {
1987
1985
  content: {
1988
1986
  "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
1987
  };
1990
1988
  };
1989
+ responses: {
1990
+ /** @description Ok */
1991
+ 200: {
1992
+ content: never;
1993
+ };
1994
+ };
1991
1995
  };
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. */
1996
+ /**
1997
+ * Look up participant information
1998
+ * @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.
1999
+ */
1993
2000
  ParticipantsByTypeAndID: {
1994
2001
  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
2002
  header: {
2002
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
2003
2003
  "Content-Type": components["parameters"]["Content-Type"];
2004
- /** The `Date` header field indicates the date when the request was sent. */
2005
2004
  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
2005
  "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
2006
  "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
2007
  "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
2008
  "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
2009
  "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
2010
  "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
2011
  "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
2012
  Accept: components["parameters"]["Accept"];
2026
2013
  };
2014
+ path: {
2015
+ Type: components["parameters"]["Type"];
2016
+ ID: components["parameters"]["ID"];
2017
+ };
2027
2018
  };
2028
2019
  responses: {
2029
2020
  202: components["responses"]["202"];
@@ -2037,45 +2028,34 @@ export interface operations {
2037
2028
  503: components["responses"]["503"];
2038
2029
  };
2039
2030
  };
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. */
2031
+ /**
2032
+ * Return participant information
2033
+ * @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.
2034
+ */
2041
2035
  ParticipantsByTypeAndID3: {
2042
2036
  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
2037
  header: {
2050
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
2051
2038
  "Content-Type": components["parameters"]["Content-Type"];
2052
- /** The `Date` header field indicates the date when the request was sent. */
2053
2039
  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
2040
  "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
2041
  "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
2042
  "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
2043
  "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
2044
  "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
2045
  "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
2046
  "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
2047
  "Content-Length"?: components["parameters"]["Content-Length"];
2078
2048
  };
2049
+ path: {
2050
+ Type: components["parameters"]["Type"];
2051
+ ID: components["parameters"]["ID"];
2052
+ };
2053
+ };
2054
+ /** @description Participant information returned. */
2055
+ requestBody: {
2056
+ content: {
2057
+ "application/json": components["schemas"]["ParticipantsTypeIDPutResponse"];
2058
+ };
2079
2059
  };
2080
2060
  responses: {
2081
2061
  200: components["responses"]["200"];
@@ -2088,54 +2068,36 @@ export interface operations {
2088
2068
  501: components["responses"]["501"];
2089
2069
  503: components["responses"]["503"];
2090
2070
  };
2091
- /** Participant information returned. */
2092
- requestBody: {
2093
- content: {
2094
- "application/json": components["schemas"]["ParticipantsTypeIDPutResponse"];
2095
- };
2096
- };
2097
2071
  };
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`). */
2072
+ /**
2073
+ * Create participant information
2074
+ * @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`).
2075
+ */
2099
2076
  ParticipantsByIDAndType: {
2100
2077
  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
2078
  header: {
2108
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
2109
2079
  "Content-Type": components["parameters"]["Content-Type"];
2110
- /** The `Date` header field indicates the date when the request was sent. */
2111
2080
  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
2081
  "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
2082
  "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
2083
  "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
2084
  "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
2085
  "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
2086
  "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
2087
  "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
2088
  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
2089
  "Content-Length"?: components["parameters"]["Content-Length"];
2138
2090
  };
2091
+ path: {
2092
+ Type: components["parameters"]["Type"];
2093
+ ID: components["parameters"]["ID"];
2094
+ };
2095
+ };
2096
+ /** @description Participant information to be created. */
2097
+ requestBody: {
2098
+ content: {
2099
+ "application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"];
2100
+ };
2139
2101
  };
2140
2102
  responses: {
2141
2103
  202: components["responses"]["202"];
@@ -2148,52 +2110,31 @@ export interface operations {
2148
2110
  501: components["responses"]["501"];
2149
2111
  503: components["responses"]["503"];
2150
2112
  };
2151
- /** Participant information to be created. */
2152
- requestBody: {
2153
- content: {
2154
- "application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"];
2155
- };
2156
- };
2157
2113
  };
2158
2114
  /**
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.
2115
+ * Delete participant information
2116
+ * @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
2117
  *
2161
2118
  * **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.
2162
2119
  */
2163
2120
  ParticipantsByTypeAndID2: {
2164
2121
  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
2122
  header: {
2172
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
2173
2123
  "Content-Type": components["parameters"]["Content-Type"];
2174
- /** The `Date` header field indicates the date when the request was sent. */
2175
2124
  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
2125
  "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
2126
  "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
2127
  "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
2128
  "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
2129
  "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
2130
  "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
2131
  "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
2132
  Accept: components["parameters"]["Accept"];
2196
2133
  };
2134
+ path: {
2135
+ Type: components["parameters"]["Type"];
2136
+ ID: components["parameters"]["ID"];
2137
+ };
2197
2138
  };
2198
2139
  responses: {
2199
2140
  202: components["responses"]["202"];
@@ -2207,45 +2148,34 @@ export interface operations {
2207
2148
  503: components["responses"]["503"];
2208
2149
  };
2209
2150
  };
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. */
2151
+ /**
2152
+ * Return participant information error
2153
+ * @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.
2154
+ */
2211
2155
  ParticipantsErrorByTypeAndID: {
2212
2156
  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
2157
  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
2158
  "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
2159
  "Content-Type": components["parameters"]["Content-Type"];
2228
- /** The `Date` header field indicates the date when the request was sent. */
2229
2160
  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
2161
  "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
2162
  "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
2163
  "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
2164
  "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
2165
  "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
2166
  "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
2167
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
2248
2168
  };
2169
+ path: {
2170
+ Type: components["parameters"]["Type"];
2171
+ ID: components["parameters"]["ID"];
2172
+ };
2173
+ };
2174
+ /** @description Details of the error returned. */
2175
+ requestBody: {
2176
+ content: {
2177
+ "application/json": components["schemas"]["ErrorInformationObject"];
2178
+ };
2249
2179
  };
2250
2180
  responses: {
2251
2181
  200: components["responses"]["200"];
@@ -2258,50 +2188,30 @@ export interface operations {
2258
2188
  501: components["responses"]["501"];
2259
2189
  503: components["responses"]["503"];
2260
2190
  };
2261
- /** Details of the error returned. */
2262
- requestBody: {
2263
- content: {
2264
- "application/json": components["schemas"]["ErrorInformationObject"];
2265
- };
2266
- };
2267
2191
  };
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. */
2192
+ /**
2193
+ * Look up participant information
2194
+ * @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.
2195
+ */
2269
2196
  ParticipantsSubIdByTypeAndID: {
2270
2197
  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
2198
  header: {
2280
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
2281
2199
  "Content-Type": components["parameters"]["Content-Type"];
2282
- /** The `Date` header field indicates the date when the request was sent. */
2283
2200
  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
2201
  "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
2202
  "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
2203
  "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
2204
  "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
2205
  "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
2206
  "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
2207
  "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
2208
  Accept: components["parameters"]["Accept"];
2304
2209
  };
2210
+ path: {
2211
+ Type: components["parameters"]["Type"];
2212
+ ID: components["parameters"]["ID"];
2213
+ SubId: components["parameters"]["SubId"];
2214
+ };
2305
2215
  };
2306
2216
  responses: {
2307
2217
  202: components["responses"]["202"];
@@ -2315,47 +2225,35 @@ export interface operations {
2315
2225
  503: components["responses"]["503"];
2316
2226
  };
2317
2227
  };
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. */
2228
+ /**
2229
+ * Return participant information
2230
+ * @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.
2231
+ */
2319
2232
  ParticipantsSubIdByTypeAndID3: {
2320
2233
  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
2234
  header: {
2330
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
2331
2235
  "Content-Type": components["parameters"]["Content-Type"];
2332
- /** The `Date` header field indicates the date when the request was sent. */
2333
2236
  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
2237
  "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
2238
  "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
2239
  "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
2240
  "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
2241
  "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
2242
  "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
2243
  "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
2244
  "Content-Length"?: components["parameters"]["Content-Length"];
2358
2245
  };
2246
+ path: {
2247
+ Type: components["parameters"]["Type"];
2248
+ ID: components["parameters"]["ID"];
2249
+ SubId: components["parameters"]["SubId"];
2250
+ };
2251
+ };
2252
+ /** @description Participant information returned. */
2253
+ requestBody: {
2254
+ content: {
2255
+ "application/json": components["schemas"]["ParticipantsTypeIDPutResponse"];
2256
+ };
2359
2257
  };
2360
2258
  responses: {
2361
2259
  200: components["responses"]["200"];
@@ -2368,56 +2266,37 @@ export interface operations {
2368
2266
  501: components["responses"]["501"];
2369
2267
  503: components["responses"]["503"];
2370
2268
  };
2371
- /** Participant information returned. */
2372
- requestBody: {
2373
- content: {
2374
- "application/json": components["schemas"]["ParticipantsTypeIDPutResponse"];
2375
- };
2376
- };
2377
2269
  };
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`). */
2270
+ /**
2271
+ * Create participant information
2272
+ * @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`).
2273
+ */
2379
2274
  ParticipantsSubIdByTypeAndIDPost: {
2380
2275
  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
2276
  header: {
2390
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
2391
2277
  "Content-Type": components["parameters"]["Content-Type"];
2392
- /** The `Date` header field indicates the date when the request was sent. */
2393
2278
  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
2279
  "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
2280
  "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
2281
  "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
2282
  "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
2283
  "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
2284
  "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
2285
  "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
2286
  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
2287
  "Content-Length"?: components["parameters"]["Content-Length"];
2420
2288
  };
2289
+ path: {
2290
+ Type: components["parameters"]["Type"];
2291
+ ID: components["parameters"]["ID"];
2292
+ SubId: components["parameters"]["SubId"];
2293
+ };
2294
+ };
2295
+ /** @description Participant information to be created. */
2296
+ requestBody: {
2297
+ content: {
2298
+ "application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"];
2299
+ };
2421
2300
  };
2422
2301
  responses: {
2423
2302
  202: components["responses"]["202"];
@@ -2430,54 +2309,32 @@ export interface operations {
2430
2309
  501: components["responses"]["501"];
2431
2310
  503: components["responses"]["503"];
2432
2311
  };
2433
- /** Participant information to be created. */
2434
- requestBody: {
2435
- content: {
2436
- "application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"];
2437
- };
2438
- };
2439
2312
  };
2440
2313
  /**
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.
2314
+ * Delete participant information
2315
+ * @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
2316
  *
2443
2317
  * **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.
2444
2318
  */
2445
2319
  ParticipantsSubIdByTypeAndID2: {
2446
2320
  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
2321
  header: {
2456
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
2457
2322
  "Content-Type": components["parameters"]["Content-Type"];
2458
- /** The `Date` header field indicates the date when the request was sent. */
2459
2323
  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
2324
  "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
2325
  "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
2326
  "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
2327
  "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
2328
  "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
2329
  "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
2330
  "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
2331
  Accept: components["parameters"]["Accept"];
2480
2332
  };
2333
+ path: {
2334
+ Type: components["parameters"]["Type"];
2335
+ ID: components["parameters"]["ID"];
2336
+ SubId: components["parameters"]["SubId"];
2337
+ };
2481
2338
  };
2482
2339
  responses: {
2483
2340
  202: components["responses"]["202"];
@@ -2491,47 +2348,35 @@ export interface operations {
2491
2348
  503: components["responses"]["503"];
2492
2349
  };
2493
2350
  };
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. */
2351
+ /**
2352
+ * Return participant information error
2353
+ * @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.
2354
+ */
2495
2355
  ParticipantsSubIdErrorByTypeAndID: {
2496
2356
  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
2357
  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
2358
  "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
2359
  "Content-Type": components["parameters"]["Content-Type"];
2514
- /** The `Date` header field indicates the date when the request was sent. */
2515
2360
  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
2361
  "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
2362
  "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
2363
  "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
2364
  "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
2365
  "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
2366
  "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
2367
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
2534
2368
  };
2369
+ path: {
2370
+ Type: components["parameters"]["Type"];
2371
+ ID: components["parameters"]["ID"];
2372
+ SubId: components["parameters"]["SubId"];
2373
+ };
2374
+ };
2375
+ /** @description Details of the error returned. */
2376
+ requestBody: {
2377
+ content: {
2378
+ "application/json": components["schemas"]["ErrorInformationObject"];
2379
+ };
2535
2380
  };
2536
2381
  responses: {
2537
2382
  200: components["responses"]["200"];
@@ -2544,49 +2389,33 @@ export interface operations {
2544
2389
  501: components["responses"]["501"];
2545
2390
  503: components["responses"]["503"];
2546
2391
  };
2547
- /** Details of the error returned. */
2548
- requestBody: {
2549
- content: {
2550
- "application/json": components["schemas"]["ErrorInformationObject"];
2551
- };
2552
- };
2553
2392
  };
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. */
2393
+ /**
2394
+ * Create bulk participant information
2395
+ * @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.
2396
+ */
2555
2397
  Participants1: {
2556
2398
  parameters: {
2557
2399
  header: {
2558
- /** The `Accept` header field indicates the version of the API the client would like the server to use. */
2559
2400
  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
2401
  "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
2402
  "Content-Type": components["parameters"]["Content-Type"];
2568
- /** The `Date` header field indicates the date when the request was sent. */
2569
2403
  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
2404
  "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
2405
  "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
2406
  "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
2407
  "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
2408
  "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
2409
  "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
2410
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
2588
2411
  };
2589
2412
  };
2413
+ /** @description Participant information to be created. */
2414
+ requestBody: {
2415
+ content: {
2416
+ "application/json": components["schemas"]["ParticipantsPostRequest"];
2417
+ };
2418
+ };
2590
2419
  responses: {
2591
2420
  202: components["responses"]["202"];
2592
2421
  400: components["responses"]["400"];
@@ -2598,50 +2427,34 @@ export interface operations {
2598
2427
  501: components["responses"]["501"];
2599
2428
  503: components["responses"]["503"];
2600
2429
  };
2601
- /** Participant information to be created. */
2602
- requestBody: {
2603
- content: {
2604
- "application/json": components["schemas"]["ParticipantsPostRequest"];
2605
- };
2606
- };
2607
2430
  };
2608
- /** The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities. */
2431
+ /**
2432
+ * Return bulk participant information
2433
+ * @description The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities.
2434
+ */
2609
2435
  putParticipantsByID: {
2610
2436
  parameters: {
2611
- path: {
2612
- /** The identifier value. */
2613
- ID: components["parameters"]["ID"];
2614
- };
2615
2437
  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
2438
  "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
2439
  "Content-Type": components["parameters"]["Content-Type"];
2624
- /** The `Date` header field indicates the date when the request was sent. */
2625
2440
  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
2441
  "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
2442
  "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
2443
  "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
2444
  "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
2445
  "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
2446
  "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
2447
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
2644
2448
  };
2449
+ path: {
2450
+ ID: components["parameters"]["ID"];
2451
+ };
2452
+ };
2453
+ /** @description Participant information returned. */
2454
+ requestBody: {
2455
+ content: {
2456
+ "application/json": components["schemas"]["ParticipantsIDPutResponse"];
2457
+ };
2645
2458
  };
2646
2459
  responses: {
2647
2460
  200: components["responses"]["200"];
@@ -2654,50 +2467,34 @@ export interface operations {
2654
2467
  501: components["responses"]["501"];
2655
2468
  503: components["responses"]["503"];
2656
2469
  };
2657
- /** Participant information returned. */
2658
- requestBody: {
2659
- content: {
2660
- "application/json": components["schemas"]["ParticipantsIDPutResponse"];
2661
- };
2662
- };
2663
2470
  };
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. */
2471
+ /**
2472
+ * Return bulk participant information error
2473
+ * @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.
2474
+ */
2665
2475
  ParticipantsByIDAndError: {
2666
2476
  parameters: {
2667
- path: {
2668
- /** The identifier value. */
2669
- ID: components["parameters"]["ID"];
2670
- };
2671
2477
  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
2478
  "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
2479
  "Content-Type": components["parameters"]["Content-Type"];
2680
- /** The `Date` header field indicates the date when the request was sent. */
2681
2480
  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
2481
  "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
2482
  "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
2483
  "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
2484
  "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
2485
  "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
2486
  "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
2487
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
2700
2488
  };
2489
+ path: {
2490
+ ID: components["parameters"]["ID"];
2491
+ };
2492
+ };
2493
+ /** @description Details of the error returned. */
2494
+ requestBody: {
2495
+ content: {
2496
+ "application/json": components["schemas"]["ErrorInformationObject"];
2497
+ };
2701
2498
  };
2702
2499
  responses: {
2703
2500
  200: components["responses"]["200"];
@@ -2710,48 +2507,29 @@ export interface operations {
2710
2507
  501: components["responses"]["501"];
2711
2508
  503: components["responses"]["503"];
2712
2509
  };
2713
- /** Details of the error returned. */
2714
- requestBody: {
2715
- content: {
2716
- "application/json": components["schemas"]["ErrorInformationObject"];
2717
- };
2718
- };
2719
2510
  };
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`). */
2511
+ /**
2512
+ * Look up party information
2513
+ * @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`).
2514
+ */
2721
2515
  PartiesByTypeAndID: {
2722
2516
  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
2517
  header: {
2730
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
2731
2518
  "Content-Type": components["parameters"]["Content-Type"];
2732
- /** The `Date` header field indicates the date when the request was sent. */
2733
2519
  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
2520
  "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
2521
  "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
2522
  "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
2523
  "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
2524
  "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
2525
  "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
2526
  "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
2527
  Accept: components["parameters"]["Accept"];
2754
2528
  };
2529
+ path: {
2530
+ Type: components["parameters"]["Type"];
2531
+ ID: components["parameters"]["ID"];
2532
+ };
2755
2533
  };
2756
2534
  responses: {
2757
2535
  202: components["responses"]["202"];
@@ -2765,45 +2543,34 @@ export interface operations {
2765
2543
  503: components["responses"]["503"];
2766
2544
  };
2767
2545
  };
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. */
2546
+ /**
2547
+ * Return party information
2548
+ * @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.
2549
+ */
2769
2550
  PartiesByTypeAndID2: {
2770
2551
  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
2552
  header: {
2778
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
2779
2553
  "Content-Type": components["parameters"]["Content-Type"];
2780
- /** The `Date` header field indicates the date when the request was sent. */
2781
2554
  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
2555
  "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
2556
  "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
2557
  "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
2558
  "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
2559
  "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
2560
  "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
2561
  "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
2562
  "Content-Length"?: components["parameters"]["Content-Length"];
2806
2563
  };
2564
+ path: {
2565
+ Type: components["parameters"]["Type"];
2566
+ ID: components["parameters"]["ID"];
2567
+ };
2568
+ };
2569
+ /** @description Party information returned. */
2570
+ requestBody: {
2571
+ content: {
2572
+ "application/json": components["schemas"]["PartiesTypeIDPutResponse"];
2573
+ };
2807
2574
  };
2808
2575
  responses: {
2809
2576
  200: components["responses"]["200"];
@@ -2816,52 +2583,35 @@ export interface operations {
2816
2583
  501: components["responses"]["501"];
2817
2584
  503: components["responses"]["503"];
2818
2585
  };
2819
- /** Party information returned. */
2820
- requestBody: {
2821
- content: {
2822
- "application/json": components["schemas"]["PartiesTypeIDPutResponse"];
2823
- };
2824
- };
2825
2586
  };
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. */
2587
+ /**
2588
+ * Return party information error
2589
+ * @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.
2590
+ */
2827
2591
  PartiesErrorByTypeAndID: {
2828
2592
  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
2593
  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
2594
  "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
2595
  "Content-Type": components["parameters"]["Content-Type"];
2844
- /** The `Date` header field indicates the date when the request was sent. */
2845
2596
  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
2597
  "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
2598
  "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
2599
  "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
2600
  "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
2601
  "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
2602
  "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
2603
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
2864
2604
  };
2605
+ path: {
2606
+ Type: components["parameters"]["Type"];
2607
+ ID: components["parameters"]["ID"];
2608
+ };
2609
+ };
2610
+ /** @description Details of the error returned. */
2611
+ requestBody: {
2612
+ content: {
2613
+ "application/json": components["schemas"]["ErrorInformationObject"];
2614
+ };
2865
2615
  };
2866
2616
  responses: {
2867
2617
  200: components["responses"]["200"];
@@ -2874,50 +2624,30 @@ export interface operations {
2874
2624
  501: components["responses"]["501"];
2875
2625
  503: components["responses"]["503"];
2876
2626
  };
2877
- /** Details of the error returned. */
2878
- requestBody: {
2879
- content: {
2880
- "application/json": components["schemas"]["ErrorInformationObject"];
2881
- };
2882
- };
2883
2627
  };
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`). */
2628
+ /**
2629
+ * Look up party information
2630
+ * @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`).
2631
+ */
2885
2632
  PartiesSubIdByTypeAndID: {
2886
2633
  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
2634
  header: {
2896
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
2897
2635
  "Content-Type": components["parameters"]["Content-Type"];
2898
- /** The `Date` header field indicates the date when the request was sent. */
2899
2636
  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
2637
  "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
2638
  "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
2639
  "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
2640
  "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
2641
  "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
2642
  "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
2643
  "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
2644
  Accept: components["parameters"]["Accept"];
2920
2645
  };
2646
+ path: {
2647
+ Type: components["parameters"]["Type"];
2648
+ ID: components["parameters"]["ID"];
2649
+ SubId: components["parameters"]["SubId"];
2650
+ };
2921
2651
  };
2922
2652
  responses: {
2923
2653
  202: components["responses"]["202"];
@@ -2931,47 +2661,35 @@ export interface operations {
2931
2661
  503: components["responses"]["503"];
2932
2662
  };
2933
2663
  };
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. */
2664
+ /**
2665
+ * Return party information
2666
+ * @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.
2667
+ */
2935
2668
  PartiesSubIdByTypeAndIDPut: {
2936
2669
  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
2670
  header: {
2946
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
2947
2671
  "Content-Type": components["parameters"]["Content-Type"];
2948
- /** The `Date` header field indicates the date when the request was sent. */
2949
2672
  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
2673
  "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
2674
  "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
2675
  "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
2676
  "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
2677
  "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
2678
  "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
2679
  "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
2680
  "Content-Length"?: components["parameters"]["Content-Length"];
2974
2681
  };
2682
+ path: {
2683
+ Type: components["parameters"]["Type"];
2684
+ ID: components["parameters"]["ID"];
2685
+ SubId: components["parameters"]["SubId"];
2686
+ };
2687
+ };
2688
+ /** @description Party information returned. */
2689
+ requestBody: {
2690
+ content: {
2691
+ "application/json": components["schemas"]["PartiesTypeIDPutResponse"];
2692
+ };
2975
2693
  };
2976
2694
  responses: {
2977
2695
  200: components["responses"]["200"];
@@ -2984,54 +2702,36 @@ export interface operations {
2984
2702
  501: components["responses"]["501"];
2985
2703
  503: components["responses"]["503"];
2986
2704
  };
2987
- /** Party information returned. */
2988
- requestBody: {
2989
- content: {
2990
- "application/json": components["schemas"]["PartiesTypeIDPutResponse"];
2991
- };
2992
- };
2993
2705
  };
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. */
2706
+ /**
2707
+ * Return party information error
2708
+ * @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.
2709
+ */
2995
2710
  PartiesSubIdErrorByTypeAndID: {
2996
2711
  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
2712
  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
2713
  "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
2714
  "Content-Type": components["parameters"]["Content-Type"];
3014
- /** The `Date` header field indicates the date when the request was sent. */
3015
2715
  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
2716
  "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
2717
  "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
2718
  "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
2719
  "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
2720
  "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
2721
  "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
2722
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
3034
2723
  };
2724
+ path: {
2725
+ Type: components["parameters"]["Type"];
2726
+ ID: components["parameters"]["ID"];
2727
+ SubId: components["parameters"]["SubId"];
2728
+ };
2729
+ };
2730
+ /** @description Details of the error returned. */
2731
+ requestBody: {
2732
+ content: {
2733
+ "application/json": components["schemas"]["ErrorInformationObject"];
2734
+ };
3035
2735
  };
3036
2736
  responses: {
3037
2737
  200: components["responses"]["200"];
@@ -3044,49 +2744,33 @@ export interface operations {
3044
2744
  501: components["responses"]["501"];
3045
2745
  503: components["responses"]["503"];
3046
2746
  };
3047
- /** Details of the error returned. */
3048
- requestBody: {
3049
- content: {
3050
- "application/json": components["schemas"]["ErrorInformationObject"];
3051
- };
3052
- };
3053
2747
  };
3054
- /** The HTTP request `POST /transactionRequests` is used to request the creation of a transaction request for the provided financial transaction in the server. */
2748
+ /**
2749
+ * Perform transaction request
2750
+ * @description The HTTP request `POST /transactionRequests` is used to request the creation of a transaction request for the provided financial transaction in the server.
2751
+ */
3055
2752
  TransactionRequests: {
3056
2753
  parameters: {
3057
2754
  header: {
3058
- /** The `Accept` header field indicates the version of the API the client would like the server to use. */
3059
2755
  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
2756
  "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
2757
  "Content-Type": components["parameters"]["Content-Type"];
3068
- /** The `Date` header field indicates the date when the request was sent. */
3069
2758
  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
2759
  "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
2760
  "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
2761
  "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
2762
  "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
2763
  "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
2764
  "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
2765
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
3088
2766
  };
3089
2767
  };
2768
+ /** @description Transaction request to be created. */
2769
+ requestBody: {
2770
+ content: {
2771
+ "application/json": components["schemas"]["TransactionRequestsPostRequest"];
2772
+ };
2773
+ };
3090
2774
  responses: {
3091
2775
  202: components["responses"]["202"];
3092
2776
  400: components["responses"]["400"];
@@ -3098,46 +2782,28 @@ export interface operations {
3098
2782
  501: components["responses"]["501"];
3099
2783
  503: components["responses"]["503"];
3100
2784
  };
3101
- /** Transaction request to be created. */
3102
- requestBody: {
3103
- content: {
3104
- "application/json": components["schemas"]["TransactionRequestsPostRequest"];
3105
- };
3106
- };
3107
2785
  };
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. */
2786
+ /**
2787
+ * Retrieve transaction request information
2788
+ * @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.
2789
+ */
3109
2790
  TransactionRequestsByID: {
3110
2791
  parameters: {
3111
- path: {
3112
- /** The identifier value. */
3113
- ID: components["parameters"]["ID"];
3114
- };
3115
2792
  header: {
3116
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
3117
2793
  "Content-Type": components["parameters"]["Content-Type"];
3118
- /** The `Date` header field indicates the date when the request was sent. */
3119
2794
  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
2795
  "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
2796
  "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
2797
  "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
2798
  "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
2799
  "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
2800
  "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
2801
  "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
2802
  Accept: components["parameters"]["Accept"];
3140
2803
  };
2804
+ path: {
2805
+ ID: components["parameters"]["ID"];
2806
+ };
3141
2807
  };
3142
2808
  responses: {
3143
2809
  202: components["responses"]["202"];
@@ -3151,43 +2817,33 @@ export interface operations {
3151
2817
  503: components["responses"]["503"];
3152
2818
  };
3153
2819
  };
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}`. */
2820
+ /**
2821
+ * Return transaction request information
2822
+ * @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}`.
2823
+ */
3155
2824
  TransactionRequestsByIDPut: {
3156
2825
  parameters: {
3157
- path: {
3158
- /** The identifier value. */
3159
- ID: components["parameters"]["ID"];
3160
- };
3161
2826
  header: {
3162
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
3163
2827
  "Content-Type": components["parameters"]["Content-Type"];
3164
- /** The `Date` header field indicates the date when the request was sent. */
3165
2828
  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
2829
  "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
2830
  "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
2831
  "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
2832
  "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
2833
  "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
2834
  "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
2835
  "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
2836
  "Content-Length"?: components["parameters"]["Content-Length"];
3190
2837
  };
2838
+ path: {
2839
+ ID: components["parameters"]["ID"];
2840
+ };
2841
+ };
2842
+ /** @description Transaction request information returned. */
2843
+ requestBody: {
2844
+ content: {
2845
+ "application/json": components["schemas"]["TransactionRequestsIDPutResponse"];
2846
+ };
3191
2847
  };
3192
2848
  responses: {
3193
2849
  200: components["responses"]["200"];
@@ -3200,50 +2856,34 @@ export interface operations {
3200
2856
  501: components["responses"]["501"];
3201
2857
  503: components["responses"]["503"];
3202
2858
  };
3203
- /** Transaction request information returned. */
3204
- requestBody: {
3205
- content: {
3206
- "application/json": components["schemas"]["TransactionRequestsIDPutResponse"];
3207
- };
3208
- };
3209
2859
  };
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}`. */
2860
+ /**
2861
+ * Return transaction request information error
2862
+ * @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}`.
2863
+ */
3211
2864
  TransactionRequestsErrorByID: {
3212
2865
  parameters: {
3213
- path: {
3214
- /** The identifier value. */
3215
- ID: components["parameters"]["ID"];
3216
- };
3217
2866
  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
2867
  "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
2868
  "Content-Type": components["parameters"]["Content-Type"];
3226
- /** The `Date` header field indicates the date when the request was sent. */
3227
2869
  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
2870
  "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
2871
  "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
2872
  "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
2873
  "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
2874
  "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
2875
  "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
2876
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
3246
2877
  };
2878
+ path: {
2879
+ ID: components["parameters"]["ID"];
2880
+ };
2881
+ };
2882
+ /** @description Details of the error returned. */
2883
+ requestBody: {
2884
+ content: {
2885
+ "application/json": components["schemas"]["ErrorInformationObject"];
2886
+ };
3247
2887
  };
3248
2888
  responses: {
3249
2889
  200: components["responses"]["200"];
@@ -3256,49 +2896,33 @@ export interface operations {
3256
2896
  501: components["responses"]["501"];
3257
2897
  503: components["responses"]["503"];
3258
2898
  };
3259
- /** Details of the error returned. */
3260
- requestBody: {
3261
- content: {
3262
- "application/json": components["schemas"]["ErrorInformationObject"];
3263
- };
3264
- };
3265
2899
  };
3266
- /** The HTTP request `POST /quotes` is used to request the creation of a quote for the provided financial transaction in the server. */
2900
+ /**
2901
+ * Calculate quote
2902
+ * @description The HTTP request `POST /quotes` is used to request the creation of a quote for the provided financial transaction in the server.
2903
+ */
3267
2904
  Quotes: {
3268
2905
  parameters: {
3269
2906
  header: {
3270
- /** The `Accept` header field indicates the version of the API the client would like the server to use. */
3271
2907
  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
2908
  "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
2909
  "Content-Type": components["parameters"]["Content-Type"];
3280
- /** The `Date` header field indicates the date when the request was sent. */
3281
2910
  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
2911
  "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
2912
  "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
2913
  "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
2914
  "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
2915
  "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
2916
  "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
2917
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
3300
2918
  };
3301
2919
  };
2920
+ /** @description Details of the quote to be created. */
2921
+ requestBody: {
2922
+ content: {
2923
+ "application/json": components["schemas"]["QuotesPostRequest"];
2924
+ };
2925
+ };
3302
2926
  responses: {
3303
2927
  202: components["responses"]["202"];
3304
2928
  400: components["responses"]["400"];
@@ -3310,46 +2934,28 @@ export interface operations {
3310
2934
  501: components["responses"]["501"];
3311
2935
  503: components["responses"]["503"];
3312
2936
  };
3313
- /** Details of the quote to be created. */
3314
- requestBody: {
3315
- content: {
3316
- "application/json": components["schemas"]["QuotesPostRequest"];
3317
- };
3318
- };
3319
2937
  };
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. */
2938
+ /**
2939
+ * Retrieve quote information
2940
+ * @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.
2941
+ */
3321
2942
  QuotesByID: {
3322
2943
  parameters: {
3323
- path: {
3324
- /** The identifier value. */
3325
- ID: components["parameters"]["ID"];
3326
- };
3327
2944
  header: {
3328
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
3329
2945
  "Content-Type": components["parameters"]["Content-Type"];
3330
- /** The `Date` header field indicates the date when the request was sent. */
3331
2946
  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
2947
  "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
2948
  "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
2949
  "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
2950
  "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
2951
  "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
2952
  "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
2953
  "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
2954
  Accept: components["parameters"]["Accept"];
3352
2955
  };
2956
+ path: {
2957
+ ID: components["parameters"]["ID"];
2958
+ };
3353
2959
  };
3354
2960
  responses: {
3355
2961
  202: components["responses"]["202"];
@@ -3363,43 +2969,33 @@ export interface operations {
3363
2969
  503: components["responses"]["503"];
3364
2970
  };
3365
2971
  };
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. */
2972
+ /**
2973
+ * Return quote information
2974
+ * @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.
2975
+ */
3367
2976
  QuotesByID1: {
3368
2977
  parameters: {
3369
- path: {
3370
- /** The identifier value. */
3371
- ID: components["parameters"]["ID"];
3372
- };
3373
2978
  header: {
3374
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
3375
2979
  "Content-Type": components["parameters"]["Content-Type"];
3376
- /** The `Date` header field indicates the date when the request was sent. */
3377
2980
  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
2981
  "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
2982
  "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
2983
  "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
2984
  "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
2985
  "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
2986
  "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
2987
  "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
2988
  "Content-Length"?: components["parameters"]["Content-Length"];
3402
2989
  };
2990
+ path: {
2991
+ ID: components["parameters"]["ID"];
2992
+ };
2993
+ };
2994
+ /** @description Quote information returned. */
2995
+ requestBody: {
2996
+ content: {
2997
+ "application/json": components["schemas"]["QuotesIDPutResponse"];
2998
+ };
3403
2999
  };
3404
3000
  responses: {
3405
3001
  200: components["responses"]["200"];
@@ -3412,50 +3008,34 @@ export interface operations {
3412
3008
  501: components["responses"]["501"];
3413
3009
  503: components["responses"]["503"];
3414
3010
  };
3415
- /** Quote information returned. */
3416
- requestBody: {
3417
- content: {
3418
- "application/json": components["schemas"]["QuotesIDPutResponse"];
3419
- };
3420
- };
3421
3011
  };
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. */
3012
+ /**
3013
+ * Return quote information error
3014
+ * @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.
3015
+ */
3423
3016
  QuotesByIDAndError: {
3424
3017
  parameters: {
3425
- path: {
3426
- /** The identifier value. */
3427
- ID: components["parameters"]["ID"];
3428
- };
3429
3018
  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
3019
  "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
3020
  "Content-Type": components["parameters"]["Content-Type"];
3438
- /** The `Date` header field indicates the date when the request was sent. */
3439
3021
  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
3022
  "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
3023
  "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
3024
  "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
3025
  "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
3026
  "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
3027
  "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
3028
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
3458
3029
  };
3030
+ path: {
3031
+ ID: components["parameters"]["ID"];
3032
+ };
3033
+ };
3034
+ /** @description Details of the error returned. */
3035
+ requestBody: {
3036
+ content: {
3037
+ "application/json": components["schemas"]["ErrorInformationObject"];
3038
+ };
3459
3039
  };
3460
3040
  responses: {
3461
3041
  200: components["responses"]["200"];
@@ -3468,15 +3048,10 @@ export interface operations {
3468
3048
  501: components["responses"]["501"];
3469
3049
  503: components["responses"]["503"];
3470
3050
  };
3471
- /** Details of the error returned. */
3472
- requestBody: {
3473
- content: {
3474
- "application/json": components["schemas"]["ErrorInformationObject"];
3475
- };
3476
- };
3477
3051
  };
3478
3052
  /**
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*:*
3053
+ * Perform authorization
3054
+ * @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
3055
  *
3481
3056
  * - `authenticationType={Type}`, where `{Type}` value is a valid authentication type from the enumeration `AuthenticationType`.
3482
3057
  *
@@ -3492,36 +3067,21 @@ export interface operations {
3492
3067
  */
3493
3068
  AuthorizationsByIDGet: {
3494
3069
  parameters: {
3495
- path: {
3496
- /** The identifier value. */
3497
- ID: components["parameters"]["ID"];
3498
- };
3499
3070
  header: {
3500
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
3501
3071
  "Content-Type": components["parameters"]["Content-Type"];
3502
- /** The `Date` header field indicates the date when the request was sent. */
3503
3072
  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
3073
  "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
3074
  "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
3075
  "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
3076
  "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
3077
  "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
3078
  "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
3079
  "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
3080
  Accept: components["parameters"]["Accept"];
3524
3081
  };
3082
+ path: {
3083
+ ID: components["parameters"]["ID"];
3084
+ };
3525
3085
  };
3526
3086
  responses: {
3527
3087
  202: components["responses"]["202"];
@@ -3535,43 +3095,33 @@ export interface operations {
3535
3095
  503: components["responses"]["503"];
3536
3096
  };
3537
3097
  };
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. */
3098
+ /**
3099
+ * Return authorization result
3100
+ * @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.
3101
+ */
3539
3102
  AuthorizationsByIDPut: {
3540
3103
  parameters: {
3541
- path: {
3542
- /** The identifier value. */
3543
- ID: components["parameters"]["ID"];
3544
- };
3545
3104
  header: {
3546
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
3547
3105
  "Content-Type": components["parameters"]["Content-Type"];
3548
- /** The `Date` header field indicates the date when the request was sent. */
3549
3106
  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
3107
  "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
3108
  "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
3109
  "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
3110
  "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
3111
  "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
3112
  "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
3113
  "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
3114
  "Content-Length"?: components["parameters"]["Content-Length"];
3574
3115
  };
3116
+ path: {
3117
+ ID: components["parameters"]["ID"];
3118
+ };
3119
+ };
3120
+ /** @description Authorization result returned. */
3121
+ requestBody: {
3122
+ content: {
3123
+ "application/json": components["schemas"]["AuthorizationsIDPutResponse"];
3124
+ };
3575
3125
  };
3576
3126
  responses: {
3577
3127
  200: components["responses"]["200"];
@@ -3584,50 +3134,34 @@ export interface operations {
3584
3134
  501: components["responses"]["501"];
3585
3135
  503: components["responses"]["503"];
3586
3136
  };
3587
- /** Authorization result returned. */
3588
- requestBody: {
3589
- content: {
3590
- "application/json": components["schemas"]["AuthorizationsIDPutResponse"];
3591
- };
3592
- };
3593
3137
  };
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}`. */
3138
+ /**
3139
+ * Return authorization error
3140
+ * @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}`.
3141
+ */
3595
3142
  AuthorizationsByIDAndError: {
3596
3143
  parameters: {
3597
- path: {
3598
- /** The identifier value. */
3599
- ID: components["parameters"]["ID"];
3600
- };
3601
3144
  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
3145
  "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
3146
  "Content-Type": components["parameters"]["Content-Type"];
3610
- /** The `Date` header field indicates the date when the request was sent. */
3611
3147
  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
3148
  "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
3149
  "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
3150
  "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
3151
  "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
3152
  "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
3153
  "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
3154
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
3630
3155
  };
3156
+ path: {
3157
+ ID: components["parameters"]["ID"];
3158
+ };
3159
+ };
3160
+ /** @description Details of the error returned. */
3161
+ requestBody: {
3162
+ content: {
3163
+ "application/json": components["schemas"]["ErrorInformationObject"];
3164
+ };
3631
3165
  };
3632
3166
  responses: {
3633
3167
  200: components["responses"]["200"];
@@ -3640,49 +3174,33 @@ export interface operations {
3640
3174
  501: components["responses"]["501"];
3641
3175
  503: components["responses"]["503"];
3642
3176
  };
3643
- /** Details of the error returned. */
3644
- requestBody: {
3645
- content: {
3646
- "application/json": components["schemas"]["ErrorInformationObject"];
3647
- };
3648
- };
3649
3177
  };
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. */
3178
+ /**
3179
+ * Perform transfer
3180
+ * @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.
3181
+ */
3651
3182
  transfers: {
3652
3183
  parameters: {
3653
3184
  header: {
3654
- /** The `Accept` header field indicates the version of the API the client would like the server to use. */
3655
3185
  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
3186
  "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
3187
  "Content-Type": components["parameters"]["Content-Type"];
3664
- /** The `Date` header field indicates the date when the request was sent. */
3665
3188
  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
3189
  "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
3190
  "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
3191
  "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
3192
  "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
3193
  "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
3194
  "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
3195
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
3684
3196
  };
3685
3197
  };
3198
+ /** @description Details of the transfer to be created. */
3199
+ requestBody: {
3200
+ content: {
3201
+ "application/json": components["schemas"]["TransfersPostRequest"];
3202
+ };
3203
+ };
3686
3204
  responses: {
3687
3205
  202: components["responses"]["202"];
3688
3206
  400: components["responses"]["400"];
@@ -3694,46 +3212,28 @@ export interface operations {
3694
3212
  501: components["responses"]["501"];
3695
3213
  503: components["responses"]["503"];
3696
3214
  };
3697
- /** Details of the transfer to be created. */
3698
- requestBody: {
3699
- content: {
3700
- "application/json": components["schemas"]["TransfersPostRequest"];
3701
- };
3702
- };
3703
3215
  };
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. */
3216
+ /**
3217
+ * Retrieve transfer information
3218
+ * @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.
3219
+ */
3705
3220
  TransfersByIDGet: {
3706
3221
  parameters: {
3707
- path: {
3708
- /** The identifier value. */
3709
- ID: components["parameters"]["ID"];
3710
- };
3711
3222
  header: {
3712
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
3713
3223
  "Content-Type": components["parameters"]["Content-Type"];
3714
- /** The `Date` header field indicates the date when the request was sent. */
3715
3224
  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
3225
  "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
3226
  "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
3227
  "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
3228
  "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
3229
  "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
3230
  "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
3231
  "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
3232
  Accept: components["parameters"]["Accept"];
3736
3233
  };
3234
+ path: {
3235
+ ID: components["parameters"]["ID"];
3236
+ };
3737
3237
  };
3738
3238
  responses: {
3739
3239
  202: components["responses"]["202"];
@@ -3747,43 +3247,33 @@ export interface operations {
3747
3247
  503: components["responses"]["503"];
3748
3248
  };
3749
3249
  };
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. */
3250
+ /**
3251
+ * Return transfer information
3252
+ * @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.
3253
+ */
3751
3254
  TransfersByIDPut: {
3752
3255
  parameters: {
3753
- path: {
3754
- /** The identifier value. */
3755
- ID: components["parameters"]["ID"];
3756
- };
3757
3256
  header: {
3758
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
3759
3257
  "Content-Type": components["parameters"]["Content-Type"];
3760
- /** The `Date` header field indicates the date when the request was sent. */
3761
3258
  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
3259
  "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
3260
  "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
3261
  "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
3262
  "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
3263
  "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
3264
  "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
3265
  "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
3266
  "Content-Length"?: components["parameters"]["Content-Length"];
3786
3267
  };
3268
+ path: {
3269
+ ID: components["parameters"]["ID"];
3270
+ };
3271
+ };
3272
+ /** @description Transfer information returned. */
3273
+ requestBody: {
3274
+ content: {
3275
+ "application/json": components["schemas"]["TransfersIDPutResponse"];
3276
+ };
3787
3277
  };
3788
3278
  responses: {
3789
3279
  200: components["responses"]["200"];
@@ -3796,50 +3286,34 @@ export interface operations {
3796
3286
  501: components["responses"]["501"];
3797
3287
  503: components["responses"]["503"];
3798
3288
  };
3799
- /** Transfer information returned. */
3800
- requestBody: {
3801
- content: {
3802
- "application/json": components["schemas"]["TransfersIDPutResponse"];
3803
- };
3804
- };
3805
3289
  };
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}`. */
3290
+ /**
3291
+ * Return transfer information error
3292
+ * @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}`.
3293
+ */
3807
3294
  TransfersByIDAndError: {
3808
3295
  parameters: {
3809
- path: {
3810
- /** The identifier value. */
3811
- ID: components["parameters"]["ID"];
3812
- };
3813
3296
  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
3297
  "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
3298
  "Content-Type": components["parameters"]["Content-Type"];
3822
- /** The `Date` header field indicates the date when the request was sent. */
3823
3299
  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
3300
  "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
3301
  "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
3302
  "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
3303
  "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
3304
  "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
3305
  "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
3306
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
3842
3307
  };
3308
+ path: {
3309
+ ID: components["parameters"]["ID"];
3310
+ };
3311
+ };
3312
+ /** @description Details of the error returned. */
3313
+ requestBody: {
3314
+ content: {
3315
+ "application/json": components["schemas"]["ErrorInformationObject"];
3316
+ };
3843
3317
  };
3844
3318
  responses: {
3845
3319
  200: components["responses"]["200"];
@@ -3852,46 +3326,28 @@ export interface operations {
3852
3326
  501: components["responses"]["501"];
3853
3327
  503: components["responses"]["503"];
3854
3328
  };
3855
- /** Details of the error returned. */
3856
- requestBody: {
3857
- content: {
3858
- "application/json": components["schemas"]["ErrorInformationObject"];
3859
- };
3860
- };
3861
3329
  };
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). */
3330
+ /**
3331
+ * Retrieve transaction information
3332
+ * @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).
3333
+ */
3863
3334
  TransactionsByID: {
3864
3335
  parameters: {
3865
- path: {
3866
- /** The identifier value. */
3867
- ID: components["parameters"]["ID"];
3868
- };
3869
3336
  header: {
3870
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
3871
3337
  "Content-Type": components["parameters"]["Content-Type"];
3872
- /** The `Date` header field indicates the date when the request was sent. */
3873
3338
  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
3339
  "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
3340
  "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
3341
  "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
3342
  "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
3343
  "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
3344
  "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
3345
  "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
3346
  Accept: components["parameters"]["Accept"];
3894
3347
  };
3348
+ path: {
3349
+ ID: components["parameters"]["ID"];
3350
+ };
3895
3351
  };
3896
3352
  responses: {
3897
3353
  202: components["responses"]["202"];
@@ -3905,43 +3361,33 @@ export interface operations {
3905
3361
  503: components["responses"]["503"];
3906
3362
  };
3907
3363
  };
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. */
3364
+ /**
3365
+ * Return transaction information
3366
+ * @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.
3367
+ */
3909
3368
  TransactionsByID1: {
3910
3369
  parameters: {
3911
- path: {
3912
- /** The identifier value. */
3913
- ID: components["parameters"]["ID"];
3914
- };
3915
3370
  header: {
3916
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
3917
3371
  "Content-Type": components["parameters"]["Content-Type"];
3918
- /** The `Date` header field indicates the date when the request was sent. */
3919
3372
  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
3373
  "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
3374
  "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
3375
  "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
3376
  "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
3377
  "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
3378
  "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
3379
  "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
3380
  "Content-Length"?: components["parameters"]["Content-Length"];
3944
3381
  };
3382
+ path: {
3383
+ ID: components["parameters"]["ID"];
3384
+ };
3385
+ };
3386
+ /** @description Transaction information returned. */
3387
+ requestBody: {
3388
+ content: {
3389
+ "application/json": components["schemas"]["TransactionsIDPutResponse"];
3390
+ };
3945
3391
  };
3946
3392
  responses: {
3947
3393
  200: components["responses"]["200"];
@@ -3954,50 +3400,34 @@ export interface operations {
3954
3400
  501: components["responses"]["501"];
3955
3401
  503: components["responses"]["503"];
3956
3402
  };
3957
- /** Transaction information returned. */
3958
- requestBody: {
3959
- content: {
3960
- "application/json": components["schemas"]["TransactionsIDPutResponse"];
3961
- };
3962
- };
3963
3403
  };
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. */
3404
+ /**
3405
+ * Return transaction information error
3406
+ * @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.
3407
+ */
3965
3408
  TransactionsErrorByID: {
3966
3409
  parameters: {
3967
- path: {
3968
- /** The identifier value. */
3969
- ID: components["parameters"]["ID"];
3970
- };
3971
3410
  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
3411
  "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
3412
  "Content-Type": components["parameters"]["Content-Type"];
3980
- /** The `Date` header field indicates the date when the request was sent. */
3981
3413
  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
3414
  "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
3415
  "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
3416
  "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
3417
  "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
3418
  "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
3419
  "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
3420
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
4000
3421
  };
3422
+ path: {
3423
+ ID: components["parameters"]["ID"];
3424
+ };
3425
+ };
3426
+ /** @description Details of the error returned. */
3427
+ requestBody: {
3428
+ content: {
3429
+ "application/json": components["schemas"]["ErrorInformationObject"];
3430
+ };
4001
3431
  };
4002
3432
  responses: {
4003
3433
  200: components["responses"]["200"];
@@ -4010,49 +3440,33 @@ export interface operations {
4010
3440
  501: components["responses"]["501"];
4011
3441
  503: components["responses"]["503"];
4012
3442
  };
4013
- /** Details of the error returned. */
4014
- requestBody: {
4015
- content: {
4016
- "application/json": components["schemas"]["ErrorInformationObject"];
4017
- };
4018
- };
4019
3443
  };
4020
- /** The HTTP request `POST /bulkQuotes` is used to request the creation of a bulk quote for the provided financial transactions in the server. */
3444
+ /**
3445
+ * Calculate bulk quote
3446
+ * @description The HTTP request `POST /bulkQuotes` is used to request the creation of a bulk quote for the provided financial transactions in the server.
3447
+ */
4021
3448
  BulkQuotes: {
4022
3449
  parameters: {
4023
3450
  header: {
4024
- /** The `Accept` header field indicates the version of the API the client would like the server to use. */
4025
3451
  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
3452
  "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
3453
  "Content-Type": components["parameters"]["Content-Type"];
4034
- /** The `Date` header field indicates the date when the request was sent. */
4035
3454
  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
3455
  "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
3456
  "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
3457
  "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
3458
  "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
3459
  "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
3460
  "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
3461
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
4054
3462
  };
4055
3463
  };
3464
+ /** @description Details of the bulk quote to be created. */
3465
+ requestBody: {
3466
+ content: {
3467
+ "application/json": components["schemas"]["BulkQuotesPostRequest"];
3468
+ };
3469
+ };
4056
3470
  responses: {
4057
3471
  202: components["responses"]["202"];
4058
3472
  400: components["responses"]["400"];
@@ -4064,46 +3478,28 @@ export interface operations {
4064
3478
  501: components["responses"]["501"];
4065
3479
  503: components["responses"]["503"];
4066
3480
  };
4067
- /** Details of the bulk quote to be created. */
4068
- requestBody: {
4069
- content: {
4070
- "application/json": components["schemas"]["BulkQuotesPostRequest"];
4071
- };
4072
- };
4073
3481
  };
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. */
3482
+ /**
3483
+ * Retrieve bulk quote information
3484
+ * @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.
3485
+ */
4075
3486
  BulkQuotesByID: {
4076
3487
  parameters: {
4077
- path: {
4078
- /** The identifier value. */
4079
- ID: components["parameters"]["ID"];
4080
- };
4081
3488
  header: {
4082
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
4083
3489
  "Content-Type": components["parameters"]["Content-Type"];
4084
- /** The `Date` header field indicates the date when the request was sent. */
4085
3490
  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
3491
  "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
3492
  "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
3493
  "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
3494
  "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
3495
  "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
3496
  "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
3497
  "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
3498
  Accept: components["parameters"]["Accept"];
4106
3499
  };
3500
+ path: {
3501
+ ID: components["parameters"]["ID"];
3502
+ };
4107
3503
  };
4108
3504
  responses: {
4109
3505
  202: components["responses"]["202"];
@@ -4117,43 +3513,33 @@ export interface operations {
4117
3513
  503: components["responses"]["503"];
4118
3514
  };
4119
3515
  };
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. */
3516
+ /**
3517
+ * Return bulk quote information
3518
+ * @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.
3519
+ */
4121
3520
  BulkQuotesByID1: {
4122
3521
  parameters: {
4123
- path: {
4124
- /** The identifier value. */
4125
- ID: components["parameters"]["ID"];
4126
- };
4127
3522
  header: {
4128
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
4129
3523
  "Content-Type": components["parameters"]["Content-Type"];
4130
- /** The `Date` header field indicates the date when the request was sent. */
4131
3524
  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
3525
  "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
3526
  "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
3527
  "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
3528
  "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
3529
  "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
3530
  "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
3531
  "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
3532
  "Content-Length"?: components["parameters"]["Content-Length"];
4156
3533
  };
3534
+ path: {
3535
+ ID: components["parameters"]["ID"];
3536
+ };
3537
+ };
3538
+ /** @description Bulk quote information returned. */
3539
+ requestBody: {
3540
+ content: {
3541
+ "application/json": components["schemas"]["BulkQuotesIDPutResponse"];
3542
+ };
4157
3543
  };
4158
3544
  responses: {
4159
3545
  200: components["responses"]["200"];
@@ -4166,50 +3552,34 @@ export interface operations {
4166
3552
  501: components["responses"]["501"];
4167
3553
  503: components["responses"]["503"];
4168
3554
  };
4169
- /** Bulk quote information returned. */
4170
- requestBody: {
4171
- content: {
4172
- "application/json": components["schemas"]["BulkQuotesIDPutResponse"];
4173
- };
4174
- };
4175
3555
  };
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. */
3556
+ /**
3557
+ * Return bulk quote information error
3558
+ * @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.
3559
+ */
4177
3560
  BulkQuotesErrorByID: {
4178
3561
  parameters: {
4179
- path: {
4180
- /** The identifier value. */
4181
- ID: components["parameters"]["ID"];
4182
- };
4183
3562
  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
3563
  "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
3564
  "Content-Type": components["parameters"]["Content-Type"];
4192
- /** The `Date` header field indicates the date when the request was sent. */
4193
3565
  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
3566
  "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
3567
  "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
3568
  "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
3569
  "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
3570
  "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
3571
  "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
3572
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
4212
3573
  };
3574
+ path: {
3575
+ ID: components["parameters"]["ID"];
3576
+ };
3577
+ };
3578
+ /** @description Details of the error returned. */
3579
+ requestBody: {
3580
+ content: {
3581
+ "application/json": components["schemas"]["ErrorInformationObject"];
3582
+ };
4213
3583
  };
4214
3584
  responses: {
4215
3585
  200: components["responses"]["200"];
@@ -4222,49 +3592,33 @@ export interface operations {
4222
3592
  501: components["responses"]["501"];
4223
3593
  503: components["responses"]["503"];
4224
3594
  };
4225
- /** Details of the error returned. */
4226
- requestBody: {
4227
- content: {
4228
- "application/json": components["schemas"]["ErrorInformationObject"];
4229
- };
4230
- };
4231
3595
  };
4232
- /** The HTTP request `POST /bulkTransfers` is used to request the creation of a bulk transfer in the server. */
3596
+ /**
3597
+ * Perform bulk transfer
3598
+ * @description The HTTP request `POST /bulkTransfers` is used to request the creation of a bulk transfer in the server.
3599
+ */
4233
3600
  BulkTransfers: {
4234
3601
  parameters: {
4235
3602
  header: {
4236
- /** The `Accept` header field indicates the version of the API the client would like the server to use. */
4237
3603
  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
3604
  "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
3605
  "Content-Type": components["parameters"]["Content-Type"];
4246
- /** The `Date` header field indicates the date when the request was sent. */
4247
3606
  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
3607
  "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
3608
  "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
3609
  "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
3610
  "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
3611
  "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
3612
  "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
3613
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
4266
3614
  };
4267
3615
  };
3616
+ /** @description Details of the bulk transfer to be created. */
3617
+ requestBody: {
3618
+ content: {
3619
+ "application/json": components["schemas"]["BulkTransfersPostRequest"];
3620
+ };
3621
+ };
4268
3622
  responses: {
4269
3623
  202: components["responses"]["202"];
4270
3624
  400: components["responses"]["400"];
@@ -4276,46 +3630,28 @@ export interface operations {
4276
3630
  501: components["responses"]["501"];
4277
3631
  503: components["responses"]["503"];
4278
3632
  };
4279
- /** Details of the bulk transfer to be created. */
4280
- requestBody: {
4281
- content: {
4282
- "application/json": components["schemas"]["BulkTransfersPostRequest"];
4283
- };
4284
- };
4285
3633
  };
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. */
3634
+ /**
3635
+ * Retrieve bulk transfer information
3636
+ * @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.
3637
+ */
4287
3638
  BulkTransferByID: {
4288
3639
  parameters: {
4289
- path: {
4290
- /** The identifier value. */
4291
- ID: components["parameters"]["ID"];
4292
- };
4293
3640
  header: {
4294
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
4295
3641
  "Content-Type": components["parameters"]["Content-Type"];
4296
- /** The `Date` header field indicates the date when the request was sent. */
4297
3642
  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
3643
  "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
3644
  "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
3645
  "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
3646
  "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
3647
  "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
3648
  "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
3649
  "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
3650
  Accept: components["parameters"]["Accept"];
4318
3651
  };
3652
+ path: {
3653
+ ID: components["parameters"]["ID"];
3654
+ };
4319
3655
  };
4320
3656
  responses: {
4321
3657
  202: components["responses"]["202"];
@@ -4329,43 +3665,33 @@ export interface operations {
4329
3665
  503: components["responses"]["503"];
4330
3666
  };
4331
3667
  };
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. */
3668
+ /**
3669
+ * Return bulk transfer information
3670
+ * @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.
3671
+ */
4333
3672
  BulkTransfersByIDPut: {
4334
3673
  parameters: {
4335
- path: {
4336
- /** The identifier value. */
4337
- ID: components["parameters"]["ID"];
4338
- };
4339
3674
  header: {
4340
- /** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
4341
3675
  "Content-Type": components["parameters"]["Content-Type"];
4342
- /** The `Date` header field indicates the date when the request was sent. */
4343
3676
  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
3677
  "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
3678
  "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
3679
  "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
3680
  "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
3681
  "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
3682
  "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
3683
  "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
3684
  "Content-Length"?: components["parameters"]["Content-Length"];
4368
3685
  };
3686
+ path: {
3687
+ ID: components["parameters"]["ID"];
3688
+ };
3689
+ };
3690
+ /** @description Bulk transfer information returned. */
3691
+ requestBody: {
3692
+ content: {
3693
+ "application/json": components["schemas"]["BulkTransfersIDPutResponse"];
3694
+ };
4369
3695
  };
4370
3696
  responses: {
4371
3697
  200: components["responses"]["200"];
@@ -4378,50 +3704,34 @@ export interface operations {
4378
3704
  501: components["responses"]["501"];
4379
3705
  503: components["responses"]["503"];
4380
3706
  };
4381
- /** Bulk transfer information returned. */
4382
- requestBody: {
4383
- content: {
4384
- "application/json": components["schemas"]["BulkTransfersIDPutResponse"];
4385
- };
4386
- };
4387
3707
  };
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. */
3708
+ /**
3709
+ * Return bulk transfer information error
3710
+ * @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.
3711
+ */
4389
3712
  BulkTransfersErrorByID: {
4390
3713
  parameters: {
4391
- path: {
4392
- /** The identifier value. */
4393
- ID: components["parameters"]["ID"];
4394
- };
4395
3714
  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
3715
  "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
3716
  "Content-Type": components["parameters"]["Content-Type"];
4404
- /** The `Date` header field indicates the date when the request was sent. */
4405
3717
  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
3718
  "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
3719
  "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
3720
  "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
3721
  "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
3722
  "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
3723
  "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
3724
  "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
4424
3725
  };
3726
+ path: {
3727
+ ID: components["parameters"]["ID"];
3728
+ };
3729
+ };
3730
+ /** @description Details of the error returned. */
3731
+ requestBody: {
3732
+ content: {
3733
+ "application/json": components["schemas"]["ErrorInformationObject"];
3734
+ };
4425
3735
  };
4426
3736
  responses: {
4427
3737
  200: components["responses"]["200"];
@@ -4434,13 +3744,5 @@ export interface operations {
4434
3744
  501: components["responses"]["501"];
4435
3745
  503: components["responses"]["503"];
4436
3746
  };
4437
- /** Details of the error returned. */
4438
- requestBody: {
4439
- content: {
4440
- "application/json": components["schemas"]["ErrorInformationObject"];
4441
- };
4442
- };
4443
3747
  };
4444
3748
  }
4445
- export interface external {
4446
- }