@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.
@@ -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
- This API can be used by DFSP backends to simplify the process of sending
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
- Continues a request funds from sender that has paused at the party
301
- resolution stage in order to accept or reject party information
302
- description: >
303
- The HTTP request `PUT /requestToPay/{transactionRequestId}` is used to
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
- Used to trigger funds from customer fsp account to merchant fsp account.
332
- This is a follow-up request to requestToPay.
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.
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.
361
301
 
362
-
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
- Continues a transfer that has paused at the otp stage in order to accept
390
- or reject quote
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
-
396
-
397
- The request body should contain either the "acceptOTP" or "acceptQuote"
398
- property set to `true` as required to continue the transfer.
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.
399
326
 
327
+ The request body should contain either the "acceptOTP" or "acceptQuote" property set to `true` as required to continue the transfer.
400
328
 
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,23 +407,13 @@ paths:
495
407
  $ref: '#/components/responses/transferTimeout'
496
408
  /transfers/{transferId}:
497
409
  put:
498
- summary: >-
499
- Continues a transfer that has paused at the quote stage in order to
500
- accept or reject payee party and/or quote and/or conversion
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 and/or currency conversion
505
- stage.
506
-
410
+ summary: Continues a transfer that has paused at the quote stage in order to accept or reject payee party and/or quote and/or conversion
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 and/or currency conversion stage.
507
413
 
508
- The request body should contain either the "acceptParty" or
509
- "acceptQuote" or "acceptConversion" property set to `true` as required
510
- to continue the transfer.
414
+ The request body should contain either the "acceptParty" or "acceptQuote" or "acceptConversion" property set to `true` as required to continue the transfer.
511
415
 
512
-
513
- See the description of the `POST /transfers` HTTP method for more
514
- information on modes of transfer.
416
+ See the description of the `POST /transfers` HTTP method for more information on modes of transfer.
515
417
  tags:
516
418
  - Transfers
517
419
  requestBody:
@@ -533,11 +435,7 @@ paths:
533
435
  $ref: '#/components/responses/transferTimeout'
534
436
  get:
535
437
  summary: Retrieves information for a specific transfer
536
- description: >-
537
- The HTTP request `GET /transfers/{transferId}` is used to get
538
- information regarding a transfer created or requested earlier. The
539
- `{transferId}` in the URI should contain the `transferId` that was used
540
- for the creation of the transfer.
438
+ 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.
541
439
  tags:
542
440
  - Transfers
543
441
  parameters:
@@ -557,10 +455,7 @@ paths:
557
455
  $ref: '#/components/schemas/errorResponse'
558
456
  /services/FXP:
559
457
  get:
560
- description: >-
561
- The HTTP request `GET /services/FXP` is used to request information
562
- about the participants in a scheme who offer currency conversion
563
- services.
458
+ description: The HTTP request `GET /services/FXP` is used to request information about the participants in a scheme who offer currency conversion services.
564
459
  summary: Obtain a list of the DFSPs in the scheme who provide FXP service
565
460
  tags:
566
461
  - servicesFXP
@@ -574,12 +469,7 @@ paths:
574
469
  $ref: '#/components/responses/500'
575
470
  /services/FXP/{SourceCurrency}/{TargetCurrency}:
576
471
  get:
577
- description: >-
578
- The HTTP request `GET /services/FXP/{SourceCurrency}/{TargetCurrency}`
579
- is used to request information about the participants in a scheme who
580
- offer currency conversion services in a particular currency corridor.
581
- The required corridor is specified by giving the ISO 4217 currency code
582
- for the SourceCurrency and the TargetCurrency.
472
+ description: The HTTP request `GET /services/FXP/{SourceCurrency}/{TargetCurrency}` is used to request information about the participants in a scheme who offer currency conversion services in a particular currency corridor. The required corridor is specified by giving the ISO 4217 currency code for the SourceCurrency and the TargetCurrency.
583
473
  summary: Obtain a list of the DFSPs in the scheme who provide FXP service
584
474
  tags:
585
475
  - servicesFXP
@@ -596,9 +486,7 @@ paths:
596
486
  $ref: '#/components/responses/500'
597
487
  /fxQuotes:
598
488
  post:
599
- description: >-
600
- The HTTP request `POST /fxQuotes` is used to ask to provide a quotation
601
- for a currency conversion.
489
+ description: The HTTP request `POST /fxQuotes` is used to ask to provide a quotation for a currency conversion.
602
490
  summary: Calculate FX quote
603
491
  tags:
604
492
  - Fx
@@ -623,9 +511,7 @@ paths:
623
511
  $ref: '#/components/responses/500'
624
512
  /fxTransfers:
625
513
  post:
626
- description: >-
627
- The HTTP request `POST /fxTransfers` is used to ask to confirm the
628
- execution of an agreed currency conversion.
514
+ description: The HTTP request `POST /fxTransfers` is used to ask to confirm the execution of an agreed currency conversion.
629
515
  summary: Perform FX transfer
630
516
  tags:
631
517
  - Fx
@@ -662,52 +548,16 @@ components:
662
548
  - ACCOUNT_ID
663
549
  - IBAN
664
550
  - ALIAS
665
- description: >-
551
+ description: |-
666
552
  Below are the allowed values for the enumeration.
667
-
668
- - MSISDN - An MSISDN (Mobile Station International Subscriber Directory
669
- Number, that is, the phone number) is used as reference to a
670
- participant. The MSISDN identifier should be in international format
671
- according to the [ITU-T E.164
672
- standard](https://www.itu.int/rec/T-REC-E.164/en). Optionally, the
673
- MSISDN may be prefixed by a single plus sign, indicating the
674
- international prefix.
675
-
676
- - EMAIL - An email is used as reference to a participant. The format of
677
- the email should be according to the informational [RFC
678
- 3696](https://tools.ietf.org/html/rfc3696).
679
-
680
- - PERSONAL_ID - A personal identifier is used as reference to a
681
- participant. Examples of personal identification are passport number,
682
- birth certificate number, and national registration number. The
683
- identifier number is added in the PartyIdentifier element. The personal
684
- identifier type is added in the PartySubIdOrType element.
685
-
686
- - BUSINESS - A specific Business (for example, an organization or a
687
- company) is used as reference to a participant. The BUSINESS identifier
688
- can be in any format. To make a transaction connected to a specific
689
- username or bill number in a Business, the PartySubIdOrType element
690
- should be used.
691
-
692
- - DEVICE - A specific device (for example, a POS or ATM) ID connected to
693
- a specific business or organization is used as reference to a Party. For
694
- referencing a specific device under a specific business or organization,
695
- use the PartySubIdOrType element.
696
-
697
- - ACCOUNT_ID - A bank account number or FSP account ID should be used as
698
- reference to a participant. The ACCOUNT_ID identifier can be in any
699
- format, as formats can greatly differ depending on country and FSP.
700
-
701
- - IBAN - A bank account number or FSP account ID is used as reference to
702
- a participant. The IBAN identifier can consist of up to 34 alphanumeric
703
- characters and should be entered without whitespace.
704
-
705
- - ALIAS An alias is used as reference to a participant. The alias should
706
- be created in the FSP as an alternative reference to an account owner.
707
- Another example of an alias is a username in the FSP system. The ALIAS
708
- identifier can be in any format. It is also possible to use the
709
- PartySubIdOrType element for identifying an account under an Alias
710
- defined by the PartyIdentifier.
553
+ - 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.
554
+ - 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).
555
+ - 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.
556
+ - 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.
557
+ - 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.
558
+ - 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.
559
+ - 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.
560
+ - 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.
711
561
  PartyIdentifier:
712
562
  title: PartyIdentifier
713
563
  type: string
@@ -720,16 +570,10 @@ components:
720
570
  type: string
721
571
  minLength: 1
722
572
  maxLength: 128
723
- description: >-
724
- Either a sub-identifier of a PartyIdentifier, or a sub-type of the
725
- PartyIdType, normally a PersonalIdentifierType.
573
+ description: Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
726
574
  Currency:
727
575
  title: Currency
728
- description: >-
729
- The currency codes defined in [ISO
730
- 4217](https://www.iso.org/iso-4217-currency-codes.html) as three-letter
731
- alphabetic codes are used as the standard naming representation for
732
- currencies.
576
+ 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.
733
577
  type: string
734
578
  minLength: 3
735
579
  maxLength: 3
@@ -918,28 +762,17 @@ components:
918
762
  CorrelationId:
919
763
  title: CorrelationId
920
764
  type: string
921
- pattern: >-
922
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
923
- description: >-
924
- Identifier that correlates all messages of the same sequence. The API
925
- data type UUID (Universally Unique Identifier) is a JSON String in
926
- canonical format, conforming to [RFC
927
- 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a
928
- regular expression for interoperability reasons. A UUID is always 36
929
- characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
765
+ pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
766
+ 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 (‘-‘).
930
767
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
931
768
  errorResponse:
932
769
  type: object
933
770
  properties:
934
771
  statusCode:
935
772
  type: string
936
- description: >
937
- Backend error code from FSP. Ideally, statusCode is FSPIOP
938
- conforming. SDK will use status code to retrieve an FSPIOP error
939
- with the same code.
940
-
941
- Otherwise, a suitable generic FSPIOP will be used with the
942
- errorResponse in the FSPIOP error message.
773
+ description: |
774
+ Backend error code from FSP. Ideally, statusCode is FSPIOP conforming. SDK will use status code to retrieve an FSPIOP error with the same code.
775
+ Otherwise, a suitable generic FSPIOP will be used with the errorResponse in the FSPIOP error message.
943
776
  message:
944
777
  type: string
945
778
  description: Error message text.
@@ -968,14 +801,7 @@ components:
968
801
  title: ErrorCode
969
802
  type: string
970
803
  pattern: ^[1-9]\d{3}$
971
- description: >-
972
- The API data type ErrorCode is a JSON String of four characters,
973
- consisting of digits only. Negative numbers are not allowed. A leading
974
- zero is not allowed. Each error code in the API is a four-digit number,
975
- for example, 1234, where the first number (1 in the example) represents
976
- the high-level error category, the second number (2 in the example)
977
- represents the low-level error category, and the last two numbers (34 in
978
- the example) represent the specific error.
804
+ 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.
979
805
  example: '5100'
980
806
  ErrorDescription:
981
807
  title: ErrorDescription
@@ -1010,9 +836,7 @@ components:
1010
836
  ExtensionList:
1011
837
  title: ExtensionList
1012
838
  type: object
1013
- description: >-
1014
- Data model for the complex type ExtensionList. An optional list of
1015
- extensions, specific to deployment.
839
+ description: Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
1016
840
  properties:
1017
841
  extension:
1018
842
  type: array
@@ -1044,15 +868,11 @@ components:
1044
868
  $ref: '#/components/schemas/ErrorInformation'
1045
869
  transferError:
1046
870
  type: object
1047
- description: >-
1048
- This object represents a Mojaloop API error received at any time during
1049
- the transfer process
871
+ description: This object represents a Mojaloop API error received at any time during the transfer process
1050
872
  properties:
1051
873
  httpStatusCode:
1052
874
  type: integer
1053
- description: >-
1054
- The HTTP status code returned to the caller. This is the same as the
1055
- actual HTTP status code returned with the response.
875
+ description: The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response.
1056
876
  mojaloopError:
1057
877
  $ref: '#/components/schemas/mojaloopError'
1058
878
  accountsResponse:
@@ -1107,29 +927,18 @@ components:
1107
927
  title: Name
1108
928
  type: string
1109
929
  pattern: ^(?!\s*$)[\w .,'-]{1,128}$
1110
- description: >-
1111
- The API data type Name is a JSON String, restricted by a regular
1112
- expression to avoid characters which are generally not used in a name.
1113
-
1114
-
1115
- Regular Expression - The regular expression for restricting the Name
1116
- type is "^(?!\s*$)[\w .,'-]{1,128}$". The restriction does not allow a
1117
- string consisting of whitespace only, all Unicode characters are
1118
- allowed, as well as the period (.) (apostrophe (‘), dash (-), comma (,)
1119
- and space characters ( ).
930
+ description: |-
931
+ 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.
1120
932
 
933
+ 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 ( ).
1121
934
 
1122
- **Note:** In some programming languages, Unicode support must be
1123
- specifically enabled. For example, if Java is used, the flag
1124
- UNICODE_CHARACTER_CLASS must be enabled to allow Unicode characters.
935
+ **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.
1125
936
  FirstName:
1126
937
  title: FirstName
1127
938
  type: string
1128
939
  minLength: 1
1129
940
  maxLength: 128
1130
- pattern: >-
1131
- ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
1132
- .,''-]{1,128}$
941
+ pattern: ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$
1133
942
  description: First name of the Party (Name Type).
1134
943
  example: Henrik
1135
944
  MiddleName:
@@ -1137,9 +946,7 @@ components:
1137
946
  type: string
1138
947
  minLength: 1
1139
948
  maxLength: 128
1140
- pattern: >-
1141
- ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
1142
- .,''-]{1,128}$
949
+ pattern: ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$
1143
950
  description: Middle name of the Party (Name Type).
1144
951
  example: Johannes
1145
952
  LastName:
@@ -1147,26 +954,20 @@ components:
1147
954
  type: string
1148
955
  minLength: 1
1149
956
  maxLength: 128
1150
- pattern: >-
1151
- ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
1152
- .,''-]{1,128}$
957
+ pattern: ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$
1153
958
  description: Last name of the Party (Name Type).
1154
959
  example: Karlsson
1155
960
  DateOfBirth:
1156
961
  title: DateofBirth (type Date)
1157
962
  type: string
1158
- pattern: >-
1159
- ^(?:[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)$
963
+ 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)$
1160
964
  description: Date of Birth of the Party.
1161
965
  example: '1966-06-16'
1162
966
  MerchantClassificationCode:
1163
967
  title: MerchantClassificationCode
1164
968
  type: string
1165
969
  pattern: ^[\d]{1,4}$
1166
- description: >-
1167
- A limited set of pre-defined numbers. This list would be a limited set
1168
- of numbers identifying a set of popular merchant types like School Fees,
1169
- Pubs and Restaurants, Groceries, etc.
970
+ 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.
1170
971
  FspId:
1171
972
  title: FspId
1172
973
  type: string
@@ -1178,9 +979,7 @@ components:
1178
979
  type: string
1179
980
  minLength: 1
1180
981
  maxLength: 2048
1181
- description: >-
1182
- KYC information for the party in a form mandated by an individual
1183
- scheme.
982
+ description: KYC information for the party in a form mandated by an individual scheme.
1184
983
  example: |-
1185
984
  {
1186
985
  "metadata": {
@@ -1260,26 +1059,16 @@ components:
1260
1059
  enum:
1261
1060
  - SEND
1262
1061
  - RECEIVE
1263
- description: >-
1062
+ description: |-
1264
1063
  Below are the allowed values for the enumeration AmountType.
1265
-
1266
- - SEND - Amount the Payer would like to send, that is, the amount that
1267
- should be withdrawn from the Payer account including any fees.
1268
-
1269
- - RECEIVE - Amount the Payer would like the Payee to receive, that is,
1270
- the amount that should be sent to the receiver exclusive of any fees.
1064
+ - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees.
1065
+ - 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.
1271
1066
  example: RECEIVE
1272
1067
  Amount:
1273
1068
  title: Amount
1274
1069
  type: string
1275
1070
  pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
1276
- description: >-
1277
- The API data type Amount is a JSON String in a canonical format that is
1278
- restricted by a regular expression for interoperability reasons. This
1279
- pattern does not allow any trailing zeroes at all, but allows an amount
1280
- without a minor currency unit. It also only allows four digits in the
1281
- minor currency unit; a negative value is not allowed. Using more than 18
1282
- digits in the major currency unit is not allowed.
1071
+ 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.
1283
1072
  example: '123.45'
1284
1073
  transferTransactionType:
1285
1074
  title: transferTransactionType
@@ -1291,9 +1080,7 @@ components:
1291
1080
  title: TransactionSubScenario
1292
1081
  type: string
1293
1082
  pattern: ^[A-Z_]{1,32}$
1294
- description: >-
1295
- Possible sub-scenario, defined locally within the scheme (UndefinedEnum
1296
- Type).
1083
+ description: Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).
1297
1084
  example: LOCALLY_DEFINED_SUBSCENARIO
1298
1085
  Note:
1299
1086
  title: Note
@@ -1341,9 +1128,7 @@ components:
1341
1128
  properties:
1342
1129
  homeTransactionId:
1343
1130
  type: string
1344
- description: >-
1345
- Transaction ID from the DFSP backend, used to reconcile transactions
1346
- between the Switch and DFSP backend systems.
1131
+ description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
1347
1132
  bulkQuoteId:
1348
1133
  $ref: '#/components/schemas/CorrelationId'
1349
1134
  from:
@@ -1360,17 +1145,8 @@ components:
1360
1145
  DateTime:
1361
1146
  title: DateTime
1362
1147
  type: string
1363
- pattern: >-
1364
- ^(?:[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)$
1365
- description: >-
1366
- The API data type DateTime is a JSON String in a lexical format that is
1367
- restricted by a regular expression for interoperability reasons. The
1368
- format is according to [ISO
1369
- 8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed
1370
- in a combined date, time and time zone format. A more readable version
1371
- of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are
1372
- "2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where Z
1373
- indicates Zulu time zone, same as UTC).
1148
+ 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)$
1149
+ 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).
1374
1150
  example: '2016-05-24T08:38:08.699-04:00'
1375
1151
  bulkTransferStatus:
1376
1152
  type: string
@@ -1392,27 +1168,19 @@ components:
1392
1168
  Latitude:
1393
1169
  title: Latitude
1394
1170
  type: string
1395
- pattern: >-
1396
- ^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$
1397
- description: >-
1398
- The API data type Latitude is a JSON String in a lexical format that is
1399
- restricted by a regular expression for interoperability reasons.
1171
+ pattern: ^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$
1172
+ description: The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
1400
1173
  example: '+45.4215'
1401
1174
  Longitude:
1402
1175
  title: Longitude
1403
1176
  type: string
1404
- pattern: >-
1405
- ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
1406
- description: >-
1407
- The API data type Longitude is a JSON String in a lexical format that is
1408
- restricted by a regular expression for interoperability reasons.
1177
+ pattern: ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
1178
+ description: The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
1409
1179
  example: '+75.6972'
1410
1180
  GeoCode:
1411
1181
  title: GeoCode
1412
1182
  type: object
1413
- description: >-
1414
- Data model for the complex type GeoCode. Indicates the geographic
1415
- location from where the transaction was initiated.
1183
+ description: Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated.
1416
1184
  properties:
1417
1185
  latitude:
1418
1186
  $ref: '#/components/schemas/Latitude'
@@ -1428,8 +1196,7 @@ components:
1428
1196
  minLength: 1
1429
1197
  maxLength: 32768
1430
1198
  description: Information for recipient (transport layer information).
1431
- example: >-
1432
- AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
1199
+ example: AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
1433
1200
  IlpCondition:
1434
1201
  title: IlpCondition
1435
1202
  type: string
@@ -1438,15 +1205,11 @@ components:
1438
1205
  description: Condition that must be attached to the transfer by the Payer.
1439
1206
  quoteError:
1440
1207
  type: object
1441
- description: >-
1442
- This object represents a Mojaloop API error received at any time during
1443
- the quote process
1208
+ description: This object represents a Mojaloop API error received at any time during the quote process
1444
1209
  properties:
1445
1210
  httpStatusCode:
1446
1211
  type: integer
1447
- description: >-
1448
- The HTTP status code returned to the caller. This is the same as the
1449
- actual HTTP status code returned with the response.
1212
+ description: The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response.
1450
1213
  mojaloopError:
1451
1214
  $ref: '#/components/schemas/mojaloopError'
1452
1215
  individualQuoteResult:
@@ -1486,9 +1249,7 @@ components:
1486
1249
  $ref: '#/components/schemas/CorrelationId'
1487
1250
  homeTransactionId:
1488
1251
  type: string
1489
- description: >-
1490
- Transaction ID from the DFSP backend, used to reconcile transactions
1491
- between the Switch and DFSP backend systems.
1252
+ description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
1492
1253
  expiration:
1493
1254
  $ref: '#/components/schemas/DateTime'
1494
1255
  extensionList:
@@ -1575,42 +1336,27 @@ components:
1575
1336
  - bulkExpiration
1576
1337
  properties:
1577
1338
  onlyValidateParty:
1578
- description: >-
1579
- Set to true if only party validation is required. This means the
1580
- quotes and transfers will not run. This is useful for only party
1581
- resolution.
1339
+ 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.
1582
1340
  type: boolean
1583
1341
  autoAcceptParty:
1584
1342
  $ref: '#/components/schemas/autoAcceptPartyOption'
1585
1343
  autoAcceptQuote:
1586
- description: >-
1587
- Set to true if the quote response is accepted without confirmation
1588
- from the payer. The fees applied by the payee will be acceptable to
1589
- the payer abiding by the limits set by optional
1590
- 'perTransferFeeLimits' array.
1344
+ 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.
1591
1345
  type: object
1592
1346
  oneOf:
1593
1347
  - $ref: '#/components/schemas/autoAcceptQuote'
1594
1348
  skipPartyLookup:
1595
- description: >-
1596
- Set to true if supplying an FSPID for the payee party and no party
1597
- resolution is needed. This may be useful if a previous party
1598
- resolution has been performed.
1349
+ 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.
1599
1350
  type: boolean
1600
1351
  synchronous:
1601
- description: >-
1602
- Set to true if the bulkTransfer requests need be handled
1603
- synchronous. Otherwise the requests will be handled asynchronously,
1604
- meaning there will be callbacks whenever the processing is done
1352
+ 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
1605
1353
  type: boolean
1606
1354
  bulkExpiration:
1607
1355
  $ref: '#/components/schemas/DateTime'
1608
1356
  PartyIdInfo:
1609
1357
  title: PartyIdInfo
1610
1358
  type: object
1611
- description: >-
1612
- Data model for the complex type PartyIdInfo. An ExtensionList element
1613
- has been added to this reqeust in version v1.1
1359
+ description: Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1
1614
1360
  properties:
1615
1361
  partyIdType:
1616
1362
  $ref: '#/components/schemas/PartyIdType'
@@ -1682,9 +1428,7 @@ components:
1682
1428
  properties:
1683
1429
  homeTransactionId:
1684
1430
  type: string
1685
- description: >-
1686
- Transaction ID from the DFSP backend, used to reconcile transactions
1687
- between the Switch and DFSP backend systems.
1431
+ description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
1688
1432
  to:
1689
1433
  $ref: '#/components/schemas/Party'
1690
1434
  reference:
@@ -1721,9 +1465,7 @@ components:
1721
1465
  properties:
1722
1466
  bulkHomeTransactionID:
1723
1467
  type: string
1724
- description: >-
1725
- Transaction ID from the DFSP backend, used to reconcile transactions
1726
- between the Switch and DFSP backend systems.
1468
+ description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
1727
1469
  bulkTransactionId:
1728
1470
  $ref: '#/components/schemas/CorrelationId'
1729
1471
  options:
@@ -1746,17 +1488,12 @@ components:
1746
1488
  - RESERVED
1747
1489
  - COMMITTED
1748
1490
  - ABORTED
1749
- description: >-
1491
+ description: |-
1750
1492
  Below are the allowed values for the enumeration.
1751
-
1752
1493
  - RECEIVED - Next ledger has received the transfer.
1753
-
1754
1494
  - RESERVED - Next ledger has reserved the transfer.
1755
-
1756
1495
  - COMMITTED - Next ledger has successfully performed the transfer.
1757
-
1758
- - ABORTED - Next ledger has aborted the transfer due to a rejection or
1759
- failure to perform the transfer.
1496
+ - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.
1760
1497
  example: RESERVED
1761
1498
  IlpFulfilment:
1762
1499
  title: IlpFulfilment
@@ -1793,9 +1530,7 @@ components:
1793
1530
  $ref: '#/components/schemas/CorrelationId'
1794
1531
  homeTransactionId:
1795
1532
  type: string
1796
- description: >-
1797
- Transaction ID from the DFSP backend, used to reconcile transactions
1798
- between the Switch and DFSP backend systems.
1533
+ description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
1799
1534
  bulkTransferState:
1800
1535
  $ref: '#/components/schemas/TransferState'
1801
1536
  completedTimestamp:
@@ -1838,17 +1573,13 @@ components:
1838
1573
  - true
1839
1574
  - false
1840
1575
  bulkTransactionContinuationAcceptParty:
1841
- description: >-
1842
- The object sent back as confirmation of payee parties when
1843
- autoAcceptParty is false.
1576
+ description: The object sent back as confirmation of payee parties when autoAcceptParty is false.
1844
1577
  type: object
1845
1578
  required:
1846
1579
  - individualTransfers
1847
1580
  properties:
1848
1581
  individualTransfers:
1849
- description: >-
1850
- List of individual transfers in a bulk transfer with accept party
1851
- information.
1582
+ description: List of individual transfers in a bulk transfer with accept party information.
1852
1583
  type: array
1853
1584
  minItems: 1
1854
1585
  items:
@@ -1866,9 +1597,7 @@ components:
1866
1597
  - true
1867
1598
  - false
1868
1599
  bulkTransactionContinuationAcceptQuote:
1869
- description: >-
1870
- The object sent back as confirmation of quotes when autoAcceptQuotes is
1871
- false.
1600
+ description: The object sent back as confirmation of quotes when autoAcceptQuotes is false.
1872
1601
  type: object
1873
1602
  required:
1874
1603
  - individualTransfers
@@ -1883,15 +1612,11 @@ components:
1883
1612
  - $ref: '#/components/schemas/transferContinuationAcceptQuote'
1884
1613
  partyError:
1885
1614
  type: object
1886
- description: >-
1887
- This object represents a Mojaloop API error received at any time during
1888
- the party discovery process
1615
+ description: This object represents a Mojaloop API error received at any time during the party discovery process
1889
1616
  properties:
1890
1617
  httpStatusCode:
1891
1618
  type: integer
1892
- description: >-
1893
- The HTTP status code returned to the caller. This is the same as the
1894
- actual HTTP status code returned with the response.
1619
+ description: The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response.
1895
1620
  mojaloopError:
1896
1621
  $ref: '#/components/schemas/mojaloopError'
1897
1622
  bulkTransactionAcceptPartyErrorResponse:
@@ -1962,9 +1687,7 @@ components:
1962
1687
  properties:
1963
1688
  homeTransactionId:
1964
1689
  type: string
1965
- description: >-
1966
- Transaction ID from the DFSP backend, used to reconcile transactions
1967
- between the Switch and DFSP backend systems.
1690
+ description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
1968
1691
  bulkTransferId:
1969
1692
  $ref: '#/components/schemas/CorrelationId'
1970
1693
  bulkQuoteId:
@@ -1982,9 +1705,7 @@ components:
1982
1705
  $ref: '#/components/schemas/ExtensionList'
1983
1706
  individualTransferFulfilment:
1984
1707
  type: object
1985
- description: >-
1986
- A Mojaloop API transfer fulfilment for individual transfers in a bulk
1987
- transfer
1708
+ description: A Mojaloop API transfer fulfilment for individual transfers in a bulk transfer
1988
1709
  properties:
1989
1710
  fulfilment:
1990
1711
  $ref: '#/components/schemas/IlpFulfilment'
@@ -2041,28 +1762,12 @@ components:
2041
1762
  - TRANSFER
2042
1763
  - PAYMENT
2043
1764
  - REFUND
2044
- description: >-
1765
+ description: |-
2045
1766
  Below are the allowed values for the enumeration.
2046
-
2047
- - DEPOSIT - Used for performing a Cash-In (deposit) transaction. In a
2048
- normal scenario, electronic funds are transferred from a Business
2049
- account to a Consumer account, and physical cash is given from the
2050
- Consumer to the Business User.
2051
-
2052
- - WITHDRAWAL - Used for performing a Cash-Out (withdrawal) transaction.
2053
- In a normal scenario, electronic funds are transferred from a Consumer’s
2054
- account to a Business account, and physical cash is given from the
2055
- Business User to the Consumer.
2056
-
2057
- - TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to
2058
- Consumer) transaction.
2059
-
2060
- - PAYMENT - Usually used for performing a transaction from a Consumer to
2061
- a Merchant or Organization, but could also be for a B2B (Business to
2062
- Business) payment. The transaction could be online for a purchase in an
2063
- Internet store, in a physical store where both the Consumer and Business
2064
- User are present, a bill payment, a donation, and so on.
2065
-
1767
+ - 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.
1768
+ - 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.
1769
+ - TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer) transaction.
1770
+ - 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.
2066
1771
  - REFUND - Used for performing a refund of transaction.
2067
1772
  example: DEPOSIT
2068
1773
  TransactionInitiator:
@@ -2071,17 +1776,10 @@ components:
2071
1776
  enum:
2072
1777
  - PAYER
2073
1778
  - PAYEE
2074
- description: >-
1779
+ description: |-
2075
1780
  Below are the allowed values for the enumeration.
2076
-
2077
- - PAYER - Sender of funds is initiating the transaction. The account to
2078
- send from is either owned by the Payer or is connected to the Payer in
2079
- some way.
2080
-
2081
- - PAYEE - Recipient of the funds is initiating the transaction by
2082
- sending a transaction request. The Payer must approve the transaction,
2083
- either automatically by a pre-generated OTP or by pre-approval of the
2084
- Payee, or by manually approving in his or her own Device.
1781
+ - 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.
1782
+ - 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.
2085
1783
  example: PAYEE
2086
1784
  RefundReason:
2087
1785
  title: RefundReason
@@ -2105,11 +1803,7 @@ components:
2105
1803
  title: BalanceOfPayments
2106
1804
  type: string
2107
1805
  pattern: ^[1-9]\d{2}$
2108
- description: >-
2109
- (BopCode) The API data type
2110
- [BopCode](https://www.imf.org/external/np/sta/bopcode/) is a JSON String
2111
- of 3 characters, consisting of digits only. Negative numbers are not
2112
- allowed. A leading zero is not allowed.
1806
+ 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.
2113
1807
  example: '123'
2114
1808
  TransactionType:
2115
1809
  title: TransactionType
@@ -2138,18 +1832,11 @@ components:
2138
1832
  enum:
2139
1833
  - PAYER
2140
1834
  - PAYEE
2141
- description: >-
2142
- Below are the allowed values for the enumeration CurrencyConverter. -
2143
- PAYER - Currency conversion should be performed by the payer. - PAYEE -
2144
- Currency conversion should be performed by the payee.
1835
+ description: Below are the allowed values for the enumeration CurrencyConverter. - PAYER - Currency conversion should be performed by the payer. - PAYEE - Currency conversion should be performed by the payee.
2145
1836
  FxRate:
2146
1837
  title: FxRate
2147
1838
  type: object
2148
- description: >-
2149
- The FxRate object contains information about a currency conversion in
2150
- the transfer. It can be used by parties to the transfer to exchange
2151
- information with each other about the exchange rate for the transfer, to
2152
- ensure that the best rate can be agreed on.
1839
+ description: The FxRate object contains information about a currency conversion in the transfer. It can be used by parties to the transfer to exchange information with each other about the exchange rate for the transfer, to ensure that the best rate can be agreed on.
2153
1840
  properties:
2154
1841
  sourceAmount:
2155
1842
  allOf:
@@ -2188,23 +1875,11 @@ components:
2188
1875
  converter:
2189
1876
  allOf:
2190
1877
  - $ref: '#/components/schemas/CurrencyConverter'
2191
- - description: >-
2192
- An optional field which will allow the payer DFSP to specify
2193
- which DFSP it wants to undertake currency conversion. This is
2194
- useful incase of if the sender wants the recipient to receive a
2195
- specified amount of the target currency, but the payer DFSP does
2196
- not want to undertake the currency conversion. In this case, the
2197
- amount of the transfer would be expressed in the target currency
2198
- and the amountType would be set to RECEIVE.
1878
+ - description: An optional field which will allow the payer DFSP to specify which DFSP it wants to undertake currency conversion. This is useful incase of if the sender wants the recipient to receive a specified amount of the target currency, but the payer DFSP does not want to undertake the currency conversion. In this case, the amount of the transfer would be expressed in the target currency and the amountType would be set to RECEIVE.
2199
1879
  currencyConversion:
2200
1880
  allOf:
2201
1881
  - $ref: '#/components/schemas/FxRate'
2202
- - description: >-
2203
- Used by the debtor party if it wants to share information about
2204
- the currency conversion it proposes to make; or if it is
2205
- required by scheme rules to share this information. This object
2206
- contains the amount of the transfer in the source and target
2207
- currencies, but does not identify the FXP being used.
1882
+ - description: Used by the debtor party if it wants to share information about the currency conversion it proposes to make; or if it is required by scheme rules to share this information. This object contains the amount of the transfer in the source and target currencies, but does not identify the FXP being used.
2208
1883
  geoCode:
2209
1884
  $ref: '#/components/schemas/GeoCode'
2210
1885
  note:
@@ -2254,9 +1929,7 @@ components:
2254
1929
  $ref: '#/components/schemas/Money'
2255
1930
  expiration:
2256
1931
  type: string
2257
- description: >-
2258
- Date and time until when the quotation is valid and can be
2259
- honored when used in the subsequent transaction.
1932
+ description: Date and time until when the quotation is valid and can be honored when used in the subsequent transaction.
2260
1933
  example: '2016-05-24T08:38:08.699-04:00'
2261
1934
  geoCode:
2262
1935
  $ref: '#/components/schemas/GeoCode'
@@ -2311,9 +1984,7 @@ components:
2311
1984
  properties:
2312
1985
  homeR2PTransactionId:
2313
1986
  type: string
2314
- description: >-
2315
- Transaction ID from the DFSP backend, used to reconcile transactions
2316
- between the Switch and DFSP backend systems.
1987
+ description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
2317
1988
  from:
2318
1989
  $ref: '#/components/schemas/transferParty'
2319
1990
  to:
@@ -2459,9 +2130,7 @@ components:
2459
2130
  FxMoney:
2460
2131
  title: FxMoney
2461
2132
  type: object
2462
- description: >-
2463
- Data model for the complex type FxMoney; This is based on the type Money
2464
- but allows the amount to be optional to support FX quotations.
2133
+ description: Data model for the complex type FxMoney; This is based on the type Money but allows the amount to be optional to support FX quotations.
2465
2134
  properties:
2466
2135
  currency:
2467
2136
  $ref: '#/components/schemas/Currency'
@@ -2472,9 +2141,7 @@ components:
2472
2141
  FxCharge:
2473
2142
  title: FxCharge
2474
2143
  type: object
2475
- description: >-
2476
- An FXP will be able to specify a charge which it proposes to levy on the
2477
- currency conversion operation using a FxCharge object.
2144
+ description: An FXP will be able to specify a charge which it proposes to levy on the currency conversion operation using a FxCharge object.
2478
2145
  properties:
2479
2146
  chargeType:
2480
2147
  type: string
@@ -2484,24 +2151,17 @@ components:
2484
2151
  sourceAmount:
2485
2152
  allOf:
2486
2153
  - $ref: '#/components/schemas/Money'
2487
- - description: >-
2488
- The amount of the charge which is being levied, expressed in the
2489
- source currency.
2154
+ - description: The amount of the charge which is being levied, expressed in the source currency.
2490
2155
  targetAmount:
2491
2156
  allOf:
2492
2157
  - $ref: '#/components/schemas/Money'
2493
- - description: >-
2494
- The amount of the charge which is being levied, expressed in the
2495
- target currency.
2158
+ - description: The amount of the charge which is being levied, expressed in the target currency.
2496
2159
  required:
2497
2160
  - chargeType
2498
2161
  FxConversion:
2499
2162
  title: FxConversion
2500
2163
  type: object
2501
- description: >-
2502
- A DFSP will be able to request a currency conversion, and an FX provider
2503
- will be able to describe its involvement in a proposed transfer, using a
2504
- FxConversion object.
2164
+ description: A DFSP will be able to request a currency conversion, and an FX provider will be able to describe its involvement in a proposed transfer, using a FxConversion object.
2505
2165
  properties:
2506
2166
  conversionId:
2507
2167
  allOf:
@@ -2510,15 +2170,11 @@ components:
2510
2170
  determiningTransferId:
2511
2171
  allOf:
2512
2172
  - $ref: '#/components/schemas/CorrelationId'
2513
- - description: >-
2514
- The transaction ID of the transfer on whose success this
2515
- currency conversion depends.
2173
+ - description: The transaction ID of the transfer on whose success this currency conversion depends.
2516
2174
  initiatingFsp:
2517
2175
  allOf:
2518
2176
  - $ref: '#/components/schemas/FspId'
2519
- - description: >-
2520
- The id of the participant who is requesting a currency
2521
- conversion.
2177
+ - description: The id of the participant who is requesting a currency conversion.
2522
2178
  counterPartyFsp:
2523
2179
  allOf:
2524
2180
  - $ref: '#/components/schemas/FspId'
@@ -2526,13 +2182,7 @@ components:
2526
2182
  amountType:
2527
2183
  allOf:
2528
2184
  - $ref: '#/components/schemas/AmountType'
2529
- - description: >-
2530
- This is the AmountType for the base transaction - If SEND - then
2531
- any charges levied by the FXP as part of the transaction will be
2532
- deducted by the FXP from the amount shown for the target party
2533
- in the conversion. If RECEIVE - then any charges levied by the
2534
- FXP as part of the transaction will be added by the FXP to the
2535
- amount shown for the source party in the conversion.
2185
+ - description: This is the AmountType for the base transaction - If SEND - then any charges levied by the FXP as part of the transaction will be deducted by the FXP from the amount shown for the target party in the conversion. If RECEIVE - then any charges levied by the FXP as part of the transaction will be added by the FXP to the amount shown for the source party in the conversion.
2536
2186
  sourceAmount:
2537
2187
  allOf:
2538
2188
  - $ref: '#/components/schemas/FxMoney'
@@ -2544,15 +2194,10 @@ components:
2544
2194
  expiration:
2545
2195
  allOf:
2546
2196
  - $ref: '#/components/schemas/DateTime'
2547
- - description: >-
2548
- The end of the period for which the currency conversion is
2549
- required to remain valid.
2197
+ - description: The end of the period for which the currency conversion is required to remain valid.
2550
2198
  charges:
2551
2199
  type: array
2552
- description: >-
2553
- One or more charges which the FXP intends to levy as part of the
2554
- currency conversion, or which the payee DFSP intends to add to the
2555
- amount transferred.
2200
+ description: One or more charges which the FXP intends to levy as part of the currency conversion, or which the payee DFSP intends to add to the amount transferred.
2556
2201
  items:
2557
2202
  $ref: '#/components/schemas/FxCharge'
2558
2203
  minItems: 0
@@ -2572,15 +2217,10 @@ components:
2572
2217
  FxQuotesPostOutboundResponse:
2573
2218
  title: FxQuotesPostOutboundResponse
2574
2219
  type: object
2575
- description: >-
2576
- The object sent as a response for the POST /fxQuotes request. The terms
2577
- under which the FXP will undertake the currency conversion proposed by
2578
- the requester.
2220
+ description: The object sent as a response for the POST /fxQuotes request. The terms under which the FXP will undertake the currency conversion proposed by the requester.
2579
2221
  properties:
2580
2222
  homeTransactionId:
2581
- description: >-
2582
- Transaction ID for the FXP backend, used to reconcile transactions
2583
- between the Switch and FXP backend systems.
2223
+ description: Transaction ID for the FXP backend, used to reconcile transactions between the Switch and FXP backend systems.
2584
2224
  type: string
2585
2225
  condition:
2586
2226
  allOf:
@@ -2589,9 +2229,7 @@ components:
2589
2229
  conversionTerms:
2590
2230
  allOf:
2591
2231
  - $ref: '#/components/schemas/FxConversion'
2592
- - description: >-
2593
- The terms under which the FXP will undertake the currency
2594
- conversion proposed by the requester.
2232
+ - description: The terms under which the FXP will undertake the currency conversion proposed by the requester.
2595
2233
  required:
2596
2234
  - conversionTerms
2597
2235
  TransfersIDPutResponse:
@@ -2624,9 +2262,7 @@ components:
2624
2262
  $ref: '#/components/schemas/CorrelationId'
2625
2263
  homeTransactionId:
2626
2264
  type: string
2627
- description: >-
2628
- Transaction ID from the DFSP backend, used to reconcile transactions
2629
- between the Switch and DFSP backend systems.
2265
+ description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
2630
2266
  from:
2631
2267
  $ref: '#/components/schemas/transferParty'
2632
2268
  to:
@@ -2667,11 +2303,8 @@ components:
2667
2303
  type: object
2668
2304
  quoteResponseSource:
2669
2305
  type: string
2670
- description: >
2671
- FSPID of the entity that supplied the quote response. This may not
2672
- be the same as the FSPID of the entity which owns the end user
2673
- account in the case of a FOREX transfer. i.e. it may be a FOREX
2674
- gateway.
2306
+ description: |
2307
+ 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.
2675
2308
  conversionRequestId:
2676
2309
  $ref: '#/components/schemas/CorrelationId'
2677
2310
  fxQuotesResponse:
@@ -2699,10 +2332,7 @@ components:
2699
2332
  lastError:
2700
2333
  $ref: '#/components/schemas/transferError'
2701
2334
  skipPartyLookup:
2702
- description: >-
2703
- Set to true if supplying an FSPID for the payee party and no party
2704
- resolution is needed. This may be useful is a previous party
2705
- resolution has been performed.
2335
+ 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.
2706
2336
  type: boolean
2707
2337
  errorTransferResponse:
2708
2338
  allOf:
@@ -2729,9 +2359,7 @@ components:
2729
2359
  properties:
2730
2360
  homeR2PTransactionId:
2731
2361
  type: string
2732
- description: >-
2733
- Transaction ID from the DFSP backend, used to reconcile transactions
2734
- between the Switch and DFSP backend systems.
2362
+ description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
2735
2363
  transactionRequestId:
2736
2364
  $ref: '#/components/schemas/CorrelationId'
2737
2365
  from:
@@ -2762,10 +2390,7 @@ components:
2762
2390
  - title: OtpValue
2763
2391
  type: string
2764
2392
  pattern: ^\d{3,10}$
2765
- description: >-
2766
- The API data type OtpValue is a JSON String of 3 to 10 characters,
2767
- consisting of digits only. Negative numbers are not allowed. One or
2768
- more leading zeros are allowed.
2393
+ 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.
2769
2394
  - title: QRCODE
2770
2395
  type: string
2771
2396
  minLength: 1
@@ -2773,33 +2398,26 @@ components:
2773
2398
  description: QR code used as a One Time Password.
2774
2399
  - title: U2FPinValue
2775
2400
  type: object
2776
- description: >
2777
- U2F challenge-response, where payer FSP verifies if the response
2778
- provided by end-user device matches the previously registered key.
2401
+ description: |
2402
+ U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key.
2779
2403
  properties:
2780
2404
  pinValue:
2781
2405
  type: string
2782
2406
  pattern: ^\S{1,64}$
2783
2407
  minLength: 1
2784
2408
  maxLength: 64
2785
- description: >
2786
- U2F challenge-response, where payer FSP verifies if the response
2787
- provided by end-user device matches the previously registered
2788
- key.
2409
+ description: |
2410
+ U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key.
2789
2411
  counter:
2790
2412
  title: Integer
2791
2413
  type: string
2792
2414
  pattern: ^[1-9]\d*$
2793
- description: >-
2794
- Sequential counter used for cloning detection. Present only for
2795
- U2F authentication.
2415
+ description: Sequential counter used for cloning detection. Present only for U2F authentication.
2796
2416
  required:
2797
2417
  - pinValue
2798
2418
  - counter
2799
2419
  pattern: ^\d{3,10}$|^\S{1,64}$
2800
- description: >-
2801
- Contains the authentication value. The format depends on the
2802
- authentication type used in the AuthenticationInfo complex type.
2420
+ description: Contains the authentication value. The format depends on the authentication type used in the AuthenticationInfo complex type.
2803
2421
  AuthenticationInfo:
2804
2422
  title: AuthenticationInfo
2805
2423
  type: object
@@ -2851,9 +2469,7 @@ components:
2851
2469
  $ref: '#/components/schemas/CorrelationId'
2852
2470
  homeR2PTransactionId:
2853
2471
  type: string
2854
- description: >-
2855
- Transaction ID from the DFSP backend, used to reconcile transactions
2856
- between the Switch and DFSP backend systems.
2472
+ description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
2857
2473
  transactionRequestId:
2858
2474
  $ref: '#/components/schemas/CorrelationId'
2859
2475
  from:
@@ -2885,11 +2501,8 @@ components:
2885
2501
  type: object
2886
2502
  quoteResponseSource:
2887
2503
  type: string
2888
- description: >
2889
- FSPID of the entity that supplied the quote response. This may not
2890
- be the same as the FSPID of the entity which owns the end user
2891
- account in the case of a FOREX transfer. i.e. it may be a FOREX
2892
- gateway.
2504
+ description: |
2505
+ 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.
2893
2506
  authorizationResponse:
2894
2507
  type: object
2895
2508
  required:
@@ -2995,9 +2608,7 @@ components:
2995
2608
  properties:
2996
2609
  homeTransactionId:
2997
2610
  type: string
2998
- description: >-
2999
- Transaction ID from the DFSP backend, used to reconcile transactions
3000
- between the Switch and DFSP backend systems.
2611
+ description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
3001
2612
  from:
3002
2613
  $ref: '#/components/schemas/transferParty'
3003
2614
  to:
@@ -3019,10 +2630,7 @@ components:
3019
2630
  transferRequestExtensions:
3020
2631
  $ref: '#/components/schemas/extensionListEmptiable'
3021
2632
  skipPartyLookup:
3022
- description: >-
3023
- Set to true if supplying an FSPID for the payee party and no party
3024
- resolution is needed. This may be useful is a previous party
3025
- resolution has been performed.
2633
+ 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.
3026
2634
  type: boolean
3027
2635
  transferStatusResponse:
3028
2636
  type: object
@@ -3061,9 +2669,7 @@ components:
3061
2669
  properties:
3062
2670
  providers:
3063
2671
  type: array
3064
- description: >-
3065
- The FSP Id(s) of the participant(s) who offer currency conversion
3066
- services.
2672
+ description: The FSP Id(s) of the participant(s) who offer currency conversion services.
3067
2673
  items:
3068
2674
  $ref: '#/components/schemas/FspId'
3069
2675
  minItems: 0
@@ -3076,9 +2682,7 @@ components:
3076
2682
  description: The object sent in the POST /fxQuotes request.
3077
2683
  properties:
3078
2684
  homeTransactionId:
3079
- description: >-
3080
- Transaction ID for the backend, used to reconcile transactions
3081
- between the Switch and backend systems.
2685
+ description: Transaction ID for the backend, used to reconcile transactions between the Switch and backend systems.
3082
2686
  type: string
3083
2687
  conversionRequestId:
3084
2688
  allOf:
@@ -3087,9 +2691,7 @@ components:
3087
2691
  conversionTerms:
3088
2692
  allOf:
3089
2693
  - $ref: '#/components/schemas/FxConversion'
3090
- - description: >-
3091
- The terms of the currency conversion for which a quotation is
3092
- sought.
2694
+ - description: The terms of the currency conversion for which a quotation is sought.
3093
2695
  required:
3094
2696
  - conversionRequestId
3095
2697
  - conversionTerms
@@ -3100,10 +2702,7 @@ components:
3100
2702
  determiningTransferId:
3101
2703
  allOf:
3102
2704
  - $ref: '#/components/schemas/CorrelationId'
3103
- - description: >-
3104
- The transaction ID of the transfer to which this currency conversion
3105
- relates, if the conversion is part of a transfer. If the conversion
3106
- is a bulk currency purchase, this field should be omitted.
2705
+ - description: The transaction ID of the transfer to which this currency conversion relates, if the conversion is part of a transfer. If the conversion is a bulk currency purchase, this field should be omitted.
3107
2706
  initiatingFsp:
3108
2707
  allOf:
3109
2708
  - $ref: '#/components/schemas/FspId'
@@ -3119,24 +2718,18 @@ components:
3119
2718
  targetAmount:
3120
2719
  allOf:
3121
2720
  - $ref: '#/components/schemas/Money'
3122
- - description: >-
3123
- The amount which the FXP is to credit to the requesting FSP in the
3124
- target currency.
2721
+ - description: The amount which the FXP is to credit to the requesting FSP in the target currency.
3125
2722
  condition:
3126
2723
  allOf:
3127
2724
  - $ref: '#/components/schemas/IlpCondition'
3128
- - description: >-
3129
- ILP condition received by the requesting FSP when the quote was
3130
- approved.
2725
+ - description: ILP condition received by the requesting FSP when the quote was approved.
3131
2726
  FxTransfersPostOutboundRequest:
3132
2727
  title: FxTransfersPostOutboundRequest
3133
2728
  type: object
3134
2729
  description: The object sent in the POST /fxTransfers request.
3135
2730
  properties:
3136
2731
  homeTransactionId:
3137
- description: >-
3138
- Transaction ID for the backend, used to reconcile transactions
3139
- between the Switch and backend systems.
2732
+ description: Transaction ID for the backend, used to reconcile transactions between the Switch and backend systems.
3140
2733
  type: string
3141
2734
  commitRequestId:
3142
2735
  $ref: '#/components/schemas/commitRequestId'
@@ -3161,10 +2754,7 @@ components:
3161
2754
  fulfilment:
3162
2755
  allOf:
3163
2756
  - $ref: '#/components/schemas/IlpFulfilment'
3164
- - description: >-
3165
- The fulfilment of the condition specified for the currency
3166
- conversion. Mandatory if the conversion has been executed
3167
- successfully.
2757
+ - description: The fulfilment of the condition specified for the currency conversion. Mandatory if the conversion has been executed successfully.
3168
2758
  completedTimestamp:
3169
2759
  allOf:
3170
2760
  - $ref: '#/components/schemas/DateTime'
@@ -3179,9 +2769,7 @@ components:
3179
2769
  description: The object sent as a response for the POST /fxTransfers request.
3180
2770
  properties:
3181
2771
  homeTransactionId:
3182
- description: >-
3183
- Transaction ID for the backend, used to reconcile transactions
3184
- between the Switch and backend systems.
2772
+ description: Transaction ID for the backend, used to reconcile transactions between the Switch and backend systems.
3185
2773
  type: string
3186
2774
  fulfilment:
3187
2775
  $ref: '#/components/schemas/fulfilment'
@@ -3358,10 +2946,7 @@ components:
3358
2946
  schema:
3359
2947
  $ref: '#/components/schemas/errorTransferResponse'
3360
2948
  servicesFXPSucess:
3361
- description: >-
3362
- The response contains participants in a scheme who offer currency
3363
- conversion services. If no participants offer these services, the return
3364
- object will be blank.
2949
+ description: The response contains participants in a scheme who offer currency conversion services. If no participants offer these services, the return object will be blank.
3365
2950
  content:
3366
2951
  application/json:
3367
2952
  schema:
@@ -3373,27 +2958,21 @@ components:
3373
2958
  required: true
3374
2959
  schema:
3375
2960
  $ref: '#/components/schemas/CorrelationId'
3376
- description: >-
3377
- Identifier of the bulk transfer to continue as returned in the response
3378
- to a `POST /bulkTransfers` request.
2961
+ description: Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request.
3379
2962
  bulkTransactionId:
3380
2963
  name: bulkTransactionId
3381
2964
  in: path
3382
2965
  required: true
3383
2966
  schema:
3384
2967
  $ref: '#/components/schemas/CorrelationId'
3385
- description: >-
3386
- Identifier of the bulk transaction to continue as returned in the
3387
- response to a `POST /bulkTransaction` request.
2968
+ description: Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request.
3388
2969
  bulkTransferId:
3389
2970
  name: bulkTransferId
3390
2971
  in: path
3391
2972
  required: true
3392
2973
  schema:
3393
2974
  $ref: '#/components/schemas/CorrelationId'
3394
- description: >-
3395
- Identifier of the bulk transfer to continue as returned in the response
3396
- to a `POST /bulkTransfers` request.
2975
+ description: Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request.
3397
2976
  Type:
3398
2977
  name: Type
3399
2978
  in: path
@@ -3414,27 +2993,21 @@ components:
3414
2993
  required: true
3415
2994
  schema:
3416
2995
  type: string
3417
- description: >-
3418
- A sub-identifier of the party identifier, or a sub-type of the party
3419
- identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`.
2996
+ description: A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`.
3420
2997
  transactionRequestId:
3421
2998
  name: transactionRequestId
3422
2999
  in: path
3423
3000
  required: true
3424
3001
  schema:
3425
3002
  $ref: '#/components/schemas/CorrelationId'
3426
- description: >-
3427
- Identifier of the merchant request to pay to continue as returned in the
3428
- response to a `POST /requestToPay` request.
3003
+ description: Identifier of the merchant request to pay to continue as returned in the response to a `POST /requestToPay` request.
3429
3004
  transferId:
3430
3005
  name: transferId
3431
3006
  in: path
3432
3007
  required: true
3433
3008
  schema:
3434
3009
  $ref: '#/components/schemas/CorrelationId'
3435
- description: >-
3436
- Identifier of the transfer to continue as returned in the response to a
3437
- `POST /transfers` request.
3010
+ description: Identifier of the transfer to continue as returned in the response to a `POST /transfers` request.
3438
3011
  SourceCurrency:
3439
3012
  name: SourceCurrency
3440
3013
  in: path