@mojaloop/api-snippets 17.2.0 → 17.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +14 -0
- package/jest.config.js +2 -4
- package/lib/fspiop/v1_0/openapi.d.ts +791 -1490
- package/lib/fspiop/v1_1/openapi.d.ts +811 -1523
- package/lib/sdk-scheme-adapter/v2_0_0/backend/openapi.d.ts +189 -141
- package/lib/sdk-scheme-adapter/v2_0_0/backend/schemas.js +1 -1
- package/lib/sdk-scheme-adapter/v2_0_0/backend/schemas.js.map +1 -1
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/openapi.d.ts +218 -207
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/schemas.js +1 -1
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/schemas.js.map +1 -1
- package/lib/thirdparty/openapi.d.ts +655 -1454
- package/package.json +23 -33
|
@@ -4,69 +4,80 @@
|
|
|
4
4
|
*/
|
|
5
5
|
export interface paths {
|
|
6
6
|
"/": {
|
|
7
|
-
/**
|
|
7
|
+
/**
|
|
8
|
+
* Health check endpoint
|
|
9
|
+
* @description This endpoint allows a user of the SDK scheme adapter to check the outbound transfers service is listening.
|
|
10
|
+
*/
|
|
8
11
|
get: {
|
|
9
12
|
responses: {
|
|
10
|
-
/** Returns empty body if the scheme adapter outbound transfers service is running. */
|
|
11
|
-
200:
|
|
13
|
+
/** @description Returns empty body if the scheme adapter outbound transfers service is running. */
|
|
14
|
+
200: {
|
|
15
|
+
content: never;
|
|
16
|
+
};
|
|
12
17
|
};
|
|
13
18
|
};
|
|
14
19
|
};
|
|
15
20
|
"/accounts": {
|
|
16
21
|
/**
|
|
17
|
-
*
|
|
22
|
+
* Create accounts on the Account Lookup Service
|
|
23
|
+
* @description The HTTP request `POST /accounts` is used to create account information on the Account Lookup Service (ALS) regarding the provided list of identities.
|
|
18
24
|
*
|
|
19
25
|
* Caller DFSP is used as the account source FSP information
|
|
20
26
|
*/
|
|
21
27
|
post: {
|
|
28
|
+
/** @description Identities list request body */
|
|
29
|
+
requestBody: {
|
|
30
|
+
content: {
|
|
31
|
+
"application/json": components["schemas"]["accountsRequest"];
|
|
32
|
+
};
|
|
33
|
+
};
|
|
22
34
|
responses: {
|
|
23
35
|
200: components["responses"]["accountsCreationCompleted"];
|
|
24
36
|
400: components["responses"]["accountsCreationError"];
|
|
25
37
|
500: components["responses"]["accountsCreationError"];
|
|
26
38
|
504: components["responses"]["accountsCreationTimeout"];
|
|
27
39
|
};
|
|
28
|
-
/** Identities list request body */
|
|
29
|
-
requestBody: {
|
|
30
|
-
content: {
|
|
31
|
-
"application/json": components["schemas"]["accountsRequest"];
|
|
32
|
-
};
|
|
33
|
-
};
|
|
34
40
|
};
|
|
35
41
|
};
|
|
36
42
|
"/bulkQuotes": {
|
|
37
|
-
/**
|
|
43
|
+
/**
|
|
44
|
+
* Request bulk quotes for the provided financial transactions
|
|
45
|
+
* @description The HTTP request `POST /bulkQuotes` is used to request a bulk quote to fascilitate funds transfer from payer DFSP to payees' DFSP.
|
|
46
|
+
*/
|
|
38
47
|
post: {
|
|
48
|
+
/** @description Bulk quote request body */
|
|
49
|
+
requestBody: {
|
|
50
|
+
content: {
|
|
51
|
+
"application/json": components["schemas"]["bulkQuoteRequest"];
|
|
52
|
+
};
|
|
53
|
+
};
|
|
39
54
|
responses: {
|
|
40
55
|
200: components["responses"]["bulkQuoteSuccess"];
|
|
41
56
|
400: components["responses"]["bulkQuoteBadRequest"];
|
|
42
57
|
500: components["responses"]["bulkQuoteServerError"];
|
|
43
58
|
504: components["responses"]["bulkQuoteTimeout"];
|
|
44
59
|
};
|
|
45
|
-
/** Bulk quote request body */
|
|
46
|
-
requestBody: {
|
|
47
|
-
content: {
|
|
48
|
-
"application/json": components["schemas"]["bulkQuoteRequest"];
|
|
49
|
-
};
|
|
50
|
-
};
|
|
51
60
|
};
|
|
52
61
|
};
|
|
53
62
|
"/bulkQuotes/{bulkQuoteId}": {
|
|
54
|
-
/**
|
|
63
|
+
/**
|
|
64
|
+
* Retrieves information for a specific bulk quote
|
|
65
|
+
* @description The HTTP request `GET /bulkQuotes/{bulktQuoteId}` is used to get information regarding a bulk quote created or requested earlier. The `{bulkQuoteId}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote.
|
|
66
|
+
*/
|
|
55
67
|
get: {
|
|
56
68
|
parameters: {
|
|
57
69
|
path: {
|
|
58
|
-
/** Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request. */
|
|
59
70
|
bulkQuoteId: components["parameters"]["bulkQuoteId"];
|
|
60
71
|
};
|
|
61
72
|
};
|
|
62
73
|
responses: {
|
|
63
|
-
/** Bulk quote information successfully retrieved */
|
|
74
|
+
/** @description Bulk quote information successfully retrieved */
|
|
64
75
|
200: {
|
|
65
76
|
content: {
|
|
66
77
|
"application/json": components["schemas"]["bulkQuoteStatusResponse"];
|
|
67
78
|
};
|
|
68
79
|
};
|
|
69
|
-
/** An error occurred processing the bulk quote */
|
|
80
|
+
/** @description An error occurred processing the bulk quote */
|
|
70
81
|
500: {
|
|
71
82
|
content: {
|
|
72
83
|
"application/json": components["schemas"]["errorResponse"];
|
|
@@ -76,82 +87,94 @@ export interface paths {
|
|
|
76
87
|
};
|
|
77
88
|
};
|
|
78
89
|
"/bulkTransactions": {
|
|
79
|
-
/**
|
|
90
|
+
/**
|
|
91
|
+
* Sends money from one account to multiple accounts
|
|
92
|
+
* @description The HTTP request `POST /bulkTransactions` is used to request the movement of funds from payer DFSP to payees' DFSP.
|
|
93
|
+
*/
|
|
80
94
|
post: {
|
|
81
|
-
|
|
82
|
-
202: components["responses"]["bulkTransactionAccepted"];
|
|
83
|
-
400: components["responses"]["bulkTransferBadRequest"];
|
|
84
|
-
500: components["responses"]["errorResponse"];
|
|
85
|
-
};
|
|
86
|
-
/** Bulk transfer request body */
|
|
95
|
+
/** @description Bulk transfer request body */
|
|
87
96
|
requestBody: {
|
|
88
97
|
content: {
|
|
89
98
|
"application/json": components["schemas"]["bulkTransactionRequest"];
|
|
90
99
|
};
|
|
91
100
|
};
|
|
101
|
+
responses: {
|
|
102
|
+
202: components["responses"]["bulkTransactionAccepted"];
|
|
103
|
+
400: components["responses"]["bulkTransferBadRequest"];
|
|
104
|
+
500: components["responses"]["errorResponse"];
|
|
105
|
+
};
|
|
92
106
|
};
|
|
93
107
|
};
|
|
94
108
|
"/bulkTransactions/{bulkTransactionId}": {
|
|
95
|
-
/**
|
|
109
|
+
/**
|
|
110
|
+
* Amends the bulk transaction request
|
|
111
|
+
* @description The HTTP request `PUT /bulkTransactions/{bulkTransactionId}` is used to amend information regarding a bulk transaction, i.e. when autoAcceptParty or autoAcceptQuote is false then the payer need to provide confirmation to proceed with further processing of the request. The `{bulkTransactionId}` in the URI should contain the `bulkTransactionId` that was used for the creation of the bulk transfer.
|
|
112
|
+
*/
|
|
96
113
|
put: {
|
|
97
114
|
parameters: {
|
|
98
115
|
path: {
|
|
99
|
-
/** Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request. */
|
|
100
116
|
bulkTransactionId: components["parameters"]["bulkTransactionId"];
|
|
101
117
|
};
|
|
102
118
|
};
|
|
119
|
+
/** @description Bulk transaction request body */
|
|
120
|
+
requestBody: {
|
|
121
|
+
content: {
|
|
122
|
+
"application/json": components["schemas"]["bulkTransactionContinuationAcceptParty"] | components["schemas"]["bulkTransactionContinuationAcceptQuote"];
|
|
123
|
+
};
|
|
124
|
+
};
|
|
103
125
|
responses: {
|
|
104
|
-
/** Bulk transaction information successfully amended */
|
|
105
|
-
202:
|
|
126
|
+
/** @description Bulk transaction information successfully amended */
|
|
127
|
+
202: {
|
|
128
|
+
content: never;
|
|
129
|
+
};
|
|
106
130
|
400: components["responses"]["bulkTransactionPutBadRequest"];
|
|
107
|
-
/** An error occurred processing the bulk transaction */
|
|
131
|
+
/** @description An error occurred processing the bulk transaction */
|
|
108
132
|
500: {
|
|
109
133
|
content: {
|
|
110
134
|
"application/json": components["schemas"]["errorResponse"];
|
|
111
135
|
};
|
|
112
136
|
};
|
|
113
137
|
};
|
|
114
|
-
/** Bulk transaction request body */
|
|
115
|
-
requestBody: {
|
|
116
|
-
content: {
|
|
117
|
-
"application/json": components["schemas"]["bulkTransactionContinuationAcceptParty"] | components["schemas"]["bulkTransactionContinuationAcceptQuote"];
|
|
118
|
-
};
|
|
119
|
-
};
|
|
120
138
|
};
|
|
121
139
|
};
|
|
122
140
|
"/bulkTransfers": {
|
|
123
|
-
/**
|
|
141
|
+
/**
|
|
142
|
+
* Sends money from one account to multiple accounts
|
|
143
|
+
* @description The HTTP request `POST /bulkTransfers` is used to request the movement of funds from payer DFSP to payees' DFSP.
|
|
144
|
+
*/
|
|
124
145
|
post: {
|
|
125
|
-
|
|
126
|
-
200: components["responses"]["bulkTransferSuccess"];
|
|
127
|
-
400: components["responses"]["bulkTransferBadRequest"];
|
|
128
|
-
500: components["responses"]["errorResponse"];
|
|
129
|
-
};
|
|
130
|
-
/** Bulk transfer request body */
|
|
146
|
+
/** @description Bulk transfer request body */
|
|
131
147
|
requestBody: {
|
|
132
148
|
content: {
|
|
133
149
|
"application/json": components["schemas"]["bulkTransferRequest"];
|
|
134
150
|
};
|
|
135
151
|
};
|
|
152
|
+
responses: {
|
|
153
|
+
200: components["responses"]["bulkTransferSuccess"];
|
|
154
|
+
400: components["responses"]["bulkTransferBadRequest"];
|
|
155
|
+
500: components["responses"]["errorResponse"];
|
|
156
|
+
};
|
|
136
157
|
};
|
|
137
158
|
};
|
|
138
159
|
"/bulkTransfers/{bulkTransferId}": {
|
|
139
|
-
/**
|
|
160
|
+
/**
|
|
161
|
+
* Retrieves information for a specific bulk transfer
|
|
162
|
+
* @description The HTTP request `GET /bulkTransfers/{bulkTransferId}` is used to get information regarding a bulk transfer created or requested earlier. The `{bulkTransferId}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer.
|
|
163
|
+
*/
|
|
140
164
|
get: {
|
|
141
165
|
parameters: {
|
|
142
166
|
path: {
|
|
143
|
-
/** Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request. */
|
|
144
167
|
bulkTransferId: components["parameters"]["bulkTransferId"];
|
|
145
168
|
};
|
|
146
169
|
};
|
|
147
170
|
responses: {
|
|
148
|
-
/** Bulk transfer information successfully retrieved */
|
|
171
|
+
/** @description Bulk transfer information successfully retrieved */
|
|
149
172
|
200: {
|
|
150
173
|
content: {
|
|
151
174
|
"application/json": components["schemas"]["bulkTransferStatusResponse"];
|
|
152
175
|
};
|
|
153
176
|
};
|
|
154
|
-
/** An error occurred processing the bulk transfer */
|
|
177
|
+
/** @description An error occurred processing the bulk transfer */
|
|
155
178
|
500: {
|
|
156
179
|
content: {
|
|
157
180
|
"application/json": components["schemas"]["errorResponse"];
|
|
@@ -161,83 +184,89 @@ export interface paths {
|
|
|
161
184
|
};
|
|
162
185
|
};
|
|
163
186
|
"/parties/{Type}/{ID}": {
|
|
164
|
-
/**
|
|
187
|
+
/**
|
|
188
|
+
* PartiesByTypeAndID
|
|
189
|
+
* @description The HTTP request GET /parties// (or GET /parties///) is used to lookup information regarding the requested Party, defined by , and optionally (for example, GET /parties/MSISDN/123456789, or GET /parties/BUSINESS/shoecompany/employee1).
|
|
190
|
+
*/
|
|
165
191
|
get: operations["PartiesByTypeAndID"];
|
|
166
192
|
parameters: {
|
|
167
193
|
path: {
|
|
168
|
-
/** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
|
169
194
|
Type: components["parameters"]["Type"];
|
|
170
|
-
/** The identifier value. */
|
|
171
195
|
ID: components["parameters"]["ID"];
|
|
172
196
|
};
|
|
173
197
|
};
|
|
174
198
|
};
|
|
175
199
|
"/parties/{Type}/{ID}/{SubId}": {
|
|
176
|
-
/**
|
|
200
|
+
/**
|
|
201
|
+
* PartiesSubIdByTypeAndID
|
|
202
|
+
* @description The HTTP request GET /parties// (or GET /parties///) is used to lookup information regarding the requested Party, defined by , and optionally (for example, GET /parties/MSISDN/123456789, or GET /parties/BUSINESS/shoecompany/employee1).
|
|
203
|
+
*/
|
|
177
204
|
get: operations["PartiesSubIdByTypeAndID"];
|
|
178
205
|
parameters: {
|
|
179
206
|
path: {
|
|
180
|
-
/** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
|
181
207
|
Type: components["parameters"]["Type"];
|
|
182
|
-
/** The identifier value. */
|
|
183
208
|
ID: components["parameters"]["ID"];
|
|
184
|
-
/** A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
|
185
209
|
SubId: components["parameters"]["SubId"];
|
|
186
210
|
};
|
|
187
211
|
};
|
|
188
212
|
};
|
|
189
213
|
"/quotes": {
|
|
190
|
-
/**
|
|
214
|
+
/**
|
|
215
|
+
* Quotes endpoint
|
|
216
|
+
* @description is used to request quotes from other DFSP
|
|
217
|
+
*/
|
|
191
218
|
post: operations["QuotesPost"];
|
|
192
219
|
};
|
|
193
220
|
"/requestToPay": {
|
|
194
221
|
/**
|
|
195
|
-
*
|
|
222
|
+
* Receiver requesting funds from Sender
|
|
223
|
+
* @description The HTTP request `POST /requestToPay` is used to support Pull Funds pattern where in a receiver can request for funds from the Sender.
|
|
196
224
|
* The underlying API has two stages:
|
|
197
225
|
*
|
|
198
226
|
* 1. Party lookup. This facilitates a check by the sending party that the destination party is correct before proceeding with a money movement.
|
|
199
227
|
* 2. Transaction Request. This request enables a Payee to request Payer to send electronic funds to the Payee.
|
|
200
228
|
*/
|
|
201
229
|
post: {
|
|
202
|
-
|
|
203
|
-
200: components["responses"]["requestToPaySuccess"];
|
|
204
|
-
};
|
|
205
|
-
/** RequestToPay request body */
|
|
230
|
+
/** @description RequestToPay request body */
|
|
206
231
|
requestBody: {
|
|
207
232
|
content: {
|
|
208
233
|
"application/json": components["schemas"]["requestToPayRequest"];
|
|
209
234
|
};
|
|
210
235
|
};
|
|
236
|
+
responses: {
|
|
237
|
+
200: components["responses"]["requestToPaySuccess"];
|
|
238
|
+
};
|
|
211
239
|
};
|
|
212
240
|
};
|
|
213
241
|
"/requestToPay/{transactionRequestId}": {
|
|
214
242
|
/**
|
|
215
|
-
*
|
|
243
|
+
* Continues a request funds from sender that has paused at the party resolution stage in order to accept or reject party information
|
|
244
|
+
* @description The HTTP request `PUT /requestToPay/{transactionRequestId}` is used to continue a transfer initiated via the `POST /requestToPay` method that has halted after party lookup stage.
|
|
216
245
|
* The request body should contain the "acceptParty" property set to `true` as required to continue the transfer.
|
|
217
246
|
* See the description of the `POST /requestToPay` HTTP method for more information on modes of transfer.
|
|
218
247
|
*/
|
|
219
248
|
put: {
|
|
220
249
|
parameters: {
|
|
221
250
|
path: {
|
|
222
|
-
/** Identifier of the merchant request to pay to continue as returned in the response to a `POST /requestToPay` request. */
|
|
223
251
|
transactionRequestId: components["parameters"]["transactionRequestId"];
|
|
224
252
|
};
|
|
225
253
|
};
|
|
254
|
+
requestBody?: {
|
|
255
|
+
content: {
|
|
256
|
+
"application/json": components["schemas"]["transferContinuationAcceptParty"];
|
|
257
|
+
};
|
|
258
|
+
};
|
|
226
259
|
responses: {
|
|
227
260
|
200: components["responses"]["requestToPaySuccess"];
|
|
228
261
|
500: components["responses"]["transferServerError"];
|
|
229
262
|
504: components["responses"]["transferTimeout"];
|
|
230
263
|
};
|
|
231
|
-
requestBody: {
|
|
232
|
-
content: {
|
|
233
|
-
"application/json": components["schemas"]["transferContinuationAcceptParty"];
|
|
234
|
-
};
|
|
235
|
-
};
|
|
236
264
|
};
|
|
237
265
|
};
|
|
238
266
|
"/requestToPayTransfer": {
|
|
239
267
|
/**
|
|
240
|
-
*
|
|
268
|
+
* Used to trigger funds from customer fsp account to merchant fsp account. This is a follow-up request to requestToPay.
|
|
269
|
+
* @description The HTTP request `POST /requestToPayTransfer` is used to request the movement of funds from payer DFSP to payee DFSP.
|
|
241
270
|
* The underlying Mojaloop API has three stages for money transfer:
|
|
242
271
|
*
|
|
243
272
|
* 1. Quotation. This facilitates the exchange of fee information and the construction of a cryptographic "contract" between payee and payer DFSPs before funds are transferred.
|
|
@@ -258,23 +287,24 @@ export interface paths {
|
|
|
258
287
|
* Combinations of settings for `AUTO_ACCEPT...` configuration variables allow the scheme adapter user to decide which mode of operation best suits their use cases. i.e. the scheme adapter can be configured to "break" the three stage transfer at these points in order to execute backend logic such as party verification, quoted fees assessments etc...
|
|
259
288
|
*/
|
|
260
289
|
post: {
|
|
290
|
+
/** @description Request To Pay Transfer request body */
|
|
291
|
+
requestBody: {
|
|
292
|
+
content: {
|
|
293
|
+
"application/json": components["schemas"]["requestToPayTransferRequest"];
|
|
294
|
+
};
|
|
295
|
+
};
|
|
261
296
|
responses: {
|
|
262
297
|
200: components["responses"]["requestToPayTransferSuccess"];
|
|
263
298
|
400: components["responses"]["requestToPayTransferBadRequest"];
|
|
264
299
|
500: components["responses"]["transferServerError"];
|
|
265
300
|
504: components["responses"]["transferTimeout"];
|
|
266
301
|
};
|
|
267
|
-
/** Request To Pay Transfer request body */
|
|
268
|
-
requestBody: {
|
|
269
|
-
content: {
|
|
270
|
-
"application/json": components["schemas"]["requestToPayTransferRequest"];
|
|
271
|
-
};
|
|
272
|
-
};
|
|
273
302
|
};
|
|
274
303
|
};
|
|
275
304
|
"/requestToPayTransfer/{transactionRequestId}": {
|
|
276
305
|
/**
|
|
277
|
-
*
|
|
306
|
+
* Continues a transfer that has paused at the otp stage in order to accept or reject quote
|
|
307
|
+
* @description This request is used to continue a requestToPayTransfer initiated via the `POST /requestToPayTransfer` method that has halted after quotation stage and/or otp stage.
|
|
278
308
|
*
|
|
279
309
|
* The request body should contain either the "acceptOTP" or "acceptQuote" property set to `true` as required to continue the transfer.
|
|
280
310
|
*
|
|
@@ -283,29 +313,32 @@ export interface paths {
|
|
|
283
313
|
put: {
|
|
284
314
|
parameters: {
|
|
285
315
|
path: {
|
|
286
|
-
/** Identifier of the merchant request to pay to continue as returned in the response to a `POST /requestToPay` request. */
|
|
287
316
|
transactionRequestId: components["parameters"]["transactionRequestId"];
|
|
288
317
|
};
|
|
289
318
|
};
|
|
319
|
+
requestBody?: {
|
|
320
|
+
content: {
|
|
321
|
+
"application/json": components["schemas"]["transferContinuationAcceptQuote"] | components["schemas"]["transferContinuationAcceptOTP"];
|
|
322
|
+
};
|
|
323
|
+
};
|
|
290
324
|
responses: {
|
|
291
325
|
200: components["responses"]["transferSuccess"];
|
|
292
326
|
500: components["responses"]["transferServerError"];
|
|
293
327
|
504: components["responses"]["transferTimeout"];
|
|
294
328
|
};
|
|
295
|
-
requestBody: {
|
|
296
|
-
content: {
|
|
297
|
-
"application/json": components["schemas"]["transferContinuationAcceptQuote"] | components["schemas"]["transferContinuationAcceptOTP"];
|
|
298
|
-
};
|
|
299
|
-
};
|
|
300
329
|
};
|
|
301
330
|
};
|
|
302
331
|
"/simpleTransfers": {
|
|
303
|
-
/**
|
|
332
|
+
/**
|
|
333
|
+
* Simple Transfers endpoint
|
|
334
|
+
* @description is used to request a transfer
|
|
335
|
+
*/
|
|
304
336
|
post: operations["SimpleTransfersPost"];
|
|
305
337
|
};
|
|
306
338
|
"/transfers": {
|
|
307
339
|
/**
|
|
308
|
-
*
|
|
340
|
+
* Sends money from one account to another
|
|
341
|
+
* @description The HTTP request `POST /transfers` is used to request the movement of funds from payer DFSP to payee DFSP.
|
|
309
342
|
* The underlying Mojaloop API has three stages for money transfer:
|
|
310
343
|
*
|
|
311
344
|
* 1. Party lookup. This facilitates a check by the sending party that the destination party is correct before proceeding with a money movement.
|
|
@@ -326,37 +359,39 @@ export interface paths {
|
|
|
326
359
|
* Combinations of settings for `AUTO_ACCEPT...` configuration variables allow the scheme adapter user to decide which mode of operation best suits their use cases. i.e. the scheme adapter can be configured to "break" the three stage transfer at these points in order to execute backend logic such as party verification, quoted fees assessments etc...
|
|
327
360
|
*/
|
|
328
361
|
post: {
|
|
362
|
+
/** @description Transfer request body */
|
|
363
|
+
requestBody: {
|
|
364
|
+
content: {
|
|
365
|
+
"application/json": components["schemas"]["transferRequest"];
|
|
366
|
+
};
|
|
367
|
+
};
|
|
329
368
|
responses: {
|
|
330
369
|
200: components["responses"]["transferSuccess"];
|
|
331
370
|
400: components["responses"]["transferBadRequest"];
|
|
332
371
|
500: components["responses"]["transferServerError"];
|
|
333
372
|
504: components["responses"]["transferTimeout"];
|
|
334
373
|
};
|
|
335
|
-
/** Transfer request body */
|
|
336
|
-
requestBody: {
|
|
337
|
-
content: {
|
|
338
|
-
"application/json": components["schemas"]["transferRequest"];
|
|
339
|
-
};
|
|
340
|
-
};
|
|
341
374
|
};
|
|
342
375
|
};
|
|
343
376
|
"/transfers/{transferId}": {
|
|
344
|
-
/**
|
|
377
|
+
/**
|
|
378
|
+
* Retrieves information for a specific transfer
|
|
379
|
+
* @description The HTTP request `GET /transfers/{transferId}` is used to get information regarding a transfer created or requested earlier. The `{transferId}` in the URI should contain the `transferId` that was used for the creation of the transfer.
|
|
380
|
+
*/
|
|
345
381
|
get: {
|
|
346
382
|
parameters: {
|
|
347
383
|
path: {
|
|
348
|
-
/** Identifier of the transfer to continue as returned in the response to a `POST /transfers` request. */
|
|
349
384
|
transferId: components["parameters"]["transferId"];
|
|
350
385
|
};
|
|
351
386
|
};
|
|
352
387
|
responses: {
|
|
353
|
-
/** Transfer information successfully retrieved */
|
|
388
|
+
/** @description Transfer information successfully retrieved */
|
|
354
389
|
200: {
|
|
355
390
|
content: {
|
|
356
391
|
"application/json": components["schemas"]["transferStatusResponse"];
|
|
357
392
|
};
|
|
358
393
|
};
|
|
359
|
-
/** An error occurred processing the transfer */
|
|
394
|
+
/** @description An error occurred processing the transfer */
|
|
360
395
|
500: {
|
|
361
396
|
content: {
|
|
362
397
|
"application/json": components["schemas"]["errorResponse"];
|
|
@@ -365,7 +400,8 @@ export interface paths {
|
|
|
365
400
|
};
|
|
366
401
|
};
|
|
367
402
|
/**
|
|
368
|
-
*
|
|
403
|
+
* Continues a transfer that has paused at the quote stage in order to accept or reject payee party and/or quote
|
|
404
|
+
* @description The HTTP request `PUT /transfers/{transferId}` is used to continue a transfer initiated via the `POST /transfers` method that has halted after party lookup and/or quotation stage.
|
|
369
405
|
*
|
|
370
406
|
* The request body should contain either the "acceptParty" or "acceptQuote" property set to `true` as required to continue the transfer.
|
|
371
407
|
*
|
|
@@ -374,23 +410,23 @@ export interface paths {
|
|
|
374
410
|
put: {
|
|
375
411
|
parameters: {
|
|
376
412
|
path: {
|
|
377
|
-
/** Identifier of the transfer to continue as returned in the response to a `POST /transfers` request. */
|
|
378
413
|
transferId: components["parameters"]["transferId"];
|
|
379
414
|
};
|
|
380
415
|
};
|
|
416
|
+
requestBody?: {
|
|
417
|
+
content: {
|
|
418
|
+
"application/json": components["schemas"]["transferContinuationAcceptParty"] | components["schemas"]["transferContinuationAcceptQuote"];
|
|
419
|
+
};
|
|
420
|
+
};
|
|
381
421
|
responses: {
|
|
382
422
|
200: components["responses"]["transferSuccess"];
|
|
383
423
|
500: components["responses"]["transferServerError"];
|
|
384
424
|
504: components["responses"]["transferTimeout"];
|
|
385
425
|
};
|
|
386
|
-
requestBody: {
|
|
387
|
-
content: {
|
|
388
|
-
"application/json": components["schemas"]["transferContinuationAcceptParty"] | components["schemas"]["transferContinuationAcceptQuote"];
|
|
389
|
-
};
|
|
390
|
-
};
|
|
391
426
|
};
|
|
392
427
|
};
|
|
393
428
|
}
|
|
429
|
+
export type webhooks = Record<string, never>;
|
|
394
430
|
export interface components {
|
|
395
431
|
schemas: {
|
|
396
432
|
/**
|
|
@@ -512,12 +548,8 @@ export interface components {
|
|
|
512
548
|
currentState?: components["schemas"]["accountsCreationState"];
|
|
513
549
|
lastError?: components["schemas"]["transferError"];
|
|
514
550
|
postAccountsResponse?: {
|
|
515
|
-
body:
|
|
516
|
-
|
|
517
|
-
};
|
|
518
|
-
headers?: {
|
|
519
|
-
[key: string]: unknown;
|
|
520
|
-
};
|
|
551
|
+
body: Record<string, never>;
|
|
552
|
+
headers?: Record<string, never>;
|
|
521
553
|
};
|
|
522
554
|
};
|
|
523
555
|
errorAccountsResponse: components["schemas"]["errorResponse"] & {
|
|
@@ -897,13 +929,11 @@ export interface components {
|
|
|
897
929
|
httpStatusCode?: number;
|
|
898
930
|
mojaloopError?: components["schemas"]["mojaloopError"];
|
|
899
931
|
};
|
|
900
|
-
bulkTransactionAcceptPartyErrorResponse: components["schemas"]["errorResponse"] & {
|
|
932
|
+
bulkTransactionAcceptPartyErrorResponse: components["schemas"]["errorResponse"] & ({
|
|
901
933
|
bulkTransferState: components["schemas"]["bulkTransactionContinuationAcceptParty"] & components["schemas"]["partyError"];
|
|
902
|
-
};
|
|
934
|
+
});
|
|
903
935
|
bulkTransactionAcceptQuoteErrorResponse: components["schemas"]["errorResponse"] & ({
|
|
904
936
|
bulkTransferState?: components["schemas"]["bulkTransactionContinuationAcceptQuote"] & components["schemas"]["quoteError"];
|
|
905
|
-
} & {
|
|
906
|
-
bulkTansferState: unknown;
|
|
907
937
|
});
|
|
908
938
|
/**
|
|
909
939
|
* IndividualTransfer
|
|
@@ -952,9 +982,7 @@ export interface components {
|
|
|
952
982
|
party: {
|
|
953
983
|
/** @description Information regarding the requested Party. */
|
|
954
984
|
body: components["schemas"]["Party"];
|
|
955
|
-
headers:
|
|
956
|
-
[key: string]: unknown;
|
|
957
|
-
};
|
|
985
|
+
headers: Record<string, never>;
|
|
958
986
|
};
|
|
959
987
|
currentState: components["schemas"]["async2SyncCurrentState"];
|
|
960
988
|
};
|
|
@@ -1058,15 +1086,11 @@ export interface components {
|
|
|
1058
1086
|
condition: components["schemas"]["IlpCondition"];
|
|
1059
1087
|
extensionList?: components["schemas"]["ExtensionList"];
|
|
1060
1088
|
};
|
|
1061
|
-
headers:
|
|
1062
|
-
[key: string]: unknown;
|
|
1063
|
-
};
|
|
1089
|
+
headers: Record<string, never>;
|
|
1064
1090
|
};
|
|
1065
1091
|
currentState: components["schemas"]["async2SyncCurrentState"];
|
|
1066
1092
|
};
|
|
1067
|
-
errorQuotesResponse: components["schemas"]["errorResponse"] &
|
|
1068
|
-
[key: string]: unknown;
|
|
1069
|
-
};
|
|
1093
|
+
errorQuotesResponse: components["schemas"]["errorResponse"] & Record<string, never>;
|
|
1070
1094
|
/**
|
|
1071
1095
|
* AuthenticationType
|
|
1072
1096
|
* @description Below are the allowed values for the enumeration AuthenticationType.
|
|
@@ -1098,9 +1122,7 @@ export interface components {
|
|
|
1098
1122
|
getPartiesResponse: {
|
|
1099
1123
|
/** @description Information regarding the requested Party. */
|
|
1100
1124
|
body: components["schemas"]["Party"];
|
|
1101
|
-
headers:
|
|
1102
|
-
[key: string]: unknown;
|
|
1103
|
-
};
|
|
1125
|
+
headers: Record<string, never>;
|
|
1104
1126
|
};
|
|
1105
1127
|
/**
|
|
1106
1128
|
* TransactionRequestState
|
|
@@ -1123,9 +1145,7 @@ export interface components {
|
|
|
1123
1145
|
transactionRequestState: components["schemas"]["TransactionRequestState"];
|
|
1124
1146
|
extensionList?: components["schemas"]["ExtensionList"];
|
|
1125
1147
|
};
|
|
1126
|
-
headers:
|
|
1127
|
-
[key: string]: unknown;
|
|
1128
|
-
};
|
|
1148
|
+
headers: Record<string, never>;
|
|
1129
1149
|
};
|
|
1130
1150
|
requestToPayResponse: {
|
|
1131
1151
|
transactionRequestId: components["schemas"]["CorrelationId"];
|
|
@@ -1184,26 +1204,18 @@ export interface components {
|
|
|
1184
1204
|
currentState?: components["schemas"]["transferStatus"];
|
|
1185
1205
|
quoteId?: components["schemas"]["CorrelationId"];
|
|
1186
1206
|
getPartiesResponse?: {
|
|
1187
|
-
body:
|
|
1188
|
-
|
|
1189
|
-
};
|
|
1190
|
-
headers?: {
|
|
1191
|
-
[key: string]: unknown;
|
|
1192
|
-
};
|
|
1207
|
+
body: Record<string, never>;
|
|
1208
|
+
headers?: Record<string, never>;
|
|
1193
1209
|
};
|
|
1194
1210
|
quoteResponse?: {
|
|
1195
1211
|
body: components["schemas"]["QuotesIDPutResponse"];
|
|
1196
|
-
headers?:
|
|
1197
|
-
[key: string]: unknown;
|
|
1198
|
-
};
|
|
1212
|
+
headers?: Record<string, never>;
|
|
1199
1213
|
};
|
|
1200
1214
|
/** @description FSPID of the entity that supplied the quote response. This may not be the same as the FSPID of the entity which owns the end user account in the case of a FOREX transfer. i.e. it may be a FOREX gateway. */
|
|
1201
1215
|
quoteResponseSource?: string;
|
|
1202
1216
|
fulfil?: {
|
|
1203
1217
|
body: components["schemas"]["TransfersIDPutResponse"];
|
|
1204
|
-
headers?:
|
|
1205
|
-
[key: string]: unknown;
|
|
1206
|
-
};
|
|
1218
|
+
headers?: Record<string, never>;
|
|
1207
1219
|
};
|
|
1208
1220
|
/** @description Object representing the last error to occur during a transfer process. This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter. */
|
|
1209
1221
|
lastError?: components["schemas"]["transferError"];
|
|
@@ -1233,7 +1245,7 @@ export interface components {
|
|
|
1233
1245
|
* AuthenticationValue
|
|
1234
1246
|
* @description Contains the authentication value. The format depends on the authentication type used in the AuthenticationInfo complex type.
|
|
1235
1247
|
*/
|
|
1236
|
-
AuthenticationValue:
|
|
1248
|
+
AuthenticationValue: string | {
|
|
1237
1249
|
/** @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key. */
|
|
1238
1250
|
pinValue: string;
|
|
1239
1251
|
/**
|
|
@@ -1241,7 +1253,7 @@ export interface components {
|
|
|
1241
1253
|
* @description Sequential counter used for cloning detection. Present only for U2F authentication.
|
|
1242
1254
|
*/
|
|
1243
1255
|
counter: string;
|
|
1244
|
-
}
|
|
1256
|
+
};
|
|
1245
1257
|
/**
|
|
1246
1258
|
* AuthenticationInfo
|
|
1247
1259
|
* @description Data model for the complex type AuthenticationInfo.
|
|
@@ -1284,23 +1296,17 @@ export interface components {
|
|
|
1284
1296
|
quoteId?: components["schemas"]["CorrelationId"];
|
|
1285
1297
|
quoteResponse?: {
|
|
1286
1298
|
body: components["schemas"]["QuotesIDPutResponse"];
|
|
1287
|
-
headers?:
|
|
1288
|
-
[key: string]: unknown;
|
|
1289
|
-
};
|
|
1299
|
+
headers?: Record<string, never>;
|
|
1290
1300
|
};
|
|
1291
1301
|
/** @description FSPID of the entity that supplied the quote response. This may not be the same as the FSPID of the entity which owns the end user account in the case of a FOREX transfer. i.e. it may be a FOREX gateway. */
|
|
1292
1302
|
quoteResponseSource?: string;
|
|
1293
1303
|
authorizationResponse?: {
|
|
1294
1304
|
body: components["schemas"]["AuthorizationIDPutResponse"];
|
|
1295
|
-
headers?:
|
|
1296
|
-
[key: string]: unknown;
|
|
1297
|
-
};
|
|
1305
|
+
headers?: Record<string, never>;
|
|
1298
1306
|
};
|
|
1299
1307
|
fulfil?: {
|
|
1300
1308
|
body: components["schemas"]["TransfersIDPutResponse"];
|
|
1301
|
-
headers?:
|
|
1302
|
-
[key: string]: unknown;
|
|
1303
|
-
};
|
|
1309
|
+
headers?: Record<string, never>;
|
|
1304
1310
|
};
|
|
1305
1311
|
/** @description Object representing the last error to occur during a transfer process. This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter. */
|
|
1306
1312
|
lastError?: components["schemas"]["transferError"];
|
|
@@ -1332,15 +1338,11 @@ export interface components {
|
|
|
1332
1338
|
simpleTransfersPostResponse: {
|
|
1333
1339
|
transfer: {
|
|
1334
1340
|
body: components["schemas"]["TransfersIDPutResponse"];
|
|
1335
|
-
headers:
|
|
1336
|
-
[key: string]: unknown;
|
|
1337
|
-
};
|
|
1341
|
+
headers: Record<string, never>;
|
|
1338
1342
|
};
|
|
1339
1343
|
currentState: components["schemas"]["async2SyncCurrentState"];
|
|
1340
1344
|
};
|
|
1341
|
-
errorSimpleTransfersResponse: components["schemas"]["errorResponse"] &
|
|
1342
|
-
[key: string]: unknown;
|
|
1343
|
-
};
|
|
1345
|
+
errorSimpleTransfersResponse: components["schemas"]["errorResponse"] & Record<string, never>;
|
|
1344
1346
|
transferRequest: {
|
|
1345
1347
|
/** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
|
|
1346
1348
|
homeTransactionId: string;
|
|
@@ -1362,88 +1364,88 @@ export interface components {
|
|
|
1362
1364
|
currentState: components["schemas"]["transferStatus"];
|
|
1363
1365
|
fulfil: {
|
|
1364
1366
|
body: components["schemas"]["TransfersIDPutResponse"];
|
|
1365
|
-
headers?:
|
|
1366
|
-
[key: string]: unknown;
|
|
1367
|
-
};
|
|
1367
|
+
headers?: Record<string, never>;
|
|
1368
1368
|
};
|
|
1369
1369
|
};
|
|
1370
1370
|
};
|
|
1371
1371
|
responses: {
|
|
1372
|
-
/** Accounts creation completed */
|
|
1372
|
+
/** @description Accounts creation completed */
|
|
1373
1373
|
accountsCreationCompleted: {
|
|
1374
1374
|
content: {
|
|
1375
1375
|
"application/json": components["schemas"]["accountsResponse"];
|
|
1376
1376
|
};
|
|
1377
1377
|
};
|
|
1378
|
-
/** An error occurred creating accounts */
|
|
1378
|
+
/** @description An error occurred creating accounts */
|
|
1379
1379
|
accountsCreationError: {
|
|
1380
1380
|
content: {
|
|
1381
1381
|
"application/json": components["schemas"]["errorAccountsResponse"];
|
|
1382
1382
|
};
|
|
1383
1383
|
};
|
|
1384
|
-
/** Timeout occurred creating accounts */
|
|
1384
|
+
/** @description Timeout occurred creating accounts */
|
|
1385
1385
|
accountsCreationTimeout: {
|
|
1386
1386
|
content: {
|
|
1387
1387
|
"application/json": components["schemas"]["errorAccountsResponse"];
|
|
1388
1388
|
};
|
|
1389
1389
|
};
|
|
1390
|
-
/** Bulk quote completed successfully */
|
|
1390
|
+
/** @description Bulk quote completed successfully */
|
|
1391
1391
|
bulkQuoteSuccess: {
|
|
1392
1392
|
content: {
|
|
1393
1393
|
"application/json": components["schemas"]["bulkQuoteResponse"];
|
|
1394
1394
|
};
|
|
1395
1395
|
};
|
|
1396
|
-
/** Malformed or missing required body, headers or parameters */
|
|
1396
|
+
/** @description Malformed or missing required body, headers or parameters */
|
|
1397
1397
|
bulkQuoteBadRequest: {
|
|
1398
1398
|
content: {
|
|
1399
1399
|
"application/json": components["schemas"]["bulkQuoteErrorResponse"];
|
|
1400
1400
|
};
|
|
1401
1401
|
};
|
|
1402
|
-
/** An error occurred processing the bulk quote */
|
|
1402
|
+
/** @description An error occurred processing the bulk quote */
|
|
1403
1403
|
bulkQuoteServerError: {
|
|
1404
1404
|
content: {
|
|
1405
1405
|
"application/json": components["schemas"]["bulkQuoteErrorResponse"];
|
|
1406
1406
|
};
|
|
1407
1407
|
};
|
|
1408
|
-
/** Timeout occurred processing the bulk quote */
|
|
1408
|
+
/** @description Timeout occurred processing the bulk quote */
|
|
1409
1409
|
bulkQuoteTimeout: {
|
|
1410
1410
|
content: {
|
|
1411
1411
|
"application/json": components["schemas"]["bulkQuoteErrorResponse"];
|
|
1412
1412
|
};
|
|
1413
1413
|
};
|
|
1414
|
-
/** Bulk transfer accepted successfully */
|
|
1415
|
-
bulkTransactionAccepted:
|
|
1416
|
-
|
|
1414
|
+
/** @description Bulk transfer accepted successfully */
|
|
1415
|
+
bulkTransactionAccepted: {
|
|
1416
|
+
content: never;
|
|
1417
|
+
};
|
|
1418
|
+
/** @description Malformed or missing required body, headers or parameters */
|
|
1417
1419
|
bulkTransferBadRequest: {
|
|
1418
1420
|
content: {
|
|
1419
1421
|
"application/json": components["schemas"]["bulkTransferErrorResponse"];
|
|
1420
1422
|
};
|
|
1421
1423
|
};
|
|
1422
|
-
/** Internal Server Error */
|
|
1424
|
+
/** @description Internal Server Error */
|
|
1423
1425
|
errorResponse: {
|
|
1424
1426
|
content: {
|
|
1425
1427
|
"application/json": components["schemas"]["errorResponse"];
|
|
1426
1428
|
};
|
|
1427
1429
|
};
|
|
1428
|
-
/** Malformed or missing required body, headers or parameters */
|
|
1430
|
+
/** @description Malformed or missing required body, headers or parameters */
|
|
1429
1431
|
bulkTransactionPutBadRequest: {
|
|
1430
1432
|
content: {
|
|
1431
1433
|
"application/json": components["schemas"]["bulkTransactionAcceptPartyErrorResponse"] | components["schemas"]["bulkTransactionAcceptQuoteErrorResponse"];
|
|
1432
1434
|
};
|
|
1433
1435
|
};
|
|
1434
|
-
/** Bulk transfer completed successfully */
|
|
1436
|
+
/** @description Bulk transfer completed successfully */
|
|
1435
1437
|
bulkTransferSuccess: {
|
|
1436
1438
|
content: {
|
|
1437
1439
|
"application/json": components["schemas"]["bulkTransferResponse"];
|
|
1438
1440
|
};
|
|
1439
1441
|
};
|
|
1440
|
-
/** PartiesByIdSuccess */
|
|
1442
|
+
/** @description PartiesByIdSuccess */
|
|
1441
1443
|
partiesByIdSuccess: {
|
|
1442
1444
|
content: {
|
|
1443
1445
|
"application/json": components["schemas"]["partiesByIdResponse"];
|
|
1444
1446
|
};
|
|
1445
1447
|
};
|
|
1446
|
-
/** PartiesByIdError404 */
|
|
1448
|
+
/** @description PartiesByIdError404 */
|
|
1447
1449
|
partiesByIdError404: {
|
|
1448
1450
|
content: {
|
|
1449
1451
|
"application/json": {
|
|
@@ -1451,67 +1453,67 @@ export interface components {
|
|
|
1451
1453
|
};
|
|
1452
1454
|
};
|
|
1453
1455
|
};
|
|
1454
|
-
/** sync response from POST /quotes */
|
|
1456
|
+
/** @description sync response from POST /quotes */
|
|
1455
1457
|
quotesPostSuccess: {
|
|
1456
1458
|
content: {
|
|
1457
1459
|
"application/json": components["schemas"]["quotesPostResponse"];
|
|
1458
1460
|
};
|
|
1459
1461
|
};
|
|
1460
|
-
/** An error occurred processing the quotes request */
|
|
1462
|
+
/** @description An error occurred processing the quotes request */
|
|
1461
1463
|
quotesServerError: {
|
|
1462
1464
|
content: {
|
|
1463
1465
|
"application/json": components["schemas"]["errorQuotesResponse"];
|
|
1464
1466
|
};
|
|
1465
1467
|
};
|
|
1466
|
-
/** Request to Pay completed successfully */
|
|
1468
|
+
/** @description Request to Pay completed successfully */
|
|
1467
1469
|
requestToPaySuccess: {
|
|
1468
1470
|
content: {
|
|
1469
1471
|
"application/json": components["schemas"]["requestToPayResponse"];
|
|
1470
1472
|
};
|
|
1471
1473
|
};
|
|
1472
|
-
/** An error occurred processing the transfer */
|
|
1474
|
+
/** @description An error occurred processing the transfer */
|
|
1473
1475
|
transferServerError: {
|
|
1474
1476
|
content: {
|
|
1475
1477
|
"application/json": components["schemas"]["errorTransferResponse"];
|
|
1476
1478
|
};
|
|
1477
1479
|
};
|
|
1478
|
-
/** Timeout occurred processing the transfer */
|
|
1480
|
+
/** @description Timeout occurred processing the transfer */
|
|
1479
1481
|
transferTimeout: {
|
|
1480
1482
|
content: {
|
|
1481
1483
|
"application/json": components["schemas"]["errorTransferResponse"];
|
|
1482
1484
|
};
|
|
1483
1485
|
};
|
|
1484
|
-
/** Transfer completed successfully */
|
|
1486
|
+
/** @description Transfer completed successfully */
|
|
1485
1487
|
requestToPayTransferSuccess: {
|
|
1486
1488
|
content: {
|
|
1487
1489
|
"application/json": components["schemas"]["requestToPayTransferResponse"];
|
|
1488
1490
|
};
|
|
1489
1491
|
};
|
|
1490
|
-
/** Malformed or missing required body, headers or parameters */
|
|
1492
|
+
/** @description Malformed or missing required body, headers or parameters */
|
|
1491
1493
|
requestToPayTransferBadRequest: {
|
|
1492
1494
|
content: {
|
|
1493
1495
|
"application/json": components["schemas"]["errorTransferResponse"];
|
|
1494
1496
|
};
|
|
1495
1497
|
};
|
|
1496
|
-
/** Transfer completed successfully */
|
|
1498
|
+
/** @description Transfer completed successfully */
|
|
1497
1499
|
transferSuccess: {
|
|
1498
1500
|
content: {
|
|
1499
1501
|
"application/json": components["schemas"]["transferResponse"];
|
|
1500
1502
|
};
|
|
1501
1503
|
};
|
|
1502
|
-
/** sync response from POST /simpleTransfers */
|
|
1504
|
+
/** @description sync response from POST /simpleTransfers */
|
|
1503
1505
|
simpleTransfersPostSuccess: {
|
|
1504
1506
|
content: {
|
|
1505
1507
|
"application/json": components["schemas"]["simpleTransfersPostResponse"];
|
|
1506
1508
|
};
|
|
1507
1509
|
};
|
|
1508
|
-
/** An error occurred processing the simple transfers request */
|
|
1510
|
+
/** @description An error occurred processing the simple transfers request */
|
|
1509
1511
|
simpleTransfersServerError: {
|
|
1510
1512
|
content: {
|
|
1511
1513
|
"application/json": components["schemas"]["errorSimpleTransfersResponse"];
|
|
1512
1514
|
};
|
|
1513
1515
|
};
|
|
1514
|
-
/** Malformed or missing required body, headers or parameters */
|
|
1516
|
+
/** @description Malformed or missing required body, headers or parameters */
|
|
1515
1517
|
transferBadRequest: {
|
|
1516
1518
|
content: {
|
|
1517
1519
|
"application/json": components["schemas"]["errorTransferResponse"];
|
|
@@ -1536,15 +1538,20 @@ export interface components {
|
|
|
1536
1538
|
/** @description Identifier of the transfer to continue as returned in the response to a `POST /transfers` request. */
|
|
1537
1539
|
transferId: components["schemas"]["CorrelationId"];
|
|
1538
1540
|
};
|
|
1541
|
+
requestBodies: never;
|
|
1542
|
+
headers: never;
|
|
1543
|
+
pathItems: never;
|
|
1539
1544
|
}
|
|
1545
|
+
export type external = Record<string, never>;
|
|
1540
1546
|
export interface operations {
|
|
1541
|
-
/**
|
|
1547
|
+
/**
|
|
1548
|
+
* PartiesByTypeAndID
|
|
1549
|
+
* @description The HTTP request GET /parties// (or GET /parties///) is used to lookup information regarding the requested Party, defined by , and optionally (for example, GET /parties/MSISDN/123456789, or GET /parties/BUSINESS/shoecompany/employee1).
|
|
1550
|
+
*/
|
|
1542
1551
|
PartiesByTypeAndID: {
|
|
1543
1552
|
parameters: {
|
|
1544
1553
|
path: {
|
|
1545
|
-
/** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
|
1546
1554
|
Type: components["parameters"]["Type"];
|
|
1547
|
-
/** The identifier value. */
|
|
1548
1555
|
ID: components["parameters"]["ID"];
|
|
1549
1556
|
};
|
|
1550
1557
|
};
|
|
@@ -1553,15 +1560,15 @@ export interface operations {
|
|
|
1553
1560
|
404: components["responses"]["partiesByIdError404"];
|
|
1554
1561
|
};
|
|
1555
1562
|
};
|
|
1556
|
-
/**
|
|
1563
|
+
/**
|
|
1564
|
+
* PartiesSubIdByTypeAndID
|
|
1565
|
+
* @description The HTTP request GET /parties// (or GET /parties///) is used to lookup information regarding the requested Party, defined by , and optionally (for example, GET /parties/MSISDN/123456789, or GET /parties/BUSINESS/shoecompany/employee1).
|
|
1566
|
+
*/
|
|
1557
1567
|
PartiesSubIdByTypeAndID: {
|
|
1558
1568
|
parameters: {
|
|
1559
1569
|
path: {
|
|
1560
|
-
/** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
|
1561
1570
|
Type: components["parameters"]["Type"];
|
|
1562
|
-
/** The identifier value. */
|
|
1563
1571
|
ID: components["parameters"]["ID"];
|
|
1564
|
-
/** A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
|
1565
1572
|
SubId: components["parameters"]["SubId"];
|
|
1566
1573
|
};
|
|
1567
1574
|
};
|
|
@@ -1570,32 +1577,36 @@ export interface operations {
|
|
|
1570
1577
|
404: components["responses"]["partiesByIdError404"];
|
|
1571
1578
|
};
|
|
1572
1579
|
};
|
|
1573
|
-
/**
|
|
1580
|
+
/**
|
|
1581
|
+
* Quotes endpoint
|
|
1582
|
+
* @description is used to request quotes from other DFSP
|
|
1583
|
+
*/
|
|
1574
1584
|
QuotesPost: {
|
|
1575
|
-
|
|
1576
|
-
200: components["responses"]["quotesPostSuccess"];
|
|
1577
|
-
500: components["responses"]["quotesServerError"];
|
|
1578
|
-
};
|
|
1579
|
-
/** Quotes request payload */
|
|
1585
|
+
/** @description Quotes request payload */
|
|
1580
1586
|
requestBody: {
|
|
1581
1587
|
content: {
|
|
1582
1588
|
"application/json": components["schemas"]["simpleQuotesPostRequest"];
|
|
1583
1589
|
};
|
|
1584
1590
|
};
|
|
1585
|
-
};
|
|
1586
|
-
/** is used to request a transfer */
|
|
1587
|
-
SimpleTransfersPost: {
|
|
1588
1591
|
responses: {
|
|
1589
|
-
200: components["responses"]["
|
|
1590
|
-
500: components["responses"]["
|
|
1592
|
+
200: components["responses"]["quotesPostSuccess"];
|
|
1593
|
+
500: components["responses"]["quotesServerError"];
|
|
1591
1594
|
};
|
|
1592
|
-
|
|
1595
|
+
};
|
|
1596
|
+
/**
|
|
1597
|
+
* Simple Transfers endpoint
|
|
1598
|
+
* @description is used to request a transfer
|
|
1599
|
+
*/
|
|
1600
|
+
SimpleTransfersPost: {
|
|
1601
|
+
/** @description Simple Transfer request payload */
|
|
1593
1602
|
requestBody: {
|
|
1594
1603
|
content: {
|
|
1595
1604
|
"application/json": components["schemas"]["simpleTransfersPostRequest"];
|
|
1596
1605
|
};
|
|
1597
1606
|
};
|
|
1607
|
+
responses: {
|
|
1608
|
+
200: components["responses"]["simpleTransfersPostSuccess"];
|
|
1609
|
+
500: components["responses"]["simpleTransfersServerError"];
|
|
1610
|
+
};
|
|
1598
1611
|
};
|
|
1599
1612
|
}
|
|
1600
|
-
export interface external {
|
|
1601
|
-
}
|