@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.
- package/CHANGELOG.md +21 -0
- package/audit-ci.jsonc +8 -0
- package/jest.config.js +2 -4
- package/lib/fspiop/v1_0/openapi.d.ts +792 -1490
- package/lib/fspiop/v1_1/openapi.d.ts +812 -1523
- package/lib/sdk-scheme-adapter/v2_0_0/backend/openapi.d.ts +190 -141
- package/lib/sdk-scheme-adapter/v2_0_0/backend/schemas.js +1 -1
- package/lib/sdk-scheme-adapter/v2_0_0/backend/schemas.js.map +1 -1
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/openapi.d.ts +219 -207
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/schemas.js +1 -1
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/schemas.js.map +1 -1
- package/lib/thirdparty/openapi.d.ts +656 -1454
- package/package.json +26 -36
@@ -4,300 +4,288 @@
|
|
4
4
|
*/
|
5
5
|
export interface paths {
|
6
6
|
"/interface": {
|
7
|
-
/** Essential path to include schema definitions that are not used so that these definitions get included into the openapi-cli bundle api definition so that they get converted into typescript definitions. */
|
7
|
+
/** @description Essential path to include schema definitions that are not used so that these definitions get included into the openapi-cli bundle api definition so that they get converted into typescript definitions. */
|
8
8
|
post: operations["test"];
|
9
9
|
};
|
10
10
|
"/participants/{Type}/{ID}": {
|
11
|
-
/**
|
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
|
-
/**
|
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
|
-
/**
|
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`). An ExtensionList element has been added to this reqeust in version v1.1
|
24
|
+
*/
|
16
25
|
post: operations["ParticipantsByIDAndType"];
|
17
26
|
/**
|
18
|
-
*
|
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 must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
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
|
-
/**
|
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
|
-
/**
|
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
|
-
/**
|
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
|
-
/**
|
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`). An ExtensionList element has been added to this reqeust in version v1.1
|
72
|
+
*/
|
66
73
|
post: operations["ParticipantsSubIdByTypeAndIDPost"];
|
67
74
|
/**
|
68
|
-
*
|
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 must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
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
|
-
/**
|
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
|
-
/**
|
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
|
-
/**
|
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
|
-
/**
|
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
|
-
/**
|
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
|
-
/**
|
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 must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
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
|
-
/**
|
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
|
-
/**
|
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
|
-
/**
|
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 must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
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
|
-
/**
|
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
|
-
/**
|
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
|
-
/**
|
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
|
-
/**
|
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 must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
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
|
-
/**
|
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
|
-
/**
|
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
|
-
/**
|
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
|
-
/**
|
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 must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
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
|
-
/**
|
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
|
-
*
|
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,218 +300,203 @@ export interface paths {
|
|
312
300
|
* `GET /authorization/3d492671-b7af-4f3f-88de-76169b1bdf88?authenticationType=OTP&retriesLeft=2&amount=102¤cy=USD`
|
313
301
|
*/
|
314
302
|
get: operations["AuthorizationsByIDGet"];
|
315
|
-
/**
|
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 must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
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
|
-
/**
|
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
|
-
/**
|
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
|
-
/**
|
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
|
-
/**
|
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
|
+
/**
|
351
|
+
* Return transfer information
|
352
|
+
* @description The HTTP request PATCH /transfers/<ID> is used by a Switch to update the state of a previously reserved transfer, if the Payee FSP has requested a commit notification when the Switch has completed processing of the transfer. The <ID> in the URI should contain the transferId that was used for the creation of the transfer. Please note that this request does not generate a callback.
|
353
|
+
*/
|
362
354
|
patch: operations["TransfersByIDPatch"];
|
363
355
|
parameters: {
|
364
|
-
path: {
|
365
|
-
/** The identifier value. */
|
366
|
-
ID: components["parameters"]["ID"];
|
367
|
-
};
|
368
356
|
header: {
|
369
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
370
357
|
"Content-Type": components["parameters"]["Content-Type"];
|
371
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
372
358
|
Date: components["parameters"]["Date"];
|
373
|
-
/**
|
374
|
-
* 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.
|
375
|
-
*
|
376
|
-
* **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`.
|
377
|
-
*/
|
378
359
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
379
|
-
/** 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`). */
|
380
360
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
381
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
382
361
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
383
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
384
362
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
385
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
386
363
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
387
|
-
/** 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). */
|
388
364
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
389
|
-
/** 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). */
|
390
365
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
391
366
|
};
|
367
|
+
path: {
|
368
|
+
ID: components["parameters"]["ID"];
|
369
|
+
};
|
392
370
|
};
|
393
371
|
};
|
394
372
|
"/transfers/{ID}/error": {
|
395
|
-
/**
|
373
|
+
/**
|
374
|
+
* Return transfer information error
|
375
|
+
* @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}`.
|
376
|
+
*/
|
396
377
|
put: operations["TransfersByIDAndError"];
|
397
378
|
};
|
398
379
|
"/transactions/{ID}": {
|
399
|
-
/**
|
380
|
+
/**
|
381
|
+
* Retrieve transaction information
|
382
|
+
* @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).
|
383
|
+
*/
|
400
384
|
get: operations["TransactionsByID"];
|
401
|
-
/**
|
385
|
+
/**
|
386
|
+
* Return transaction information
|
387
|
+
* @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.
|
388
|
+
*/
|
402
389
|
put: operations["TransactionsByID1"];
|
403
390
|
parameters: {
|
404
|
-
path: {
|
405
|
-
/** The identifier value. */
|
406
|
-
ID: components["parameters"]["ID"];
|
407
|
-
};
|
408
391
|
header: {
|
409
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
410
392
|
"Content-Type": components["parameters"]["Content-Type"];
|
411
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
412
393
|
Date: components["parameters"]["Date"];
|
413
|
-
/**
|
414
|
-
* 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.
|
415
|
-
*
|
416
|
-
* **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`.
|
417
|
-
*/
|
418
394
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
419
|
-
/** 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`). */
|
420
395
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
421
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
422
396
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
423
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
424
397
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
425
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
426
398
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
427
|
-
/** 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). */
|
428
399
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
429
|
-
/** 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). */
|
430
400
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
431
401
|
};
|
402
|
+
path: {
|
403
|
+
ID: components["parameters"]["ID"];
|
404
|
+
};
|
432
405
|
};
|
433
406
|
};
|
434
407
|
"/transactions/{ID}/error": {
|
435
|
-
/**
|
408
|
+
/**
|
409
|
+
* Return transaction information error
|
410
|
+
* @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.
|
411
|
+
*/
|
436
412
|
put: operations["TransactionsErrorByID"];
|
437
413
|
};
|
438
414
|
"/bulkQuotes": {
|
439
|
-
/**
|
415
|
+
/**
|
416
|
+
* Calculate bulk quote
|
417
|
+
* @description The HTTP request `POST /bulkQuotes` is used to request the creation of a bulk quote for the provided financial transactions in the server.
|
418
|
+
*/
|
440
419
|
post: operations["BulkQuotes"];
|
441
420
|
};
|
442
421
|
"/bulkQuotes/{ID}": {
|
443
|
-
/**
|
422
|
+
/**
|
423
|
+
* Retrieve bulk quote information
|
424
|
+
* @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.
|
425
|
+
*/
|
444
426
|
get: operations["BulkQuotesByID"];
|
445
|
-
/**
|
427
|
+
/**
|
428
|
+
* Return bulk quote information
|
429
|
+
* @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.
|
430
|
+
*/
|
446
431
|
put: operations["BulkQuotesByID1"];
|
447
432
|
parameters: {
|
448
|
-
path: {
|
449
|
-
/** The identifier value. */
|
450
|
-
ID: components["parameters"]["ID"];
|
451
|
-
};
|
452
433
|
header: {
|
453
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
454
434
|
"Content-Type": components["parameters"]["Content-Type"];
|
455
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
456
435
|
Date: components["parameters"]["Date"];
|
457
|
-
/**
|
458
|
-
* 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.
|
459
|
-
*
|
460
|
-
* **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`.
|
461
|
-
*/
|
462
436
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
463
|
-
/** 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`). */
|
464
437
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
465
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
466
438
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
467
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
468
439
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
469
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
470
440
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
471
|
-
/** 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). */
|
472
441
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
473
|
-
/** 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). */
|
474
442
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
475
443
|
};
|
444
|
+
path: {
|
445
|
+
ID: components["parameters"]["ID"];
|
446
|
+
};
|
476
447
|
};
|
477
448
|
};
|
478
449
|
"/bulkQuotes/{ID}/error": {
|
479
|
-
/**
|
450
|
+
/**
|
451
|
+
* Return bulk quote information error
|
452
|
+
* @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.
|
453
|
+
*/
|
480
454
|
put: operations["BulkQuotesErrorByID"];
|
481
455
|
};
|
482
456
|
"/bulkTransfers": {
|
483
|
-
/**
|
457
|
+
/**
|
458
|
+
* Perform bulk transfer
|
459
|
+
* @description The HTTP request `POST /bulkTransfers` is used to request the creation of a bulk transfer in the server.
|
460
|
+
*/
|
484
461
|
post: operations["BulkTransfers"];
|
485
462
|
};
|
486
463
|
"/bulkTransfers/{ID}": {
|
487
|
-
/**
|
464
|
+
/**
|
465
|
+
* Retrieve bulk transfer information
|
466
|
+
* @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.
|
467
|
+
*/
|
488
468
|
get: operations["BulkTransferByID"];
|
489
|
-
/**
|
469
|
+
/**
|
470
|
+
* Return bulk transfer information
|
471
|
+
* @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.
|
472
|
+
*/
|
490
473
|
put: operations["BulkTransfersByIDPut"];
|
491
474
|
parameters: {
|
492
|
-
path: {
|
493
|
-
/** The identifier value. */
|
494
|
-
ID: components["parameters"]["ID"];
|
495
|
-
};
|
496
475
|
header: {
|
497
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
498
476
|
"Content-Type": components["parameters"]["Content-Type"];
|
499
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
500
477
|
Date: components["parameters"]["Date"];
|
501
|
-
/**
|
502
|
-
* 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.
|
503
|
-
*
|
504
|
-
* **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`.
|
505
|
-
*/
|
506
478
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
507
|
-
/** 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`). */
|
508
479
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
509
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
510
480
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
511
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
512
481
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
513
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
514
482
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
515
|
-
/** 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). */
|
516
483
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
517
|
-
/** 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). */
|
518
484
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
519
485
|
};
|
486
|
+
path: {
|
487
|
+
ID: components["parameters"]["ID"];
|
488
|
+
};
|
520
489
|
};
|
521
490
|
};
|
522
491
|
"/bulkTransfers/{ID}/error": {
|
523
|
-
/**
|
492
|
+
/**
|
493
|
+
* Return bulk transfer information error
|
494
|
+
* @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.
|
495
|
+
*/
|
524
496
|
put: operations["BulkTransfersErrorByID"];
|
525
497
|
};
|
526
498
|
}
|
499
|
+
export type webhooks = Record<string, never>;
|
527
500
|
export interface components {
|
528
501
|
schemas: {
|
529
502
|
/** @description The API data type BinaryString is a JSON String. The string is a base64url encoding of a string of raw bytes, where padding (character ‘=’) is added at the end of the data if needed to ensure that the string is a multiple of 4 characters. The length restriction indicates the allowed number of characters. */
|
@@ -1061,7 +1034,7 @@ export interface components {
|
|
1061
1034
|
* AuthenticationValue
|
1062
1035
|
* @description Contains the authentication value. The format depends on the authentication type used in the AuthenticationInfo complex type.
|
1063
1036
|
*/
|
1064
|
-
AuthenticationValue:
|
1037
|
+
AuthenticationValue: components["schemas"]["OtpValue"] | components["schemas"]["QRCODE"] | components["schemas"]["U2FPinValue"];
|
1065
1038
|
/**
|
1066
1039
|
* AuthenticationInfo
|
1067
1040
|
* @description Data model for the complex type AuthenticationInfo.
|
@@ -1280,62 +1253,90 @@ export interface components {
|
|
1280
1253
|
};
|
1281
1254
|
};
|
1282
1255
|
responses: {
|
1283
|
-
/** OK */
|
1284
|
-
200:
|
1285
|
-
|
1286
|
-
|
1287
|
-
/**
|
1256
|
+
/** @description OK */
|
1257
|
+
200: {
|
1258
|
+
content: never;
|
1259
|
+
};
|
1260
|
+
/** @description Accepted */
|
1261
|
+
202: {
|
1262
|
+
content: never;
|
1263
|
+
};
|
1264
|
+
/** @description Bad Request */
|
1288
1265
|
400: {
|
1289
|
-
headers: {
|
1266
|
+
headers: {
|
1267
|
+
"Content-Length": components["headers"]["Content-Length"];
|
1268
|
+
"Content-Type": components["headers"]["Content-Type"];
|
1269
|
+
};
|
1290
1270
|
content: {
|
1291
1271
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
1292
1272
|
};
|
1293
1273
|
};
|
1294
|
-
/** Unauthorized */
|
1274
|
+
/** @description Unauthorized */
|
1295
1275
|
401: {
|
1296
|
-
headers: {
|
1276
|
+
headers: {
|
1277
|
+
"Content-Length": components["headers"]["Content-Length"];
|
1278
|
+
"Content-Type": components["headers"]["Content-Type"];
|
1279
|
+
};
|
1297
1280
|
content: {
|
1298
1281
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
1299
1282
|
};
|
1300
1283
|
};
|
1301
|
-
/** Forbidden */
|
1284
|
+
/** @description Forbidden */
|
1302
1285
|
403: {
|
1303
|
-
headers: {
|
1286
|
+
headers: {
|
1287
|
+
"Content-Length": components["headers"]["Content-Length"];
|
1288
|
+
"Content-Type": components["headers"]["Content-Type"];
|
1289
|
+
};
|
1304
1290
|
content: {
|
1305
1291
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
1306
1292
|
};
|
1307
1293
|
};
|
1308
|
-
/** Not Found */
|
1294
|
+
/** @description Not Found */
|
1309
1295
|
404: {
|
1310
|
-
headers: {
|
1296
|
+
headers: {
|
1297
|
+
"Content-Length": components["headers"]["Content-Length"];
|
1298
|
+
"Content-Type": components["headers"]["Content-Type"];
|
1299
|
+
};
|
1311
1300
|
content: {
|
1312
1301
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
1313
1302
|
};
|
1314
1303
|
};
|
1315
|
-
/** Method Not Allowed */
|
1304
|
+
/** @description Method Not Allowed */
|
1316
1305
|
405: {
|
1317
|
-
headers: {
|
1306
|
+
headers: {
|
1307
|
+
"Content-Length": components["headers"]["Content-Length"];
|
1308
|
+
"Content-Type": components["headers"]["Content-Type"];
|
1309
|
+
};
|
1318
1310
|
content: {
|
1319
1311
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
1320
1312
|
};
|
1321
1313
|
};
|
1322
|
-
/** Not Acceptable */
|
1314
|
+
/** @description Not Acceptable */
|
1323
1315
|
406: {
|
1324
|
-
headers: {
|
1316
|
+
headers: {
|
1317
|
+
"Content-Length": components["headers"]["Content-Length"];
|
1318
|
+
"Content-Type": components["headers"]["Content-Type"];
|
1319
|
+
};
|
1325
1320
|
content: {
|
1326
1321
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
1327
1322
|
};
|
1328
1323
|
};
|
1329
|
-
/** Not Implemented */
|
1324
|
+
/** @description Not Implemented */
|
1330
1325
|
501: {
|
1331
|
-
headers: {
|
1326
|
+
headers: {
|
1327
|
+
"Content-Length": components["headers"]["Content-Length"];
|
1328
|
+
"Content-Type": components["headers"]["Content-Type"];
|
1329
|
+
};
|
1332
1330
|
content: {
|
1333
1331
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
1334
1332
|
};
|
1335
1333
|
};
|
1336
|
-
/** Service Unavailable */
|
1334
|
+
/** @description Service Unavailable */
|
1337
1335
|
503: {
|
1338
|
-
headers: {
|
1336
|
+
headers: {
|
1337
|
+
"Content-Length": components["headers"]["Content-Length"];
|
1338
|
+
"Content-Type": components["headers"]["Content-Type"];
|
1339
|
+
};
|
1339
1340
|
content: {
|
1340
1341
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
1341
1342
|
};
|
@@ -1355,19 +1356,19 @@ export interface components {
|
|
1355
1356
|
*
|
1356
1357
|
* **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`.
|
1357
1358
|
*/
|
1358
|
-
"X-Forwarded-For"
|
1359
|
+
"X-Forwarded-For"?: string;
|
1359
1360
|
/** @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`). */
|
1360
1361
|
"FSPIOP-Source": string;
|
1361
1362
|
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
1362
|
-
"FSPIOP-Destination"
|
1363
|
+
"FSPIOP-Destination"?: string;
|
1363
1364
|
/** @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. */
|
1364
|
-
"FSPIOP-Encryption"
|
1365
|
+
"FSPIOP-Encryption"?: string;
|
1365
1366
|
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1366
|
-
"FSPIOP-Signature"
|
1367
|
+
"FSPIOP-Signature"?: string;
|
1367
1368
|
/** @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). */
|
1368
|
-
"FSPIOP-URI"
|
1369
|
+
"FSPIOP-URI"?: string;
|
1369
1370
|
/** @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). */
|
1370
|
-
"FSPIOP-HTTP-Method"
|
1371
|
+
"FSPIOP-HTTP-Method"?: string;
|
1371
1372
|
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
1372
1373
|
Accept: string;
|
1373
1374
|
/**
|
@@ -1375,69 +1376,62 @@ export interface components {
|
|
1375
1376
|
*
|
1376
1377
|
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
1377
1378
|
*/
|
1378
|
-
"Content-Length"
|
1379
|
+
"Content-Length"?: number;
|
1379
1380
|
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
1380
1381
|
SubId: string;
|
1381
1382
|
};
|
1383
|
+
requestBodies: never;
|
1382
1384
|
headers: {
|
1383
1385
|
/**
|
1384
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
1386
|
+
* @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
1385
1387
|
*
|
1386
1388
|
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
1387
1389
|
*/
|
1388
|
-
"Content-Length"
|
1389
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1390
|
+
"Content-Length": number;
|
1391
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1390
1392
|
"Content-Type": string;
|
1391
1393
|
};
|
1394
|
+
pathItems: never;
|
1392
1395
|
}
|
1396
|
+
export type $defs = Record<string, never>;
|
1397
|
+
export type external = Record<string, never>;
|
1393
1398
|
export interface operations {
|
1394
|
-
/** Essential path to include schema definitions that are not used so that these definitions get included into the openapi-cli bundle api definition so that they get converted into typescript definitions. */
|
1399
|
+
/** @description Essential path to include schema definitions that are not used so that these definitions get included into the openapi-cli bundle api definition so that they get converted into typescript definitions. */
|
1395
1400
|
test: {
|
1396
|
-
|
1397
|
-
/** Ok */
|
1398
|
-
200: unknown;
|
1399
|
-
};
|
1400
|
-
requestBody: {
|
1401
|
+
requestBody?: {
|
1401
1402
|
content: {
|
1402
1403
|
"application/json": components["schemas"]["BinaryString"] | components["schemas"]["BinaryString32"] | components["schemas"]["Date"] | components["schemas"]["Integer"] | components["schemas"]["Name"] | components["schemas"]["PersonalIdentifierType"] | components["schemas"]["TokenCode"] | components["schemas"]["Transaction"] | components["schemas"]["UndefinedEnum"];
|
1403
1404
|
};
|
1404
1405
|
};
|
1406
|
+
responses: {
|
1407
|
+
/** @description Ok */
|
1408
|
+
200: {
|
1409
|
+
content: never;
|
1410
|
+
};
|
1411
|
+
};
|
1405
1412
|
};
|
1406
|
-
/**
|
1413
|
+
/**
|
1414
|
+
* Look up participant information
|
1415
|
+
* @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.
|
1416
|
+
*/
|
1407
1417
|
ParticipantsByTypeAndID: {
|
1408
1418
|
parameters: {
|
1409
|
-
path: {
|
1410
|
-
/** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1411
|
-
Type: components["parameters"]["Type"];
|
1412
|
-
/** The identifier value. */
|
1413
|
-
ID: components["parameters"]["ID"];
|
1414
|
-
};
|
1415
1419
|
header: {
|
1416
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1417
1420
|
"Content-Type": components["parameters"]["Content-Type"];
|
1418
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
1419
1421
|
Date: components["parameters"]["Date"];
|
1420
|
-
/**
|
1421
|
-
* 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.
|
1422
|
-
*
|
1423
|
-
* **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`.
|
1424
|
-
*/
|
1425
1422
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
1426
|
-
/** 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`). */
|
1427
1423
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
1428
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
1429
1424
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
1430
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
1431
1425
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
1432
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1433
1426
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
1434
|
-
/** 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). */
|
1435
1427
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
1436
|
-
/** 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). */
|
1437
1428
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
1438
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
1439
1429
|
Accept: components["parameters"]["Accept"];
|
1440
1430
|
};
|
1431
|
+
path: {
|
1432
|
+
Type: components["parameters"]["Type"];
|
1433
|
+
ID: components["parameters"]["ID"];
|
1434
|
+
};
|
1441
1435
|
};
|
1442
1436
|
responses: {
|
1443
1437
|
202: components["responses"]["202"];
|
@@ -1451,45 +1445,34 @@ export interface operations {
|
|
1451
1445
|
503: components["responses"]["503"];
|
1452
1446
|
};
|
1453
1447
|
};
|
1454
|
-
/**
|
1448
|
+
/**
|
1449
|
+
* Return participant information
|
1450
|
+
* @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.
|
1451
|
+
*/
|
1455
1452
|
ParticipantsByTypeAndID3: {
|
1456
1453
|
parameters: {
|
1457
|
-
path: {
|
1458
|
-
/** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1459
|
-
Type: components["parameters"]["Type"];
|
1460
|
-
/** The identifier value. */
|
1461
|
-
ID: components["parameters"]["ID"];
|
1462
|
-
};
|
1463
1454
|
header: {
|
1464
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1465
1455
|
"Content-Type": components["parameters"]["Content-Type"];
|
1466
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
1467
1456
|
Date: components["parameters"]["Date"];
|
1468
|
-
/**
|
1469
|
-
* 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.
|
1470
|
-
*
|
1471
|
-
* **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`.
|
1472
|
-
*/
|
1473
1457
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
1474
|
-
/** 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`). */
|
1475
1458
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
1476
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
1477
1459
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
1478
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
1479
1460
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
1480
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1481
1461
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
1482
|
-
/** 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). */
|
1483
1462
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
1484
|
-
/** 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). */
|
1485
1463
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
1486
|
-
/**
|
1487
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
1488
|
-
*
|
1489
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
1490
|
-
*/
|
1491
1464
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
1492
1465
|
};
|
1466
|
+
path: {
|
1467
|
+
Type: components["parameters"]["Type"];
|
1468
|
+
ID: components["parameters"]["ID"];
|
1469
|
+
};
|
1470
|
+
};
|
1471
|
+
/** @description Participant information returned. */
|
1472
|
+
requestBody: {
|
1473
|
+
content: {
|
1474
|
+
"application/json": components["schemas"]["ParticipantsTypeIDPutResponse"];
|
1475
|
+
};
|
1493
1476
|
};
|
1494
1477
|
responses: {
|
1495
1478
|
200: components["responses"]["200"];
|
@@ -1502,54 +1485,36 @@ export interface operations {
|
|
1502
1485
|
501: components["responses"]["501"];
|
1503
1486
|
503: components["responses"]["503"];
|
1504
1487
|
};
|
1505
|
-
/** Participant information returned. */
|
1506
|
-
requestBody: {
|
1507
|
-
content: {
|
1508
|
-
"application/json": components["schemas"]["ParticipantsTypeIDPutResponse"];
|
1509
|
-
};
|
1510
|
-
};
|
1511
1488
|
};
|
1512
|
-
/**
|
1489
|
+
/**
|
1490
|
+
* Create participant information
|
1491
|
+
* @description The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). An ExtensionList element has been added to this reqeust in version v1.1
|
1492
|
+
*/
|
1513
1493
|
ParticipantsByIDAndType: {
|
1514
1494
|
parameters: {
|
1515
|
-
path: {
|
1516
|
-
/** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1517
|
-
Type: components["parameters"]["Type"];
|
1518
|
-
/** The identifier value. */
|
1519
|
-
ID: components["parameters"]["ID"];
|
1520
|
-
};
|
1521
1495
|
header: {
|
1522
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1523
1496
|
"Content-Type": components["parameters"]["Content-Type"];
|
1524
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
1525
1497
|
Date: components["parameters"]["Date"];
|
1526
|
-
/**
|
1527
|
-
* 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.
|
1528
|
-
*
|
1529
|
-
* **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`.
|
1530
|
-
*/
|
1531
1498
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
1532
|
-
/** 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`). */
|
1533
1499
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
1534
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
1535
1500
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
1536
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
1537
1501
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
1538
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1539
1502
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
1540
|
-
/** 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). */
|
1541
1503
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
1542
|
-
/** 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). */
|
1543
1504
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
1544
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
1545
1505
|
Accept: components["parameters"]["Accept"];
|
1546
|
-
/**
|
1547
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
1548
|
-
*
|
1549
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
1550
|
-
*/
|
1551
1506
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
1552
1507
|
};
|
1508
|
+
path: {
|
1509
|
+
Type: components["parameters"]["Type"];
|
1510
|
+
ID: components["parameters"]["ID"];
|
1511
|
+
};
|
1512
|
+
};
|
1513
|
+
/** @description Participant information to be created. */
|
1514
|
+
requestBody: {
|
1515
|
+
content: {
|
1516
|
+
"application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"];
|
1517
|
+
};
|
1553
1518
|
};
|
1554
1519
|
responses: {
|
1555
1520
|
202: components["responses"]["202"];
|
@@ -1562,52 +1527,31 @@ export interface operations {
|
|
1562
1527
|
501: components["responses"]["501"];
|
1563
1528
|
503: components["responses"]["503"];
|
1564
1529
|
};
|
1565
|
-
/** Participant information to be created. */
|
1566
|
-
requestBody: {
|
1567
|
-
content: {
|
1568
|
-
"application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"];
|
1569
|
-
};
|
1570
|
-
};
|
1571
1530
|
};
|
1572
1531
|
/**
|
1573
|
-
*
|
1532
|
+
* Delete participant information
|
1533
|
+
* @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.
|
1574
1534
|
*
|
1575
1535
|
* **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.
|
1576
1536
|
*/
|
1577
1537
|
ParticipantsByTypeAndID2: {
|
1578
1538
|
parameters: {
|
1579
|
-
path: {
|
1580
|
-
/** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1581
|
-
Type: components["parameters"]["Type"];
|
1582
|
-
/** The identifier value. */
|
1583
|
-
ID: components["parameters"]["ID"];
|
1584
|
-
};
|
1585
1539
|
header: {
|
1586
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1587
1540
|
"Content-Type": components["parameters"]["Content-Type"];
|
1588
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
1589
1541
|
Date: components["parameters"]["Date"];
|
1590
|
-
/**
|
1591
|
-
* 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.
|
1592
|
-
*
|
1593
|
-
* **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`.
|
1594
|
-
*/
|
1595
1542
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
1596
|
-
/** 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`). */
|
1597
1543
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
1598
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
1599
1544
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
1600
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
1601
1545
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
1602
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1603
1546
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
1604
|
-
/** 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). */
|
1605
1547
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
1606
|
-
/** 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). */
|
1607
1548
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
1608
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
1609
1549
|
Accept: components["parameters"]["Accept"];
|
1610
1550
|
};
|
1551
|
+
path: {
|
1552
|
+
Type: components["parameters"]["Type"];
|
1553
|
+
ID: components["parameters"]["ID"];
|
1554
|
+
};
|
1611
1555
|
};
|
1612
1556
|
responses: {
|
1613
1557
|
202: components["responses"]["202"];
|
@@ -1621,48 +1565,37 @@ export interface operations {
|
|
1621
1565
|
503: components["responses"]["503"];
|
1622
1566
|
};
|
1623
1567
|
};
|
1624
|
-
/**
|
1568
|
+
/**
|
1569
|
+
* Return participant information error
|
1570
|
+
* @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.
|
1571
|
+
*/
|
1625
1572
|
ParticipantsErrorByTypeAndID: {
|
1626
1573
|
parameters: {
|
1627
|
-
path: {
|
1628
|
-
/** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1629
|
-
Type: components["parameters"]["Type"];
|
1630
|
-
/** The identifier value. */
|
1631
|
-
ID: components["parameters"]["ID"];
|
1632
|
-
};
|
1633
1574
|
header: {
|
1634
|
-
/**
|
1635
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
1636
|
-
*
|
1637
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
1638
|
-
*/
|
1639
1575
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
1640
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1641
1576
|
"Content-Type": components["parameters"]["Content-Type"];
|
1642
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
1643
1577
|
Date: components["parameters"]["Date"];
|
1644
|
-
/**
|
1645
|
-
* 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.
|
1646
|
-
*
|
1647
|
-
* **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`.
|
1648
|
-
*/
|
1649
1578
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
1650
|
-
/** 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`). */
|
1651
1579
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
1652
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
1653
1580
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
1654
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
1655
1581
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
1656
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1657
1582
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
1658
|
-
/** 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). */
|
1659
1583
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
1660
|
-
/** 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). */
|
1661
1584
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
1662
1585
|
};
|
1586
|
+
path: {
|
1587
|
+
Type: components["parameters"]["Type"];
|
1588
|
+
ID: components["parameters"]["ID"];
|
1589
|
+
};
|
1663
1590
|
};
|
1664
|
-
|
1665
|
-
|
1591
|
+
/** @description Details of the error returned. */
|
1592
|
+
requestBody: {
|
1593
|
+
content: {
|
1594
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
1595
|
+
};
|
1596
|
+
};
|
1597
|
+
responses: {
|
1598
|
+
200: components["responses"]["200"];
|
1666
1599
|
400: components["responses"]["400"];
|
1667
1600
|
401: components["responses"]["401"];
|
1668
1601
|
403: components["responses"]["403"];
|
@@ -1672,50 +1605,30 @@ export interface operations {
|
|
1672
1605
|
501: components["responses"]["501"];
|
1673
1606
|
503: components["responses"]["503"];
|
1674
1607
|
};
|
1675
|
-
/** Details of the error returned. */
|
1676
|
-
requestBody: {
|
1677
|
-
content: {
|
1678
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
1679
|
-
};
|
1680
|
-
};
|
1681
1608
|
};
|
1682
|
-
/**
|
1609
|
+
/**
|
1610
|
+
* Look up participant information
|
1611
|
+
* @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.
|
1612
|
+
*/
|
1683
1613
|
ParticipantsSubIdByTypeAndID: {
|
1684
1614
|
parameters: {
|
1685
|
-
path: {
|
1686
|
-
/** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1687
|
-
Type: components["parameters"]["Type"];
|
1688
|
-
/** The identifier value. */
|
1689
|
-
ID: components["parameters"]["ID"];
|
1690
|
-
/** A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
1691
|
-
SubId: components["parameters"]["SubId"];
|
1692
|
-
};
|
1693
1615
|
header: {
|
1694
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1695
1616
|
"Content-Type": components["parameters"]["Content-Type"];
|
1696
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
1697
1617
|
Date: components["parameters"]["Date"];
|
1698
|
-
/**
|
1699
|
-
* 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.
|
1700
|
-
*
|
1701
|
-
* **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`.
|
1702
|
-
*/
|
1703
1618
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
1704
|
-
/** 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`). */
|
1705
1619
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
1706
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
1707
1620
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
1708
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
1709
1621
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
1710
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1711
1622
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
1712
|
-
/** 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). */
|
1713
1623
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
1714
|
-
/** 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). */
|
1715
1624
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
1716
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
1717
1625
|
Accept: components["parameters"]["Accept"];
|
1718
1626
|
};
|
1627
|
+
path: {
|
1628
|
+
Type: components["parameters"]["Type"];
|
1629
|
+
ID: components["parameters"]["ID"];
|
1630
|
+
SubId: components["parameters"]["SubId"];
|
1631
|
+
};
|
1719
1632
|
};
|
1720
1633
|
responses: {
|
1721
1634
|
202: components["responses"]["202"];
|
@@ -1729,47 +1642,35 @@ export interface operations {
|
|
1729
1642
|
503: components["responses"]["503"];
|
1730
1643
|
};
|
1731
1644
|
};
|
1732
|
-
/**
|
1645
|
+
/**
|
1646
|
+
* Return participant information
|
1647
|
+
* @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.
|
1648
|
+
*/
|
1733
1649
|
ParticipantsSubIdByTypeAndID3: {
|
1734
1650
|
parameters: {
|
1735
|
-
path: {
|
1736
|
-
/** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1737
|
-
Type: components["parameters"]["Type"];
|
1738
|
-
/** The identifier value. */
|
1739
|
-
ID: components["parameters"]["ID"];
|
1740
|
-
/** A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
1741
|
-
SubId: components["parameters"]["SubId"];
|
1742
|
-
};
|
1743
1651
|
header: {
|
1744
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1745
1652
|
"Content-Type": components["parameters"]["Content-Type"];
|
1746
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
1747
1653
|
Date: components["parameters"]["Date"];
|
1748
|
-
/**
|
1749
|
-
* 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.
|
1750
|
-
*
|
1751
|
-
* **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`.
|
1752
|
-
*/
|
1753
1654
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
1754
|
-
/** 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`). */
|
1755
1655
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
1756
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
1757
1656
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
1758
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
1759
1657
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
1760
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1761
1658
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
1762
|
-
/** 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). */
|
1763
1659
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
1764
|
-
/** 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). */
|
1765
1660
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
1766
|
-
/**
|
1767
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
1768
|
-
*
|
1769
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
1770
|
-
*/
|
1771
1661
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
1772
1662
|
};
|
1663
|
+
path: {
|
1664
|
+
Type: components["parameters"]["Type"];
|
1665
|
+
ID: components["parameters"]["ID"];
|
1666
|
+
SubId: components["parameters"]["SubId"];
|
1667
|
+
};
|
1668
|
+
};
|
1669
|
+
/** @description Participant information returned. */
|
1670
|
+
requestBody: {
|
1671
|
+
content: {
|
1672
|
+
"application/json": components["schemas"]["ParticipantsTypeIDPutResponse"];
|
1673
|
+
};
|
1773
1674
|
};
|
1774
1675
|
responses: {
|
1775
1676
|
200: components["responses"]["200"];
|
@@ -1782,56 +1683,37 @@ export interface operations {
|
|
1782
1683
|
501: components["responses"]["501"];
|
1783
1684
|
503: components["responses"]["503"];
|
1784
1685
|
};
|
1785
|
-
/** Participant information returned. */
|
1786
|
-
requestBody: {
|
1787
|
-
content: {
|
1788
|
-
"application/json": components["schemas"]["ParticipantsTypeIDPutResponse"];
|
1789
|
-
};
|
1790
|
-
};
|
1791
1686
|
};
|
1792
|
-
/**
|
1687
|
+
/**
|
1688
|
+
* Create participant information
|
1689
|
+
* @description The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). An ExtensionList element has been added to this reqeust in version v1.1
|
1690
|
+
*/
|
1793
1691
|
ParticipantsSubIdByTypeAndIDPost: {
|
1794
1692
|
parameters: {
|
1795
|
-
path: {
|
1796
|
-
/** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1797
|
-
Type: components["parameters"]["Type"];
|
1798
|
-
/** The identifier value. */
|
1799
|
-
ID: components["parameters"]["ID"];
|
1800
|
-
/** A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
1801
|
-
SubId: components["parameters"]["SubId"];
|
1802
|
-
};
|
1803
1693
|
header: {
|
1804
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1805
1694
|
"Content-Type": components["parameters"]["Content-Type"];
|
1806
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
1807
1695
|
Date: components["parameters"]["Date"];
|
1808
|
-
/**
|
1809
|
-
* 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.
|
1810
|
-
*
|
1811
|
-
* **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`.
|
1812
|
-
*/
|
1813
1696
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
1814
|
-
/** 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`). */
|
1815
1697
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
1816
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
1817
1698
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
1818
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
1819
1699
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
1820
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1821
1700
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
1822
|
-
/** 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). */
|
1823
1701
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
1824
|
-
/** 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). */
|
1825
1702
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
1826
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
1827
1703
|
Accept: components["parameters"]["Accept"];
|
1828
|
-
/**
|
1829
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
1830
|
-
*
|
1831
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
1832
|
-
*/
|
1833
1704
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
1834
1705
|
};
|
1706
|
+
path: {
|
1707
|
+
Type: components["parameters"]["Type"];
|
1708
|
+
ID: components["parameters"]["ID"];
|
1709
|
+
SubId: components["parameters"]["SubId"];
|
1710
|
+
};
|
1711
|
+
};
|
1712
|
+
/** @description Participant information to be created. */
|
1713
|
+
requestBody: {
|
1714
|
+
content: {
|
1715
|
+
"application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"];
|
1716
|
+
};
|
1835
1717
|
};
|
1836
1718
|
responses: {
|
1837
1719
|
202: components["responses"]["202"];
|
@@ -1844,54 +1726,32 @@ export interface operations {
|
|
1844
1726
|
501: components["responses"]["501"];
|
1845
1727
|
503: components["responses"]["503"];
|
1846
1728
|
};
|
1847
|
-
/** Participant information to be created. */
|
1848
|
-
requestBody: {
|
1849
|
-
content: {
|
1850
|
-
"application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"];
|
1851
|
-
};
|
1852
|
-
};
|
1853
1729
|
};
|
1854
1730
|
/**
|
1855
|
-
*
|
1731
|
+
* Delete participant information
|
1732
|
+
* @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.
|
1856
1733
|
*
|
1857
1734
|
* **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.
|
1858
1735
|
*/
|
1859
1736
|
ParticipantsSubIdByTypeAndID2: {
|
1860
1737
|
parameters: {
|
1861
|
-
path: {
|
1862
|
-
/** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1863
|
-
Type: components["parameters"]["Type"];
|
1864
|
-
/** The identifier value. */
|
1865
|
-
ID: components["parameters"]["ID"];
|
1866
|
-
/** A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
1867
|
-
SubId: components["parameters"]["SubId"];
|
1868
|
-
};
|
1869
1738
|
header: {
|
1870
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1871
1739
|
"Content-Type": components["parameters"]["Content-Type"];
|
1872
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
1873
1740
|
Date: components["parameters"]["Date"];
|
1874
|
-
/**
|
1875
|
-
* 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.
|
1876
|
-
*
|
1877
|
-
* **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`.
|
1878
|
-
*/
|
1879
1741
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
1880
|
-
/** 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`). */
|
1881
1742
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
1882
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
1883
1743
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
1884
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
1885
1744
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
1886
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1887
1745
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
1888
|
-
/** 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). */
|
1889
1746
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
1890
|
-
/** 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). */
|
1891
1747
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
1892
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
1893
1748
|
Accept: components["parameters"]["Accept"];
|
1894
1749
|
};
|
1750
|
+
path: {
|
1751
|
+
Type: components["parameters"]["Type"];
|
1752
|
+
ID: components["parameters"]["ID"];
|
1753
|
+
SubId: components["parameters"]["SubId"];
|
1754
|
+
};
|
1895
1755
|
};
|
1896
1756
|
responses: {
|
1897
1757
|
202: components["responses"]["202"];
|
@@ -1905,47 +1765,35 @@ export interface operations {
|
|
1905
1765
|
503: components["responses"]["503"];
|
1906
1766
|
};
|
1907
1767
|
};
|
1908
|
-
/**
|
1768
|
+
/**
|
1769
|
+
* Return participant information error
|
1770
|
+
* @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.
|
1771
|
+
*/
|
1909
1772
|
ParticipantsSubIdErrorByTypeAndID: {
|
1910
1773
|
parameters: {
|
1911
|
-
path: {
|
1912
|
-
/** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1913
|
-
Type: components["parameters"]["Type"];
|
1914
|
-
/** The identifier value. */
|
1915
|
-
ID: components["parameters"]["ID"];
|
1916
|
-
/** A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
1917
|
-
SubId: components["parameters"]["SubId"];
|
1918
|
-
};
|
1919
1774
|
header: {
|
1920
|
-
/**
|
1921
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
1922
|
-
*
|
1923
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
1924
|
-
*/
|
1925
1775
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
1926
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1927
1776
|
"Content-Type": components["parameters"]["Content-Type"];
|
1928
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
1929
1777
|
Date: components["parameters"]["Date"];
|
1930
|
-
/**
|
1931
|
-
* 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.
|
1932
|
-
*
|
1933
|
-
* **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`.
|
1934
|
-
*/
|
1935
1778
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
1936
|
-
/** 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`). */
|
1937
1779
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
1938
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
1939
1780
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
1940
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
1941
1781
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
1942
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1943
1782
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
1944
|
-
/** 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). */
|
1945
1783
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
1946
|
-
/** 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). */
|
1947
1784
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
1948
1785
|
};
|
1786
|
+
path: {
|
1787
|
+
Type: components["parameters"]["Type"];
|
1788
|
+
ID: components["parameters"]["ID"];
|
1789
|
+
SubId: components["parameters"]["SubId"];
|
1790
|
+
};
|
1791
|
+
};
|
1792
|
+
/** @description Details of the error returned. */
|
1793
|
+
requestBody: {
|
1794
|
+
content: {
|
1795
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
1796
|
+
};
|
1949
1797
|
};
|
1950
1798
|
responses: {
|
1951
1799
|
200: components["responses"]["200"];
|
@@ -1958,49 +1806,33 @@ export interface operations {
|
|
1958
1806
|
501: components["responses"]["501"];
|
1959
1807
|
503: components["responses"]["503"];
|
1960
1808
|
};
|
1961
|
-
/** Details of the error returned. */
|
1962
|
-
requestBody: {
|
1963
|
-
content: {
|
1964
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
1965
|
-
};
|
1966
|
-
};
|
1967
1809
|
};
|
1968
|
-
/**
|
1810
|
+
/**
|
1811
|
+
* Create bulk participant information
|
1812
|
+
* @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.
|
1813
|
+
*/
|
1969
1814
|
Participants1: {
|
1970
1815
|
parameters: {
|
1971
1816
|
header: {
|
1972
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
1973
1817
|
Accept: components["parameters"]["Accept"];
|
1974
|
-
/**
|
1975
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
1976
|
-
*
|
1977
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
1978
|
-
*/
|
1979
1818
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
1980
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1981
1819
|
"Content-Type": components["parameters"]["Content-Type"];
|
1982
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
1983
1820
|
Date: components["parameters"]["Date"];
|
1984
|
-
/**
|
1985
|
-
* 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.
|
1986
|
-
*
|
1987
|
-
* **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`.
|
1988
|
-
*/
|
1989
1821
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
1990
|
-
/** 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`). */
|
1991
1822
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
1992
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
1993
1823
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
1994
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
1995
1824
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
1996
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1997
1825
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
1998
|
-
/** 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). */
|
1999
1826
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2000
|
-
/** 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). */
|
2001
1827
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2002
1828
|
};
|
2003
1829
|
};
|
1830
|
+
/** @description Participant information to be created. */
|
1831
|
+
requestBody: {
|
1832
|
+
content: {
|
1833
|
+
"application/json": components["schemas"]["ParticipantsPostRequest"];
|
1834
|
+
};
|
1835
|
+
};
|
2004
1836
|
responses: {
|
2005
1837
|
202: components["responses"]["202"];
|
2006
1838
|
400: components["responses"]["400"];
|
@@ -2012,50 +1844,34 @@ export interface operations {
|
|
2012
1844
|
501: components["responses"]["501"];
|
2013
1845
|
503: components["responses"]["503"];
|
2014
1846
|
};
|
2015
|
-
/** Participant information to be created. */
|
2016
|
-
requestBody: {
|
2017
|
-
content: {
|
2018
|
-
"application/json": components["schemas"]["ParticipantsPostRequest"];
|
2019
|
-
};
|
2020
|
-
};
|
2021
1847
|
};
|
2022
|
-
/**
|
1848
|
+
/**
|
1849
|
+
* Return bulk participant information
|
1850
|
+
* @description The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities.
|
1851
|
+
*/
|
2023
1852
|
putParticipantsByID: {
|
2024
1853
|
parameters: {
|
2025
|
-
path: {
|
2026
|
-
/** The identifier value. */
|
2027
|
-
ID: components["parameters"]["ID"];
|
2028
|
-
};
|
2029
1854
|
header: {
|
2030
|
-
/**
|
2031
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2032
|
-
*
|
2033
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
2034
|
-
*/
|
2035
1855
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2036
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2037
1856
|
"Content-Type": components["parameters"]["Content-Type"];
|
2038
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2039
1857
|
Date: components["parameters"]["Date"];
|
2040
|
-
/**
|
2041
|
-
* 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.
|
2042
|
-
*
|
2043
|
-
* **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`.
|
2044
|
-
*/
|
2045
1858
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2046
|
-
/** 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`). */
|
2047
1859
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2048
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2049
1860
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2050
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2051
1861
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2052
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2053
1862
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2054
|
-
/** 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). */
|
2055
1863
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2056
|
-
/** 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). */
|
2057
1864
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2058
1865
|
};
|
1866
|
+
path: {
|
1867
|
+
ID: components["parameters"]["ID"];
|
1868
|
+
};
|
1869
|
+
};
|
1870
|
+
/** @description Participant information returned. */
|
1871
|
+
requestBody: {
|
1872
|
+
content: {
|
1873
|
+
"application/json": components["schemas"]["ParticipantsIDPutResponse"];
|
1874
|
+
};
|
2059
1875
|
};
|
2060
1876
|
responses: {
|
2061
1877
|
200: components["responses"]["200"];
|
@@ -2068,50 +1884,34 @@ export interface operations {
|
|
2068
1884
|
501: components["responses"]["501"];
|
2069
1885
|
503: components["responses"]["503"];
|
2070
1886
|
};
|
2071
|
-
/** Participant information returned. */
|
2072
|
-
requestBody: {
|
2073
|
-
content: {
|
2074
|
-
"application/json": components["schemas"]["ParticipantsIDPutResponse"];
|
2075
|
-
};
|
2076
|
-
};
|
2077
1887
|
};
|
2078
|
-
/**
|
1888
|
+
/**
|
1889
|
+
* Return bulk participant information error
|
1890
|
+
* @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.
|
1891
|
+
*/
|
2079
1892
|
ParticipantsByIDAndError: {
|
2080
1893
|
parameters: {
|
2081
|
-
path: {
|
2082
|
-
/** The identifier value. */
|
2083
|
-
ID: components["parameters"]["ID"];
|
2084
|
-
};
|
2085
1894
|
header: {
|
2086
|
-
/**
|
2087
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2088
|
-
*
|
2089
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
2090
|
-
*/
|
2091
1895
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2092
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2093
1896
|
"Content-Type": components["parameters"]["Content-Type"];
|
2094
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2095
1897
|
Date: components["parameters"]["Date"];
|
2096
|
-
/**
|
2097
|
-
* 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.
|
2098
|
-
*
|
2099
|
-
* **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`.
|
2100
|
-
*/
|
2101
1898
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2102
|
-
/** 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`). */
|
2103
1899
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2104
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2105
1900
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2106
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2107
1901
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2108
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2109
1902
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2110
|
-
/** 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). */
|
2111
1903
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2112
|
-
/** 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). */
|
2113
1904
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2114
1905
|
};
|
1906
|
+
path: {
|
1907
|
+
ID: components["parameters"]["ID"];
|
1908
|
+
};
|
1909
|
+
};
|
1910
|
+
/** @description Details of the error returned. */
|
1911
|
+
requestBody: {
|
1912
|
+
content: {
|
1913
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
1914
|
+
};
|
2115
1915
|
};
|
2116
1916
|
responses: {
|
2117
1917
|
200: components["responses"]["200"];
|
@@ -2124,48 +1924,29 @@ export interface operations {
|
|
2124
1924
|
501: components["responses"]["501"];
|
2125
1925
|
503: components["responses"]["503"];
|
2126
1926
|
};
|
2127
|
-
/** Details of the error returned. */
|
2128
|
-
requestBody: {
|
2129
|
-
content: {
|
2130
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
2131
|
-
};
|
2132
|
-
};
|
2133
1927
|
};
|
2134
|
-
/**
|
1928
|
+
/**
|
1929
|
+
* Look up party information
|
1930
|
+
* @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`).
|
1931
|
+
*/
|
2135
1932
|
PartiesByTypeAndID: {
|
2136
1933
|
parameters: {
|
2137
|
-
path: {
|
2138
|
-
/** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2139
|
-
Type: components["parameters"]["Type"];
|
2140
|
-
/** The identifier value. */
|
2141
|
-
ID: components["parameters"]["ID"];
|
2142
|
-
};
|
2143
1934
|
header: {
|
2144
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2145
1935
|
"Content-Type": components["parameters"]["Content-Type"];
|
2146
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2147
1936
|
Date: components["parameters"]["Date"];
|
2148
|
-
/**
|
2149
|
-
* 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.
|
2150
|
-
*
|
2151
|
-
* **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`.
|
2152
|
-
*/
|
2153
1937
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2154
|
-
/** 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`). */
|
2155
1938
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2156
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2157
1939
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2158
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2159
1940
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2160
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2161
1941
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2162
|
-
/** 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). */
|
2163
1942
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2164
|
-
/** 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). */
|
2165
1943
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2166
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2167
1944
|
Accept: components["parameters"]["Accept"];
|
2168
1945
|
};
|
1946
|
+
path: {
|
1947
|
+
Type: components["parameters"]["Type"];
|
1948
|
+
ID: components["parameters"]["ID"];
|
1949
|
+
};
|
2169
1950
|
};
|
2170
1951
|
responses: {
|
2171
1952
|
202: components["responses"]["202"];
|
@@ -2179,45 +1960,34 @@ export interface operations {
|
|
2179
1960
|
503: components["responses"]["503"];
|
2180
1961
|
};
|
2181
1962
|
};
|
2182
|
-
/**
|
1963
|
+
/**
|
1964
|
+
* Return party information
|
1965
|
+
* @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.
|
1966
|
+
*/
|
2183
1967
|
PartiesByTypeAndID2: {
|
2184
1968
|
parameters: {
|
2185
|
-
path: {
|
2186
|
-
/** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2187
|
-
Type: components["parameters"]["Type"];
|
2188
|
-
/** The identifier value. */
|
2189
|
-
ID: components["parameters"]["ID"];
|
2190
|
-
};
|
2191
1969
|
header: {
|
2192
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2193
1970
|
"Content-Type": components["parameters"]["Content-Type"];
|
2194
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2195
1971
|
Date: components["parameters"]["Date"];
|
2196
|
-
/**
|
2197
|
-
* 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.
|
2198
|
-
*
|
2199
|
-
* **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`.
|
2200
|
-
*/
|
2201
1972
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2202
|
-
/** 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`). */
|
2203
1973
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2204
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2205
1974
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2206
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2207
1975
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2208
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2209
1976
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2210
|
-
/** 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). */
|
2211
1977
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2212
|
-
/** 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). */
|
2213
1978
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2214
|
-
/**
|
2215
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2216
|
-
*
|
2217
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
2218
|
-
*/
|
2219
1979
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2220
1980
|
};
|
1981
|
+
path: {
|
1982
|
+
Type: components["parameters"]["Type"];
|
1983
|
+
ID: components["parameters"]["ID"];
|
1984
|
+
};
|
1985
|
+
};
|
1986
|
+
/** @description Party information returned. */
|
1987
|
+
requestBody: {
|
1988
|
+
content: {
|
1989
|
+
"application/json": components["schemas"]["PartiesTypeIDPutResponse"];
|
1990
|
+
};
|
2221
1991
|
};
|
2222
1992
|
responses: {
|
2223
1993
|
200: components["responses"]["200"];
|
@@ -2230,52 +2000,35 @@ export interface operations {
|
|
2230
2000
|
501: components["responses"]["501"];
|
2231
2001
|
503: components["responses"]["503"];
|
2232
2002
|
};
|
2233
|
-
/** Party information returned. */
|
2234
|
-
requestBody: {
|
2235
|
-
content: {
|
2236
|
-
"application/json": components["schemas"]["PartiesTypeIDPutResponse"];
|
2237
|
-
};
|
2238
|
-
};
|
2239
2003
|
};
|
2240
|
-
/**
|
2004
|
+
/**
|
2005
|
+
* Return party information error
|
2006
|
+
* @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.
|
2007
|
+
*/
|
2241
2008
|
PartiesErrorByTypeAndID: {
|
2242
2009
|
parameters: {
|
2243
|
-
path: {
|
2244
|
-
/** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2245
|
-
Type: components["parameters"]["Type"];
|
2246
|
-
/** The identifier value. */
|
2247
|
-
ID: components["parameters"]["ID"];
|
2248
|
-
};
|
2249
2010
|
header: {
|
2250
|
-
/**
|
2251
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2252
|
-
*
|
2253
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
2254
|
-
*/
|
2255
2011
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2256
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2257
2012
|
"Content-Type": components["parameters"]["Content-Type"];
|
2258
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2259
2013
|
Date: components["parameters"]["Date"];
|
2260
|
-
/**
|
2261
|
-
* 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.
|
2262
|
-
*
|
2263
|
-
* **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`.
|
2264
|
-
*/
|
2265
2014
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2266
|
-
/** 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`). */
|
2267
2015
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2268
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2269
2016
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2270
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2271
2017
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2272
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2273
2018
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2274
|
-
/** 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). */
|
2275
2019
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2276
|
-
/** 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). */
|
2277
2020
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2278
2021
|
};
|
2022
|
+
path: {
|
2023
|
+
Type: components["parameters"]["Type"];
|
2024
|
+
ID: components["parameters"]["ID"];
|
2025
|
+
};
|
2026
|
+
};
|
2027
|
+
/** @description Details of the error returned. */
|
2028
|
+
requestBody: {
|
2029
|
+
content: {
|
2030
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
2031
|
+
};
|
2279
2032
|
};
|
2280
2033
|
responses: {
|
2281
2034
|
200: components["responses"]["200"];
|
@@ -2288,50 +2041,30 @@ export interface operations {
|
|
2288
2041
|
501: components["responses"]["501"];
|
2289
2042
|
503: components["responses"]["503"];
|
2290
2043
|
};
|
2291
|
-
/** Details of the error returned. */
|
2292
|
-
requestBody: {
|
2293
|
-
content: {
|
2294
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
2295
|
-
};
|
2296
|
-
};
|
2297
2044
|
};
|
2298
|
-
/**
|
2045
|
+
/**
|
2046
|
+
* Look up party information
|
2047
|
+
* @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`).
|
2048
|
+
*/
|
2299
2049
|
PartiesSubIdByTypeAndID: {
|
2300
2050
|
parameters: {
|
2301
|
-
path: {
|
2302
|
-
/** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2303
|
-
Type: components["parameters"]["Type"];
|
2304
|
-
/** The identifier value. */
|
2305
|
-
ID: components["parameters"]["ID"];
|
2306
|
-
/** A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
2307
|
-
SubId: components["parameters"]["SubId"];
|
2308
|
-
};
|
2309
2051
|
header: {
|
2310
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2311
2052
|
"Content-Type": components["parameters"]["Content-Type"];
|
2312
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2313
2053
|
Date: components["parameters"]["Date"];
|
2314
|
-
/**
|
2315
|
-
* 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.
|
2316
|
-
*
|
2317
|
-
* **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`.
|
2318
|
-
*/
|
2319
2054
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2320
|
-
/** 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`). */
|
2321
2055
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2322
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2323
2056
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2324
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2325
2057
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2326
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2327
2058
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2328
|
-
/** 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). */
|
2329
2059
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2330
|
-
/** 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). */
|
2331
2060
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2332
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2333
2061
|
Accept: components["parameters"]["Accept"];
|
2334
2062
|
};
|
2063
|
+
path: {
|
2064
|
+
Type: components["parameters"]["Type"];
|
2065
|
+
ID: components["parameters"]["ID"];
|
2066
|
+
SubId: components["parameters"]["SubId"];
|
2067
|
+
};
|
2335
2068
|
};
|
2336
2069
|
responses: {
|
2337
2070
|
202: components["responses"]["202"];
|
@@ -2345,47 +2078,35 @@ export interface operations {
|
|
2345
2078
|
503: components["responses"]["503"];
|
2346
2079
|
};
|
2347
2080
|
};
|
2348
|
-
/**
|
2081
|
+
/**
|
2082
|
+
* Return party information
|
2083
|
+
* @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.
|
2084
|
+
*/
|
2349
2085
|
PartiesSubIdByTypeAndIDPut: {
|
2350
2086
|
parameters: {
|
2351
|
-
path: {
|
2352
|
-
/** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2353
|
-
Type: components["parameters"]["Type"];
|
2354
|
-
/** The identifier value. */
|
2355
|
-
ID: components["parameters"]["ID"];
|
2356
|
-
/** A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
2357
|
-
SubId: components["parameters"]["SubId"];
|
2358
|
-
};
|
2359
2087
|
header: {
|
2360
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2361
2088
|
"Content-Type": components["parameters"]["Content-Type"];
|
2362
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2363
2089
|
Date: components["parameters"]["Date"];
|
2364
|
-
/**
|
2365
|
-
* 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.
|
2366
|
-
*
|
2367
|
-
* **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`.
|
2368
|
-
*/
|
2369
2090
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2370
|
-
/** 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`). */
|
2371
2091
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2372
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2373
2092
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2374
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2375
2093
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2376
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2377
2094
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2378
|
-
/** 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). */
|
2379
2095
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2380
|
-
/** 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). */
|
2381
2096
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2382
|
-
/**
|
2383
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2384
|
-
*
|
2385
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
2386
|
-
*/
|
2387
2097
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2388
2098
|
};
|
2099
|
+
path: {
|
2100
|
+
Type: components["parameters"]["Type"];
|
2101
|
+
ID: components["parameters"]["ID"];
|
2102
|
+
SubId: components["parameters"]["SubId"];
|
2103
|
+
};
|
2104
|
+
};
|
2105
|
+
/** @description Party information returned. */
|
2106
|
+
requestBody: {
|
2107
|
+
content: {
|
2108
|
+
"application/json": components["schemas"]["PartiesTypeIDPutResponse"];
|
2109
|
+
};
|
2389
2110
|
};
|
2390
2111
|
responses: {
|
2391
2112
|
200: components["responses"]["200"];
|
@@ -2398,54 +2119,36 @@ export interface operations {
|
|
2398
2119
|
501: components["responses"]["501"];
|
2399
2120
|
503: components["responses"]["503"];
|
2400
2121
|
};
|
2401
|
-
/** Party information returned. */
|
2402
|
-
requestBody: {
|
2403
|
-
content: {
|
2404
|
-
"application/json": components["schemas"]["PartiesTypeIDPutResponse"];
|
2405
|
-
};
|
2406
|
-
};
|
2407
2122
|
};
|
2408
|
-
/**
|
2123
|
+
/**
|
2124
|
+
* Return party information error
|
2125
|
+
* @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.
|
2126
|
+
*/
|
2409
2127
|
PartiesSubIdErrorByTypeAndID: {
|
2410
2128
|
parameters: {
|
2411
|
-
path: {
|
2412
|
-
/** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2413
|
-
Type: components["parameters"]["Type"];
|
2414
|
-
/** The identifier value. */
|
2415
|
-
ID: components["parameters"]["ID"];
|
2416
|
-
/** A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
2417
|
-
SubId: components["parameters"]["SubId"];
|
2418
|
-
};
|
2419
2129
|
header: {
|
2420
|
-
/**
|
2421
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2422
|
-
*
|
2423
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
2424
|
-
*/
|
2425
2130
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2426
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2427
2131
|
"Content-Type": components["parameters"]["Content-Type"];
|
2428
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2429
2132
|
Date: components["parameters"]["Date"];
|
2430
|
-
/**
|
2431
|
-
* 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.
|
2432
|
-
*
|
2433
|
-
* **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`.
|
2434
|
-
*/
|
2435
2133
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2436
|
-
/** 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`). */
|
2437
2134
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2438
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2439
2135
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2440
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2441
2136
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2442
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2443
2137
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2444
|
-
/** 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). */
|
2445
2138
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2446
|
-
/** 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). */
|
2447
2139
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2448
2140
|
};
|
2141
|
+
path: {
|
2142
|
+
Type: components["parameters"]["Type"];
|
2143
|
+
ID: components["parameters"]["ID"];
|
2144
|
+
SubId: components["parameters"]["SubId"];
|
2145
|
+
};
|
2146
|
+
};
|
2147
|
+
/** @description Details of the error returned. */
|
2148
|
+
requestBody: {
|
2149
|
+
content: {
|
2150
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
2151
|
+
};
|
2449
2152
|
};
|
2450
2153
|
responses: {
|
2451
2154
|
200: components["responses"]["200"];
|
@@ -2458,49 +2161,33 @@ export interface operations {
|
|
2458
2161
|
501: components["responses"]["501"];
|
2459
2162
|
503: components["responses"]["503"];
|
2460
2163
|
};
|
2461
|
-
/** Details of the error returned. */
|
2462
|
-
requestBody: {
|
2463
|
-
content: {
|
2464
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
2465
|
-
};
|
2466
|
-
};
|
2467
2164
|
};
|
2468
|
-
/**
|
2165
|
+
/**
|
2166
|
+
* Perform transaction request
|
2167
|
+
* @description The HTTP request `POST /transactionRequests` is used to request the creation of a transaction request for the provided financial transaction in the server.
|
2168
|
+
*/
|
2469
2169
|
TransactionRequests: {
|
2470
2170
|
parameters: {
|
2471
2171
|
header: {
|
2472
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2473
2172
|
Accept: components["parameters"]["Accept"];
|
2474
|
-
/**
|
2475
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2476
|
-
*
|
2477
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
2478
|
-
*/
|
2479
2173
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2480
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2481
2174
|
"Content-Type": components["parameters"]["Content-Type"];
|
2482
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2483
2175
|
Date: components["parameters"]["Date"];
|
2484
|
-
/**
|
2485
|
-
* 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.
|
2486
|
-
*
|
2487
|
-
* **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`.
|
2488
|
-
*/
|
2489
2176
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2490
|
-
/** 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`). */
|
2491
2177
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2492
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2493
2178
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2494
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2495
2179
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2496
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2497
2180
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2498
|
-
/** 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). */
|
2499
2181
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2500
|
-
/** 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). */
|
2501
2182
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2502
2183
|
};
|
2503
2184
|
};
|
2185
|
+
/** @description Transaction request to be created. */
|
2186
|
+
requestBody: {
|
2187
|
+
content: {
|
2188
|
+
"application/json": components["schemas"]["TransactionRequestsPostRequest"];
|
2189
|
+
};
|
2190
|
+
};
|
2504
2191
|
responses: {
|
2505
2192
|
202: components["responses"]["202"];
|
2506
2193
|
400: components["responses"]["400"];
|
@@ -2512,46 +2199,28 @@ export interface operations {
|
|
2512
2199
|
501: components["responses"]["501"];
|
2513
2200
|
503: components["responses"]["503"];
|
2514
2201
|
};
|
2515
|
-
/** Transaction request to be created. */
|
2516
|
-
requestBody: {
|
2517
|
-
content: {
|
2518
|
-
"application/json": components["schemas"]["TransactionRequestsPostRequest"];
|
2519
|
-
};
|
2520
|
-
};
|
2521
2202
|
};
|
2522
|
-
/**
|
2203
|
+
/**
|
2204
|
+
* Retrieve transaction request information
|
2205
|
+
* @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.
|
2206
|
+
*/
|
2523
2207
|
TransactionRequestsByID: {
|
2524
2208
|
parameters: {
|
2525
|
-
path: {
|
2526
|
-
/** The identifier value. */
|
2527
|
-
ID: components["parameters"]["ID"];
|
2528
|
-
};
|
2529
2209
|
header: {
|
2530
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2531
2210
|
"Content-Type": components["parameters"]["Content-Type"];
|
2532
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2533
2211
|
Date: components["parameters"]["Date"];
|
2534
|
-
/**
|
2535
|
-
* 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.
|
2536
|
-
*
|
2537
|
-
* **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`.
|
2538
|
-
*/
|
2539
2212
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2540
|
-
/** 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`). */
|
2541
2213
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2542
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2543
2214
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2544
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2545
2215
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2546
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2547
2216
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2548
|
-
/** 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). */
|
2549
2217
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2550
|
-
/** 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). */
|
2551
2218
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2552
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2553
2219
|
Accept: components["parameters"]["Accept"];
|
2554
2220
|
};
|
2221
|
+
path: {
|
2222
|
+
ID: components["parameters"]["ID"];
|
2223
|
+
};
|
2555
2224
|
};
|
2556
2225
|
responses: {
|
2557
2226
|
202: components["responses"]["202"];
|
@@ -2565,43 +2234,33 @@ export interface operations {
|
|
2565
2234
|
503: components["responses"]["503"];
|
2566
2235
|
};
|
2567
2236
|
};
|
2568
|
-
/**
|
2237
|
+
/**
|
2238
|
+
* Return transaction request information
|
2239
|
+
* @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}`.
|
2240
|
+
*/
|
2569
2241
|
TransactionRequestsByIDPut: {
|
2570
2242
|
parameters: {
|
2571
|
-
path: {
|
2572
|
-
/** The identifier value. */
|
2573
|
-
ID: components["parameters"]["ID"];
|
2574
|
-
};
|
2575
2243
|
header: {
|
2576
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2577
2244
|
"Content-Type": components["parameters"]["Content-Type"];
|
2578
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2579
2245
|
Date: components["parameters"]["Date"];
|
2580
|
-
/**
|
2581
|
-
* 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.
|
2582
|
-
*
|
2583
|
-
* **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`.
|
2584
|
-
*/
|
2585
2246
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2586
|
-
/** 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`). */
|
2587
2247
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2588
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2589
2248
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2590
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2591
2249
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2592
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2593
2250
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2594
|
-
/** 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). */
|
2595
2251
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2596
|
-
/** 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). */
|
2597
2252
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2598
|
-
/**
|
2599
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2600
|
-
*
|
2601
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
2602
|
-
*/
|
2603
2253
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2604
2254
|
};
|
2255
|
+
path: {
|
2256
|
+
ID: components["parameters"]["ID"];
|
2257
|
+
};
|
2258
|
+
};
|
2259
|
+
/** @description Transaction request information returned. */
|
2260
|
+
requestBody: {
|
2261
|
+
content: {
|
2262
|
+
"application/json": components["schemas"]["TransactionRequestsIDPutResponse"];
|
2263
|
+
};
|
2605
2264
|
};
|
2606
2265
|
responses: {
|
2607
2266
|
200: components["responses"]["200"];
|
@@ -2614,50 +2273,34 @@ export interface operations {
|
|
2614
2273
|
501: components["responses"]["501"];
|
2615
2274
|
503: components["responses"]["503"];
|
2616
2275
|
};
|
2617
|
-
/** Transaction request information returned. */
|
2618
|
-
requestBody: {
|
2619
|
-
content: {
|
2620
|
-
"application/json": components["schemas"]["TransactionRequestsIDPutResponse"];
|
2621
|
-
};
|
2622
|
-
};
|
2623
2276
|
};
|
2624
|
-
/**
|
2277
|
+
/**
|
2278
|
+
* Return transaction request information error
|
2279
|
+
* @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}`.
|
2280
|
+
*/
|
2625
2281
|
TransactionRequestsErrorByID: {
|
2626
2282
|
parameters: {
|
2627
|
-
path: {
|
2628
|
-
/** The identifier value. */
|
2629
|
-
ID: components["parameters"]["ID"];
|
2630
|
-
};
|
2631
2283
|
header: {
|
2632
|
-
/**
|
2633
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2634
|
-
*
|
2635
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
2636
|
-
*/
|
2637
2284
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2638
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2639
2285
|
"Content-Type": components["parameters"]["Content-Type"];
|
2640
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2641
2286
|
Date: components["parameters"]["Date"];
|
2642
|
-
/**
|
2643
|
-
* 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.
|
2644
|
-
*
|
2645
|
-
* **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`.
|
2646
|
-
*/
|
2647
2287
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2648
|
-
/** 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`). */
|
2649
2288
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2650
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2651
2289
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2652
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2653
2290
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2654
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2655
2291
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2656
|
-
/** 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). */
|
2657
2292
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2658
|
-
/** 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). */
|
2659
2293
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2660
2294
|
};
|
2295
|
+
path: {
|
2296
|
+
ID: components["parameters"]["ID"];
|
2297
|
+
};
|
2298
|
+
};
|
2299
|
+
/** @description Details of the error returned. */
|
2300
|
+
requestBody: {
|
2301
|
+
content: {
|
2302
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
2303
|
+
};
|
2661
2304
|
};
|
2662
2305
|
responses: {
|
2663
2306
|
200: components["responses"]["200"];
|
@@ -2670,49 +2313,33 @@ export interface operations {
|
|
2670
2313
|
501: components["responses"]["501"];
|
2671
2314
|
503: components["responses"]["503"];
|
2672
2315
|
};
|
2673
|
-
/** Details of the error returned. */
|
2674
|
-
requestBody: {
|
2675
|
-
content: {
|
2676
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
2677
|
-
};
|
2678
|
-
};
|
2679
2316
|
};
|
2680
|
-
/**
|
2317
|
+
/**
|
2318
|
+
* Calculate quote
|
2319
|
+
* @description The HTTP request `POST /quotes` is used to request the creation of a quote for the provided financial transaction in the server.
|
2320
|
+
*/
|
2681
2321
|
Quotes: {
|
2682
2322
|
parameters: {
|
2683
2323
|
header: {
|
2684
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2685
2324
|
Accept: components["parameters"]["Accept"];
|
2686
|
-
/**
|
2687
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2688
|
-
*
|
2689
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
2690
|
-
*/
|
2691
2325
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2692
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2693
2326
|
"Content-Type": components["parameters"]["Content-Type"];
|
2694
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2695
2327
|
Date: components["parameters"]["Date"];
|
2696
|
-
/**
|
2697
|
-
* 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.
|
2698
|
-
*
|
2699
|
-
* **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`.
|
2700
|
-
*/
|
2701
2328
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2702
|
-
/** 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`). */
|
2703
2329
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2704
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2705
2330
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2706
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2707
2331
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2708
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2709
2332
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2710
|
-
/** 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). */
|
2711
2333
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2712
|
-
/** 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). */
|
2713
2334
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2714
2335
|
};
|
2715
2336
|
};
|
2337
|
+
/** @description Details of the quote to be created. */
|
2338
|
+
requestBody: {
|
2339
|
+
content: {
|
2340
|
+
"application/json": components["schemas"]["QuotesPostRequest"];
|
2341
|
+
};
|
2342
|
+
};
|
2716
2343
|
responses: {
|
2717
2344
|
202: components["responses"]["202"];
|
2718
2345
|
400: components["responses"]["400"];
|
@@ -2724,46 +2351,28 @@ export interface operations {
|
|
2724
2351
|
501: components["responses"]["501"];
|
2725
2352
|
503: components["responses"]["503"];
|
2726
2353
|
};
|
2727
|
-
/** Details of the quote to be created. */
|
2728
|
-
requestBody: {
|
2729
|
-
content: {
|
2730
|
-
"application/json": components["schemas"]["QuotesPostRequest"];
|
2731
|
-
};
|
2732
|
-
};
|
2733
2354
|
};
|
2734
|
-
/**
|
2355
|
+
/**
|
2356
|
+
* Retrieve quote information
|
2357
|
+
* @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.
|
2358
|
+
*/
|
2735
2359
|
QuotesByID: {
|
2736
2360
|
parameters: {
|
2737
|
-
path: {
|
2738
|
-
/** The identifier value. */
|
2739
|
-
ID: components["parameters"]["ID"];
|
2740
|
-
};
|
2741
2361
|
header: {
|
2742
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2743
2362
|
"Content-Type": components["parameters"]["Content-Type"];
|
2744
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2745
2363
|
Date: components["parameters"]["Date"];
|
2746
|
-
/**
|
2747
|
-
* 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.
|
2748
|
-
*
|
2749
|
-
* **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`.
|
2750
|
-
*/
|
2751
2364
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2752
|
-
/** 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`). */
|
2753
2365
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2754
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2755
2366
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2756
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2757
2367
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2758
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2759
2368
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2760
|
-
/** 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). */
|
2761
2369
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2762
|
-
/** 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). */
|
2763
2370
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2764
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2765
2371
|
Accept: components["parameters"]["Accept"];
|
2766
2372
|
};
|
2373
|
+
path: {
|
2374
|
+
ID: components["parameters"]["ID"];
|
2375
|
+
};
|
2767
2376
|
};
|
2768
2377
|
responses: {
|
2769
2378
|
202: components["responses"]["202"];
|
@@ -2777,43 +2386,33 @@ export interface operations {
|
|
2777
2386
|
503: components["responses"]["503"];
|
2778
2387
|
};
|
2779
2388
|
};
|
2780
|
-
/**
|
2389
|
+
/**
|
2390
|
+
* Return quote information
|
2391
|
+
* @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.
|
2392
|
+
*/
|
2781
2393
|
QuotesByID1: {
|
2782
2394
|
parameters: {
|
2783
|
-
path: {
|
2784
|
-
/** The identifier value. */
|
2785
|
-
ID: components["parameters"]["ID"];
|
2786
|
-
};
|
2787
2395
|
header: {
|
2788
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2789
2396
|
"Content-Type": components["parameters"]["Content-Type"];
|
2790
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2791
2397
|
Date: components["parameters"]["Date"];
|
2792
|
-
/**
|
2793
|
-
* 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.
|
2794
|
-
*
|
2795
|
-
* **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`.
|
2796
|
-
*/
|
2797
2398
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2798
|
-
/** 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`). */
|
2799
2399
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2800
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2801
2400
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2802
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2803
2401
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2804
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2805
2402
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2806
|
-
/** 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). */
|
2807
2403
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2808
|
-
/** 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). */
|
2809
2404
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2810
|
-
/**
|
2811
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2812
|
-
*
|
2813
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
2814
|
-
*/
|
2815
2405
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2816
2406
|
};
|
2407
|
+
path: {
|
2408
|
+
ID: components["parameters"]["ID"];
|
2409
|
+
};
|
2410
|
+
};
|
2411
|
+
/** @description Quote information returned. */
|
2412
|
+
requestBody: {
|
2413
|
+
content: {
|
2414
|
+
"application/json": components["schemas"]["QuotesIDPutResponse"];
|
2415
|
+
};
|
2817
2416
|
};
|
2818
2417
|
responses: {
|
2819
2418
|
200: components["responses"]["200"];
|
@@ -2826,50 +2425,34 @@ export interface operations {
|
|
2826
2425
|
501: components["responses"]["501"];
|
2827
2426
|
503: components["responses"]["503"];
|
2828
2427
|
};
|
2829
|
-
/** Quote information returned. */
|
2830
|
-
requestBody: {
|
2831
|
-
content: {
|
2832
|
-
"application/json": components["schemas"]["QuotesIDPutResponse"];
|
2833
|
-
};
|
2834
|
-
};
|
2835
2428
|
};
|
2836
|
-
/**
|
2429
|
+
/**
|
2430
|
+
* Return quote information error
|
2431
|
+
* @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.
|
2432
|
+
*/
|
2837
2433
|
QuotesByIDAndError: {
|
2838
2434
|
parameters: {
|
2839
|
-
path: {
|
2840
|
-
/** The identifier value. */
|
2841
|
-
ID: components["parameters"]["ID"];
|
2842
|
-
};
|
2843
2435
|
header: {
|
2844
|
-
/**
|
2845
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2846
|
-
*
|
2847
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
2848
|
-
*/
|
2849
2436
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2850
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2851
2437
|
"Content-Type": components["parameters"]["Content-Type"];
|
2852
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2853
2438
|
Date: components["parameters"]["Date"];
|
2854
|
-
/**
|
2855
|
-
* 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.
|
2856
|
-
*
|
2857
|
-
* **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`.
|
2858
|
-
*/
|
2859
2439
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2860
|
-
/** 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`). */
|
2861
2440
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2862
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2863
2441
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2864
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2865
2442
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2866
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2867
2443
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2868
|
-
/** 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). */
|
2869
2444
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2870
|
-
/** 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). */
|
2871
2445
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2872
2446
|
};
|
2447
|
+
path: {
|
2448
|
+
ID: components["parameters"]["ID"];
|
2449
|
+
};
|
2450
|
+
};
|
2451
|
+
/** @description Details of the error returned. */
|
2452
|
+
requestBody: {
|
2453
|
+
content: {
|
2454
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
2455
|
+
};
|
2873
2456
|
};
|
2874
2457
|
responses: {
|
2875
2458
|
200: components["responses"]["200"];
|
@@ -2882,15 +2465,10 @@ export interface operations {
|
|
2882
2465
|
501: components["responses"]["501"];
|
2883
2466
|
503: components["responses"]["503"];
|
2884
2467
|
};
|
2885
|
-
/** Details of the error returned. */
|
2886
|
-
requestBody: {
|
2887
|
-
content: {
|
2888
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
2889
|
-
};
|
2890
|
-
};
|
2891
2468
|
};
|
2892
2469
|
/**
|
2893
|
-
*
|
2470
|
+
* Perform authorization
|
2471
|
+
* @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*:*
|
2894
2472
|
*
|
2895
2473
|
* - `authenticationType={Type}`, where `{Type}` value is a valid authentication type from the enumeration `AuthenticationType`.
|
2896
2474
|
*
|
@@ -2906,36 +2484,21 @@ export interface operations {
|
|
2906
2484
|
*/
|
2907
2485
|
AuthorizationsByIDGet: {
|
2908
2486
|
parameters: {
|
2909
|
-
path: {
|
2910
|
-
/** The identifier value. */
|
2911
|
-
ID: components["parameters"]["ID"];
|
2912
|
-
};
|
2913
2487
|
header: {
|
2914
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2915
2488
|
"Content-Type": components["parameters"]["Content-Type"];
|
2916
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2917
2489
|
Date: components["parameters"]["Date"];
|
2918
|
-
/**
|
2919
|
-
* 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.
|
2920
|
-
*
|
2921
|
-
* **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`.
|
2922
|
-
*/
|
2923
2490
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2924
|
-
/** 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`). */
|
2925
2491
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2926
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2927
2492
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2928
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2929
2493
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2930
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2931
2494
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2932
|
-
/** 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). */
|
2933
2495
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2934
|
-
/** 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). */
|
2935
2496
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2936
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2937
2497
|
Accept: components["parameters"]["Accept"];
|
2938
2498
|
};
|
2499
|
+
path: {
|
2500
|
+
ID: components["parameters"]["ID"];
|
2501
|
+
};
|
2939
2502
|
};
|
2940
2503
|
responses: {
|
2941
2504
|
202: components["responses"]["202"];
|
@@ -2949,43 +2512,33 @@ export interface operations {
|
|
2949
2512
|
503: components["responses"]["503"];
|
2950
2513
|
};
|
2951
2514
|
};
|
2952
|
-
/**
|
2515
|
+
/**
|
2516
|
+
* Return authorization result
|
2517
|
+
* @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.
|
2518
|
+
*/
|
2953
2519
|
AuthorizationsByIDPut: {
|
2954
2520
|
parameters: {
|
2955
|
-
path: {
|
2956
|
-
/** The identifier value. */
|
2957
|
-
ID: components["parameters"]["ID"];
|
2958
|
-
};
|
2959
2521
|
header: {
|
2960
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2961
2522
|
"Content-Type": components["parameters"]["Content-Type"];
|
2962
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2963
2523
|
Date: components["parameters"]["Date"];
|
2964
|
-
/**
|
2965
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
2966
|
-
*
|
2967
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
2968
|
-
*/
|
2969
2524
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2970
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2971
2525
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2972
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2973
2526
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2974
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2975
2527
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2976
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2977
2528
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2978
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
2979
2529
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2980
|
-
/** The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
2981
2530
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2982
|
-
/**
|
2983
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2984
|
-
*
|
2985
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
2986
|
-
*/
|
2987
2531
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2988
2532
|
};
|
2533
|
+
path: {
|
2534
|
+
ID: components["parameters"]["ID"];
|
2535
|
+
};
|
2536
|
+
};
|
2537
|
+
/** @description Authorization result returned. */
|
2538
|
+
requestBody: {
|
2539
|
+
content: {
|
2540
|
+
"application/json": components["schemas"]["AuthorizationsIDPutResponse"];
|
2541
|
+
};
|
2989
2542
|
};
|
2990
2543
|
responses: {
|
2991
2544
|
200: components["responses"]["200"];
|
@@ -2998,50 +2551,34 @@ export interface operations {
|
|
2998
2551
|
501: components["responses"]["501"];
|
2999
2552
|
503: components["responses"]["503"];
|
3000
2553
|
};
|
3001
|
-
/** Authorization result returned. */
|
3002
|
-
requestBody: {
|
3003
|
-
content: {
|
3004
|
-
"application/json": components["schemas"]["AuthorizationsIDPutResponse"];
|
3005
|
-
};
|
3006
|
-
};
|
3007
2554
|
};
|
3008
|
-
/**
|
2555
|
+
/**
|
2556
|
+
* Return authorization error
|
2557
|
+
* @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}`.
|
2558
|
+
*/
|
3009
2559
|
AuthorizationsByIDAndError: {
|
3010
2560
|
parameters: {
|
3011
|
-
path: {
|
3012
|
-
/** The identifier value. */
|
3013
|
-
ID: components["parameters"]["ID"];
|
3014
|
-
};
|
3015
2561
|
header: {
|
3016
|
-
/**
|
3017
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3018
|
-
*
|
3019
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
3020
|
-
*/
|
3021
2562
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3022
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3023
2563
|
"Content-Type": components["parameters"]["Content-Type"];
|
3024
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3025
2564
|
Date: components["parameters"]["Date"];
|
3026
|
-
/**
|
3027
|
-
* 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.
|
3028
|
-
*
|
3029
|
-
* **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`.
|
3030
|
-
*/
|
3031
2565
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3032
|
-
/** 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`). */
|
3033
2566
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3034
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3035
2567
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3036
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3037
2568
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3038
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3039
2569
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3040
|
-
/** 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). */
|
3041
2570
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3042
|
-
/** 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). */
|
3043
2571
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3044
2572
|
};
|
2573
|
+
path: {
|
2574
|
+
ID: components["parameters"]["ID"];
|
2575
|
+
};
|
2576
|
+
};
|
2577
|
+
/** @description Details of the error returned. */
|
2578
|
+
requestBody: {
|
2579
|
+
content: {
|
2580
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
2581
|
+
};
|
3045
2582
|
};
|
3046
2583
|
responses: {
|
3047
2584
|
200: components["responses"]["200"];
|
@@ -3054,49 +2591,33 @@ export interface operations {
|
|
3054
2591
|
501: components["responses"]["501"];
|
3055
2592
|
503: components["responses"]["503"];
|
3056
2593
|
};
|
3057
|
-
/** Details of the error returned. */
|
3058
|
-
requestBody: {
|
3059
|
-
content: {
|
3060
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
3061
|
-
};
|
3062
|
-
};
|
3063
2594
|
};
|
3064
|
-
/**
|
2595
|
+
/**
|
2596
|
+
* Perform transfer
|
2597
|
+
* @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.
|
2598
|
+
*/
|
3065
2599
|
transfers: {
|
3066
2600
|
parameters: {
|
3067
2601
|
header: {
|
3068
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3069
2602
|
Accept: components["parameters"]["Accept"];
|
3070
|
-
/**
|
3071
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3072
|
-
*
|
3073
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
3074
|
-
*/
|
3075
2603
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3076
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3077
2604
|
"Content-Type": components["parameters"]["Content-Type"];
|
3078
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3079
2605
|
Date: components["parameters"]["Date"];
|
3080
|
-
/**
|
3081
|
-
* 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.
|
3082
|
-
*
|
3083
|
-
* **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`.
|
3084
|
-
*/
|
3085
2606
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3086
|
-
/** 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`). */
|
3087
2607
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3088
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3089
2608
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3090
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3091
2609
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3092
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3093
2610
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3094
|
-
/** 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). */
|
3095
2611
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3096
|
-
/** 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). */
|
3097
2612
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3098
2613
|
};
|
3099
2614
|
};
|
2615
|
+
/** @description Details of the transfer to be created. */
|
2616
|
+
requestBody: {
|
2617
|
+
content: {
|
2618
|
+
"application/json": components["schemas"]["TransfersPostRequest"];
|
2619
|
+
};
|
2620
|
+
};
|
3100
2621
|
responses: {
|
3101
2622
|
202: components["responses"]["202"];
|
3102
2623
|
400: components["responses"]["400"];
|
@@ -3108,46 +2629,28 @@ export interface operations {
|
|
3108
2629
|
501: components["responses"]["501"];
|
3109
2630
|
503: components["responses"]["503"];
|
3110
2631
|
};
|
3111
|
-
/** Details of the transfer to be created. */
|
3112
|
-
requestBody: {
|
3113
|
-
content: {
|
3114
|
-
"application/json": components["schemas"]["TransfersPostRequest"];
|
3115
|
-
};
|
3116
|
-
};
|
3117
2632
|
};
|
3118
|
-
/**
|
2633
|
+
/**
|
2634
|
+
* Retrieve transfer information
|
2635
|
+
* @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.
|
2636
|
+
*/
|
3119
2637
|
TransfersByIDGet: {
|
3120
2638
|
parameters: {
|
3121
|
-
path: {
|
3122
|
-
/** The identifier value. */
|
3123
|
-
ID: components["parameters"]["ID"];
|
3124
|
-
};
|
3125
2639
|
header: {
|
3126
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3127
2640
|
"Content-Type": components["parameters"]["Content-Type"];
|
3128
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3129
2641
|
Date: components["parameters"]["Date"];
|
3130
|
-
/**
|
3131
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3132
|
-
*
|
3133
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
3134
|
-
*/
|
3135
2642
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3136
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3137
2643
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3138
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3139
2644
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3140
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3141
2645
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3142
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3143
2646
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3144
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
3145
2647
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3146
|
-
/** The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
3147
2648
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3148
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3149
2649
|
Accept: components["parameters"]["Accept"];
|
3150
2650
|
};
|
2651
|
+
path: {
|
2652
|
+
ID: components["parameters"]["ID"];
|
2653
|
+
};
|
3151
2654
|
};
|
3152
2655
|
responses: {
|
3153
2656
|
202: components["responses"]["202"];
|
@@ -3161,43 +2664,33 @@ export interface operations {
|
|
3161
2664
|
503: components["responses"]["503"];
|
3162
2665
|
};
|
3163
2666
|
};
|
3164
|
-
/**
|
2667
|
+
/**
|
2668
|
+
* Return transfer information
|
2669
|
+
* @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.
|
2670
|
+
*/
|
3165
2671
|
TransfersByIDPut: {
|
3166
2672
|
parameters: {
|
3167
|
-
path: {
|
3168
|
-
/** The identifier value. */
|
3169
|
-
ID: components["parameters"]["ID"];
|
3170
|
-
};
|
3171
2673
|
header: {
|
3172
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3173
2674
|
"Content-Type": components["parameters"]["Content-Type"];
|
3174
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3175
2675
|
Date: components["parameters"]["Date"];
|
3176
|
-
/**
|
3177
|
-
* 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.
|
3178
|
-
*
|
3179
|
-
* **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`.
|
3180
|
-
*/
|
3181
2676
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3182
|
-
/** 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`). */
|
3183
2677
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3184
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3185
2678
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3186
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3187
2679
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3188
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3189
2680
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3190
|
-
/** 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). */
|
3191
2681
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3192
|
-
/** 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). */
|
3193
2682
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3194
|
-
/**
|
3195
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3196
|
-
*
|
3197
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
3198
|
-
*/
|
3199
2683
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3200
2684
|
};
|
2685
|
+
path: {
|
2686
|
+
ID: components["parameters"]["ID"];
|
2687
|
+
};
|
2688
|
+
};
|
2689
|
+
/** @description Transfer information returned. */
|
2690
|
+
requestBody: {
|
2691
|
+
content: {
|
2692
|
+
"application/json": components["schemas"]["TransfersIDPutResponse"];
|
2693
|
+
};
|
3201
2694
|
};
|
3202
2695
|
responses: {
|
3203
2696
|
200: components["responses"]["200"];
|
@@ -3210,50 +2703,34 @@ export interface operations {
|
|
3210
2703
|
501: components["responses"]["501"];
|
3211
2704
|
503: components["responses"]["503"];
|
3212
2705
|
};
|
3213
|
-
/** Transfer information returned. */
|
3214
|
-
requestBody: {
|
3215
|
-
content: {
|
3216
|
-
"application/json": components["schemas"]["TransfersIDPutResponse"];
|
3217
|
-
};
|
3218
|
-
};
|
3219
2706
|
};
|
3220
|
-
/**
|
2707
|
+
/**
|
2708
|
+
* Return transfer information
|
2709
|
+
* @description The HTTP request PATCH /transfers/<ID> is used by a Switch to update the state of a previously reserved transfer, if the Payee FSP has requested a commit notification when the Switch has completed processing of the transfer. The <ID> in the URI should contain the transferId that was used for the creation of the transfer. Please note that this request does not generate a callback.
|
2710
|
+
*/
|
3221
2711
|
TransfersByIDPatch: {
|
3222
2712
|
parameters: {
|
3223
|
-
path: {
|
3224
|
-
/** The identifier value. */
|
3225
|
-
ID: components["parameters"]["ID"];
|
3226
|
-
};
|
3227
2713
|
header: {
|
3228
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3229
2714
|
"Content-Type": components["parameters"]["Content-Type"];
|
3230
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3231
2715
|
Date: components["parameters"]["Date"];
|
3232
|
-
/**
|
3233
|
-
* 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.
|
3234
|
-
*
|
3235
|
-
* **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`.
|
3236
|
-
*/
|
3237
2716
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3238
|
-
/** 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`). */
|
3239
2717
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3240
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3241
2718
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3242
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3243
2719
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3244
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3245
2720
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3246
|
-
/** 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). */
|
3247
2721
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3248
|
-
/** 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). */
|
3249
2722
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3250
|
-
/**
|
3251
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3252
|
-
*
|
3253
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
3254
|
-
*/
|
3255
2723
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3256
2724
|
};
|
2725
|
+
path: {
|
2726
|
+
ID: components["parameters"]["ID"];
|
2727
|
+
};
|
2728
|
+
};
|
2729
|
+
/** @description Transfer notification upon completion. */
|
2730
|
+
requestBody: {
|
2731
|
+
content: {
|
2732
|
+
"application/json": components["schemas"]["TransfersIDPatchResponse"];
|
2733
|
+
};
|
3257
2734
|
};
|
3258
2735
|
responses: {
|
3259
2736
|
200: components["responses"]["200"];
|
@@ -3266,50 +2743,34 @@ export interface operations {
|
|
3266
2743
|
501: components["responses"]["501"];
|
3267
2744
|
503: components["responses"]["503"];
|
3268
2745
|
};
|
3269
|
-
/** Transfer notification upon completion. */
|
3270
|
-
requestBody: {
|
3271
|
-
content: {
|
3272
|
-
"application/json": components["schemas"]["TransfersIDPatchResponse"];
|
3273
|
-
};
|
3274
|
-
};
|
3275
2746
|
};
|
3276
|
-
/**
|
2747
|
+
/**
|
2748
|
+
* Return transfer information error
|
2749
|
+
* @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}`.
|
2750
|
+
*/
|
3277
2751
|
TransfersByIDAndError: {
|
3278
2752
|
parameters: {
|
3279
|
-
path: {
|
3280
|
-
/** The identifier value. */
|
3281
|
-
ID: components["parameters"]["ID"];
|
3282
|
-
};
|
3283
2753
|
header: {
|
3284
|
-
/**
|
3285
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3286
|
-
*
|
3287
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
3288
|
-
*/
|
3289
2754
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3290
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3291
2755
|
"Content-Type": components["parameters"]["Content-Type"];
|
3292
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3293
2756
|
Date: components["parameters"]["Date"];
|
3294
|
-
/**
|
3295
|
-
* The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3296
|
-
*
|
3297
|
-
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
3298
|
-
*/
|
3299
2757
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3300
|
-
/** The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3301
2758
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3302
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3303
2759
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3304
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3305
2760
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3306
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3307
2761
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3308
|
-
/** The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
3309
2762
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3310
|
-
/** The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
|
3311
2763
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3312
2764
|
};
|
2765
|
+
path: {
|
2766
|
+
ID: components["parameters"]["ID"];
|
2767
|
+
};
|
2768
|
+
};
|
2769
|
+
/** @description Details of the error returned. */
|
2770
|
+
requestBody: {
|
2771
|
+
content: {
|
2772
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
2773
|
+
};
|
3313
2774
|
};
|
3314
2775
|
responses: {
|
3315
2776
|
200: components["responses"]["200"];
|
@@ -3322,46 +2783,28 @@ export interface operations {
|
|
3322
2783
|
501: components["responses"]["501"];
|
3323
2784
|
503: components["responses"]["503"];
|
3324
2785
|
};
|
3325
|
-
/** Details of the error returned. */
|
3326
|
-
requestBody: {
|
3327
|
-
content: {
|
3328
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
3329
|
-
};
|
3330
|
-
};
|
3331
2786
|
};
|
3332
|
-
/**
|
2787
|
+
/**
|
2788
|
+
* Retrieve transaction information
|
2789
|
+
* @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).
|
2790
|
+
*/
|
3333
2791
|
TransactionsByID: {
|
3334
2792
|
parameters: {
|
3335
|
-
path: {
|
3336
|
-
/** The identifier value. */
|
3337
|
-
ID: components["parameters"]["ID"];
|
3338
|
-
};
|
3339
2793
|
header: {
|
3340
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3341
2794
|
"Content-Type": components["parameters"]["Content-Type"];
|
3342
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3343
2795
|
Date: components["parameters"]["Date"];
|
3344
|
-
/**
|
3345
|
-
* 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.
|
3346
|
-
*
|
3347
|
-
* **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`.
|
3348
|
-
*/
|
3349
2796
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3350
|
-
/** 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`). */
|
3351
2797
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3352
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3353
2798
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3354
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3355
2799
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3356
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3357
2800
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3358
|
-
/** 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). */
|
3359
2801
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3360
|
-
/** 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). */
|
3361
2802
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3362
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3363
2803
|
Accept: components["parameters"]["Accept"];
|
3364
2804
|
};
|
2805
|
+
path: {
|
2806
|
+
ID: components["parameters"]["ID"];
|
2807
|
+
};
|
3365
2808
|
};
|
3366
2809
|
responses: {
|
3367
2810
|
202: components["responses"]["202"];
|
@@ -3375,43 +2818,33 @@ export interface operations {
|
|
3375
2818
|
503: components["responses"]["503"];
|
3376
2819
|
};
|
3377
2820
|
};
|
3378
|
-
/**
|
2821
|
+
/**
|
2822
|
+
* Return transaction information
|
2823
|
+
* @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.
|
2824
|
+
*/
|
3379
2825
|
TransactionsByID1: {
|
3380
2826
|
parameters: {
|
3381
|
-
path: {
|
3382
|
-
/** The identifier value. */
|
3383
|
-
ID: components["parameters"]["ID"];
|
3384
|
-
};
|
3385
2827
|
header: {
|
3386
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3387
2828
|
"Content-Type": components["parameters"]["Content-Type"];
|
3388
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3389
2829
|
Date: components["parameters"]["Date"];
|
3390
|
-
/**
|
3391
|
-
* 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.
|
3392
|
-
*
|
3393
|
-
* **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`.
|
3394
|
-
*/
|
3395
2830
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3396
|
-
/** 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`). */
|
3397
2831
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3398
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3399
2832
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3400
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3401
2833
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3402
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3403
2834
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3404
|
-
/** 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). */
|
3405
2835
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3406
|
-
/** 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). */
|
3407
2836
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3408
|
-
/**
|
3409
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3410
|
-
*
|
3411
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
3412
|
-
*/
|
3413
2837
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3414
2838
|
};
|
2839
|
+
path: {
|
2840
|
+
ID: components["parameters"]["ID"];
|
2841
|
+
};
|
2842
|
+
};
|
2843
|
+
/** @description Transaction information returned. */
|
2844
|
+
requestBody: {
|
2845
|
+
content: {
|
2846
|
+
"application/json": components["schemas"]["TransactionsIDPutResponse"];
|
2847
|
+
};
|
3415
2848
|
};
|
3416
2849
|
responses: {
|
3417
2850
|
200: components["responses"]["200"];
|
@@ -3424,50 +2857,34 @@ export interface operations {
|
|
3424
2857
|
501: components["responses"]["501"];
|
3425
2858
|
503: components["responses"]["503"];
|
3426
2859
|
};
|
3427
|
-
/** Transaction information returned. */
|
3428
|
-
requestBody: {
|
3429
|
-
content: {
|
3430
|
-
"application/json": components["schemas"]["TransactionsIDPutResponse"];
|
3431
|
-
};
|
3432
|
-
};
|
3433
2860
|
};
|
3434
|
-
/**
|
2861
|
+
/**
|
2862
|
+
* Return transaction information error
|
2863
|
+
* @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.
|
2864
|
+
*/
|
3435
2865
|
TransactionsErrorByID: {
|
3436
2866
|
parameters: {
|
3437
|
-
path: {
|
3438
|
-
/** The identifier value. */
|
3439
|
-
ID: components["parameters"]["ID"];
|
3440
|
-
};
|
3441
2867
|
header: {
|
3442
|
-
/**
|
3443
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3444
|
-
*
|
3445
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
3446
|
-
*/
|
3447
2868
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3448
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3449
2869
|
"Content-Type": components["parameters"]["Content-Type"];
|
3450
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3451
2870
|
Date: components["parameters"]["Date"];
|
3452
|
-
/**
|
3453
|
-
* 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.
|
3454
|
-
*
|
3455
|
-
* **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`.
|
3456
|
-
*/
|
3457
2871
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3458
|
-
/** 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`). */
|
3459
2872
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3460
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3461
2873
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3462
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3463
2874
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3464
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3465
2875
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3466
|
-
/** 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). */
|
3467
2876
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3468
|
-
/** 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). */
|
3469
2877
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3470
2878
|
};
|
2879
|
+
path: {
|
2880
|
+
ID: components["parameters"]["ID"];
|
2881
|
+
};
|
2882
|
+
};
|
2883
|
+
/** @description Details of the error returned. */
|
2884
|
+
requestBody: {
|
2885
|
+
content: {
|
2886
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
2887
|
+
};
|
3471
2888
|
};
|
3472
2889
|
responses: {
|
3473
2890
|
200: components["responses"]["200"];
|
@@ -3480,49 +2897,33 @@ export interface operations {
|
|
3480
2897
|
501: components["responses"]["501"];
|
3481
2898
|
503: components["responses"]["503"];
|
3482
2899
|
};
|
3483
|
-
/** Details of the error returned. */
|
3484
|
-
requestBody: {
|
3485
|
-
content: {
|
3486
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
3487
|
-
};
|
3488
|
-
};
|
3489
2900
|
};
|
3490
|
-
/**
|
2901
|
+
/**
|
2902
|
+
* Calculate bulk quote
|
2903
|
+
* @description The HTTP request `POST /bulkQuotes` is used to request the creation of a bulk quote for the provided financial transactions in the server.
|
2904
|
+
*/
|
3491
2905
|
BulkQuotes: {
|
3492
2906
|
parameters: {
|
3493
2907
|
header: {
|
3494
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3495
2908
|
Accept: components["parameters"]["Accept"];
|
3496
|
-
/**
|
3497
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3498
|
-
*
|
3499
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
3500
|
-
*/
|
3501
2909
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3502
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3503
2910
|
"Content-Type": components["parameters"]["Content-Type"];
|
3504
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3505
2911
|
Date: components["parameters"]["Date"];
|
3506
|
-
/**
|
3507
|
-
* 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.
|
3508
|
-
*
|
3509
|
-
* **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`.
|
3510
|
-
*/
|
3511
2912
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3512
|
-
/** 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`). */
|
3513
2913
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3514
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3515
2914
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3516
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3517
2915
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3518
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3519
2916
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3520
|
-
/** 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). */
|
3521
2917
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3522
|
-
/** 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). */
|
3523
2918
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3524
2919
|
};
|
3525
2920
|
};
|
2921
|
+
/** @description Details of the bulk quote to be created. */
|
2922
|
+
requestBody: {
|
2923
|
+
content: {
|
2924
|
+
"application/json": components["schemas"]["BulkQuotesPostRequest"];
|
2925
|
+
};
|
2926
|
+
};
|
3526
2927
|
responses: {
|
3527
2928
|
202: components["responses"]["202"];
|
3528
2929
|
400: components["responses"]["400"];
|
@@ -3534,46 +2935,28 @@ export interface operations {
|
|
3534
2935
|
501: components["responses"]["501"];
|
3535
2936
|
503: components["responses"]["503"];
|
3536
2937
|
};
|
3537
|
-
/** Details of the bulk quote to be created. */
|
3538
|
-
requestBody: {
|
3539
|
-
content: {
|
3540
|
-
"application/json": components["schemas"]["BulkQuotesPostRequest"];
|
3541
|
-
};
|
3542
|
-
};
|
3543
2938
|
};
|
3544
|
-
/**
|
2939
|
+
/**
|
2940
|
+
* Retrieve bulk quote information
|
2941
|
+
* @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.
|
2942
|
+
*/
|
3545
2943
|
BulkQuotesByID: {
|
3546
2944
|
parameters: {
|
3547
|
-
path: {
|
3548
|
-
/** The identifier value. */
|
3549
|
-
ID: components["parameters"]["ID"];
|
3550
|
-
};
|
3551
2945
|
header: {
|
3552
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3553
2946
|
"Content-Type": components["parameters"]["Content-Type"];
|
3554
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3555
2947
|
Date: components["parameters"]["Date"];
|
3556
|
-
/**
|
3557
|
-
* 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.
|
3558
|
-
*
|
3559
|
-
* **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`.
|
3560
|
-
*/
|
3561
2948
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3562
|
-
/** 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`). */
|
3563
2949
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3564
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3565
2950
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3566
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3567
2951
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3568
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3569
2952
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3570
|
-
/** 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). */
|
3571
2953
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3572
|
-
/** 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). */
|
3573
2954
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3574
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3575
2955
|
Accept: components["parameters"]["Accept"];
|
3576
2956
|
};
|
2957
|
+
path: {
|
2958
|
+
ID: components["parameters"]["ID"];
|
2959
|
+
};
|
3577
2960
|
};
|
3578
2961
|
responses: {
|
3579
2962
|
202: components["responses"]["202"];
|
@@ -3587,43 +2970,33 @@ export interface operations {
|
|
3587
2970
|
503: components["responses"]["503"];
|
3588
2971
|
};
|
3589
2972
|
};
|
3590
|
-
/**
|
2973
|
+
/**
|
2974
|
+
* Return bulk quote information
|
2975
|
+
* @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.
|
2976
|
+
*/
|
3591
2977
|
BulkQuotesByID1: {
|
3592
2978
|
parameters: {
|
3593
|
-
path: {
|
3594
|
-
/** The identifier value. */
|
3595
|
-
ID: components["parameters"]["ID"];
|
3596
|
-
};
|
3597
2979
|
header: {
|
3598
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3599
2980
|
"Content-Type": components["parameters"]["Content-Type"];
|
3600
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3601
2981
|
Date: components["parameters"]["Date"];
|
3602
|
-
/**
|
3603
|
-
* 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.
|
3604
|
-
*
|
3605
|
-
* **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`.
|
3606
|
-
*/
|
3607
2982
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3608
|
-
/** 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`). */
|
3609
2983
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3610
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3611
2984
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3612
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3613
2985
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3614
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3615
2986
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3616
|
-
/** 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). */
|
3617
2987
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3618
|
-
/** 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). */
|
3619
2988
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3620
|
-
/**
|
3621
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3622
|
-
*
|
3623
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
3624
|
-
*/
|
3625
2989
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3626
2990
|
};
|
2991
|
+
path: {
|
2992
|
+
ID: components["parameters"]["ID"];
|
2993
|
+
};
|
2994
|
+
};
|
2995
|
+
/** @description Bulk quote information returned. */
|
2996
|
+
requestBody: {
|
2997
|
+
content: {
|
2998
|
+
"application/json": components["schemas"]["BulkQuotesIDPutResponse"];
|
2999
|
+
};
|
3627
3000
|
};
|
3628
3001
|
responses: {
|
3629
3002
|
200: components["responses"]["200"];
|
@@ -3636,50 +3009,34 @@ export interface operations {
|
|
3636
3009
|
501: components["responses"]["501"];
|
3637
3010
|
503: components["responses"]["503"];
|
3638
3011
|
};
|
3639
|
-
/** Bulk quote information returned. */
|
3640
|
-
requestBody: {
|
3641
|
-
content: {
|
3642
|
-
"application/json": components["schemas"]["BulkQuotesIDPutResponse"];
|
3643
|
-
};
|
3644
|
-
};
|
3645
3012
|
};
|
3646
|
-
/**
|
3013
|
+
/**
|
3014
|
+
* Return bulk quote information error
|
3015
|
+
* @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.
|
3016
|
+
*/
|
3647
3017
|
BulkQuotesErrorByID: {
|
3648
3018
|
parameters: {
|
3649
|
-
path: {
|
3650
|
-
/** The identifier value. */
|
3651
|
-
ID: components["parameters"]["ID"];
|
3652
|
-
};
|
3653
3019
|
header: {
|
3654
|
-
/**
|
3655
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3656
|
-
*
|
3657
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
3658
|
-
*/
|
3659
3020
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3660
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3661
3021
|
"Content-Type": components["parameters"]["Content-Type"];
|
3662
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3663
3022
|
Date: components["parameters"]["Date"];
|
3664
|
-
/**
|
3665
|
-
* 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.
|
3666
|
-
*
|
3667
|
-
* **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`.
|
3668
|
-
*/
|
3669
3023
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3670
|
-
/** 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`). */
|
3671
3024
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3672
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3673
3025
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3674
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3675
3026
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3676
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3677
3027
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3678
|
-
/** 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). */
|
3679
3028
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3680
|
-
/** 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). */
|
3681
3029
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3682
3030
|
};
|
3031
|
+
path: {
|
3032
|
+
ID: components["parameters"]["ID"];
|
3033
|
+
};
|
3034
|
+
};
|
3035
|
+
/** @description Details of the error returned. */
|
3036
|
+
requestBody: {
|
3037
|
+
content: {
|
3038
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
3039
|
+
};
|
3683
3040
|
};
|
3684
3041
|
responses: {
|
3685
3042
|
200: components["responses"]["200"];
|
@@ -3692,49 +3049,33 @@ export interface operations {
|
|
3692
3049
|
501: components["responses"]["501"];
|
3693
3050
|
503: components["responses"]["503"];
|
3694
3051
|
};
|
3695
|
-
/** Details of the error returned. */
|
3696
|
-
requestBody: {
|
3697
|
-
content: {
|
3698
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
3699
|
-
};
|
3700
|
-
};
|
3701
3052
|
};
|
3702
|
-
/**
|
3053
|
+
/**
|
3054
|
+
* Perform bulk transfer
|
3055
|
+
* @description The HTTP request `POST /bulkTransfers` is used to request the creation of a bulk transfer in the server.
|
3056
|
+
*/
|
3703
3057
|
BulkTransfers: {
|
3704
3058
|
parameters: {
|
3705
3059
|
header: {
|
3706
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3707
3060
|
Accept: components["parameters"]["Accept"];
|
3708
|
-
/**
|
3709
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3710
|
-
*
|
3711
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
3712
|
-
*/
|
3713
3061
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3714
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3715
3062
|
"Content-Type": components["parameters"]["Content-Type"];
|
3716
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3717
3063
|
Date: components["parameters"]["Date"];
|
3718
|
-
/**
|
3719
|
-
* 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.
|
3720
|
-
*
|
3721
|
-
* **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`.
|
3722
|
-
*/
|
3723
3064
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3724
|
-
/** 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`). */
|
3725
3065
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3726
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3727
3066
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3728
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3729
3067
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3730
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3731
3068
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3732
|
-
/** 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). */
|
3733
3069
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3734
|
-
/** 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). */
|
3735
3070
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3736
3071
|
};
|
3737
3072
|
};
|
3073
|
+
/** @description Details of the bulk transfer to be created. */
|
3074
|
+
requestBody: {
|
3075
|
+
content: {
|
3076
|
+
"application/json": components["schemas"]["BulkTransfersPostRequest"];
|
3077
|
+
};
|
3078
|
+
};
|
3738
3079
|
responses: {
|
3739
3080
|
202: components["responses"]["202"];
|
3740
3081
|
400: components["responses"]["400"];
|
@@ -3746,46 +3087,28 @@ export interface operations {
|
|
3746
3087
|
501: components["responses"]["501"];
|
3747
3088
|
503: components["responses"]["503"];
|
3748
3089
|
};
|
3749
|
-
/** Details of the bulk transfer to be created. */
|
3750
|
-
requestBody: {
|
3751
|
-
content: {
|
3752
|
-
"application/json": components["schemas"]["BulkTransfersPostRequest"];
|
3753
|
-
};
|
3754
|
-
};
|
3755
3090
|
};
|
3756
|
-
/**
|
3091
|
+
/**
|
3092
|
+
* Retrieve bulk transfer information
|
3093
|
+
* @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.
|
3094
|
+
*/
|
3757
3095
|
BulkTransferByID: {
|
3758
3096
|
parameters: {
|
3759
|
-
path: {
|
3760
|
-
/** The identifier value. */
|
3761
|
-
ID: components["parameters"]["ID"];
|
3762
|
-
};
|
3763
3097
|
header: {
|
3764
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3765
3098
|
"Content-Type": components["parameters"]["Content-Type"];
|
3766
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3767
3099
|
Date: components["parameters"]["Date"];
|
3768
|
-
/**
|
3769
|
-
* 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.
|
3770
|
-
*
|
3771
|
-
* **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`.
|
3772
|
-
*/
|
3773
3100
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3774
|
-
/** 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`). */
|
3775
3101
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3776
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3777
3102
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3778
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3779
3103
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3780
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3781
3104
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3782
|
-
/** 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). */
|
3783
3105
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3784
|
-
/** 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). */
|
3785
3106
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3786
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3787
3107
|
Accept: components["parameters"]["Accept"];
|
3788
3108
|
};
|
3109
|
+
path: {
|
3110
|
+
ID: components["parameters"]["ID"];
|
3111
|
+
};
|
3789
3112
|
};
|
3790
3113
|
responses: {
|
3791
3114
|
202: components["responses"]["202"];
|
@@ -3799,43 +3122,33 @@ export interface operations {
|
|
3799
3122
|
503: components["responses"]["503"];
|
3800
3123
|
};
|
3801
3124
|
};
|
3802
|
-
/**
|
3125
|
+
/**
|
3126
|
+
* Return bulk transfer information
|
3127
|
+
* @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.
|
3128
|
+
*/
|
3803
3129
|
BulkTransfersByIDPut: {
|
3804
3130
|
parameters: {
|
3805
|
-
path: {
|
3806
|
-
/** The identifier value. */
|
3807
|
-
ID: components["parameters"]["ID"];
|
3808
|
-
};
|
3809
3131
|
header: {
|
3810
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3811
3132
|
"Content-Type": components["parameters"]["Content-Type"];
|
3812
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3813
3133
|
Date: components["parameters"]["Date"];
|
3814
|
-
/**
|
3815
|
-
* 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.
|
3816
|
-
*
|
3817
|
-
* **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`.
|
3818
|
-
*/
|
3819
3134
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3820
|
-
/** 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`). */
|
3821
3135
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3822
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3823
3136
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3824
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3825
3137
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3826
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3827
3138
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3828
|
-
/** 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). */
|
3829
3139
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3830
|
-
/** 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). */
|
3831
3140
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3832
|
-
/**
|
3833
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3834
|
-
*
|
3835
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
3836
|
-
*/
|
3837
3141
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3838
3142
|
};
|
3143
|
+
path: {
|
3144
|
+
ID: components["parameters"]["ID"];
|
3145
|
+
};
|
3146
|
+
};
|
3147
|
+
/** @description Bulk transfer information returned. */
|
3148
|
+
requestBody: {
|
3149
|
+
content: {
|
3150
|
+
"application/json": components["schemas"]["BulkTransfersIDPutResponse"];
|
3151
|
+
};
|
3839
3152
|
};
|
3840
3153
|
responses: {
|
3841
3154
|
200: components["responses"]["200"];
|
@@ -3848,50 +3161,34 @@ export interface operations {
|
|
3848
3161
|
501: components["responses"]["501"];
|
3849
3162
|
503: components["responses"]["503"];
|
3850
3163
|
};
|
3851
|
-
/** Bulk transfer information returned. */
|
3852
|
-
requestBody: {
|
3853
|
-
content: {
|
3854
|
-
"application/json": components["schemas"]["BulkTransfersIDPutResponse"];
|
3855
|
-
};
|
3856
|
-
};
|
3857
3164
|
};
|
3858
|
-
/**
|
3165
|
+
/**
|
3166
|
+
* Return bulk transfer information error
|
3167
|
+
* @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.
|
3168
|
+
*/
|
3859
3169
|
BulkTransfersErrorByID: {
|
3860
3170
|
parameters: {
|
3861
|
-
path: {
|
3862
|
-
/** The identifier value. */
|
3863
|
-
ID: components["parameters"]["ID"];
|
3864
|
-
};
|
3865
3171
|
header: {
|
3866
|
-
/**
|
3867
|
-
* The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3868
|
-
*
|
3869
|
-
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
3870
|
-
*/
|
3871
3172
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3872
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3873
3173
|
"Content-Type": components["parameters"]["Content-Type"];
|
3874
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3875
3174
|
Date: components["parameters"]["Date"];
|
3876
|
-
/**
|
3877
|
-
* 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.
|
3878
|
-
*
|
3879
|
-
* **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`.
|
3880
|
-
*/
|
3881
3175
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3882
|
-
/** 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`). */
|
3883
3176
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3884
|
-
/** The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3885
3177
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3886
|
-
/** The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3887
3178
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3888
|
-
/** The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3889
3179
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3890
|
-
/** 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). */
|
3891
3180
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3892
|
-
/** 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). */
|
3893
3181
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3894
3182
|
};
|
3183
|
+
path: {
|
3184
|
+
ID: components["parameters"]["ID"];
|
3185
|
+
};
|
3186
|
+
};
|
3187
|
+
/** @description Details of the error returned. */
|
3188
|
+
requestBody: {
|
3189
|
+
content: {
|
3190
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
3191
|
+
};
|
3895
3192
|
};
|
3896
3193
|
responses: {
|
3897
3194
|
200: components["responses"]["200"];
|
@@ -3904,13 +3201,5 @@ export interface operations {
|
|
3904
3201
|
501: components["responses"]["501"];
|
3905
3202
|
503: components["responses"]["503"];
|
3906
3203
|
};
|
3907
|
-
/** Details of the error returned. */
|
3908
|
-
requestBody: {
|
3909
|
-
content: {
|
3910
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
3911
|
-
};
|
3912
|
-
};
|
3913
3204
|
};
|
3914
3205
|
}
|
3915
|
-
export interface external {
|
3916
|
-
}
|