@mojaloop/api-snippets 17.3.0-snapshot.0 → 17.4.0
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/audit-ci.jsonc +1 -1
- package/docs/fspiop-rest-v1.0-openapi3-snippets.yaml +204 -805
- package/docs/fspiop-rest-v1.1-openapi3-snippets.yaml +2432 -2447
- package/docs/fspiop-rest-v2.0-openapi3-snippets.yaml +3149 -3163
- package/docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml +103 -346
- package/docs/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml +131 -449
- package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml +144 -478
- package/docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml +179 -606
- package/docs/thirdparty-openapi3-snippets.yaml +296 -886
- package/fspiop/v1_1/openapi3/openapi.yaml +10 -2
- package/fspiop/v2_0/openapi3/openapi.yaml +11 -1
- package/lib/fspiop/v1_1/openapi.d.ts +524 -542
- package/lib/fspiop/v2_0/openapi.d.ts +685 -703
- package/lib/scripts/openapi-refactor.d.ts +29 -0
- package/lib/scripts/openapi-refactor.js +70 -0
- package/lib/scripts/openapi-refactor.js.map +1 -0
- package/package.json +14 -9
@@ -1,20 +1,14 @@
|
|
1
1
|
openapi: 3.0.1
|
2
2
|
info:
|
3
3
|
title: Mojaloop SDK Outbound Scheme Adapter API
|
4
|
-
description:
|
4
|
+
description: |
|
5
5
|
Specification for the Mojaloop SDK Scheme Adapter Outbound Transfers API
|
6
6
|
|
7
|
+
This API can be used by DFSP backends to simplify the process of sending funds to other parties within a Mojaloop scheme.
|
7
8
|
|
8
|
-
|
9
|
-
funds to other parties within a Mojaloop scheme.
|
9
|
+
Please see other documentation on https://github.com/mojaloop/sdk-scheme-adapter for more information.
|
10
10
|
|
11
|
-
|
12
|
-
Please see other documentation on
|
13
|
-
https://github.com/mojaloop/sdk-scheme-adapter for more information.
|
14
|
-
|
15
|
-
|
16
|
-
**Note on terminology:** The term "Switch" is equal to the term "Hub", and
|
17
|
-
the term "FSP" is equal to the term "DFSP".
|
11
|
+
**Note on terminology:** The term "Switch" is equal to the term "Hub", and the term "FSP" is equal to the term "DFSP".
|
18
12
|
license:
|
19
13
|
name: Apache License Version 2.0, January 2004
|
20
14
|
url: https://github.com/mojaloop/documentation/blob/main/LICENSE.md
|
@@ -23,24 +17,17 @@ paths:
|
|
23
17
|
/:
|
24
18
|
get:
|
25
19
|
summary: Health check endpoint
|
26
|
-
description:
|
27
|
-
This endpoint allows a user of the SDK scheme adapter to check the
|
28
|
-
outbound transfers service is listening.
|
20
|
+
description: This endpoint allows a user of the SDK scheme adapter to check the outbound transfers service is listening.
|
29
21
|
tags:
|
30
22
|
- Health
|
31
23
|
responses:
|
32
24
|
'200':
|
33
|
-
description:
|
34
|
-
Returns empty body if the scheme adapter outbound transfers service
|
35
|
-
is running.
|
25
|
+
description: Returns empty body if the scheme adapter outbound transfers service is running.
|
36
26
|
/accounts:
|
37
27
|
post:
|
38
28
|
summary: Create accounts on the Account Lookup Service
|
39
|
-
description:
|
40
|
-
The HTTP request `POST /accounts` is used to create account information
|
41
|
-
on the Account Lookup Service (ALS) regarding the provided list of
|
42
|
-
identities.
|
43
|
-
|
29
|
+
description: |-
|
30
|
+
The HTTP request `POST /accounts` is used to create account information on the Account Lookup Service (ALS) regarding the provided list of identities.
|
44
31
|
|
45
32
|
Caller DFSP is used as the account source FSP information
|
46
33
|
tags:
|
@@ -64,9 +51,8 @@ paths:
|
|
64
51
|
/bulkQuotes:
|
65
52
|
post:
|
66
53
|
summary: Request bulk quotes for the provided financial transactions
|
67
|
-
description:
|
68
|
-
The HTTP request `POST /bulkQuotes` is used to request a bulk quote to
|
69
|
-
fascilitate funds transfer from payer DFSP to payees' DFSP.
|
54
|
+
description: |
|
55
|
+
The HTTP request `POST /bulkQuotes` is used to request a bulk quote to fascilitate funds transfer from payer DFSP to payees' DFSP.
|
70
56
|
tags:
|
71
57
|
- BulkQuotes
|
72
58
|
requestBody:
|
@@ -88,11 +74,7 @@ paths:
|
|
88
74
|
/bulkQuotes/{bulkQuoteId}:
|
89
75
|
get:
|
90
76
|
summary: Retrieves information for a specific bulk quote
|
91
|
-
description:
|
92
|
-
The HTTP request `GET /bulkQuotes/{bulktQuoteId}` is used to get
|
93
|
-
information regarding a bulk quote created or requested earlier. The
|
94
|
-
`{bulkQuoteId}` in the URI should contain the `bulkQuoteId` that was
|
95
|
-
used for the creation of the bulk quote.
|
77
|
+
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.
|
96
78
|
tags:
|
97
79
|
- BulkQuotes
|
98
80
|
parameters:
|
@@ -113,9 +95,8 @@ paths:
|
|
113
95
|
/bulkTransactions:
|
114
96
|
post:
|
115
97
|
summary: Sends money from one account to multiple accounts
|
116
|
-
description:
|
117
|
-
The HTTP request `POST /bulkTransactions` is used to request the
|
118
|
-
movement of funds from payer DFSP to payees' DFSP.
|
98
|
+
description: |
|
99
|
+
The HTTP request `POST /bulkTransactions` is used to request the movement of funds from payer DFSP to payees' DFSP.
|
119
100
|
tags:
|
120
101
|
- BulkTransactions
|
121
102
|
requestBody:
|
@@ -135,13 +116,7 @@ paths:
|
|
135
116
|
/bulkTransactions/{bulkTransactionId}:
|
136
117
|
put:
|
137
118
|
summary: Amends the bulk transaction request
|
138
|
-
description:
|
139
|
-
The HTTP request `PUT /bulkTransactions/{bulkTransactionId}` is used to
|
140
|
-
amend information regarding a bulk transaction, i.e. when
|
141
|
-
autoAcceptParty or autoAcceptQuote is false then the payer need to
|
142
|
-
provide confirmation to proceed with further processing of the request.
|
143
|
-
The `{bulkTransactionId}` in the URI should contain the
|
144
|
-
`bulkTransactionId` that was used for the creation of the bulk transfer.
|
119
|
+
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.
|
145
120
|
tags:
|
146
121
|
- BulkTransactions
|
147
122
|
parameters:
|
@@ -169,9 +144,8 @@ paths:
|
|
169
144
|
/bulkTransfers:
|
170
145
|
post:
|
171
146
|
summary: Sends money from one account to multiple accounts
|
172
|
-
description:
|
173
|
-
The HTTP request `POST /bulkTransfers` is used to request the movement
|
174
|
-
of funds from payer DFSP to payees' DFSP.
|
147
|
+
description: |
|
148
|
+
The HTTP request `POST /bulkTransfers` is used to request the movement of funds from payer DFSP to payees' DFSP.
|
175
149
|
tags:
|
176
150
|
- BulkTransfers
|
177
151
|
requestBody:
|
@@ -191,11 +165,7 @@ paths:
|
|
191
165
|
/bulkTransfers/{bulkTransferId}:
|
192
166
|
get:
|
193
167
|
summary: Retrieves information for a specific bulk transfer
|
194
|
-
description:
|
195
|
-
The HTTP request `GET /bulkTransfers/{bulkTransferId}` is used to get
|
196
|
-
information regarding a bulk transfer created or requested earlier. The
|
197
|
-
`{bulkTransferId}` in the URI should contain the `bulkTransferId` that
|
198
|
-
was used for the creation of the bulk transfer.
|
168
|
+
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.
|
199
169
|
tags:
|
200
170
|
- BulkTransfers
|
201
171
|
parameters:
|
@@ -218,11 +188,7 @@ paths:
|
|
218
188
|
- $ref: '#/components/parameters/Type'
|
219
189
|
- $ref: '#/components/parameters/ID'
|
220
190
|
get:
|
221
|
-
description:
|
222
|
-
The HTTP request GET /parties// (or GET /parties///) is used to lookup
|
223
|
-
information regarding the requested Party, defined by , and optionally
|
224
|
-
(for example, GET /parties/MSISDN/123456789, or GET
|
225
|
-
/parties/BUSINESS/shoecompany/employee1).
|
191
|
+
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).
|
226
192
|
summary: PartiesByTypeAndID
|
227
193
|
tags:
|
228
194
|
- parties
|
@@ -238,11 +204,7 @@ paths:
|
|
238
204
|
- $ref: '#/components/parameters/ID'
|
239
205
|
- $ref: '#/components/parameters/SubId'
|
240
206
|
get:
|
241
|
-
description:
|
242
|
-
The HTTP request GET /parties// (or GET /parties///) is used to lookup
|
243
|
-
information regarding the requested Party, defined by , and optionally
|
244
|
-
(for example, GET /parties/MSISDN/123456789, or GET
|
245
|
-
/parties/BUSINESS/shoecompany/employee1).
|
207
|
+
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).
|
246
208
|
summary: PartiesSubIdByTypeAndID
|
247
209
|
tags:
|
248
210
|
- parties
|
@@ -274,10 +236,8 @@ paths:
|
|
274
236
|
/requestToPay:
|
275
237
|
post:
|
276
238
|
summary: Receiver requesting funds from Sender
|
277
|
-
description:
|
278
|
-
The HTTP request `POST /requestToPay` is used to support Pull Funds
|
279
|
-
pattern where in a receiver can request for funds from the Sender.
|
280
|
-
|
239
|
+
description: |
|
240
|
+
The HTTP request `POST /requestToPay` is used to support Pull Funds pattern where in a receiver can request for funds from the Sender.
|
281
241
|
The underlying API has two stages:
|
282
242
|
|
283
243
|
1. Party lookup. This facilitates a check by the sending party that the destination party is correct before proceeding with a money movement.
|
@@ -296,19 +256,11 @@ paths:
|
|
296
256
|
$ref: '#/components/responses/requestToPaySuccess'
|
297
257
|
/requestToPay/{transactionRequestId}:
|
298
258
|
put:
|
299
|
-
summary:
|
300
|
-
|
301
|
-
|
302
|
-
|
303
|
-
|
304
|
-
continue a transfer initiated via the `POST /requestToPay` method that
|
305
|
-
has halted after party lookup stage.
|
306
|
-
|
307
|
-
The request body should contain the "acceptParty" property set to `true`
|
308
|
-
as required to continue the transfer.
|
309
|
-
|
310
|
-
See the description of the `POST /requestToPay` HTTP method for more
|
311
|
-
information on modes of transfer.
|
259
|
+
summary: Continues a request funds from sender that has paused at the party resolution stage in order to accept or reject party information
|
260
|
+
description: |
|
261
|
+
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.
|
262
|
+
The request body should contain the "acceptParty" property set to `true` as required to continue the transfer.
|
263
|
+
See the description of the `POST /requestToPay` HTTP method for more information on modes of transfer.
|
312
264
|
tags:
|
313
265
|
- RequestToPay
|
314
266
|
requestBody:
|
@@ -327,13 +279,9 @@ paths:
|
|
327
279
|
$ref: '#/components/responses/transferTimeout'
|
328
280
|
/requestToPayTransfer:
|
329
281
|
post:
|
330
|
-
summary:
|
331
|
-
|
332
|
-
|
333
|
-
description: >
|
334
|
-
The HTTP request `POST /requestToPayTransfer` is used to request the
|
335
|
-
movement of funds from payer DFSP to payee DFSP.
|
336
|
-
|
282
|
+
summary: Used to trigger funds from customer fsp account to merchant fsp account. This is a follow-up request to requestToPay.
|
283
|
+
description: |
|
284
|
+
The HTTP request `POST /requestToPayTransfer` is used to request the movement of funds from payer DFSP to payee DFSP.
|
337
285
|
The underlying Mojaloop API has three stages for money transfer:
|
338
286
|
|
339
287
|
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.
|
@@ -341,30 +289,17 @@ paths:
|
|
341
289
|
3. Transfer. The enactment of the previously agreed "contract"
|
342
290
|
|
343
291
|
This method has several modes of operation.
|
344
|
-
|
345
|
-
- If the configuration variable `AUTO_ACCEPT_QUOTES` is set to `"false"`
|
346
|
-
this method will terminate and return the quotation when it has been
|
347
|
-
received from the payee DFSP.
|
292
|
+
- If the configuration variable `AUTO_ACCEPT_QUOTES` is set to `"false"` this method will terminate and return the quotation when it has been received from the payee DFSP.
|
348
293
|
If the payee wished to proceed with the otp, then a subsequent `PUT /transfers/{transferId}` request (accepting the quote) is required to continue the operation.
|
349
294
|
The scheme adapter will then proceed with the transfer state.
|
350
295
|
|
351
|
-
- If the configuration variable `AUTO_ACCEPT_OTP` is set to `"false"`
|
352
|
-
this method will terminate and return the otp when it has been received
|
353
|
-
from the payee DFSP.
|
296
|
+
- If the configuration variable `AUTO_ACCEPT_OTP` is set to `"false"` this method will terminate and return the otp when it has been received from the payee DFSP.
|
354
297
|
If the payer wished to proceed with the transfer, then a subsequent `PUT /transfers/{transferId}` request (accepting the quote) is required to continue the operation.
|
355
298
|
The scheme adapter will then proceed with the transfer state.
|
356
299
|
|
357
|
-
If the configuration variables `AUTO_ACCEPT_PARTIES` and
|
358
|
-
`AUTO_ACCEPT_QUOTES` are both set to `"true"` this method will block
|
359
|
-
until all three transfer stages are complete. Upon completion it will
|
360
|
-
return the entire set of transfer details received during the operation.
|
361
|
-
|
300
|
+
If the configuration variables `AUTO_ACCEPT_PARTIES` and `AUTO_ACCEPT_QUOTES` are both set to `"true"` this method will block until all three transfer stages are complete. Upon completion it will return the entire set of transfer details received during the operation.
|
362
301
|
|
363
|
-
Combinations of settings for `AUTO_ACCEPT...` configuration variables
|
364
|
-
allow the scheme adapter user to decide which mode of operation best
|
365
|
-
suits their use cases. i.e. the scheme adapter can be configured to
|
366
|
-
"break" the three stage transfer at these points in order to execute
|
367
|
-
backend logic such as party verification, quoted fees assessments etc...
|
302
|
+
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...
|
368
303
|
tags:
|
369
304
|
- RequestToPayTransfer
|
370
305
|
requestBody:
|
@@ -385,21 +320,13 @@ paths:
|
|
385
320
|
$ref: '#/components/responses/transferTimeout'
|
386
321
|
/requestToPayTransfer/{transactionRequestId}:
|
387
322
|
put:
|
388
|
-
summary:
|
389
|
-
|
390
|
-
or
|
391
|
-
description: >
|
392
|
-
This request is used to continue a requestToPayTransfer initiated via
|
393
|
-
the `POST /requestToPayTransfer` method that has halted after quotation
|
394
|
-
stage and/or otp stage.
|
395
|
-
|
323
|
+
summary: Continues a transfer that has paused at the otp stage in order to accept or reject quote
|
324
|
+
description: |
|
325
|
+
This request is used to continue a requestToPayTransfer initiated via the `POST /requestToPayTransfer` method that has halted after quotation stage and/or otp stage.
|
396
326
|
|
397
|
-
The request body should contain either the "acceptOTP" or "acceptQuote"
|
398
|
-
property set to `true` as required to continue the transfer.
|
327
|
+
The request body should contain either the "acceptOTP" or "acceptQuote" property set to `true` as required to continue the transfer.
|
399
328
|
|
400
|
-
|
401
|
-
See the description of the `POST /requestToPayTransfer` HTTP method for
|
402
|
-
more information on modes of transfer.
|
329
|
+
See the description of the `POST /requestToPayTransfer` HTTP method for more information on modes of transfer.
|
403
330
|
tags:
|
404
331
|
- RequestToPayTransferID
|
405
332
|
requestBody:
|
@@ -440,10 +367,8 @@ paths:
|
|
440
367
|
/transfers:
|
441
368
|
post:
|
442
369
|
summary: Sends money from one account to another
|
443
|
-
description:
|
444
|
-
The HTTP request `POST /transfers` is used to request the movement of
|
445
|
-
funds from payer DFSP to payee DFSP.
|
446
|
-
|
370
|
+
description: |
|
371
|
+
The HTTP request `POST /transfers` is used to request the movement of funds from payer DFSP to payee DFSP.
|
447
372
|
The underlying Mojaloop API has three stages for money transfer:
|
448
373
|
|
449
374
|
1. Party lookup. This facilitates a check by the sending party that the destination party is correct before proceeding with a money movement.
|
@@ -451,30 +376,17 @@ paths:
|
|
451
376
|
3. Transfer. The enactment of the previously agreed "contract"
|
452
377
|
|
453
378
|
This method has several modes of operation.
|
454
|
-
|
455
|
-
- If the configuration variables `AUTO_ACCEPT_PARTIES` is set to
|
456
|
-
`"false"` this method will terminate when the payee party has been
|
457
|
-
resolved and return the payee party details.
|
379
|
+
- If the configuration variables `AUTO_ACCEPT_PARTIES` is set to `"false"` this method will terminate when the payee party has been resolved and return the payee party details.
|
458
380
|
If the payee wishes to proceed with the transfer, then a subsequent `PUT /transfers/{transferId}` request (accepting the payee party) is required to continue the operation.
|
459
381
|
The scheme adapter will then proceed with quotation stage...
|
460
382
|
|
461
|
-
- If the configuration variable `AUTO_ACCEPT_QUOTES` is set to `"false"`
|
462
|
-
this method will terminate and return the quotation when it has been
|
463
|
-
received from the payee DFSP.
|
383
|
+
- If the configuration variable `AUTO_ACCEPT_QUOTES` is set to `"false"` this method will terminate and return the quotation when it has been received from the payee DFSP.
|
464
384
|
If the payee wished to proceed with the transfer, then a subsequent `PUT /transfers/{transferId}` request (accepting the quote) is required to continue the operation.
|
465
385
|
The scheme adapter will then proceed with the transfer state.
|
466
386
|
|
467
|
-
If the configuration variables `AUTO_ACCEPT_PARTIES` and
|
468
|
-
`AUTO_ACCEPT_QUOTES` are both set to `"true"` this method will block
|
469
|
-
until all three transfer stages are complete. Upon completion it will
|
470
|
-
return the entire set of transfer details received during the operation.
|
387
|
+
If the configuration variables `AUTO_ACCEPT_PARTIES` and `AUTO_ACCEPT_QUOTES` are both set to `"true"` this method will block until all three transfer stages are complete. Upon completion it will return the entire set of transfer details received during the operation.
|
471
388
|
|
472
|
-
|
473
|
-
Combinations of settings for `AUTO_ACCEPT...` configuration variables
|
474
|
-
allow the scheme adapter user to decide which mode of operation best
|
475
|
-
suits their use cases. i.e. the scheme adapter can be configured to
|
476
|
-
"break" the three stage transfer at these points in order to execute
|
477
|
-
backend logic such as party verification, quoted fees assessments etc...
|
389
|
+
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...
|
478
390
|
tags:
|
479
391
|
- Transfers
|
480
392
|
requestBody:
|
@@ -495,22 +407,13 @@ paths:
|
|
495
407
|
$ref: '#/components/responses/transferTimeout'
|
496
408
|
/transfers/{transferId}:
|
497
409
|
put:
|
498
|
-
summary:
|
499
|
-
|
500
|
-
|
501
|
-
description: >
|
502
|
-
The HTTP request `PUT /transfers/{transferId}` is used to continue a
|
503
|
-
transfer initiated via the `POST /transfers` method that has halted
|
504
|
-
after party lookup and/or quotation stage.
|
505
|
-
|
506
|
-
|
507
|
-
The request body should contain either the "acceptParty" or
|
508
|
-
"acceptQuote" property set to `true` as required to continue the
|
509
|
-
transfer.
|
410
|
+
summary: Continues a transfer that has paused at the quote stage in order to accept or reject payee party and/or quote
|
411
|
+
description: |
|
412
|
+
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.
|
510
413
|
|
414
|
+
The request body should contain either the "acceptParty" or "acceptQuote" property set to `true` as required to continue the transfer.
|
511
415
|
|
512
|
-
See the description of the `POST /transfers` HTTP method for more
|
513
|
-
information on modes of transfer.
|
416
|
+
See the description of the `POST /transfers` HTTP method for more information on modes of transfer.
|
514
417
|
tags:
|
515
418
|
- Transfers
|
516
419
|
requestBody:
|
@@ -531,11 +434,7 @@ paths:
|
|
531
434
|
$ref: '#/components/responses/transferTimeout'
|
532
435
|
get:
|
533
436
|
summary: Retrieves information for a specific transfer
|
534
|
-
description:
|
535
|
-
The HTTP request `GET /transfers/{transferId}` is used to get
|
536
|
-
information regarding a transfer created or requested earlier. The
|
537
|
-
`{transferId}` in the URI should contain the `transferId` that was used
|
538
|
-
for the creation of the transfer.
|
437
|
+
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.
|
539
438
|
tags:
|
540
439
|
- Transfers
|
541
440
|
parameters:
|
@@ -567,52 +466,16 @@ components:
|
|
567
466
|
- ACCOUNT_ID
|
568
467
|
- IBAN
|
569
468
|
- ALIAS
|
570
|
-
description:
|
469
|
+
description: |-
|
571
470
|
Below are the allowed values for the enumeration.
|
572
|
-
|
573
|
-
-
|
574
|
-
|
575
|
-
participant. The
|
576
|
-
|
577
|
-
|
578
|
-
|
579
|
-
|
580
|
-
|
581
|
-
- EMAIL - An email is used as reference to a participant. The format of
|
582
|
-
the email should be according to the informational [RFC
|
583
|
-
3696](https://tools.ietf.org/html/rfc3696).
|
584
|
-
|
585
|
-
- PERSONAL_ID - A personal identifier is used as reference to a
|
586
|
-
participant. Examples of personal identification are passport number,
|
587
|
-
birth certificate number, and national registration number. The
|
588
|
-
identifier number is added in the PartyIdentifier element. The personal
|
589
|
-
identifier type is added in the PartySubIdOrType element.
|
590
|
-
|
591
|
-
- BUSINESS - A specific Business (for example, an organization or a
|
592
|
-
company) is used as reference to a participant. The BUSINESS identifier
|
593
|
-
can be in any format. To make a transaction connected to a specific
|
594
|
-
username or bill number in a Business, the PartySubIdOrType element
|
595
|
-
should be used.
|
596
|
-
|
597
|
-
- DEVICE - A specific device (for example, a POS or ATM) ID connected to
|
598
|
-
a specific business or organization is used as reference to a Party. For
|
599
|
-
referencing a specific device under a specific business or organization,
|
600
|
-
use the PartySubIdOrType element.
|
601
|
-
|
602
|
-
- ACCOUNT_ID - A bank account number or FSP account ID should be used as
|
603
|
-
reference to a participant. The ACCOUNT_ID identifier can be in any
|
604
|
-
format, as formats can greatly differ depending on country and FSP.
|
605
|
-
|
606
|
-
- IBAN - A bank account number or FSP account ID is used as reference to
|
607
|
-
a participant. The IBAN identifier can consist of up to 34 alphanumeric
|
608
|
-
characters and should be entered without whitespace.
|
609
|
-
|
610
|
-
- ALIAS An alias is used as reference to a participant. The alias should
|
611
|
-
be created in the FSP as an alternative reference to an account owner.
|
612
|
-
Another example of an alias is a username in the FSP system. The ALIAS
|
613
|
-
identifier can be in any format. It is also possible to use the
|
614
|
-
PartySubIdOrType element for identifying an account under an Alias
|
615
|
-
defined by the PartyIdentifier.
|
471
|
+
- MSISDN - An MSISDN (Mobile Station International Subscriber Directory Number, that is, the phone number) is used as reference to a participant. The MSISDN identifier should be in international format according to the [ITU-T E.164 standard](https://www.itu.int/rec/T-REC-E.164/en). Optionally, the MSISDN may be prefixed by a single plus sign, indicating the international prefix.
|
472
|
+
- EMAIL - An email is used as reference to a participant. The format of the email should be according to the informational [RFC 3696](https://tools.ietf.org/html/rfc3696).
|
473
|
+
- PERSONAL_ID - A personal identifier is used as reference to a participant. Examples of personal identification are passport number, birth certificate number, and national registration number. The identifier number is added in the PartyIdentifier element. The personal identifier type is added in the PartySubIdOrType element.
|
474
|
+
- BUSINESS - A specific Business (for example, an organization or a company) is used as reference to a participant. The BUSINESS identifier can be in any format. To make a transaction connected to a specific username or bill number in a Business, the PartySubIdOrType element should be used.
|
475
|
+
- DEVICE - A specific device (for example, a POS or ATM) ID connected to a specific business or organization is used as reference to a Party. For referencing a specific device under a specific business or organization, use the PartySubIdOrType element.
|
476
|
+
- ACCOUNT_ID - A bank account number or FSP account ID should be used as reference to a participant. The ACCOUNT_ID identifier can be in any format, as formats can greatly differ depending on country and FSP.
|
477
|
+
- IBAN - A bank account number or FSP account ID is used as reference to a participant. The IBAN identifier can consist of up to 34 alphanumeric characters and should be entered without whitespace.
|
478
|
+
- ALIAS An alias is used as reference to a participant. The alias should be created in the FSP as an alternative reference to an account owner. Another example of an alias is a username in the FSP system. The ALIAS identifier can be in any format. It is also possible to use the PartySubIdOrType element for identifying an account under an Alias defined by the PartyIdentifier.
|
616
479
|
PartyIdentifier:
|
617
480
|
title: PartyIdentifier
|
618
481
|
type: string
|
@@ -625,16 +488,10 @@ components:
|
|
625
488
|
type: string
|
626
489
|
minLength: 1
|
627
490
|
maxLength: 128
|
628
|
-
description:
|
629
|
-
Either a sub-identifier of a PartyIdentifier, or a sub-type of the
|
630
|
-
PartyIdType, normally a PersonalIdentifierType.
|
491
|
+
description: Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
|
631
492
|
Currency:
|
632
493
|
title: Currency
|
633
|
-
description:
|
634
|
-
The currency codes defined in [ISO
|
635
|
-
4217](https://www.iso.org/iso-4217-currency-codes.html) as three-letter
|
636
|
-
alphabetic codes are used as the standard naming representation for
|
637
|
-
currencies.
|
494
|
+
description: The currency codes defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) as three-letter alphabetic codes are used as the standard naming representation for currencies.
|
638
495
|
type: string
|
639
496
|
minLength: 3
|
640
497
|
maxLength: 3
|
@@ -823,15 +680,8 @@ components:
|
|
823
680
|
CorrelationId:
|
824
681
|
title: CorrelationId
|
825
682
|
type: string
|
826
|
-
pattern:
|
827
|
-
|
828
|
-
description: >-
|
829
|
-
Identifier that correlates all messages of the same sequence. The API
|
830
|
-
data type UUID (Universally Unique Identifier) is a JSON String in
|
831
|
-
canonical format, conforming to [RFC
|
832
|
-
4122](https://tools.ietf.org/html/rfc4122), that is restricted by a
|
833
|
-
regular expression for interoperability reasons. A UUID is always 36
|
834
|
-
characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
|
683
|
+
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
684
|
+
description: Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
|
835
685
|
example: b51ec534-ee48-4575-b6a9-ead2955b8069
|
836
686
|
errorResponse:
|
837
687
|
type: object
|
@@ -867,14 +717,7 @@ components:
|
|
867
717
|
title: ErrorCode
|
868
718
|
type: string
|
869
719
|
pattern: ^[1-9]\d{3}$
|
870
|
-
description:
|
871
|
-
The API data type ErrorCode is a JSON String of four characters,
|
872
|
-
consisting of digits only. Negative numbers are not allowed. A leading
|
873
|
-
zero is not allowed. Each error code in the API is a four-digit number,
|
874
|
-
for example, 1234, where the first number (1 in the example) represents
|
875
|
-
the high-level error category, the second number (2 in the example)
|
876
|
-
represents the low-level error category, and the last two numbers (34 in
|
877
|
-
the example) represent the specific error.
|
720
|
+
description: The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.
|
878
721
|
example: '5100'
|
879
722
|
ErrorDescription:
|
880
723
|
title: ErrorDescription
|
@@ -909,9 +752,7 @@ components:
|
|
909
752
|
ExtensionList:
|
910
753
|
title: ExtensionList
|
911
754
|
type: object
|
912
|
-
description:
|
913
|
-
Data model for the complex type ExtensionList. An optional list of
|
914
|
-
extensions, specific to deployment.
|
755
|
+
description: Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
|
915
756
|
properties:
|
916
757
|
extension:
|
917
758
|
type: array
|
@@ -943,16 +784,11 @@ components:
|
|
943
784
|
$ref: '#/components/schemas/ErrorInformation'
|
944
785
|
transferError:
|
945
786
|
type: object
|
946
|
-
description:
|
947
|
-
This may be a Mojaloop API error returned from another entity in the
|
948
|
-
scheme or an object representing other types of error e.g. exceptions
|
949
|
-
that may occur inside the scheme adapter.
|
787
|
+
description: 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.
|
950
788
|
properties:
|
951
789
|
httpStatusCode:
|
952
790
|
type: integer
|
953
|
-
description:
|
954
|
-
The HTTP status code returned to the caller. This is the same as the
|
955
|
-
actual HTTP status code returned with the response.
|
791
|
+
description: The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response.
|
956
792
|
mojaloopError:
|
957
793
|
$ref: '#/components/schemas/mojaloopError'
|
958
794
|
accountsResponse:
|
@@ -1007,29 +843,18 @@ components:
|
|
1007
843
|
title: Name
|
1008
844
|
type: string
|
1009
845
|
pattern: ^(?!\s*$)[\w .,'-]{1,128}$
|
1010
|
-
description:
|
1011
|
-
The API data type Name is a JSON String, restricted by a regular
|
1012
|
-
expression to avoid characters which are generally not used in a name.
|
1013
|
-
|
1014
|
-
|
1015
|
-
Regular Expression - The regular expression for restricting the Name
|
1016
|
-
type is "^(?!\s*$)[\w .,'-]{1,128}$". The restriction does not allow a
|
1017
|
-
string consisting of whitespace only, all Unicode characters are
|
1018
|
-
allowed, as well as the period (.) (apostrophe (‘), dash (-), comma (,)
|
1019
|
-
and space characters ( ).
|
846
|
+
description: |-
|
847
|
+
The API data type Name is a JSON String, restricted by a regular expression to avoid characters which are generally not used in a name.
|
1020
848
|
|
849
|
+
Regular Expression - The regular expression for restricting the Name type is "^(?!\s*$)[\w .,'-]{1,128}$". The restriction does not allow a string consisting of whitespace only, all Unicode characters are allowed, as well as the period (.) (apostrophe (‘), dash (-), comma (,) and space characters ( ).
|
1021
850
|
|
1022
|
-
**Note:** In some programming languages, Unicode support must be
|
1023
|
-
specifically enabled. For example, if Java is used, the flag
|
1024
|
-
UNICODE_CHARACTER_CLASS must be enabled to allow Unicode characters.
|
851
|
+
**Note:** In some programming languages, Unicode support must be specifically enabled. For example, if Java is used, the flag UNICODE_CHARACTER_CLASS must be enabled to allow Unicode characters.
|
1025
852
|
FirstName:
|
1026
853
|
title: FirstName
|
1027
854
|
type: string
|
1028
855
|
minLength: 1
|
1029
856
|
maxLength: 128
|
1030
|
-
pattern:
|
1031
|
-
^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
|
1032
|
-
.,''-]{1,128}$
|
857
|
+
pattern: ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$
|
1033
858
|
description: First name of the Party (Name Type).
|
1034
859
|
example: Henrik
|
1035
860
|
MiddleName:
|
@@ -1037,9 +862,7 @@ components:
|
|
1037
862
|
type: string
|
1038
863
|
minLength: 1
|
1039
864
|
maxLength: 128
|
1040
|
-
pattern:
|
1041
|
-
^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
|
1042
|
-
.,''-]{1,128}$
|
865
|
+
pattern: ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$
|
1043
866
|
description: Middle name of the Party (Name Type).
|
1044
867
|
example: Johannes
|
1045
868
|
LastName:
|
@@ -1047,26 +870,20 @@ components:
|
|
1047
870
|
type: string
|
1048
871
|
minLength: 1
|
1049
872
|
maxLength: 128
|
1050
|
-
pattern:
|
1051
|
-
^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
|
1052
|
-
.,''-]{1,128}$
|
873
|
+
pattern: ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$
|
1053
874
|
description: Last name of the Party (Name Type).
|
1054
875
|
example: Karlsson
|
1055
876
|
DateOfBirth:
|
1056
877
|
title: DateofBirth (type Date)
|
1057
878
|
type: string
|
1058
|
-
pattern:
|
1059
|
-
^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
|
879
|
+
pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
|
1060
880
|
description: Date of Birth of the Party.
|
1061
881
|
example: '1966-06-16'
|
1062
882
|
MerchantClassificationCode:
|
1063
883
|
title: MerchantClassificationCode
|
1064
884
|
type: string
|
1065
885
|
pattern: ^[\d]{1,4}$
|
1066
|
-
description:
|
1067
|
-
A limited set of pre-defined numbers. This list would be a limited set
|
1068
|
-
of numbers identifying a set of popular merchant types like School Fees,
|
1069
|
-
Pubs and Restaurants, Groceries, etc.
|
886
|
+
description: A limited set of pre-defined numbers. This list would be a limited set of numbers identifying a set of popular merchant types like School Fees, Pubs and Restaurants, Groceries, etc.
|
1070
887
|
FspId:
|
1071
888
|
title: FspId
|
1072
889
|
type: string
|
@@ -1115,26 +932,16 @@ components:
|
|
1115
932
|
enum:
|
1116
933
|
- SEND
|
1117
934
|
- RECEIVE
|
1118
|
-
description:
|
935
|
+
description: |-
|
1119
936
|
Below are the allowed values for the enumeration AmountType.
|
1120
|
-
|
1121
|
-
-
|
1122
|
-
should be withdrawn from the Payer account including any fees.
|
1123
|
-
|
1124
|
-
- RECEIVE - Amount the Payer would like the Payee to receive, that is,
|
1125
|
-
the amount that should be sent to the receiver exclusive of any fees.
|
937
|
+
- SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees.
|
938
|
+
- RECEIVE - Amount the Payer would like the Payee to receive, that is, the amount that should be sent to the receiver exclusive of any fees.
|
1126
939
|
example: RECEIVE
|
1127
940
|
Amount:
|
1128
941
|
title: Amount
|
1129
942
|
type: string
|
1130
943
|
pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
|
1131
|
-
description:
|
1132
|
-
The API data type Amount is a JSON String in a canonical format that is
|
1133
|
-
restricted by a regular expression for interoperability reasons. This
|
1134
|
-
pattern does not allow any trailing zeroes at all, but allows an amount
|
1135
|
-
without a minor currency unit. It also only allows four digits in the
|
1136
|
-
minor currency unit; a negative value is not allowed. Using more than 18
|
1137
|
-
digits in the major currency unit is not allowed.
|
944
|
+
description: The API data type Amount is a JSON String in a canonical format that is restricted by a regular expression for interoperability reasons. This pattern does not allow any trailing zeroes at all, but allows an amount without a minor currency unit. It also only allows four digits in the minor currency unit; a negative value is not allowed. Using more than 18 digits in the major currency unit is not allowed.
|
1138
945
|
example: '123.45'
|
1139
946
|
transferTransactionType:
|
1140
947
|
title: transferTransactionType
|
@@ -1146,9 +953,7 @@ components:
|
|
1146
953
|
title: TransactionSubScenario
|
1147
954
|
type: string
|
1148
955
|
pattern: ^[A-Z_]{1,32}$
|
1149
|
-
description:
|
1150
|
-
Possible sub-scenario, defined locally within the scheme (UndefinedEnum
|
1151
|
-
Type).
|
956
|
+
description: Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).
|
1152
957
|
example: LOCALLY_DEFINED_SUBSCENARIO
|
1153
958
|
Note:
|
1154
959
|
title: Note
|
@@ -1196,9 +1001,7 @@ components:
|
|
1196
1001
|
properties:
|
1197
1002
|
homeTransactionId:
|
1198
1003
|
type: string
|
1199
|
-
description:
|
1200
|
-
Transaction ID from the DFSP backend, used to reconcile transactions
|
1201
|
-
between the Switch and DFSP backend systems.
|
1004
|
+
description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
|
1202
1005
|
bulkQuoteId:
|
1203
1006
|
$ref: '#/components/schemas/CorrelationId'
|
1204
1007
|
from:
|
@@ -1215,17 +1018,8 @@ components:
|
|
1215
1018
|
DateTime:
|
1216
1019
|
title: DateTime
|
1217
1020
|
type: string
|
1218
|
-
pattern:
|
1219
|
-
|
1220
|
-
description: >-
|
1221
|
-
The API data type DateTime is a JSON String in a lexical format that is
|
1222
|
-
restricted by a regular expression for interoperability reasons. The
|
1223
|
-
format is according to [ISO
|
1224
|
-
8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed
|
1225
|
-
in a combined date, time and time zone format. A more readable version
|
1226
|
-
of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are
|
1227
|
-
"2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where Z
|
1228
|
-
indicates Zulu time zone, same as UTC).
|
1021
|
+
pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:(\.\d{3}))(?:Z|[+-][01]\d:[0-5]\d)$
|
1022
|
+
description: The API data type DateTime is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. The format is according to [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed in a combined date, time and time zone format. A more readable version of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are "2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where Z indicates Zulu time zone, same as UTC).
|
1229
1023
|
example: '2016-05-24T08:38:08.699-04:00'
|
1230
1024
|
bulkTransferStatus:
|
1231
1025
|
type: string
|
@@ -1247,27 +1041,19 @@ components:
|
|
1247
1041
|
Latitude:
|
1248
1042
|
title: Latitude
|
1249
1043
|
type: string
|
1250
|
-
pattern:
|
1251
|
-
|
1252
|
-
description: >-
|
1253
|
-
The API data type Latitude is a JSON String in a lexical format that is
|
1254
|
-
restricted by a regular expression for interoperability reasons.
|
1044
|
+
pattern: ^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$
|
1045
|
+
description: The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
|
1255
1046
|
example: '+45.4215'
|
1256
1047
|
Longitude:
|
1257
1048
|
title: Longitude
|
1258
1049
|
type: string
|
1259
|
-
pattern:
|
1260
|
-
|
1261
|
-
description: >-
|
1262
|
-
The API data type Longitude is a JSON String in a lexical format that is
|
1263
|
-
restricted by a regular expression for interoperability reasons.
|
1050
|
+
pattern: ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
|
1051
|
+
description: The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
|
1264
1052
|
example: '+75.6972'
|
1265
1053
|
GeoCode:
|
1266
1054
|
title: GeoCode
|
1267
1055
|
type: object
|
1268
|
-
description:
|
1269
|
-
Data model for the complex type GeoCode. Indicates the geographic
|
1270
|
-
location from where the transaction was initiated.
|
1056
|
+
description: Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated.
|
1271
1057
|
properties:
|
1272
1058
|
latitude:
|
1273
1059
|
$ref: '#/components/schemas/Latitude'
|
@@ -1283,8 +1069,7 @@ components:
|
|
1283
1069
|
minLength: 1
|
1284
1070
|
maxLength: 32768
|
1285
1071
|
description: Information for recipient (transport layer information).
|
1286
|
-
example:
|
1287
|
-
AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
|
1072
|
+
example: AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
|
1288
1073
|
IlpCondition:
|
1289
1074
|
title: IlpCondition
|
1290
1075
|
type: string
|
@@ -1293,15 +1078,11 @@ components:
|
|
1293
1078
|
description: Condition that must be attached to the transfer by the Payer.
|
1294
1079
|
quoteError:
|
1295
1080
|
type: object
|
1296
|
-
description:
|
1297
|
-
This object represents a Mojaloop API error received at any time during
|
1298
|
-
the quote process
|
1081
|
+
description: This object represents a Mojaloop API error received at any time during the quote process
|
1299
1082
|
properties:
|
1300
1083
|
httpStatusCode:
|
1301
1084
|
type: integer
|
1302
|
-
description:
|
1303
|
-
The HTTP status code returned to the caller. This is the same as the
|
1304
|
-
actual HTTP status code returned with the response.
|
1085
|
+
description: The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response.
|
1305
1086
|
mojaloopError:
|
1306
1087
|
$ref: '#/components/schemas/mojaloopError'
|
1307
1088
|
individualQuoteResult:
|
@@ -1341,9 +1122,7 @@ components:
|
|
1341
1122
|
$ref: '#/components/schemas/CorrelationId'
|
1342
1123
|
homeTransactionId:
|
1343
1124
|
type: string
|
1344
|
-
description:
|
1345
|
-
Transaction ID from the DFSP backend, used to reconcile transactions
|
1346
|
-
between the Switch and DFSP backend systems.
|
1125
|
+
description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
|
1347
1126
|
expiration:
|
1348
1127
|
$ref: '#/components/schemas/DateTime'
|
1349
1128
|
extensionList:
|
@@ -1430,42 +1209,27 @@ components:
|
|
1430
1209
|
- bulkExpiration
|
1431
1210
|
properties:
|
1432
1211
|
onlyValidateParty:
|
1433
|
-
description:
|
1434
|
-
Set to true if only party validation is required. This means the
|
1435
|
-
quotes and transfers will not run. This is useful for only party
|
1436
|
-
resolution.
|
1212
|
+
description: Set to true if only party validation is required. This means the quotes and transfers will not run. This is useful for only party resolution.
|
1437
1213
|
type: boolean
|
1438
1214
|
autoAcceptParty:
|
1439
1215
|
$ref: '#/components/schemas/autoAcceptPartyOption'
|
1440
1216
|
autoAcceptQuote:
|
1441
|
-
description:
|
1442
|
-
Set to true if the quote response is accepted without confirmation
|
1443
|
-
from the payer. The fees applied by the payee will be acceptable to
|
1444
|
-
the payer abiding by the limits set by optional
|
1445
|
-
'perTransferFeeLimits' array.
|
1217
|
+
description: Set to true if the quote response is accepted without confirmation from the payer. The fees applied by the payee will be acceptable to the payer abiding by the limits set by optional 'perTransferFeeLimits' array.
|
1446
1218
|
type: object
|
1447
1219
|
oneOf:
|
1448
1220
|
- $ref: '#/components/schemas/autoAcceptQuote'
|
1449
1221
|
skipPartyLookup:
|
1450
|
-
description:
|
1451
|
-
Set to true if supplying an FSPID for the payee party and no party
|
1452
|
-
resolution is needed. This may be useful if a previous party
|
1453
|
-
resolution has been performed.
|
1222
|
+
description: Set to true if supplying an FSPID for the payee party and no party resolution is needed. This may be useful if a previous party resolution has been performed.
|
1454
1223
|
type: boolean
|
1455
1224
|
synchronous:
|
1456
|
-
description:
|
1457
|
-
Set to true if the bulkTransfer requests need be handled
|
1458
|
-
synchronous. Otherwise the requests will be handled asynchronously,
|
1459
|
-
meaning there will be callbacks whenever the processing is done
|
1225
|
+
description: Set to true if the bulkTransfer requests need be handled synchronous. Otherwise the requests will be handled asynchronously, meaning there will be callbacks whenever the processing is done
|
1460
1226
|
type: boolean
|
1461
1227
|
bulkExpiration:
|
1462
1228
|
$ref: '#/components/schemas/DateTime'
|
1463
1229
|
PartyIdInfo:
|
1464
1230
|
title: PartyIdInfo
|
1465
1231
|
type: object
|
1466
|
-
description:
|
1467
|
-
Data model for the complex type PartyIdInfo. An ExtensionList element
|
1468
|
-
has been added to this reqeust in version v1.1
|
1232
|
+
description: Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1
|
1469
1233
|
properties:
|
1470
1234
|
partyIdType:
|
1471
1235
|
$ref: '#/components/schemas/PartyIdType'
|
@@ -1528,9 +1292,7 @@ components:
|
|
1528
1292
|
properties:
|
1529
1293
|
homeTransactionId:
|
1530
1294
|
type: string
|
1531
|
-
description:
|
1532
|
-
Transaction ID from the DFSP backend, used to reconcile transactions
|
1533
|
-
between the Switch and DFSP backend systems.
|
1295
|
+
description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
|
1534
1296
|
to:
|
1535
1297
|
$ref: '#/components/schemas/Party'
|
1536
1298
|
reference:
|
@@ -1567,9 +1329,7 @@ components:
|
|
1567
1329
|
properties:
|
1568
1330
|
bulkHomeTransactionID:
|
1569
1331
|
type: string
|
1570
|
-
description:
|
1571
|
-
Transaction ID from the DFSP backend, used to reconcile transactions
|
1572
|
-
between the Switch and DFSP backend systems.
|
1332
|
+
description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
|
1573
1333
|
bulkTransactionId:
|
1574
1334
|
$ref: '#/components/schemas/CorrelationId'
|
1575
1335
|
options:
|
@@ -1592,17 +1352,12 @@ components:
|
|
1592
1352
|
- RESERVED
|
1593
1353
|
- COMMITTED
|
1594
1354
|
- ABORTED
|
1595
|
-
description:
|
1355
|
+
description: |-
|
1596
1356
|
Below are the allowed values for the enumeration.
|
1597
|
-
|
1598
1357
|
- RECEIVED - Next ledger has received the transfer.
|
1599
|
-
|
1600
1358
|
- RESERVED - Next ledger has reserved the transfer.
|
1601
|
-
|
1602
1359
|
- COMMITTED - Next ledger has successfully performed the transfer.
|
1603
|
-
|
1604
|
-
- ABORTED - Next ledger has aborted the transfer due to a rejection or
|
1605
|
-
failure to perform the transfer.
|
1360
|
+
- ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.
|
1606
1361
|
example: RESERVED
|
1607
1362
|
IlpFulfilment:
|
1608
1363
|
title: IlpFulfilment
|
@@ -1639,9 +1394,7 @@ components:
|
|
1639
1394
|
$ref: '#/components/schemas/CorrelationId'
|
1640
1395
|
homeTransactionId:
|
1641
1396
|
type: string
|
1642
|
-
description:
|
1643
|
-
Transaction ID from the DFSP backend, used to reconcile transactions
|
1644
|
-
between the Switch and DFSP backend systems.
|
1397
|
+
description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
|
1645
1398
|
bulkTransferState:
|
1646
1399
|
$ref: '#/components/schemas/TransferState'
|
1647
1400
|
completedTimestamp:
|
@@ -1684,17 +1437,13 @@ components:
|
|
1684
1437
|
- true
|
1685
1438
|
- false
|
1686
1439
|
bulkTransactionContinuationAcceptParty:
|
1687
|
-
description:
|
1688
|
-
The object sent back as confirmation of payee parties when
|
1689
|
-
autoAcceptParty is false.
|
1440
|
+
description: The object sent back as confirmation of payee parties when autoAcceptParty is false.
|
1690
1441
|
type: object
|
1691
1442
|
required:
|
1692
1443
|
- individualTransfers
|
1693
1444
|
properties:
|
1694
1445
|
individualTransfers:
|
1695
|
-
description:
|
1696
|
-
List of individual transfers in a bulk transfer with accept party
|
1697
|
-
information.
|
1446
|
+
description: List of individual transfers in a bulk transfer with accept party information.
|
1698
1447
|
type: array
|
1699
1448
|
minItems: 1
|
1700
1449
|
items:
|
@@ -1712,9 +1461,7 @@ components:
|
|
1712
1461
|
- true
|
1713
1462
|
- false
|
1714
1463
|
bulkTransactionContinuationAcceptQuote:
|
1715
|
-
description:
|
1716
|
-
The object sent back as confirmation of quotes when autoAcceptQuotes is
|
1717
|
-
false.
|
1464
|
+
description: The object sent back as confirmation of quotes when autoAcceptQuotes is false.
|
1718
1465
|
type: object
|
1719
1466
|
required:
|
1720
1467
|
- individualTransfers
|
@@ -1729,15 +1476,11 @@ components:
|
|
1729
1476
|
- $ref: '#/components/schemas/transferContinuationAcceptQuote'
|
1730
1477
|
partyError:
|
1731
1478
|
type: object
|
1732
|
-
description:
|
1733
|
-
This object represents a Mojaloop API error received at any time during
|
1734
|
-
the party discovery process
|
1479
|
+
description: This object represents a Mojaloop API error received at any time during the party discovery process
|
1735
1480
|
properties:
|
1736
1481
|
httpStatusCode:
|
1737
1482
|
type: integer
|
1738
|
-
description:
|
1739
|
-
The HTTP status code returned to the caller. This is the same as the
|
1740
|
-
actual HTTP status code returned with the response.
|
1483
|
+
description: The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response.
|
1741
1484
|
mojaloopError:
|
1742
1485
|
$ref: '#/components/schemas/mojaloopError'
|
1743
1486
|
bulkTransactionAcceptPartyErrorResponse:
|
@@ -1808,9 +1551,7 @@ components:
|
|
1808
1551
|
properties:
|
1809
1552
|
homeTransactionId:
|
1810
1553
|
type: string
|
1811
|
-
description:
|
1812
|
-
Transaction ID from the DFSP backend, used to reconcile transactions
|
1813
|
-
between the Switch and DFSP backend systems.
|
1554
|
+
description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
|
1814
1555
|
bulkTransferId:
|
1815
1556
|
$ref: '#/components/schemas/CorrelationId'
|
1816
1557
|
bulkQuoteId:
|
@@ -1828,9 +1569,7 @@ components:
|
|
1828
1569
|
$ref: '#/components/schemas/ExtensionList'
|
1829
1570
|
individualTransferFulfilment:
|
1830
1571
|
type: object
|
1831
|
-
description:
|
1832
|
-
A Mojaloop API transfer fulfilment for individual transfers in a bulk
|
1833
|
-
transfer
|
1572
|
+
description: A Mojaloop API transfer fulfilment for individual transfers in a bulk transfer
|
1834
1573
|
properties:
|
1835
1574
|
fulfilment:
|
1836
1575
|
$ref: '#/components/schemas/IlpFulfilment'
|
@@ -1887,28 +1626,12 @@ components:
|
|
1887
1626
|
- TRANSFER
|
1888
1627
|
- PAYMENT
|
1889
1628
|
- REFUND
|
1890
|
-
description:
|
1629
|
+
description: |-
|
1891
1630
|
Below are the allowed values for the enumeration.
|
1892
|
-
|
1893
|
-
-
|
1894
|
-
|
1895
|
-
|
1896
|
-
Consumer to the Business User.
|
1897
|
-
|
1898
|
-
- WITHDRAWAL - Used for performing a Cash-Out (withdrawal) transaction.
|
1899
|
-
In a normal scenario, electronic funds are transferred from a Consumer’s
|
1900
|
-
account to a Business account, and physical cash is given from the
|
1901
|
-
Business User to the Consumer.
|
1902
|
-
|
1903
|
-
- TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to
|
1904
|
-
Consumer) transaction.
|
1905
|
-
|
1906
|
-
- PAYMENT - Usually used for performing a transaction from a Consumer to
|
1907
|
-
a Merchant or Organization, but could also be for a B2B (Business to
|
1908
|
-
Business) payment. The transaction could be online for a purchase in an
|
1909
|
-
Internet store, in a physical store where both the Consumer and Business
|
1910
|
-
User are present, a bill payment, a donation, and so on.
|
1911
|
-
|
1631
|
+
- DEPOSIT - Used for performing a Cash-In (deposit) transaction. In a normal scenario, electronic funds are transferred from a Business account to a Consumer account, and physical cash is given from the Consumer to the Business User.
|
1632
|
+
- WITHDRAWAL - Used for performing a Cash-Out (withdrawal) transaction. In a normal scenario, electronic funds are transferred from a Consumer’s account to a Business account, and physical cash is given from the Business User to the Consumer.
|
1633
|
+
- TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer) transaction.
|
1634
|
+
- PAYMENT - Usually used for performing a transaction from a Consumer to a Merchant or Organization, but could also be for a B2B (Business to Business) payment. The transaction could be online for a purchase in an Internet store, in a physical store where both the Consumer and Business User are present, a bill payment, a donation, and so on.
|
1912
1635
|
- REFUND - Used for performing a refund of transaction.
|
1913
1636
|
example: DEPOSIT
|
1914
1637
|
TransactionInitiator:
|
@@ -1917,17 +1640,10 @@ components:
|
|
1917
1640
|
enum:
|
1918
1641
|
- PAYER
|
1919
1642
|
- PAYEE
|
1920
|
-
description:
|
1643
|
+
description: |-
|
1921
1644
|
Below are the allowed values for the enumeration.
|
1922
|
-
|
1923
|
-
-
|
1924
|
-
send from is either owned by the Payer or is connected to the Payer in
|
1925
|
-
some way.
|
1926
|
-
|
1927
|
-
- PAYEE - Recipient of the funds is initiating the transaction by
|
1928
|
-
sending a transaction request. The Payer must approve the transaction,
|
1929
|
-
either automatically by a pre-generated OTP or by pre-approval of the
|
1930
|
-
Payee, or by manually approving in his or her own Device.
|
1645
|
+
- PAYER - Sender of funds is initiating the transaction. The account to send from is either owned by the Payer or is connected to the Payer in some way.
|
1646
|
+
- PAYEE - Recipient of the funds is initiating the transaction by sending a transaction request. The Payer must approve the transaction, either automatically by a pre-generated OTP or by pre-approval of the Payee, or by manually approving in his or her own Device.
|
1931
1647
|
example: PAYEE
|
1932
1648
|
RefundReason:
|
1933
1649
|
title: RefundReason
|
@@ -1951,11 +1667,7 @@ components:
|
|
1951
1667
|
title: BalanceOfPayments
|
1952
1668
|
type: string
|
1953
1669
|
pattern: ^[1-9]\d{2}$
|
1954
|
-
description:
|
1955
|
-
(BopCode) The API data type
|
1956
|
-
[BopCode](https://www.imf.org/external/np/sta/bopcode/) is a JSON String
|
1957
|
-
of 3 characters, consisting of digits only. Negative numbers are not
|
1958
|
-
allowed. A leading zero is not allowed.
|
1670
|
+
description: (BopCode) The API data type [BopCode](https://www.imf.org/external/np/sta/bopcode/) is a JSON String of 3 characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed.
|
1959
1671
|
example: '123'
|
1960
1672
|
TransactionType:
|
1961
1673
|
title: TransactionType
|
@@ -2050,9 +1762,7 @@ components:
|
|
2050
1762
|
$ref: '#/components/schemas/Money'
|
2051
1763
|
expiration:
|
2052
1764
|
type: string
|
2053
|
-
description:
|
2054
|
-
Date and time until when the quotation is valid and can be
|
2055
|
-
honored when used in the subsequent transaction.
|
1765
|
+
description: Date and time until when the quotation is valid and can be honored when used in the subsequent transaction.
|
2056
1766
|
example: '2016-05-24T08:38:08.699-04:00'
|
2057
1767
|
geoCode:
|
2058
1768
|
$ref: '#/components/schemas/GeoCode'
|
@@ -2107,9 +1817,7 @@ components:
|
|
2107
1817
|
properties:
|
2108
1818
|
homeR2PTransactionId:
|
2109
1819
|
type: string
|
2110
|
-
description:
|
2111
|
-
Transaction ID from the DFSP backend, used to reconcile transactions
|
2112
|
-
between the Switch and DFSP backend systems.
|
1820
|
+
description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
|
2113
1821
|
from:
|
2114
1822
|
$ref: '#/components/schemas/transferParty'
|
2115
1823
|
to:
|
@@ -2281,9 +1989,7 @@ components:
|
|
2281
1989
|
$ref: '#/components/schemas/CorrelationId'
|
2282
1990
|
homeTransactionId:
|
2283
1991
|
type: string
|
2284
|
-
description:
|
2285
|
-
Transaction ID from the DFSP backend, used to reconcile transactions
|
2286
|
-
between the Switch and DFSP backend systems.
|
1992
|
+
description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
|
2287
1993
|
from:
|
2288
1994
|
$ref: '#/components/schemas/transferParty'
|
2289
1995
|
to:
|
@@ -2324,11 +2030,8 @@ components:
|
|
2324
2030
|
type: object
|
2325
2031
|
quoteResponseSource:
|
2326
2032
|
type: string
|
2327
|
-
description:
|
2328
|
-
FSPID of the entity that supplied the quote response. This may not
|
2329
|
-
be the same as the FSPID of the entity which owns the end user
|
2330
|
-
account in the case of a FOREX transfer. i.e. it may be a FOREX
|
2331
|
-
gateway.
|
2033
|
+
description: |
|
2034
|
+
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.
|
2332
2035
|
fulfil:
|
2333
2036
|
type: object
|
2334
2037
|
required:
|
@@ -2341,10 +2044,7 @@ components:
|
|
2341
2044
|
lastError:
|
2342
2045
|
$ref: '#/components/schemas/transferError'
|
2343
2046
|
skipPartyLookup:
|
2344
|
-
description:
|
2345
|
-
Set to true if supplying an FSPID for the payee party and no party
|
2346
|
-
resolution is needed. This may be useful is a previous party
|
2347
|
-
resolution has been performed.
|
2047
|
+
description: Set to true if supplying an FSPID for the payee party and no party resolution is needed. This may be useful is a previous party resolution has been performed.
|
2348
2048
|
type: boolean
|
2349
2049
|
errorTransferResponse:
|
2350
2050
|
allOf:
|
@@ -2371,9 +2071,7 @@ components:
|
|
2371
2071
|
properties:
|
2372
2072
|
homeR2PTransactionId:
|
2373
2073
|
type: string
|
2374
|
-
description:
|
2375
|
-
Transaction ID from the DFSP backend, used to reconcile transactions
|
2376
|
-
between the Switch and DFSP backend systems.
|
2074
|
+
description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
|
2377
2075
|
transactionRequestId:
|
2378
2076
|
$ref: '#/components/schemas/CorrelationId'
|
2379
2077
|
from:
|
@@ -2404,10 +2102,7 @@ components:
|
|
2404
2102
|
- title: OtpValue
|
2405
2103
|
type: string
|
2406
2104
|
pattern: ^\d{3,10}$
|
2407
|
-
description:
|
2408
|
-
The API data type OtpValue is a JSON String of 3 to 10 characters,
|
2409
|
-
consisting of digits only. Negative numbers are not allowed. One or
|
2410
|
-
more leading zeros are allowed.
|
2105
|
+
description: The API data type OtpValue is a JSON String of 3 to 10 characters, consisting of digits only. Negative numbers are not allowed. One or more leading zeros are allowed.
|
2411
2106
|
- title: QRCODE
|
2412
2107
|
type: string
|
2413
2108
|
minLength: 1
|
@@ -2415,33 +2110,26 @@ components:
|
|
2415
2110
|
description: QR code used as a One Time Password.
|
2416
2111
|
- title: U2FPinValue
|
2417
2112
|
type: object
|
2418
|
-
description:
|
2419
|
-
U2F challenge-response, where payer FSP verifies if the response
|
2420
|
-
provided by end-user device matches the previously registered key.
|
2113
|
+
description: |
|
2114
|
+
U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key.
|
2421
2115
|
properties:
|
2422
2116
|
pinValue:
|
2423
2117
|
type: string
|
2424
2118
|
pattern: ^\S{1,64}$
|
2425
2119
|
minLength: 1
|
2426
2120
|
maxLength: 64
|
2427
|
-
description:
|
2428
|
-
U2F challenge-response, where payer FSP verifies if the response
|
2429
|
-
provided by end-user device matches the previously registered
|
2430
|
-
key.
|
2121
|
+
description: |
|
2122
|
+
U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key.
|
2431
2123
|
counter:
|
2432
2124
|
title: Integer
|
2433
2125
|
type: string
|
2434
2126
|
pattern: ^[1-9]\d*$
|
2435
|
-
description:
|
2436
|
-
Sequential counter used for cloning detection. Present only for
|
2437
|
-
U2F authentication.
|
2127
|
+
description: Sequential counter used for cloning detection. Present only for U2F authentication.
|
2438
2128
|
required:
|
2439
2129
|
- pinValue
|
2440
2130
|
- counter
|
2441
2131
|
pattern: ^\d{3,10}$|^\S{1,64}$
|
2442
|
-
description:
|
2443
|
-
Contains the authentication value. The format depends on the
|
2444
|
-
authentication type used in the AuthenticationInfo complex type.
|
2132
|
+
description: Contains the authentication value. The format depends on the authentication type used in the AuthenticationInfo complex type.
|
2445
2133
|
AuthenticationInfo:
|
2446
2134
|
title: AuthenticationInfo
|
2447
2135
|
type: object
|
@@ -2493,9 +2181,7 @@ components:
|
|
2493
2181
|
$ref: '#/components/schemas/CorrelationId'
|
2494
2182
|
homeR2PTransactionId:
|
2495
2183
|
type: string
|
2496
|
-
description:
|
2497
|
-
Transaction ID from the DFSP backend, used to reconcile transactions
|
2498
|
-
between the Switch and DFSP backend systems.
|
2184
|
+
description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
|
2499
2185
|
transactionRequestId:
|
2500
2186
|
$ref: '#/components/schemas/CorrelationId'
|
2501
2187
|
from:
|
@@ -2527,11 +2213,8 @@ components:
|
|
2527
2213
|
type: object
|
2528
2214
|
quoteResponseSource:
|
2529
2215
|
type: string
|
2530
|
-
description:
|
2531
|
-
FSPID of the entity that supplied the quote response. This may not
|
2532
|
-
be the same as the FSPID of the entity which owns the end user
|
2533
|
-
account in the case of a FOREX transfer. i.e. it may be a FOREX
|
2534
|
-
gateway.
|
2216
|
+
description: |
|
2217
|
+
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.
|
2535
2218
|
authorizationResponse:
|
2536
2219
|
type: object
|
2537
2220
|
required:
|
@@ -2637,9 +2320,7 @@ components:
|
|
2637
2320
|
properties:
|
2638
2321
|
homeTransactionId:
|
2639
2322
|
type: string
|
2640
|
-
description:
|
2641
|
-
Transaction ID from the DFSP backend, used to reconcile transactions
|
2642
|
-
between the Switch and DFSP backend systems.
|
2323
|
+
description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
|
2643
2324
|
from:
|
2644
2325
|
$ref: '#/components/schemas/transferParty'
|
2645
2326
|
to:
|
@@ -2661,10 +2342,7 @@ components:
|
|
2661
2342
|
transferRequestExtensions:
|
2662
2343
|
$ref: '#/components/schemas/extensionListEmptiable'
|
2663
2344
|
skipPartyLookup:
|
2664
|
-
description:
|
2665
|
-
Set to true if supplying an FSPID for the payee party and no party
|
2666
|
-
resolution is needed. This may be useful is a previous party
|
2667
|
-
resolution has been performed.
|
2345
|
+
description: Set to true if supplying an FSPID for the payee party and no party resolution is needed. This may be useful is a previous party resolution has been performed.
|
2668
2346
|
type: boolean
|
2669
2347
|
transferStatusResponse:
|
2670
2348
|
type: object
|
@@ -2845,27 +2523,21 @@ components:
|
|
2845
2523
|
required: true
|
2846
2524
|
schema:
|
2847
2525
|
$ref: '#/components/schemas/CorrelationId'
|
2848
|
-
description:
|
2849
|
-
Identifier of the bulk transfer to continue as returned in the response
|
2850
|
-
to a `POST /bulkTransfers` request.
|
2526
|
+
description: Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request.
|
2851
2527
|
bulkTransactionId:
|
2852
2528
|
name: bulkTransactionId
|
2853
2529
|
in: path
|
2854
2530
|
required: true
|
2855
2531
|
schema:
|
2856
2532
|
$ref: '#/components/schemas/CorrelationId'
|
2857
|
-
description:
|
2858
|
-
Identifier of the bulk transaction to continue as returned in the
|
2859
|
-
response to a `POST /bulkTransaction` request.
|
2533
|
+
description: Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request.
|
2860
2534
|
bulkTransferId:
|
2861
2535
|
name: bulkTransferId
|
2862
2536
|
in: path
|
2863
2537
|
required: true
|
2864
2538
|
schema:
|
2865
2539
|
$ref: '#/components/schemas/CorrelationId'
|
2866
|
-
description:
|
2867
|
-
Identifier of the bulk transfer to continue as returned in the response
|
2868
|
-
to a `POST /bulkTransfers` request.
|
2540
|
+
description: Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request.
|
2869
2541
|
Type:
|
2870
2542
|
name: Type
|
2871
2543
|
in: path
|
@@ -2886,24 +2558,18 @@ components:
|
|
2886
2558
|
required: true
|
2887
2559
|
schema:
|
2888
2560
|
type: string
|
2889
|
-
description:
|
2890
|
-
A sub-identifier of the party identifier, or a sub-type of the party
|
2891
|
-
identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`.
|
2561
|
+
description: A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`.
|
2892
2562
|
transactionRequestId:
|
2893
2563
|
name: transactionRequestId
|
2894
2564
|
in: path
|
2895
2565
|
required: true
|
2896
2566
|
schema:
|
2897
2567
|
$ref: '#/components/schemas/CorrelationId'
|
2898
|
-
description:
|
2899
|
-
Identifier of the merchant request to pay to continue as returned in the
|
2900
|
-
response to a `POST /requestToPay` request.
|
2568
|
+
description: Identifier of the merchant request to pay to continue as returned in the response to a `POST /requestToPay` request.
|
2901
2569
|
transferId:
|
2902
2570
|
name: transferId
|
2903
2571
|
in: path
|
2904
2572
|
required: true
|
2905
2573
|
schema:
|
2906
2574
|
$ref: '#/components/schemas/CorrelationId'
|
2907
|
-
description:
|
2908
|
-
Identifier of the transfer to continue as returned in the response to a
|
2909
|
-
`POST /transfers` request.
|
2575
|
+
description: Identifier of the transfer to continue as returned in the response to a `POST /transfers` request.
|