@mojaloop/api-snippets 17.2.0-snapshot.2 → 17.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +21 -0
- package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml +105 -2
- package/jest.config.js +2 -4
- package/lib/fspiop/v1_0/openapi.d.ts +791 -1490
- package/lib/fspiop/v1_1/openapi.d.ts +811 -1523
- package/lib/sdk-scheme-adapter/v2_0_0/backend/openapi.d.ts +189 -141
- package/lib/sdk-scheme-adapter/v2_0_0/backend/schemas.js +1 -1
- package/lib/sdk-scheme-adapter/v2_0_0/backend/schemas.js.map +1 -1
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/json-schemas.json +1233 -905
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/openapi.d.ts +264 -198
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/schemas.d.ts +457 -160
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/schemas.js +5 -1
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/schemas.js.map +1 -1
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/types.d.ts +4 -0
- package/lib/thirdparty/openapi.d.ts +655 -1454
- package/package.json +24 -34
- package/sdk-scheme-adapter/v2_0_0/components/schemas/AuthenticationInfo.yaml +11 -0
- package/sdk-scheme-adapter/v2_0_0/components/schemas/AuthenticationValue.yaml +44 -0
- package/sdk-scheme-adapter/v2_0_0/components/schemas/AuthorizationIDPutResponse.yaml +10 -0
- package/sdk-scheme-adapter/v2_0_0/components/schemas/AuthorizationResponseType.yaml +12 -0
- package/sdk-scheme-adapter/v2_0_0/components/schemas/requestToPayTransferResponse.yaml +25 -2
@@ -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,61 @@ 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 external = Record<string, never>;
|
1393
1397
|
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. */
|
1398
|
+
/** @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
1399
|
test: {
|
1396
|
-
|
1397
|
-
/** Ok */
|
1398
|
-
200: unknown;
|
1399
|
-
};
|
1400
|
-
requestBody: {
|
1400
|
+
requestBody?: {
|
1401
1401
|
content: {
|
1402
1402
|
"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
1403
|
};
|
1404
1404
|
};
|
1405
|
+
responses: {
|
1406
|
+
/** @description Ok */
|
1407
|
+
200: {
|
1408
|
+
content: never;
|
1409
|
+
};
|
1410
|
+
};
|
1405
1411
|
};
|
1406
|
-
/**
|
1412
|
+
/**
|
1413
|
+
* Look up participant information
|
1414
|
+
* @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.
|
1415
|
+
*/
|
1407
1416
|
ParticipantsByTypeAndID: {
|
1408
1417
|
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
1418
|
header: {
|
1416
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1417
1419
|
"Content-Type": components["parameters"]["Content-Type"];
|
1418
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
1419
1420
|
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
1421
|
"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
1422
|
"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
1423
|
"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
1424
|
"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
1425
|
"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
1426
|
"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
1427
|
"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
1428
|
Accept: components["parameters"]["Accept"];
|
1440
1429
|
};
|
1430
|
+
path: {
|
1431
|
+
Type: components["parameters"]["Type"];
|
1432
|
+
ID: components["parameters"]["ID"];
|
1433
|
+
};
|
1441
1434
|
};
|
1442
1435
|
responses: {
|
1443
1436
|
202: components["responses"]["202"];
|
@@ -1451,45 +1444,34 @@ export interface operations {
|
|
1451
1444
|
503: components["responses"]["503"];
|
1452
1445
|
};
|
1453
1446
|
};
|
1454
|
-
/**
|
1447
|
+
/**
|
1448
|
+
* Return participant information
|
1449
|
+
* @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.
|
1450
|
+
*/
|
1455
1451
|
ParticipantsByTypeAndID3: {
|
1456
1452
|
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
1453
|
header: {
|
1464
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1465
1454
|
"Content-Type": components["parameters"]["Content-Type"];
|
1466
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
1467
1455
|
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
1456
|
"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
1457
|
"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
1458
|
"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
1459
|
"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
1460
|
"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
1461
|
"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
1462
|
"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
1463
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
1492
1464
|
};
|
1465
|
+
path: {
|
1466
|
+
Type: components["parameters"]["Type"];
|
1467
|
+
ID: components["parameters"]["ID"];
|
1468
|
+
};
|
1469
|
+
};
|
1470
|
+
/** @description Participant information returned. */
|
1471
|
+
requestBody: {
|
1472
|
+
content: {
|
1473
|
+
"application/json": components["schemas"]["ParticipantsTypeIDPutResponse"];
|
1474
|
+
};
|
1493
1475
|
};
|
1494
1476
|
responses: {
|
1495
1477
|
200: components["responses"]["200"];
|
@@ -1502,54 +1484,36 @@ export interface operations {
|
|
1502
1484
|
501: components["responses"]["501"];
|
1503
1485
|
503: components["responses"]["503"];
|
1504
1486
|
};
|
1505
|
-
/** Participant information returned. */
|
1506
|
-
requestBody: {
|
1507
|
-
content: {
|
1508
|
-
"application/json": components["schemas"]["ParticipantsTypeIDPutResponse"];
|
1509
|
-
};
|
1510
|
-
};
|
1511
1487
|
};
|
1512
|
-
/**
|
1488
|
+
/**
|
1489
|
+
* Create participant information
|
1490
|
+
* @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
|
1491
|
+
*/
|
1513
1492
|
ParticipantsByIDAndType: {
|
1514
1493
|
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
1494
|
header: {
|
1522
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1523
1495
|
"Content-Type": components["parameters"]["Content-Type"];
|
1524
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
1525
1496
|
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
1497
|
"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
1498
|
"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
1499
|
"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
1500
|
"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
1501
|
"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
1502
|
"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
1503
|
"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
1504
|
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
1505
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
1552
1506
|
};
|
1507
|
+
path: {
|
1508
|
+
Type: components["parameters"]["Type"];
|
1509
|
+
ID: components["parameters"]["ID"];
|
1510
|
+
};
|
1511
|
+
};
|
1512
|
+
/** @description Participant information to be created. */
|
1513
|
+
requestBody: {
|
1514
|
+
content: {
|
1515
|
+
"application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"];
|
1516
|
+
};
|
1553
1517
|
};
|
1554
1518
|
responses: {
|
1555
1519
|
202: components["responses"]["202"];
|
@@ -1562,52 +1526,31 @@ export interface operations {
|
|
1562
1526
|
501: components["responses"]["501"];
|
1563
1527
|
503: components["responses"]["503"];
|
1564
1528
|
};
|
1565
|
-
/** Participant information to be created. */
|
1566
|
-
requestBody: {
|
1567
|
-
content: {
|
1568
|
-
"application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"];
|
1569
|
-
};
|
1570
|
-
};
|
1571
1529
|
};
|
1572
1530
|
/**
|
1573
|
-
*
|
1531
|
+
* Delete participant information
|
1532
|
+
* @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
1533
|
*
|
1575
1534
|
* **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.
|
1576
1535
|
*/
|
1577
1536
|
ParticipantsByTypeAndID2: {
|
1578
1537
|
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
1538
|
header: {
|
1586
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1587
1539
|
"Content-Type": components["parameters"]["Content-Type"];
|
1588
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
1589
1540
|
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
1541
|
"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
1542
|
"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
1543
|
"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
1544
|
"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
1545
|
"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
1546
|
"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
1547
|
"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
1548
|
Accept: components["parameters"]["Accept"];
|
1610
1549
|
};
|
1550
|
+
path: {
|
1551
|
+
Type: components["parameters"]["Type"];
|
1552
|
+
ID: components["parameters"]["ID"];
|
1553
|
+
};
|
1611
1554
|
};
|
1612
1555
|
responses: {
|
1613
1556
|
202: components["responses"]["202"];
|
@@ -1621,48 +1564,37 @@ export interface operations {
|
|
1621
1564
|
503: components["responses"]["503"];
|
1622
1565
|
};
|
1623
1566
|
};
|
1624
|
-
/**
|
1567
|
+
/**
|
1568
|
+
* Return participant information error
|
1569
|
+
* @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.
|
1570
|
+
*/
|
1625
1571
|
ParticipantsErrorByTypeAndID: {
|
1626
1572
|
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
1573
|
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
1574
|
"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
1575
|
"Content-Type": components["parameters"]["Content-Type"];
|
1642
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
1643
1576
|
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
1577
|
"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
1578
|
"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
1579
|
"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
1580
|
"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
1581
|
"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
1582
|
"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
1583
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
1662
1584
|
};
|
1585
|
+
path: {
|
1586
|
+
Type: components["parameters"]["Type"];
|
1587
|
+
ID: components["parameters"]["ID"];
|
1588
|
+
};
|
1663
1589
|
};
|
1664
|
-
|
1665
|
-
|
1590
|
+
/** @description Details of the error returned. */
|
1591
|
+
requestBody: {
|
1592
|
+
content: {
|
1593
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
1594
|
+
};
|
1595
|
+
};
|
1596
|
+
responses: {
|
1597
|
+
200: components["responses"]["200"];
|
1666
1598
|
400: components["responses"]["400"];
|
1667
1599
|
401: components["responses"]["401"];
|
1668
1600
|
403: components["responses"]["403"];
|
@@ -1672,50 +1604,30 @@ export interface operations {
|
|
1672
1604
|
501: components["responses"]["501"];
|
1673
1605
|
503: components["responses"]["503"];
|
1674
1606
|
};
|
1675
|
-
/** Details of the error returned. */
|
1676
|
-
requestBody: {
|
1677
|
-
content: {
|
1678
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
1679
|
-
};
|
1680
|
-
};
|
1681
1607
|
};
|
1682
|
-
/**
|
1608
|
+
/**
|
1609
|
+
* Look up participant information
|
1610
|
+
* @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.
|
1611
|
+
*/
|
1683
1612
|
ParticipantsSubIdByTypeAndID: {
|
1684
1613
|
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
1614
|
header: {
|
1694
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1695
1615
|
"Content-Type": components["parameters"]["Content-Type"];
|
1696
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
1697
1616
|
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
1617
|
"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
1618
|
"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
1619
|
"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
1620
|
"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
1621
|
"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
1622
|
"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
1623
|
"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
1624
|
Accept: components["parameters"]["Accept"];
|
1718
1625
|
};
|
1626
|
+
path: {
|
1627
|
+
Type: components["parameters"]["Type"];
|
1628
|
+
ID: components["parameters"]["ID"];
|
1629
|
+
SubId: components["parameters"]["SubId"];
|
1630
|
+
};
|
1719
1631
|
};
|
1720
1632
|
responses: {
|
1721
1633
|
202: components["responses"]["202"];
|
@@ -1729,47 +1641,35 @@ export interface operations {
|
|
1729
1641
|
503: components["responses"]["503"];
|
1730
1642
|
};
|
1731
1643
|
};
|
1732
|
-
/**
|
1644
|
+
/**
|
1645
|
+
* Return participant information
|
1646
|
+
* @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.
|
1647
|
+
*/
|
1733
1648
|
ParticipantsSubIdByTypeAndID3: {
|
1734
1649
|
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
1650
|
header: {
|
1744
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1745
1651
|
"Content-Type": components["parameters"]["Content-Type"];
|
1746
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
1747
1652
|
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
1653
|
"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
1654
|
"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
1655
|
"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
1656
|
"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
1657
|
"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
1658
|
"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
1659
|
"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
1660
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
1772
1661
|
};
|
1662
|
+
path: {
|
1663
|
+
Type: components["parameters"]["Type"];
|
1664
|
+
ID: components["parameters"]["ID"];
|
1665
|
+
SubId: components["parameters"]["SubId"];
|
1666
|
+
};
|
1667
|
+
};
|
1668
|
+
/** @description Participant information returned. */
|
1669
|
+
requestBody: {
|
1670
|
+
content: {
|
1671
|
+
"application/json": components["schemas"]["ParticipantsTypeIDPutResponse"];
|
1672
|
+
};
|
1773
1673
|
};
|
1774
1674
|
responses: {
|
1775
1675
|
200: components["responses"]["200"];
|
@@ -1782,56 +1682,37 @@ export interface operations {
|
|
1782
1682
|
501: components["responses"]["501"];
|
1783
1683
|
503: components["responses"]["503"];
|
1784
1684
|
};
|
1785
|
-
/** Participant information returned. */
|
1786
|
-
requestBody: {
|
1787
|
-
content: {
|
1788
|
-
"application/json": components["schemas"]["ParticipantsTypeIDPutResponse"];
|
1789
|
-
};
|
1790
|
-
};
|
1791
1685
|
};
|
1792
|
-
/**
|
1686
|
+
/**
|
1687
|
+
* Create participant information
|
1688
|
+
* @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
|
1689
|
+
*/
|
1793
1690
|
ParticipantsSubIdByTypeAndIDPost: {
|
1794
1691
|
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
1692
|
header: {
|
1804
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1805
1693
|
"Content-Type": components["parameters"]["Content-Type"];
|
1806
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
1807
1694
|
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
1695
|
"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
1696
|
"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
1697
|
"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
1698
|
"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
1699
|
"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
1700
|
"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
1701
|
"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
1702
|
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
1703
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
1834
1704
|
};
|
1705
|
+
path: {
|
1706
|
+
Type: components["parameters"]["Type"];
|
1707
|
+
ID: components["parameters"]["ID"];
|
1708
|
+
SubId: components["parameters"]["SubId"];
|
1709
|
+
};
|
1710
|
+
};
|
1711
|
+
/** @description Participant information to be created. */
|
1712
|
+
requestBody: {
|
1713
|
+
content: {
|
1714
|
+
"application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"];
|
1715
|
+
};
|
1835
1716
|
};
|
1836
1717
|
responses: {
|
1837
1718
|
202: components["responses"]["202"];
|
@@ -1844,54 +1725,32 @@ export interface operations {
|
|
1844
1725
|
501: components["responses"]["501"];
|
1845
1726
|
503: components["responses"]["503"];
|
1846
1727
|
};
|
1847
|
-
/** Participant information to be created. */
|
1848
|
-
requestBody: {
|
1849
|
-
content: {
|
1850
|
-
"application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"];
|
1851
|
-
};
|
1852
|
-
};
|
1853
1728
|
};
|
1854
1729
|
/**
|
1855
|
-
*
|
1730
|
+
* Delete participant information
|
1731
|
+
* @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
1732
|
*
|
1857
1733
|
* **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.
|
1858
1734
|
*/
|
1859
1735
|
ParticipantsSubIdByTypeAndID2: {
|
1860
1736
|
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
1737
|
header: {
|
1870
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1871
1738
|
"Content-Type": components["parameters"]["Content-Type"];
|
1872
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
1873
1739
|
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
1740
|
"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
1741
|
"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
1742
|
"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
1743
|
"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
1744
|
"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
1745
|
"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
1746
|
"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
1747
|
Accept: components["parameters"]["Accept"];
|
1894
1748
|
};
|
1749
|
+
path: {
|
1750
|
+
Type: components["parameters"]["Type"];
|
1751
|
+
ID: components["parameters"]["ID"];
|
1752
|
+
SubId: components["parameters"]["SubId"];
|
1753
|
+
};
|
1895
1754
|
};
|
1896
1755
|
responses: {
|
1897
1756
|
202: components["responses"]["202"];
|
@@ -1905,47 +1764,35 @@ export interface operations {
|
|
1905
1764
|
503: components["responses"]["503"];
|
1906
1765
|
};
|
1907
1766
|
};
|
1908
|
-
/**
|
1767
|
+
/**
|
1768
|
+
* Return participant information error
|
1769
|
+
* @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.
|
1770
|
+
*/
|
1909
1771
|
ParticipantsSubIdErrorByTypeAndID: {
|
1910
1772
|
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
1773
|
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
1774
|
"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
1775
|
"Content-Type": components["parameters"]["Content-Type"];
|
1928
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
1929
1776
|
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
1777
|
"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
1778
|
"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
1779
|
"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
1780
|
"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
1781
|
"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
1782
|
"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
1783
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
1948
1784
|
};
|
1785
|
+
path: {
|
1786
|
+
Type: components["parameters"]["Type"];
|
1787
|
+
ID: components["parameters"]["ID"];
|
1788
|
+
SubId: components["parameters"]["SubId"];
|
1789
|
+
};
|
1790
|
+
};
|
1791
|
+
/** @description Details of the error returned. */
|
1792
|
+
requestBody: {
|
1793
|
+
content: {
|
1794
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
1795
|
+
};
|
1949
1796
|
};
|
1950
1797
|
responses: {
|
1951
1798
|
200: components["responses"]["200"];
|
@@ -1958,49 +1805,33 @@ export interface operations {
|
|
1958
1805
|
501: components["responses"]["501"];
|
1959
1806
|
503: components["responses"]["503"];
|
1960
1807
|
};
|
1961
|
-
/** Details of the error returned. */
|
1962
|
-
requestBody: {
|
1963
|
-
content: {
|
1964
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
1965
|
-
};
|
1966
|
-
};
|
1967
1808
|
};
|
1968
|
-
/**
|
1809
|
+
/**
|
1810
|
+
* Create bulk participant information
|
1811
|
+
* @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.
|
1812
|
+
*/
|
1969
1813
|
Participants1: {
|
1970
1814
|
parameters: {
|
1971
1815
|
header: {
|
1972
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
1973
1816
|
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
1817
|
"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
1818
|
"Content-Type": components["parameters"]["Content-Type"];
|
1982
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
1983
1819
|
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
1820
|
"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
1821
|
"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
1822
|
"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
1823
|
"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
1824
|
"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
1825
|
"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
1826
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2002
1827
|
};
|
2003
1828
|
};
|
1829
|
+
/** @description Participant information to be created. */
|
1830
|
+
requestBody: {
|
1831
|
+
content: {
|
1832
|
+
"application/json": components["schemas"]["ParticipantsPostRequest"];
|
1833
|
+
};
|
1834
|
+
};
|
2004
1835
|
responses: {
|
2005
1836
|
202: components["responses"]["202"];
|
2006
1837
|
400: components["responses"]["400"];
|
@@ -2012,50 +1843,34 @@ export interface operations {
|
|
2012
1843
|
501: components["responses"]["501"];
|
2013
1844
|
503: components["responses"]["503"];
|
2014
1845
|
};
|
2015
|
-
/** Participant information to be created. */
|
2016
|
-
requestBody: {
|
2017
|
-
content: {
|
2018
|
-
"application/json": components["schemas"]["ParticipantsPostRequest"];
|
2019
|
-
};
|
2020
|
-
};
|
2021
1846
|
};
|
2022
|
-
/**
|
1847
|
+
/**
|
1848
|
+
* Return bulk participant information
|
1849
|
+
* @description The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities.
|
1850
|
+
*/
|
2023
1851
|
putParticipantsByID: {
|
2024
1852
|
parameters: {
|
2025
|
-
path: {
|
2026
|
-
/** The identifier value. */
|
2027
|
-
ID: components["parameters"]["ID"];
|
2028
|
-
};
|
2029
1853
|
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
1854
|
"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
1855
|
"Content-Type": components["parameters"]["Content-Type"];
|
2038
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2039
1856
|
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
1857
|
"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
1858
|
"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
1859
|
"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
1860
|
"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
1861
|
"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
1862
|
"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
1863
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2058
1864
|
};
|
1865
|
+
path: {
|
1866
|
+
ID: components["parameters"]["ID"];
|
1867
|
+
};
|
1868
|
+
};
|
1869
|
+
/** @description Participant information returned. */
|
1870
|
+
requestBody: {
|
1871
|
+
content: {
|
1872
|
+
"application/json": components["schemas"]["ParticipantsIDPutResponse"];
|
1873
|
+
};
|
2059
1874
|
};
|
2060
1875
|
responses: {
|
2061
1876
|
200: components["responses"]["200"];
|
@@ -2068,50 +1883,34 @@ export interface operations {
|
|
2068
1883
|
501: components["responses"]["501"];
|
2069
1884
|
503: components["responses"]["503"];
|
2070
1885
|
};
|
2071
|
-
/** Participant information returned. */
|
2072
|
-
requestBody: {
|
2073
|
-
content: {
|
2074
|
-
"application/json": components["schemas"]["ParticipantsIDPutResponse"];
|
2075
|
-
};
|
2076
|
-
};
|
2077
1886
|
};
|
2078
|
-
/**
|
1887
|
+
/**
|
1888
|
+
* Return bulk participant information error
|
1889
|
+
* @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.
|
1890
|
+
*/
|
2079
1891
|
ParticipantsByIDAndError: {
|
2080
1892
|
parameters: {
|
2081
|
-
path: {
|
2082
|
-
/** The identifier value. */
|
2083
|
-
ID: components["parameters"]["ID"];
|
2084
|
-
};
|
2085
1893
|
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
1894
|
"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
1895
|
"Content-Type": components["parameters"]["Content-Type"];
|
2094
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2095
1896
|
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
1897
|
"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
1898
|
"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
1899
|
"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
1900
|
"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
1901
|
"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
1902
|
"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
1903
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2114
1904
|
};
|
1905
|
+
path: {
|
1906
|
+
ID: components["parameters"]["ID"];
|
1907
|
+
};
|
1908
|
+
};
|
1909
|
+
/** @description Details of the error returned. */
|
1910
|
+
requestBody: {
|
1911
|
+
content: {
|
1912
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
1913
|
+
};
|
2115
1914
|
};
|
2116
1915
|
responses: {
|
2117
1916
|
200: components["responses"]["200"];
|
@@ -2124,48 +1923,29 @@ export interface operations {
|
|
2124
1923
|
501: components["responses"]["501"];
|
2125
1924
|
503: components["responses"]["503"];
|
2126
1925
|
};
|
2127
|
-
/** Details of the error returned. */
|
2128
|
-
requestBody: {
|
2129
|
-
content: {
|
2130
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
2131
|
-
};
|
2132
|
-
};
|
2133
1926
|
};
|
2134
|
-
/**
|
1927
|
+
/**
|
1928
|
+
* Look up party information
|
1929
|
+
* @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`).
|
1930
|
+
*/
|
2135
1931
|
PartiesByTypeAndID: {
|
2136
1932
|
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
1933
|
header: {
|
2144
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2145
1934
|
"Content-Type": components["parameters"]["Content-Type"];
|
2146
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2147
1935
|
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
1936
|
"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
1937
|
"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
1938
|
"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
1939
|
"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
1940
|
"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
1941
|
"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
1942
|
"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
1943
|
Accept: components["parameters"]["Accept"];
|
2168
1944
|
};
|
1945
|
+
path: {
|
1946
|
+
Type: components["parameters"]["Type"];
|
1947
|
+
ID: components["parameters"]["ID"];
|
1948
|
+
};
|
2169
1949
|
};
|
2170
1950
|
responses: {
|
2171
1951
|
202: components["responses"]["202"];
|
@@ -2179,45 +1959,34 @@ export interface operations {
|
|
2179
1959
|
503: components["responses"]["503"];
|
2180
1960
|
};
|
2181
1961
|
};
|
2182
|
-
/**
|
1962
|
+
/**
|
1963
|
+
* Return party information
|
1964
|
+
* @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.
|
1965
|
+
*/
|
2183
1966
|
PartiesByTypeAndID2: {
|
2184
1967
|
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
1968
|
header: {
|
2192
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2193
1969
|
"Content-Type": components["parameters"]["Content-Type"];
|
2194
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2195
1970
|
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
1971
|
"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
1972
|
"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
1973
|
"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
1974
|
"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
1975
|
"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
1976
|
"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
1977
|
"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
1978
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2220
1979
|
};
|
1980
|
+
path: {
|
1981
|
+
Type: components["parameters"]["Type"];
|
1982
|
+
ID: components["parameters"]["ID"];
|
1983
|
+
};
|
1984
|
+
};
|
1985
|
+
/** @description Party information returned. */
|
1986
|
+
requestBody: {
|
1987
|
+
content: {
|
1988
|
+
"application/json": components["schemas"]["PartiesTypeIDPutResponse"];
|
1989
|
+
};
|
2221
1990
|
};
|
2222
1991
|
responses: {
|
2223
1992
|
200: components["responses"]["200"];
|
@@ -2230,52 +1999,35 @@ export interface operations {
|
|
2230
1999
|
501: components["responses"]["501"];
|
2231
2000
|
503: components["responses"]["503"];
|
2232
2001
|
};
|
2233
|
-
/** Party information returned. */
|
2234
|
-
requestBody: {
|
2235
|
-
content: {
|
2236
|
-
"application/json": components["schemas"]["PartiesTypeIDPutResponse"];
|
2237
|
-
};
|
2238
|
-
};
|
2239
2002
|
};
|
2240
|
-
/**
|
2003
|
+
/**
|
2004
|
+
* Return party information error
|
2005
|
+
* @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.
|
2006
|
+
*/
|
2241
2007
|
PartiesErrorByTypeAndID: {
|
2242
2008
|
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
2009
|
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
2010
|
"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
2011
|
"Content-Type": components["parameters"]["Content-Type"];
|
2258
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2259
2012
|
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
2013
|
"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
2014
|
"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
2015
|
"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
2016
|
"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
2017
|
"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
2018
|
"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
2019
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2278
2020
|
};
|
2021
|
+
path: {
|
2022
|
+
Type: components["parameters"]["Type"];
|
2023
|
+
ID: components["parameters"]["ID"];
|
2024
|
+
};
|
2025
|
+
};
|
2026
|
+
/** @description Details of the error returned. */
|
2027
|
+
requestBody: {
|
2028
|
+
content: {
|
2029
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
2030
|
+
};
|
2279
2031
|
};
|
2280
2032
|
responses: {
|
2281
2033
|
200: components["responses"]["200"];
|
@@ -2288,50 +2040,30 @@ export interface operations {
|
|
2288
2040
|
501: components["responses"]["501"];
|
2289
2041
|
503: components["responses"]["503"];
|
2290
2042
|
};
|
2291
|
-
/** Details of the error returned. */
|
2292
|
-
requestBody: {
|
2293
|
-
content: {
|
2294
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
2295
|
-
};
|
2296
|
-
};
|
2297
2043
|
};
|
2298
|
-
/**
|
2044
|
+
/**
|
2045
|
+
* Look up party information
|
2046
|
+
* @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`).
|
2047
|
+
*/
|
2299
2048
|
PartiesSubIdByTypeAndID: {
|
2300
2049
|
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
2050
|
header: {
|
2310
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2311
2051
|
"Content-Type": components["parameters"]["Content-Type"];
|
2312
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2313
2052
|
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
2053
|
"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
2054
|
"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
2055
|
"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
2056
|
"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
2057
|
"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
2058
|
"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
2059
|
"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
2060
|
Accept: components["parameters"]["Accept"];
|
2334
2061
|
};
|
2062
|
+
path: {
|
2063
|
+
Type: components["parameters"]["Type"];
|
2064
|
+
ID: components["parameters"]["ID"];
|
2065
|
+
SubId: components["parameters"]["SubId"];
|
2066
|
+
};
|
2335
2067
|
};
|
2336
2068
|
responses: {
|
2337
2069
|
202: components["responses"]["202"];
|
@@ -2345,47 +2077,35 @@ export interface operations {
|
|
2345
2077
|
503: components["responses"]["503"];
|
2346
2078
|
};
|
2347
2079
|
};
|
2348
|
-
/**
|
2080
|
+
/**
|
2081
|
+
* Return party information
|
2082
|
+
* @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.
|
2083
|
+
*/
|
2349
2084
|
PartiesSubIdByTypeAndIDPut: {
|
2350
2085
|
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
2086
|
header: {
|
2360
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2361
2087
|
"Content-Type": components["parameters"]["Content-Type"];
|
2362
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2363
2088
|
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
2089
|
"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
2090
|
"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
2091
|
"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
2092
|
"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
2093
|
"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
2094
|
"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
2095
|
"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
2096
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2388
2097
|
};
|
2098
|
+
path: {
|
2099
|
+
Type: components["parameters"]["Type"];
|
2100
|
+
ID: components["parameters"]["ID"];
|
2101
|
+
SubId: components["parameters"]["SubId"];
|
2102
|
+
};
|
2103
|
+
};
|
2104
|
+
/** @description Party information returned. */
|
2105
|
+
requestBody: {
|
2106
|
+
content: {
|
2107
|
+
"application/json": components["schemas"]["PartiesTypeIDPutResponse"];
|
2108
|
+
};
|
2389
2109
|
};
|
2390
2110
|
responses: {
|
2391
2111
|
200: components["responses"]["200"];
|
@@ -2398,54 +2118,36 @@ export interface operations {
|
|
2398
2118
|
501: components["responses"]["501"];
|
2399
2119
|
503: components["responses"]["503"];
|
2400
2120
|
};
|
2401
|
-
/** Party information returned. */
|
2402
|
-
requestBody: {
|
2403
|
-
content: {
|
2404
|
-
"application/json": components["schemas"]["PartiesTypeIDPutResponse"];
|
2405
|
-
};
|
2406
|
-
};
|
2407
2121
|
};
|
2408
|
-
/**
|
2122
|
+
/**
|
2123
|
+
* Return party information error
|
2124
|
+
* @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.
|
2125
|
+
*/
|
2409
2126
|
PartiesSubIdErrorByTypeAndID: {
|
2410
2127
|
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
2128
|
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
2129
|
"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
2130
|
"Content-Type": components["parameters"]["Content-Type"];
|
2428
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2429
2131
|
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
2132
|
"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
2133
|
"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
2134
|
"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
2135
|
"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
2136
|
"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
2137
|
"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
2138
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2448
2139
|
};
|
2140
|
+
path: {
|
2141
|
+
Type: components["parameters"]["Type"];
|
2142
|
+
ID: components["parameters"]["ID"];
|
2143
|
+
SubId: components["parameters"]["SubId"];
|
2144
|
+
};
|
2145
|
+
};
|
2146
|
+
/** @description Details of the error returned. */
|
2147
|
+
requestBody: {
|
2148
|
+
content: {
|
2149
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
2150
|
+
};
|
2449
2151
|
};
|
2450
2152
|
responses: {
|
2451
2153
|
200: components["responses"]["200"];
|
@@ -2458,49 +2160,33 @@ export interface operations {
|
|
2458
2160
|
501: components["responses"]["501"];
|
2459
2161
|
503: components["responses"]["503"];
|
2460
2162
|
};
|
2461
|
-
/** Details of the error returned. */
|
2462
|
-
requestBody: {
|
2463
|
-
content: {
|
2464
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
2465
|
-
};
|
2466
|
-
};
|
2467
2163
|
};
|
2468
|
-
/**
|
2164
|
+
/**
|
2165
|
+
* Perform transaction request
|
2166
|
+
* @description The HTTP request `POST /transactionRequests` is used to request the creation of a transaction request for the provided financial transaction in the server.
|
2167
|
+
*/
|
2469
2168
|
TransactionRequests: {
|
2470
2169
|
parameters: {
|
2471
2170
|
header: {
|
2472
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2473
2171
|
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
2172
|
"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
2173
|
"Content-Type": components["parameters"]["Content-Type"];
|
2482
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2483
2174
|
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
2175
|
"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
2176
|
"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
2177
|
"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
2178
|
"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
2179
|
"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
2180
|
"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
2181
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2502
2182
|
};
|
2503
2183
|
};
|
2184
|
+
/** @description Transaction request to be created. */
|
2185
|
+
requestBody: {
|
2186
|
+
content: {
|
2187
|
+
"application/json": components["schemas"]["TransactionRequestsPostRequest"];
|
2188
|
+
};
|
2189
|
+
};
|
2504
2190
|
responses: {
|
2505
2191
|
202: components["responses"]["202"];
|
2506
2192
|
400: components["responses"]["400"];
|
@@ -2512,46 +2198,28 @@ export interface operations {
|
|
2512
2198
|
501: components["responses"]["501"];
|
2513
2199
|
503: components["responses"]["503"];
|
2514
2200
|
};
|
2515
|
-
/** Transaction request to be created. */
|
2516
|
-
requestBody: {
|
2517
|
-
content: {
|
2518
|
-
"application/json": components["schemas"]["TransactionRequestsPostRequest"];
|
2519
|
-
};
|
2520
|
-
};
|
2521
2201
|
};
|
2522
|
-
/**
|
2202
|
+
/**
|
2203
|
+
* Retrieve transaction request information
|
2204
|
+
* @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.
|
2205
|
+
*/
|
2523
2206
|
TransactionRequestsByID: {
|
2524
2207
|
parameters: {
|
2525
|
-
path: {
|
2526
|
-
/** The identifier value. */
|
2527
|
-
ID: components["parameters"]["ID"];
|
2528
|
-
};
|
2529
2208
|
header: {
|
2530
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2531
2209
|
"Content-Type": components["parameters"]["Content-Type"];
|
2532
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2533
2210
|
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
2211
|
"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
2212
|
"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
2213
|
"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
2214
|
"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
2215
|
"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
2216
|
"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
2217
|
"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
2218
|
Accept: components["parameters"]["Accept"];
|
2554
2219
|
};
|
2220
|
+
path: {
|
2221
|
+
ID: components["parameters"]["ID"];
|
2222
|
+
};
|
2555
2223
|
};
|
2556
2224
|
responses: {
|
2557
2225
|
202: components["responses"]["202"];
|
@@ -2565,43 +2233,33 @@ export interface operations {
|
|
2565
2233
|
503: components["responses"]["503"];
|
2566
2234
|
};
|
2567
2235
|
};
|
2568
|
-
/**
|
2236
|
+
/**
|
2237
|
+
* Return transaction request information
|
2238
|
+
* @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}`.
|
2239
|
+
*/
|
2569
2240
|
TransactionRequestsByIDPut: {
|
2570
2241
|
parameters: {
|
2571
|
-
path: {
|
2572
|
-
/** The identifier value. */
|
2573
|
-
ID: components["parameters"]["ID"];
|
2574
|
-
};
|
2575
2242
|
header: {
|
2576
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2577
2243
|
"Content-Type": components["parameters"]["Content-Type"];
|
2578
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2579
2244
|
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
2245
|
"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
2246
|
"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
2247
|
"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
2248
|
"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
2249
|
"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
2250
|
"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
2251
|
"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
2252
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2604
2253
|
};
|
2254
|
+
path: {
|
2255
|
+
ID: components["parameters"]["ID"];
|
2256
|
+
};
|
2257
|
+
};
|
2258
|
+
/** @description Transaction request information returned. */
|
2259
|
+
requestBody: {
|
2260
|
+
content: {
|
2261
|
+
"application/json": components["schemas"]["TransactionRequestsIDPutResponse"];
|
2262
|
+
};
|
2605
2263
|
};
|
2606
2264
|
responses: {
|
2607
2265
|
200: components["responses"]["200"];
|
@@ -2614,50 +2272,34 @@ export interface operations {
|
|
2614
2272
|
501: components["responses"]["501"];
|
2615
2273
|
503: components["responses"]["503"];
|
2616
2274
|
};
|
2617
|
-
/** Transaction request information returned. */
|
2618
|
-
requestBody: {
|
2619
|
-
content: {
|
2620
|
-
"application/json": components["schemas"]["TransactionRequestsIDPutResponse"];
|
2621
|
-
};
|
2622
|
-
};
|
2623
2275
|
};
|
2624
|
-
/**
|
2276
|
+
/**
|
2277
|
+
* Return transaction request information error
|
2278
|
+
* @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}`.
|
2279
|
+
*/
|
2625
2280
|
TransactionRequestsErrorByID: {
|
2626
2281
|
parameters: {
|
2627
|
-
path: {
|
2628
|
-
/** The identifier value. */
|
2629
|
-
ID: components["parameters"]["ID"];
|
2630
|
-
};
|
2631
2282
|
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
2283
|
"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
2284
|
"Content-Type": components["parameters"]["Content-Type"];
|
2640
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2641
2285
|
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
2286
|
"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
2287
|
"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
2288
|
"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
2289
|
"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
2290
|
"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
2291
|
"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
2292
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2660
2293
|
};
|
2294
|
+
path: {
|
2295
|
+
ID: components["parameters"]["ID"];
|
2296
|
+
};
|
2297
|
+
};
|
2298
|
+
/** @description Details of the error returned. */
|
2299
|
+
requestBody: {
|
2300
|
+
content: {
|
2301
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
2302
|
+
};
|
2661
2303
|
};
|
2662
2304
|
responses: {
|
2663
2305
|
200: components["responses"]["200"];
|
@@ -2670,49 +2312,33 @@ export interface operations {
|
|
2670
2312
|
501: components["responses"]["501"];
|
2671
2313
|
503: components["responses"]["503"];
|
2672
2314
|
};
|
2673
|
-
/** Details of the error returned. */
|
2674
|
-
requestBody: {
|
2675
|
-
content: {
|
2676
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
2677
|
-
};
|
2678
|
-
};
|
2679
2315
|
};
|
2680
|
-
/**
|
2316
|
+
/**
|
2317
|
+
* Calculate quote
|
2318
|
+
* @description The HTTP request `POST /quotes` is used to request the creation of a quote for the provided financial transaction in the server.
|
2319
|
+
*/
|
2681
2320
|
Quotes: {
|
2682
2321
|
parameters: {
|
2683
2322
|
header: {
|
2684
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2685
2323
|
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
2324
|
"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
2325
|
"Content-Type": components["parameters"]["Content-Type"];
|
2694
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2695
2326
|
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
2327
|
"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
2328
|
"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
2329
|
"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
2330
|
"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
2331
|
"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
2332
|
"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
2333
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2714
2334
|
};
|
2715
2335
|
};
|
2336
|
+
/** @description Details of the quote to be created. */
|
2337
|
+
requestBody: {
|
2338
|
+
content: {
|
2339
|
+
"application/json": components["schemas"]["QuotesPostRequest"];
|
2340
|
+
};
|
2341
|
+
};
|
2716
2342
|
responses: {
|
2717
2343
|
202: components["responses"]["202"];
|
2718
2344
|
400: components["responses"]["400"];
|
@@ -2724,46 +2350,28 @@ export interface operations {
|
|
2724
2350
|
501: components["responses"]["501"];
|
2725
2351
|
503: components["responses"]["503"];
|
2726
2352
|
};
|
2727
|
-
/** Details of the quote to be created. */
|
2728
|
-
requestBody: {
|
2729
|
-
content: {
|
2730
|
-
"application/json": components["schemas"]["QuotesPostRequest"];
|
2731
|
-
};
|
2732
|
-
};
|
2733
2353
|
};
|
2734
|
-
/**
|
2354
|
+
/**
|
2355
|
+
* Retrieve quote information
|
2356
|
+
* @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.
|
2357
|
+
*/
|
2735
2358
|
QuotesByID: {
|
2736
2359
|
parameters: {
|
2737
|
-
path: {
|
2738
|
-
/** The identifier value. */
|
2739
|
-
ID: components["parameters"]["ID"];
|
2740
|
-
};
|
2741
2360
|
header: {
|
2742
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2743
2361
|
"Content-Type": components["parameters"]["Content-Type"];
|
2744
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2745
2362
|
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
2363
|
"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
2364
|
"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
2365
|
"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
2366
|
"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
2367
|
"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
2368
|
"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
2369
|
"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
2370
|
Accept: components["parameters"]["Accept"];
|
2766
2371
|
};
|
2372
|
+
path: {
|
2373
|
+
ID: components["parameters"]["ID"];
|
2374
|
+
};
|
2767
2375
|
};
|
2768
2376
|
responses: {
|
2769
2377
|
202: components["responses"]["202"];
|
@@ -2777,43 +2385,33 @@ export interface operations {
|
|
2777
2385
|
503: components["responses"]["503"];
|
2778
2386
|
};
|
2779
2387
|
};
|
2780
|
-
/**
|
2388
|
+
/**
|
2389
|
+
* Return quote information
|
2390
|
+
* @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.
|
2391
|
+
*/
|
2781
2392
|
QuotesByID1: {
|
2782
2393
|
parameters: {
|
2783
|
-
path: {
|
2784
|
-
/** The identifier value. */
|
2785
|
-
ID: components["parameters"]["ID"];
|
2786
|
-
};
|
2787
2394
|
header: {
|
2788
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2789
2395
|
"Content-Type": components["parameters"]["Content-Type"];
|
2790
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2791
2396
|
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
2397
|
"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
2398
|
"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
2399
|
"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
2400
|
"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
2401
|
"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
2402
|
"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
2403
|
"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
2404
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2816
2405
|
};
|
2406
|
+
path: {
|
2407
|
+
ID: components["parameters"]["ID"];
|
2408
|
+
};
|
2409
|
+
};
|
2410
|
+
/** @description Quote information returned. */
|
2411
|
+
requestBody: {
|
2412
|
+
content: {
|
2413
|
+
"application/json": components["schemas"]["QuotesIDPutResponse"];
|
2414
|
+
};
|
2817
2415
|
};
|
2818
2416
|
responses: {
|
2819
2417
|
200: components["responses"]["200"];
|
@@ -2826,50 +2424,34 @@ export interface operations {
|
|
2826
2424
|
501: components["responses"]["501"];
|
2827
2425
|
503: components["responses"]["503"];
|
2828
2426
|
};
|
2829
|
-
/** Quote information returned. */
|
2830
|
-
requestBody: {
|
2831
|
-
content: {
|
2832
|
-
"application/json": components["schemas"]["QuotesIDPutResponse"];
|
2833
|
-
};
|
2834
|
-
};
|
2835
2427
|
};
|
2836
|
-
/**
|
2428
|
+
/**
|
2429
|
+
* Return quote information error
|
2430
|
+
* @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.
|
2431
|
+
*/
|
2837
2432
|
QuotesByIDAndError: {
|
2838
2433
|
parameters: {
|
2839
|
-
path: {
|
2840
|
-
/** The identifier value. */
|
2841
|
-
ID: components["parameters"]["ID"];
|
2842
|
-
};
|
2843
2434
|
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
2435
|
"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
2436
|
"Content-Type": components["parameters"]["Content-Type"];
|
2852
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2853
2437
|
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
2438
|
"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
2439
|
"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
2440
|
"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
2441
|
"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
2442
|
"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
2443
|
"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
2444
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2872
2445
|
};
|
2446
|
+
path: {
|
2447
|
+
ID: components["parameters"]["ID"];
|
2448
|
+
};
|
2449
|
+
};
|
2450
|
+
/** @description Details of the error returned. */
|
2451
|
+
requestBody: {
|
2452
|
+
content: {
|
2453
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
2454
|
+
};
|
2873
2455
|
};
|
2874
2456
|
responses: {
|
2875
2457
|
200: components["responses"]["200"];
|
@@ -2882,15 +2464,10 @@ export interface operations {
|
|
2882
2464
|
501: components["responses"]["501"];
|
2883
2465
|
503: components["responses"]["503"];
|
2884
2466
|
};
|
2885
|
-
/** Details of the error returned. */
|
2886
|
-
requestBody: {
|
2887
|
-
content: {
|
2888
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
2889
|
-
};
|
2890
|
-
};
|
2891
2467
|
};
|
2892
2468
|
/**
|
2893
|
-
*
|
2469
|
+
* Perform authorization
|
2470
|
+
* @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
2471
|
*
|
2895
2472
|
* - `authenticationType={Type}`, where `{Type}` value is a valid authentication type from the enumeration `AuthenticationType`.
|
2896
2473
|
*
|
@@ -2906,36 +2483,21 @@ export interface operations {
|
|
2906
2483
|
*/
|
2907
2484
|
AuthorizationsByIDGet: {
|
2908
2485
|
parameters: {
|
2909
|
-
path: {
|
2910
|
-
/** The identifier value. */
|
2911
|
-
ID: components["parameters"]["ID"];
|
2912
|
-
};
|
2913
2486
|
header: {
|
2914
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2915
2487
|
"Content-Type": components["parameters"]["Content-Type"];
|
2916
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2917
2488
|
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
2489
|
"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
2490
|
"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
2491
|
"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
2492
|
"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
2493
|
"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
2494
|
"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
2495
|
"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
2496
|
Accept: components["parameters"]["Accept"];
|
2938
2497
|
};
|
2498
|
+
path: {
|
2499
|
+
ID: components["parameters"]["ID"];
|
2500
|
+
};
|
2939
2501
|
};
|
2940
2502
|
responses: {
|
2941
2503
|
202: components["responses"]["202"];
|
@@ -2949,43 +2511,33 @@ export interface operations {
|
|
2949
2511
|
503: components["responses"]["503"];
|
2950
2512
|
};
|
2951
2513
|
};
|
2952
|
-
/**
|
2514
|
+
/**
|
2515
|
+
* Return authorization result
|
2516
|
+
* @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.
|
2517
|
+
*/
|
2953
2518
|
AuthorizationsByIDPut: {
|
2954
2519
|
parameters: {
|
2955
|
-
path: {
|
2956
|
-
/** The identifier value. */
|
2957
|
-
ID: components["parameters"]["ID"];
|
2958
|
-
};
|
2959
2520
|
header: {
|
2960
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2961
2521
|
"Content-Type": components["parameters"]["Content-Type"];
|
2962
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
2963
2522
|
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
2523
|
"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
2524
|
"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
2525
|
"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
2526
|
"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
2527
|
"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
2528
|
"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
2529
|
"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
2530
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2988
2531
|
};
|
2532
|
+
path: {
|
2533
|
+
ID: components["parameters"]["ID"];
|
2534
|
+
};
|
2535
|
+
};
|
2536
|
+
/** @description Authorization result returned. */
|
2537
|
+
requestBody: {
|
2538
|
+
content: {
|
2539
|
+
"application/json": components["schemas"]["AuthorizationsIDPutResponse"];
|
2540
|
+
};
|
2989
2541
|
};
|
2990
2542
|
responses: {
|
2991
2543
|
200: components["responses"]["200"];
|
@@ -2998,50 +2550,34 @@ export interface operations {
|
|
2998
2550
|
501: components["responses"]["501"];
|
2999
2551
|
503: components["responses"]["503"];
|
3000
2552
|
};
|
3001
|
-
/** Authorization result returned. */
|
3002
|
-
requestBody: {
|
3003
|
-
content: {
|
3004
|
-
"application/json": components["schemas"]["AuthorizationsIDPutResponse"];
|
3005
|
-
};
|
3006
|
-
};
|
3007
2553
|
};
|
3008
|
-
/**
|
2554
|
+
/**
|
2555
|
+
* Return authorization error
|
2556
|
+
* @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}`.
|
2557
|
+
*/
|
3009
2558
|
AuthorizationsByIDAndError: {
|
3010
2559
|
parameters: {
|
3011
|
-
path: {
|
3012
|
-
/** The identifier value. */
|
3013
|
-
ID: components["parameters"]["ID"];
|
3014
|
-
};
|
3015
2560
|
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
2561
|
"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
2562
|
"Content-Type": components["parameters"]["Content-Type"];
|
3024
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3025
2563
|
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
2564
|
"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
2565
|
"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
2566
|
"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
2567
|
"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
2568
|
"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
2569
|
"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
2570
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3044
2571
|
};
|
2572
|
+
path: {
|
2573
|
+
ID: components["parameters"]["ID"];
|
2574
|
+
};
|
2575
|
+
};
|
2576
|
+
/** @description Details of the error returned. */
|
2577
|
+
requestBody: {
|
2578
|
+
content: {
|
2579
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
2580
|
+
};
|
3045
2581
|
};
|
3046
2582
|
responses: {
|
3047
2583
|
200: components["responses"]["200"];
|
@@ -3054,49 +2590,33 @@ export interface operations {
|
|
3054
2590
|
501: components["responses"]["501"];
|
3055
2591
|
503: components["responses"]["503"];
|
3056
2592
|
};
|
3057
|
-
/** Details of the error returned. */
|
3058
|
-
requestBody: {
|
3059
|
-
content: {
|
3060
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
3061
|
-
};
|
3062
|
-
};
|
3063
2593
|
};
|
3064
|
-
/**
|
2594
|
+
/**
|
2595
|
+
* Perform transfer
|
2596
|
+
* @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.
|
2597
|
+
*/
|
3065
2598
|
transfers: {
|
3066
2599
|
parameters: {
|
3067
2600
|
header: {
|
3068
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3069
2601
|
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
2602
|
"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
2603
|
"Content-Type": components["parameters"]["Content-Type"];
|
3078
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3079
2604
|
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
2605
|
"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
2606
|
"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
2607
|
"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
2608
|
"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
2609
|
"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
2610
|
"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
2611
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3098
2612
|
};
|
3099
2613
|
};
|
2614
|
+
/** @description Details of the transfer to be created. */
|
2615
|
+
requestBody: {
|
2616
|
+
content: {
|
2617
|
+
"application/json": components["schemas"]["TransfersPostRequest"];
|
2618
|
+
};
|
2619
|
+
};
|
3100
2620
|
responses: {
|
3101
2621
|
202: components["responses"]["202"];
|
3102
2622
|
400: components["responses"]["400"];
|
@@ -3108,46 +2628,28 @@ export interface operations {
|
|
3108
2628
|
501: components["responses"]["501"];
|
3109
2629
|
503: components["responses"]["503"];
|
3110
2630
|
};
|
3111
|
-
/** Details of the transfer to be created. */
|
3112
|
-
requestBody: {
|
3113
|
-
content: {
|
3114
|
-
"application/json": components["schemas"]["TransfersPostRequest"];
|
3115
|
-
};
|
3116
|
-
};
|
3117
2631
|
};
|
3118
|
-
/**
|
2632
|
+
/**
|
2633
|
+
* Retrieve transfer information
|
2634
|
+
* @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.
|
2635
|
+
*/
|
3119
2636
|
TransfersByIDGet: {
|
3120
2637
|
parameters: {
|
3121
|
-
path: {
|
3122
|
-
/** The identifier value. */
|
3123
|
-
ID: components["parameters"]["ID"];
|
3124
|
-
};
|
3125
2638
|
header: {
|
3126
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3127
2639
|
"Content-Type": components["parameters"]["Content-Type"];
|
3128
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3129
2640
|
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
2641
|
"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
2642
|
"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
2643
|
"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
2644
|
"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
2645
|
"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
2646
|
"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
2647
|
"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
2648
|
Accept: components["parameters"]["Accept"];
|
3150
2649
|
};
|
2650
|
+
path: {
|
2651
|
+
ID: components["parameters"]["ID"];
|
2652
|
+
};
|
3151
2653
|
};
|
3152
2654
|
responses: {
|
3153
2655
|
202: components["responses"]["202"];
|
@@ -3161,43 +2663,33 @@ export interface operations {
|
|
3161
2663
|
503: components["responses"]["503"];
|
3162
2664
|
};
|
3163
2665
|
};
|
3164
|
-
/**
|
2666
|
+
/**
|
2667
|
+
* Return transfer information
|
2668
|
+
* @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.
|
2669
|
+
*/
|
3165
2670
|
TransfersByIDPut: {
|
3166
2671
|
parameters: {
|
3167
|
-
path: {
|
3168
|
-
/** The identifier value. */
|
3169
|
-
ID: components["parameters"]["ID"];
|
3170
|
-
};
|
3171
2672
|
header: {
|
3172
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3173
2673
|
"Content-Type": components["parameters"]["Content-Type"];
|
3174
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3175
2674
|
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
2675
|
"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
2676
|
"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
2677
|
"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
2678
|
"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
2679
|
"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
2680
|
"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
2681
|
"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
2682
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3200
2683
|
};
|
2684
|
+
path: {
|
2685
|
+
ID: components["parameters"]["ID"];
|
2686
|
+
};
|
2687
|
+
};
|
2688
|
+
/** @description Transfer information returned. */
|
2689
|
+
requestBody: {
|
2690
|
+
content: {
|
2691
|
+
"application/json": components["schemas"]["TransfersIDPutResponse"];
|
2692
|
+
};
|
3201
2693
|
};
|
3202
2694
|
responses: {
|
3203
2695
|
200: components["responses"]["200"];
|
@@ -3210,50 +2702,34 @@ export interface operations {
|
|
3210
2702
|
501: components["responses"]["501"];
|
3211
2703
|
503: components["responses"]["503"];
|
3212
2704
|
};
|
3213
|
-
/** Transfer information returned. */
|
3214
|
-
requestBody: {
|
3215
|
-
content: {
|
3216
|
-
"application/json": components["schemas"]["TransfersIDPutResponse"];
|
3217
|
-
};
|
3218
|
-
};
|
3219
2705
|
};
|
3220
|
-
/**
|
2706
|
+
/**
|
2707
|
+
* Return transfer information
|
2708
|
+
* @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.
|
2709
|
+
*/
|
3221
2710
|
TransfersByIDPatch: {
|
3222
2711
|
parameters: {
|
3223
|
-
path: {
|
3224
|
-
/** The identifier value. */
|
3225
|
-
ID: components["parameters"]["ID"];
|
3226
|
-
};
|
3227
2712
|
header: {
|
3228
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3229
2713
|
"Content-Type": components["parameters"]["Content-Type"];
|
3230
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3231
2714
|
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
2715
|
"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
2716
|
"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
2717
|
"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
2718
|
"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
2719
|
"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
2720
|
"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
2721
|
"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
2722
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3256
2723
|
};
|
2724
|
+
path: {
|
2725
|
+
ID: components["parameters"]["ID"];
|
2726
|
+
};
|
2727
|
+
};
|
2728
|
+
/** @description Transfer notification upon completion. */
|
2729
|
+
requestBody: {
|
2730
|
+
content: {
|
2731
|
+
"application/json": components["schemas"]["TransfersIDPatchResponse"];
|
2732
|
+
};
|
3257
2733
|
};
|
3258
2734
|
responses: {
|
3259
2735
|
200: components["responses"]["200"];
|
@@ -3266,50 +2742,34 @@ export interface operations {
|
|
3266
2742
|
501: components["responses"]["501"];
|
3267
2743
|
503: components["responses"]["503"];
|
3268
2744
|
};
|
3269
|
-
/** Transfer notification upon completion. */
|
3270
|
-
requestBody: {
|
3271
|
-
content: {
|
3272
|
-
"application/json": components["schemas"]["TransfersIDPatchResponse"];
|
3273
|
-
};
|
3274
|
-
};
|
3275
2745
|
};
|
3276
|
-
/**
|
2746
|
+
/**
|
2747
|
+
* Return transfer information error
|
2748
|
+
* @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}`.
|
2749
|
+
*/
|
3277
2750
|
TransfersByIDAndError: {
|
3278
2751
|
parameters: {
|
3279
|
-
path: {
|
3280
|
-
/** The identifier value. */
|
3281
|
-
ID: components["parameters"]["ID"];
|
3282
|
-
};
|
3283
2752
|
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
2753
|
"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
2754
|
"Content-Type": components["parameters"]["Content-Type"];
|
3292
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3293
2755
|
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
2756
|
"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
2757
|
"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
2758
|
"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
2759
|
"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
2760
|
"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
2761
|
"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
2762
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3312
2763
|
};
|
2764
|
+
path: {
|
2765
|
+
ID: components["parameters"]["ID"];
|
2766
|
+
};
|
2767
|
+
};
|
2768
|
+
/** @description Details of the error returned. */
|
2769
|
+
requestBody: {
|
2770
|
+
content: {
|
2771
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
2772
|
+
};
|
3313
2773
|
};
|
3314
2774
|
responses: {
|
3315
2775
|
200: components["responses"]["200"];
|
@@ -3322,46 +2782,28 @@ export interface operations {
|
|
3322
2782
|
501: components["responses"]["501"];
|
3323
2783
|
503: components["responses"]["503"];
|
3324
2784
|
};
|
3325
|
-
/** Details of the error returned. */
|
3326
|
-
requestBody: {
|
3327
|
-
content: {
|
3328
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
3329
|
-
};
|
3330
|
-
};
|
3331
2785
|
};
|
3332
|
-
/**
|
2786
|
+
/**
|
2787
|
+
* Retrieve transaction information
|
2788
|
+
* @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).
|
2789
|
+
*/
|
3333
2790
|
TransactionsByID: {
|
3334
2791
|
parameters: {
|
3335
|
-
path: {
|
3336
|
-
/** The identifier value. */
|
3337
|
-
ID: components["parameters"]["ID"];
|
3338
|
-
};
|
3339
2792
|
header: {
|
3340
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3341
2793
|
"Content-Type": components["parameters"]["Content-Type"];
|
3342
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3343
2794
|
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
2795
|
"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
2796
|
"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
2797
|
"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
2798
|
"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
2799
|
"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
2800
|
"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
2801
|
"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
2802
|
Accept: components["parameters"]["Accept"];
|
3364
2803
|
};
|
2804
|
+
path: {
|
2805
|
+
ID: components["parameters"]["ID"];
|
2806
|
+
};
|
3365
2807
|
};
|
3366
2808
|
responses: {
|
3367
2809
|
202: components["responses"]["202"];
|
@@ -3375,43 +2817,33 @@ export interface operations {
|
|
3375
2817
|
503: components["responses"]["503"];
|
3376
2818
|
};
|
3377
2819
|
};
|
3378
|
-
/**
|
2820
|
+
/**
|
2821
|
+
* Return transaction information
|
2822
|
+
* @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.
|
2823
|
+
*/
|
3379
2824
|
TransactionsByID1: {
|
3380
2825
|
parameters: {
|
3381
|
-
path: {
|
3382
|
-
/** The identifier value. */
|
3383
|
-
ID: components["parameters"]["ID"];
|
3384
|
-
};
|
3385
2826
|
header: {
|
3386
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3387
2827
|
"Content-Type": components["parameters"]["Content-Type"];
|
3388
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3389
2828
|
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
2829
|
"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
2830
|
"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
2831
|
"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
2832
|
"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
2833
|
"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
2834
|
"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
2835
|
"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
2836
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3414
2837
|
};
|
2838
|
+
path: {
|
2839
|
+
ID: components["parameters"]["ID"];
|
2840
|
+
};
|
2841
|
+
};
|
2842
|
+
/** @description Transaction information returned. */
|
2843
|
+
requestBody: {
|
2844
|
+
content: {
|
2845
|
+
"application/json": components["schemas"]["TransactionsIDPutResponse"];
|
2846
|
+
};
|
3415
2847
|
};
|
3416
2848
|
responses: {
|
3417
2849
|
200: components["responses"]["200"];
|
@@ -3424,50 +2856,34 @@ export interface operations {
|
|
3424
2856
|
501: components["responses"]["501"];
|
3425
2857
|
503: components["responses"]["503"];
|
3426
2858
|
};
|
3427
|
-
/** Transaction information returned. */
|
3428
|
-
requestBody: {
|
3429
|
-
content: {
|
3430
|
-
"application/json": components["schemas"]["TransactionsIDPutResponse"];
|
3431
|
-
};
|
3432
|
-
};
|
3433
2859
|
};
|
3434
|
-
/**
|
2860
|
+
/**
|
2861
|
+
* Return transaction information error
|
2862
|
+
* @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.
|
2863
|
+
*/
|
3435
2864
|
TransactionsErrorByID: {
|
3436
2865
|
parameters: {
|
3437
|
-
path: {
|
3438
|
-
/** The identifier value. */
|
3439
|
-
ID: components["parameters"]["ID"];
|
3440
|
-
};
|
3441
2866
|
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
2867
|
"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
2868
|
"Content-Type": components["parameters"]["Content-Type"];
|
3450
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3451
2869
|
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
2870
|
"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
2871
|
"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
2872
|
"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
2873
|
"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
2874
|
"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
2875
|
"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
2876
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3470
2877
|
};
|
2878
|
+
path: {
|
2879
|
+
ID: components["parameters"]["ID"];
|
2880
|
+
};
|
2881
|
+
};
|
2882
|
+
/** @description Details of the error returned. */
|
2883
|
+
requestBody: {
|
2884
|
+
content: {
|
2885
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
2886
|
+
};
|
3471
2887
|
};
|
3472
2888
|
responses: {
|
3473
2889
|
200: components["responses"]["200"];
|
@@ -3480,49 +2896,33 @@ export interface operations {
|
|
3480
2896
|
501: components["responses"]["501"];
|
3481
2897
|
503: components["responses"]["503"];
|
3482
2898
|
};
|
3483
|
-
/** Details of the error returned. */
|
3484
|
-
requestBody: {
|
3485
|
-
content: {
|
3486
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
3487
|
-
};
|
3488
|
-
};
|
3489
2899
|
};
|
3490
|
-
/**
|
2900
|
+
/**
|
2901
|
+
* Calculate bulk quote
|
2902
|
+
* @description The HTTP request `POST /bulkQuotes` is used to request the creation of a bulk quote for the provided financial transactions in the server.
|
2903
|
+
*/
|
3491
2904
|
BulkQuotes: {
|
3492
2905
|
parameters: {
|
3493
2906
|
header: {
|
3494
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3495
2907
|
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
2908
|
"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
2909
|
"Content-Type": components["parameters"]["Content-Type"];
|
3504
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3505
2910
|
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
2911
|
"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
2912
|
"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
2913
|
"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
2914
|
"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
2915
|
"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
2916
|
"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
2917
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3524
2918
|
};
|
3525
2919
|
};
|
2920
|
+
/** @description Details of the bulk quote to be created. */
|
2921
|
+
requestBody: {
|
2922
|
+
content: {
|
2923
|
+
"application/json": components["schemas"]["BulkQuotesPostRequest"];
|
2924
|
+
};
|
2925
|
+
};
|
3526
2926
|
responses: {
|
3527
2927
|
202: components["responses"]["202"];
|
3528
2928
|
400: components["responses"]["400"];
|
@@ -3534,46 +2934,28 @@ export interface operations {
|
|
3534
2934
|
501: components["responses"]["501"];
|
3535
2935
|
503: components["responses"]["503"];
|
3536
2936
|
};
|
3537
|
-
/** Details of the bulk quote to be created. */
|
3538
|
-
requestBody: {
|
3539
|
-
content: {
|
3540
|
-
"application/json": components["schemas"]["BulkQuotesPostRequest"];
|
3541
|
-
};
|
3542
|
-
};
|
3543
2937
|
};
|
3544
|
-
/**
|
2938
|
+
/**
|
2939
|
+
* Retrieve bulk quote information
|
2940
|
+
* @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.
|
2941
|
+
*/
|
3545
2942
|
BulkQuotesByID: {
|
3546
2943
|
parameters: {
|
3547
|
-
path: {
|
3548
|
-
/** The identifier value. */
|
3549
|
-
ID: components["parameters"]["ID"];
|
3550
|
-
};
|
3551
2944
|
header: {
|
3552
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3553
2945
|
"Content-Type": components["parameters"]["Content-Type"];
|
3554
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3555
2946
|
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
2947
|
"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
2948
|
"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
2949
|
"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
2950
|
"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
2951
|
"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
2952
|
"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
2953
|
"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
2954
|
Accept: components["parameters"]["Accept"];
|
3576
2955
|
};
|
2956
|
+
path: {
|
2957
|
+
ID: components["parameters"]["ID"];
|
2958
|
+
};
|
3577
2959
|
};
|
3578
2960
|
responses: {
|
3579
2961
|
202: components["responses"]["202"];
|
@@ -3587,43 +2969,33 @@ export interface operations {
|
|
3587
2969
|
503: components["responses"]["503"];
|
3588
2970
|
};
|
3589
2971
|
};
|
3590
|
-
/**
|
2972
|
+
/**
|
2973
|
+
* Return bulk quote information
|
2974
|
+
* @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.
|
2975
|
+
*/
|
3591
2976
|
BulkQuotesByID1: {
|
3592
2977
|
parameters: {
|
3593
|
-
path: {
|
3594
|
-
/** The identifier value. */
|
3595
|
-
ID: components["parameters"]["ID"];
|
3596
|
-
};
|
3597
2978
|
header: {
|
3598
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3599
2979
|
"Content-Type": components["parameters"]["Content-Type"];
|
3600
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3601
2980
|
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
2981
|
"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
2982
|
"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
2983
|
"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
2984
|
"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
2985
|
"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
2986
|
"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
2987
|
"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
2988
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3626
2989
|
};
|
2990
|
+
path: {
|
2991
|
+
ID: components["parameters"]["ID"];
|
2992
|
+
};
|
2993
|
+
};
|
2994
|
+
/** @description Bulk quote information returned. */
|
2995
|
+
requestBody: {
|
2996
|
+
content: {
|
2997
|
+
"application/json": components["schemas"]["BulkQuotesIDPutResponse"];
|
2998
|
+
};
|
3627
2999
|
};
|
3628
3000
|
responses: {
|
3629
3001
|
200: components["responses"]["200"];
|
@@ -3636,50 +3008,34 @@ export interface operations {
|
|
3636
3008
|
501: components["responses"]["501"];
|
3637
3009
|
503: components["responses"]["503"];
|
3638
3010
|
};
|
3639
|
-
/** Bulk quote information returned. */
|
3640
|
-
requestBody: {
|
3641
|
-
content: {
|
3642
|
-
"application/json": components["schemas"]["BulkQuotesIDPutResponse"];
|
3643
|
-
};
|
3644
|
-
};
|
3645
3011
|
};
|
3646
|
-
/**
|
3012
|
+
/**
|
3013
|
+
* Return bulk quote information error
|
3014
|
+
* @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.
|
3015
|
+
*/
|
3647
3016
|
BulkQuotesErrorByID: {
|
3648
3017
|
parameters: {
|
3649
|
-
path: {
|
3650
|
-
/** The identifier value. */
|
3651
|
-
ID: components["parameters"]["ID"];
|
3652
|
-
};
|
3653
3018
|
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
3019
|
"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
3020
|
"Content-Type": components["parameters"]["Content-Type"];
|
3662
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3663
3021
|
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
3022
|
"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
3023
|
"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
3024
|
"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
3025
|
"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
3026
|
"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
3027
|
"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
3028
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3682
3029
|
};
|
3030
|
+
path: {
|
3031
|
+
ID: components["parameters"]["ID"];
|
3032
|
+
};
|
3033
|
+
};
|
3034
|
+
/** @description Details of the error returned. */
|
3035
|
+
requestBody: {
|
3036
|
+
content: {
|
3037
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
3038
|
+
};
|
3683
3039
|
};
|
3684
3040
|
responses: {
|
3685
3041
|
200: components["responses"]["200"];
|
@@ -3692,49 +3048,33 @@ export interface operations {
|
|
3692
3048
|
501: components["responses"]["501"];
|
3693
3049
|
503: components["responses"]["503"];
|
3694
3050
|
};
|
3695
|
-
/** Details of the error returned. */
|
3696
|
-
requestBody: {
|
3697
|
-
content: {
|
3698
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
3699
|
-
};
|
3700
|
-
};
|
3701
3051
|
};
|
3702
|
-
/**
|
3052
|
+
/**
|
3053
|
+
* Perform bulk transfer
|
3054
|
+
* @description The HTTP request `POST /bulkTransfers` is used to request the creation of a bulk transfer in the server.
|
3055
|
+
*/
|
3703
3056
|
BulkTransfers: {
|
3704
3057
|
parameters: {
|
3705
3058
|
header: {
|
3706
|
-
/** The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3707
3059
|
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
3060
|
"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
3061
|
"Content-Type": components["parameters"]["Content-Type"];
|
3716
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3717
3062
|
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
3063
|
"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
3064
|
"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
3065
|
"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
3066
|
"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
3067
|
"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
3068
|
"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
3069
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3736
3070
|
};
|
3737
3071
|
};
|
3072
|
+
/** @description Details of the bulk transfer to be created. */
|
3073
|
+
requestBody: {
|
3074
|
+
content: {
|
3075
|
+
"application/json": components["schemas"]["BulkTransfersPostRequest"];
|
3076
|
+
};
|
3077
|
+
};
|
3738
3078
|
responses: {
|
3739
3079
|
202: components["responses"]["202"];
|
3740
3080
|
400: components["responses"]["400"];
|
@@ -3746,46 +3086,28 @@ export interface operations {
|
|
3746
3086
|
501: components["responses"]["501"];
|
3747
3087
|
503: components["responses"]["503"];
|
3748
3088
|
};
|
3749
|
-
/** Details of the bulk transfer to be created. */
|
3750
|
-
requestBody: {
|
3751
|
-
content: {
|
3752
|
-
"application/json": components["schemas"]["BulkTransfersPostRequest"];
|
3753
|
-
};
|
3754
|
-
};
|
3755
3089
|
};
|
3756
|
-
/**
|
3090
|
+
/**
|
3091
|
+
* Retrieve bulk transfer information
|
3092
|
+
* @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.
|
3093
|
+
*/
|
3757
3094
|
BulkTransferByID: {
|
3758
3095
|
parameters: {
|
3759
|
-
path: {
|
3760
|
-
/** The identifier value. */
|
3761
|
-
ID: components["parameters"]["ID"];
|
3762
|
-
};
|
3763
3096
|
header: {
|
3764
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3765
3097
|
"Content-Type": components["parameters"]["Content-Type"];
|
3766
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3767
3098
|
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
3099
|
"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
3100
|
"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
3101
|
"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
3102
|
"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
3103
|
"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
3104
|
"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
3105
|
"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
3106
|
Accept: components["parameters"]["Accept"];
|
3788
3107
|
};
|
3108
|
+
path: {
|
3109
|
+
ID: components["parameters"]["ID"];
|
3110
|
+
};
|
3789
3111
|
};
|
3790
3112
|
responses: {
|
3791
3113
|
202: components["responses"]["202"];
|
@@ -3799,43 +3121,33 @@ export interface operations {
|
|
3799
3121
|
503: components["responses"]["503"];
|
3800
3122
|
};
|
3801
3123
|
};
|
3802
|
-
/**
|
3124
|
+
/**
|
3125
|
+
* Return bulk transfer information
|
3126
|
+
* @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.
|
3127
|
+
*/
|
3803
3128
|
BulkTransfersByIDPut: {
|
3804
3129
|
parameters: {
|
3805
|
-
path: {
|
3806
|
-
/** The identifier value. */
|
3807
|
-
ID: components["parameters"]["ID"];
|
3808
|
-
};
|
3809
3130
|
header: {
|
3810
|
-
/** The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3811
3131
|
"Content-Type": components["parameters"]["Content-Type"];
|
3812
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3813
3132
|
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
3133
|
"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
3134
|
"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
3135
|
"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
3136
|
"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
3137
|
"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
3138
|
"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
3139
|
"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
3140
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3838
3141
|
};
|
3142
|
+
path: {
|
3143
|
+
ID: components["parameters"]["ID"];
|
3144
|
+
};
|
3145
|
+
};
|
3146
|
+
/** @description Bulk transfer information returned. */
|
3147
|
+
requestBody: {
|
3148
|
+
content: {
|
3149
|
+
"application/json": components["schemas"]["BulkTransfersIDPutResponse"];
|
3150
|
+
};
|
3839
3151
|
};
|
3840
3152
|
responses: {
|
3841
3153
|
200: components["responses"]["200"];
|
@@ -3848,50 +3160,34 @@ export interface operations {
|
|
3848
3160
|
501: components["responses"]["501"];
|
3849
3161
|
503: components["responses"]["503"];
|
3850
3162
|
};
|
3851
|
-
/** Bulk transfer information returned. */
|
3852
|
-
requestBody: {
|
3853
|
-
content: {
|
3854
|
-
"application/json": components["schemas"]["BulkTransfersIDPutResponse"];
|
3855
|
-
};
|
3856
|
-
};
|
3857
3163
|
};
|
3858
|
-
/**
|
3164
|
+
/**
|
3165
|
+
* Return bulk transfer information error
|
3166
|
+
* @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.
|
3167
|
+
*/
|
3859
3168
|
BulkTransfersErrorByID: {
|
3860
3169
|
parameters: {
|
3861
|
-
path: {
|
3862
|
-
/** The identifier value. */
|
3863
|
-
ID: components["parameters"]["ID"];
|
3864
|
-
};
|
3865
3170
|
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
3171
|
"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
3172
|
"Content-Type": components["parameters"]["Content-Type"];
|
3874
|
-
/** The `Date` header field indicates the date when the request was sent. */
|
3875
3173
|
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
3174
|
"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
3175
|
"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
3176
|
"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
3177
|
"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
3178
|
"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
3179
|
"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
3180
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3894
3181
|
};
|
3182
|
+
path: {
|
3183
|
+
ID: components["parameters"]["ID"];
|
3184
|
+
};
|
3185
|
+
};
|
3186
|
+
/** @description Details of the error returned. */
|
3187
|
+
requestBody: {
|
3188
|
+
content: {
|
3189
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
3190
|
+
};
|
3895
3191
|
};
|
3896
3192
|
responses: {
|
3897
3193
|
200: components["responses"]["200"];
|
@@ -3904,13 +3200,5 @@ export interface operations {
|
|
3904
3200
|
501: components["responses"]["501"];
|
3905
3201
|
503: components["responses"]["503"];
|
3906
3202
|
};
|
3907
|
-
/** Details of the error returned. */
|
3908
|
-
requestBody: {
|
3909
|
-
content: {
|
3910
|
-
"application/json": components["schemas"]["ErrorInformationObject"];
|
3911
|
-
};
|
3912
|
-
};
|
3913
3203
|
};
|
3914
3204
|
}
|
3915
|
-
export interface external {
|
3916
|
-
}
|