@mojaloop/api-snippets 16.0.3 → 16.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4657 +0,0 @@
1
- openapi: 3.0.1
2
- info:
3
- title: Mojaloop SDK Outbound Scheme Adapter API
4
- description: >
5
- Specification for the Mojaloop SDK Scheme Adapter Outbound Transfers API
6
-
7
-
8
- This API can be used by DFSP backends to simplify the process of sending
9
- funds to other parties within a Mojaloop scheme.
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".
18
- license:
19
- name: Apache License Version 2.0, January 2004
20
- url: https://github.com/mojaloop/documentation/blob/master/LICENSE.md
21
- version: 1.0.0
22
- paths:
23
- /:
24
- get:
25
- 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.
29
- tags:
30
- - Health
31
- responses:
32
- '200':
33
- description: >-
34
- Returns empty body if the scheme adapter outbound transfers service
35
- is running.
36
- /transfers:
37
- post:
38
- summary: Sends money from one account to another
39
- description: >
40
- The HTTP request `POST /transfers` is used to request the movement of
41
- funds from payer DFSP to payee DFSP.
42
-
43
- The underlying Mojaloop API has three stages for money transfer:
44
-
45
- 1. Party lookup. This facilitates a check by the sending party that the destination party is correct before proceeding with a money movement.
46
- 2. Quotation. This facilitates the exchange of fee information and the construction of a cryptographic "contract" between payee and payer DFSPs before funds are transferred.
47
- 3. Transfer. The enactment of the previously agreed "contract"
48
-
49
- This method has several modes of operation.
50
-
51
- - If the configuration variables `AUTO_ACCEPT_PARTIES` is set to
52
- `"false"` this method will terminate when the payee party has been
53
- resolved and return the payee party details.
54
- 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.
55
- The scheme adapter will then proceed with quotation stage...
56
-
57
- - If the configuration variable `AUTO_ACCEPT_QUOTES` is set to `"false"`
58
- this method will terminate and return the quotation when it has been
59
- received from the payee DFSP.
60
- 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.
61
- The scheme adapter will then proceed with the transfer state.
62
-
63
- If the configuration variables `AUTO_ACCEPT_PARTIES` and
64
- `AUTO_ACCEPT_QUOTES` are both set to `"true"` this method will block
65
- until all three transfer stages are complete. Upon completion it will
66
- return the entire set of transfer details received during the operation.
67
-
68
-
69
- Combinations of settings for `AUTO_ACCEPT...` configuration variables
70
- allow the scheme adapter user to decide which mode of operation best
71
- suits their use cases. i.e. the scheme adapter can be configured to
72
- "break" the three stage transfer at these points in order to execute
73
- backend logic such as party verification, quoted fees assessments etc...
74
- tags:
75
- - Transfers
76
- requestBody:
77
- description: Transfer request body
78
- content:
79
- application/json:
80
- schema:
81
- type: object
82
- required: &ref_65
83
- - homeTransactionId
84
- - from
85
- - to
86
- - amountType
87
- - currency
88
- - amount
89
- - transactionType
90
- properties: &ref_66
91
- homeTransactionId:
92
- type: string
93
- description: >-
94
- Transaction ID from the DFSP backend, used to reconcile
95
- transactions between the Switch and DFSP backend systems.
96
- from:
97
- type: object
98
- required: &ref_0
99
- - idType
100
- - idValue
101
- properties: &ref_1
102
- type:
103
- title: TransactionInitiatorType
104
- type: string
105
- enum: &ref_48
106
- - CONSUMER
107
- - AGENT
108
- - BUSINESS
109
- - DEVICE
110
- description: >-
111
- Below are the allowed values for the enumeration.
112
-
113
- - CONSUMER - Consumer is the initiator of the
114
- transaction.
115
-
116
- - AGENT - Agent is the initiator of the transaction.
117
-
118
- - BUSINESS - Business is the initiator of the
119
- transaction.
120
-
121
- - DEVICE - Device is the initiator of the transaction.
122
- example: CONSUMER
123
- idType:
124
- title: PartyIdType
125
- type: string
126
- enum: &ref_23
127
- - MSISDN
128
- - EMAIL
129
- - PERSONAL_ID
130
- - BUSINESS
131
- - DEVICE
132
- - ACCOUNT_ID
133
- - IBAN
134
- - ALIAS
135
- description: >-
136
- Below are the allowed values for the enumeration.
137
-
138
- - MSISDN - An MSISDN (Mobile Station International
139
- Subscriber Directory Number, that is, the phone number)
140
- is used as reference to a participant. The MSISDN
141
- identifier should be in international format according
142
- to the [ITU-T E.164
143
- standard](https://www.itu.int/rec/T-REC-E.164/en).
144
- Optionally, the MSISDN may be prefixed by a single plus
145
- sign, indicating the international prefix.
146
-
147
- - EMAIL - An email is used as reference to a
148
- participant. The format of the email should be according
149
- to the informational [RFC
150
- 3696](https://tools.ietf.org/html/rfc3696).
151
-
152
- - PERSONAL_ID - A personal identifier is used as
153
- reference to a participant. Examples of personal
154
- identification are passport number, birth certificate
155
- number, and national registration number. The identifier
156
- number is added in the PartyIdentifier element. The
157
- personal identifier type is added in the
158
- PartySubIdOrType element.
159
-
160
- - BUSINESS - A specific Business (for example, an
161
- organization or a company) is used as reference to a
162
- participant. The BUSINESS identifier can be in any
163
- format. To make a transaction connected to a specific
164
- username or bill number in a Business, the
165
- PartySubIdOrType element should be used.
166
-
167
- - DEVICE - A specific device (for example, a POS or ATM)
168
- ID connected to a specific business or organization is
169
- used as reference to a Party. For referencing a specific
170
- device under a specific business or organization, use
171
- the PartySubIdOrType element.
172
-
173
- - ACCOUNT_ID - A bank account number or FSP account ID
174
- should be used as reference to a participant. The
175
- ACCOUNT_ID identifier can be in any format, as formats
176
- can greatly differ depending on country and FSP.
177
-
178
- - IBAN - A bank account number or FSP account ID is used
179
- as reference to a participant. The IBAN identifier can
180
- consist of up to 34 alphanumeric characters and should
181
- be entered without whitespace.
182
-
183
- - ALIAS An alias is used as reference to a participant.
184
- The alias should be created in the FSP as an alternative
185
- reference to an account owner. Another example of an
186
- alias is a username in the FSP system. The ALIAS
187
- identifier can be in any format. It is also possible to
188
- use the PartySubIdOrType element for identifying an
189
- account under an Alias defined by the PartyIdentifier.
190
- idValue:
191
- title: PartyIdentifier
192
- type: string
193
- minLength: 1
194
- maxLength: 128
195
- description: Identifier of the Party.
196
- example: '16135551212'
197
- idSubValue:
198
- title: PartySubIdOrType
199
- type: string
200
- minLength: 1
201
- maxLength: 128
202
- description: >-
203
- Either a sub-identifier of a PartyIdentifier, or a
204
- sub-type of the PartyIdType, normally a
205
- PersonalIdentifierType.
206
- displayName:
207
- title: Name
208
- type: string
209
- pattern: ^(?!\s*$)[\w .,'-]{1,128}$
210
- description: >-
211
- The API data type Name is a JSON String, restricted by a
212
- regular expression to avoid characters which are
213
- generally not used in a name.
214
-
215
-
216
- Regular Expression - The regular expression for
217
- restricting the Name type is "^(?!\s*$)[\w
218
- .,'-]{1,128}$". The restriction does not allow a string
219
- consisting of whitespace only, all Unicode characters
220
- are allowed, as well as the period (.) (apostrophe (‘),
221
- dash (-), comma (,) and space characters ( ).
222
-
223
-
224
- **Note:** In some programming languages, Unicode support
225
- must be specifically enabled. For example, if Java is
226
- used, the flag UNICODE_CHARACTER_CLASS must be enabled
227
- to allow Unicode characters.
228
- firstName:
229
- title: FirstName
230
- type: string
231
- minLength: 1
232
- maxLength: 128
233
- pattern: >-
234
- ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
235
- .,''-]{1,128}$
236
- description: First name of the Party (Name Type).
237
- example: Henrik
238
- middleName:
239
- title: MiddleName
240
- type: string
241
- minLength: 1
242
- maxLength: 128
243
- pattern: >-
244
- ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
245
- .,''-]{1,128}$
246
- description: Middle name of the Party (Name Type).
247
- example: Johannes
248
- lastName:
249
- title: LastName
250
- type: string
251
- minLength: 1
252
- maxLength: 128
253
- pattern: >-
254
- ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
255
- .,''-]{1,128}$
256
- description: Last name of the Party (Name Type).
257
- example: Karlsson
258
- dateOfBirth:
259
- title: DateofBirth (type Date)
260
- type: string
261
- pattern: >-
262
- ^(?:[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)$
263
- description: Date of Birth of the Party.
264
- example: '1966-06-16'
265
- merchantClassificationCode:
266
- title: MerchantClassificationCode
267
- type: string
268
- pattern: ^[\d]{1,4}$
269
- description: >-
270
- A limited set of pre-defined numbers. This list would be
271
- a limited set of numbers identifying a set of popular
272
- merchant types like School Fees, Pubs and Restaurants,
273
- Groceries, etc.
274
- fspId:
275
- title: FspId
276
- type: string
277
- minLength: 1
278
- maxLength: 32
279
- description: FSP identifier.
280
- extensionList:
281
- type: array
282
- items: &ref_2
283
- title: Extension
284
- type: object
285
- description: Data model for the complex type Extension.
286
- properties: &ref_8
287
- key:
288
- title: ExtensionKey
289
- type: string
290
- minLength: 1
291
- maxLength: 32
292
- description: Extension key.
293
- value:
294
- title: ExtensionValue
295
- type: string
296
- minLength: 1
297
- maxLength: 128
298
- description: Extension value.
299
- required: &ref_9
300
- - key
301
- - value
302
- minItems: 0
303
- maxItems: 16
304
- to:
305
- type: object
306
- required: *ref_0
307
- properties: *ref_1
308
- amountType:
309
- title: AmountType
310
- type: string
311
- enum: &ref_3
312
- - SEND
313
- - RECEIVE
314
- description: >-
315
- Below are the allowed values for the enumeration AmountType.
316
-
317
- - SEND - Amount the Payer would like to send, that is, the
318
- amount that should be withdrawn from the Payer account
319
- including any fees.
320
-
321
- - RECEIVE - Amount the Payer would like the Payee to
322
- receive, that is, the amount that should be sent to the
323
- receiver exclusive of any fees.
324
- example: RECEIVE
325
- currency:
326
- title: Currency
327
- description: >-
328
- The currency codes defined in [ISO
329
- 4217](https://www.iso.org/iso-4217-currency-codes.html) as
330
- three-letter alphabetic codes are used as the standard
331
- naming representation for currencies.
332
- type: string
333
- minLength: 3
334
- maxLength: 3
335
- enum: &ref_4
336
- - AED
337
- - AFN
338
- - ALL
339
- - AMD
340
- - ANG
341
- - AOA
342
- - ARS
343
- - AUD
344
- - AWG
345
- - AZN
346
- - BAM
347
- - BBD
348
- - BDT
349
- - BGN
350
- - BHD
351
- - BIF
352
- - BMD
353
- - BND
354
- - BOB
355
- - BRL
356
- - BSD
357
- - BTN
358
- - BWP
359
- - BYN
360
- - BZD
361
- - CAD
362
- - CDF
363
- - CHF
364
- - CLP
365
- - CNY
366
- - COP
367
- - CRC
368
- - CUC
369
- - CUP
370
- - CVE
371
- - CZK
372
- - DJF
373
- - DKK
374
- - DOP
375
- - DZD
376
- - EGP
377
- - ERN
378
- - ETB
379
- - EUR
380
- - FJD
381
- - FKP
382
- - GBP
383
- - GEL
384
- - GGP
385
- - GHS
386
- - GIP
387
- - GMD
388
- - GNF
389
- - GTQ
390
- - GYD
391
- - HKD
392
- - HNL
393
- - HRK
394
- - HTG
395
- - HUF
396
- - IDR
397
- - ILS
398
- - IMP
399
- - INR
400
- - IQD
401
- - IRR
402
- - ISK
403
- - JEP
404
- - JMD
405
- - JOD
406
- - JPY
407
- - KES
408
- - KGS
409
- - KHR
410
- - KMF
411
- - KPW
412
- - KRW
413
- - KWD
414
- - KYD
415
- - KZT
416
- - LAK
417
- - LBP
418
- - LKR
419
- - LRD
420
- - LSL
421
- - LYD
422
- - MAD
423
- - MDL
424
- - MGA
425
- - MKD
426
- - MMK
427
- - MNT
428
- - MOP
429
- - MRO
430
- - MUR
431
- - MVR
432
- - MWK
433
- - MXN
434
- - MYR
435
- - MZN
436
- - NAD
437
- - NGN
438
- - NIO
439
- - NOK
440
- - NPR
441
- - NZD
442
- - OMR
443
- - PAB
444
- - PEN
445
- - PGK
446
- - PHP
447
- - PKR
448
- - PLN
449
- - PYG
450
- - QAR
451
- - RON
452
- - RSD
453
- - RUB
454
- - RWF
455
- - SAR
456
- - SBD
457
- - SCR
458
- - SDG
459
- - SEK
460
- - SGD
461
- - SHP
462
- - SLL
463
- - SOS
464
- - SPL
465
- - SRD
466
- - STD
467
- - SVC
468
- - SYP
469
- - SZL
470
- - THB
471
- - TJS
472
- - TMT
473
- - TND
474
- - TOP
475
- - TRY
476
- - TTD
477
- - TVD
478
- - TWD
479
- - TZS
480
- - UAH
481
- - UGX
482
- - USD
483
- - UYU
484
- - UZS
485
- - VEF
486
- - VND
487
- - VUV
488
- - WST
489
- - XAF
490
- - XCD
491
- - XDR
492
- - XOF
493
- - XPF
494
- - XTS
495
- - XXX
496
- - YER
497
- - ZAR
498
- - ZMW
499
- - ZWD
500
- amount:
501
- title: Amount
502
- type: string
503
- pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
504
- description: >-
505
- The API data type Amount is a JSON String in a canonical
506
- format that is restricted by a regular expression for
507
- interoperability reasons. This pattern does not allow any
508
- trailing zeroes at all, but allows an amount without a minor
509
- currency unit. It also only allows four digits in the minor
510
- currency unit; a negative value is not allowed. Using more
511
- than 18 digits in the major currency unit is not allowed.
512
- example: '123.45'
513
- transactionType:
514
- type: string
515
- enum: &ref_5
516
- - TRANSFER
517
- description: Type of transaction.
518
- note:
519
- title: Note
520
- type: string
521
- minLength: 1
522
- maxLength: 128
523
- description: Memo assigned to transaction.
524
- example: Note sent to Payee.
525
- quoteRequestExtensions:
526
- type: array
527
- items: *ref_2
528
- minItems: 0
529
- maxItems: 16
530
- transferRequestExtensions:
531
- type: array
532
- items: *ref_2
533
- minItems: 0
534
- maxItems: 16
535
- skipPartyLookup:
536
- description: >-
537
- Set to true if supplying an FSPID for the payee party and no
538
- party resolution is needed. This may be useful is a previous
539
- party resolution has been performed.
540
- type: boolean
541
- required: true
542
- responses:
543
- '200':
544
- description: Transfer completed successfully
545
- content: &ref_15
546
- application/json:
547
- schema:
548
- type: object
549
- required: &ref_12
550
- - homeTransactionId
551
- - from
552
- - to
553
- - amountType
554
- - currency
555
- - amount
556
- - transactionType
557
- properties: &ref_13
558
- transferId:
559
- title: CorrelationId
560
- type: string
561
- pattern: >-
562
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
563
- description: >-
564
- Identifier that correlates all messages of the same
565
- sequence. The API data type UUID (Universally Unique
566
- Identifier) is a JSON String in canonical format,
567
- conforming to [RFC
568
- 4122](https://tools.ietf.org/html/rfc4122), that is
569
- restricted by a regular expression for interoperability
570
- reasons. A UUID is always 36 characters long, 32
571
- hexadecimal symbols and 4 dashes (‘-‘).
572
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
573
- homeTransactionId:
574
- type: string
575
- description: >-
576
- Transaction ID from the DFSP backend, used to reconcile
577
- transactions between the Switch and DFSP backend systems.
578
- from:
579
- type: object
580
- required: *ref_0
581
- properties: *ref_1
582
- to:
583
- type: object
584
- required: *ref_0
585
- properties: *ref_1
586
- amountType:
587
- title: AmountType
588
- type: string
589
- enum: *ref_3
590
- description: >-
591
- Below are the allowed values for the enumeration
592
- AmountType.
593
-
594
- - SEND - Amount the Payer would like to send, that is, the
595
- amount that should be withdrawn from the Payer account
596
- including any fees.
597
-
598
- - RECEIVE - Amount the Payer would like the Payee to
599
- receive, that is, the amount that should be sent to the
600
- receiver exclusive of any fees.
601
- example: RECEIVE
602
- currency:
603
- title: Currency
604
- description: >-
605
- The currency codes defined in [ISO
606
- 4217](https://www.iso.org/iso-4217-currency-codes.html) as
607
- three-letter alphabetic codes are used as the standard
608
- naming representation for currencies.
609
- type: string
610
- minLength: 3
611
- maxLength: 3
612
- enum: *ref_4
613
- amount:
614
- title: Amount
615
- type: string
616
- pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
617
- description: >-
618
- The API data type Amount is a JSON String in a canonical
619
- format that is restricted by a regular expression for
620
- interoperability reasons. This pattern does not allow any
621
- trailing zeroes at all, but allows an amount without a
622
- minor currency unit. It also only allows four digits in
623
- the minor currency unit; a negative value is not allowed.
624
- Using more than 18 digits in the major currency unit is
625
- not allowed.
626
- example: '123.45'
627
- transactionType:
628
- type: string
629
- enum: *ref_5
630
- description: Type of transaction.
631
- note:
632
- title: Note
633
- type: string
634
- minLength: 1
635
- maxLength: 128
636
- description: Memo assigned to transaction.
637
- example: Note sent to Payee.
638
- currentState:
639
- type: string
640
- enum: &ref_19
641
- - ERROR_OCCURRED
642
- - WAITING_FOR_PARTY_ACCEPTANCE
643
- - WAITING_FOR_QUOTE_ACCEPTANCE
644
- - COMPLETED
645
- quoteId:
646
- title: CorrelationId
647
- type: string
648
- pattern: >-
649
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
650
- description: >-
651
- Identifier that correlates all messages of the same
652
- sequence. The API data type UUID (Universally Unique
653
- Identifier) is a JSON String in canonical format,
654
- conforming to [RFC
655
- 4122](https://tools.ietf.org/html/rfc4122), that is
656
- restricted by a regular expression for interoperability
657
- reasons. A UUID is always 36 characters long, 32
658
- hexadecimal symbols and 4 dashes (‘-‘).
659
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
660
- getPartiesResponse:
661
- type: object
662
- required:
663
- - body
664
- properties:
665
- body:
666
- type: object
667
- headers:
668
- type: object
669
- quoteResponse:
670
- type: object
671
- required:
672
- - body
673
- properties:
674
- body:
675
- title: QuotesIDPutResponse
676
- type: object
677
- description: The object sent in the PUT /quotes/{ID} callback.
678
- properties: &ref_29
679
- transferAmount:
680
- title: Money
681
- type: object
682
- description: Data model for the complex type Money.
683
- properties: &ref_6
684
- currency:
685
- title: Currency
686
- description: >-
687
- The currency codes defined in [ISO
688
- 4217](https://www.iso.org/iso-4217-currency-codes.html)
689
- as three-letter alphabetic codes are used as
690
- the standard naming representation for
691
- currencies.
692
- type: string
693
- minLength: 3
694
- maxLength: 3
695
- enum: *ref_4
696
- amount:
697
- title: Amount
698
- type: string
699
- pattern: >-
700
- ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
701
- description: >-
702
- The API data type Amount is a JSON String in a
703
- canonical format that is restricted by a
704
- regular expression for interoperability
705
- reasons. This pattern does not allow any
706
- trailing zeroes at all, but allows an amount
707
- without a minor currency unit. It also only
708
- allows four digits in the minor currency unit;
709
- a negative value is not allowed. Using more
710
- than 18 digits in the major currency unit is
711
- not allowed.
712
- example: '123.45'
713
- required: &ref_7
714
- - currency
715
- - amount
716
- payeeReceiveAmount:
717
- title: Money
718
- type: object
719
- description: Data model for the complex type Money.
720
- properties: *ref_6
721
- required: *ref_7
722
- payeeFspFee:
723
- title: Money
724
- type: object
725
- description: Data model for the complex type Money.
726
- properties: *ref_6
727
- required: *ref_7
728
- payeeFspCommission:
729
- title: Money
730
- type: object
731
- description: Data model for the complex type Money.
732
- properties: *ref_6
733
- required: *ref_7
734
- expiration:
735
- title: DateTime
736
- type: string
737
- pattern: >-
738
- ^(?:[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)$
739
- description: >-
740
- The API data type DateTime is a JSON String in a
741
- lexical format that is restricted by a regular
742
- expression for interoperability reasons. The
743
- format is according to [ISO
744
- 8601](https://www.iso.org/iso-8601-date-and-time-format.html),
745
- expressed in a combined date, time and time zone
746
- format. A more readable version of the format is
747
- yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are
748
- "2016-05-24T08:38:08.699-04:00",
749
- "2016-05-24T08:38:08.699Z" (where Z indicates Zulu
750
- time zone, same as UTC).
751
- example: '2016-05-24T08:38:08.699-04:00'
752
- geoCode:
753
- title: GeoCode
754
- type: object
755
- description: >-
756
- Data model for the complex type GeoCode. Indicates
757
- the geographic location from where the transaction
758
- was initiated.
759
- properties: &ref_62
760
- latitude:
761
- title: Latitude
762
- type: string
763
- pattern: >-
764
- ^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$
765
- description: >-
766
- The API data type Latitude is a JSON String in
767
- a lexical format that is restricted by a
768
- regular expression for interoperability
769
- reasons.
770
- example: '+45.4215'
771
- longitude:
772
- title: Longitude
773
- type: string
774
- pattern: >-
775
- ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
776
- description: >-
777
- The API data type Longitude is a JSON String
778
- in a lexical format that is restricted by a
779
- regular expression for interoperability
780
- reasons.
781
- example: '+75.6972'
782
- required: &ref_63
783
- - latitude
784
- - longitude
785
- ilpPacket:
786
- title: IlpPacket
787
- type: string
788
- pattern: ^[A-Za-z0-9-_]+[=]{0,2}$
789
- minLength: 1
790
- maxLength: 32768
791
- description: >-
792
- Information for recipient (transport layer
793
- information).
794
- example: >-
795
- AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
796
- condition:
797
- title: IlpCondition
798
- type: string
799
- pattern: ^[A-Za-z0-9-_]{43}$
800
- maxLength: 48
801
- description: >-
802
- Condition that must be attached to the transfer by
803
- the Payer.
804
- extensionList:
805
- title: ExtensionList
806
- type: object
807
- description: >-
808
- Data model for the complex type ExtensionList. An
809
- optional list of extensions, specific to
810
- deployment.
811
- properties: &ref_10
812
- extension:
813
- type: array
814
- items:
815
- title: Extension
816
- type: object
817
- description: Data model for the complex type Extension.
818
- properties: *ref_8
819
- required: *ref_9
820
- minItems: 1
821
- maxItems: 16
822
- description: Number of Extension elements.
823
- required: &ref_11
824
- - extension
825
- required: &ref_30
826
- - transferAmount
827
- - expiration
828
- - ilpPacket
829
- - condition
830
- headers:
831
- type: object
832
- quoteResponseSource:
833
- type: string
834
- description: >
835
- FSPID of the entity that supplied the quote response. This
836
- may not be the same as the FSPID of the entity which owns
837
- the end user account in the case of a FOREX transfer. i.e.
838
- it may be a FOREX gateway.
839
- fulfil:
840
- type: object
841
- required:
842
- - body
843
- properties:
844
- body:
845
- title: TransfersIDPutResponse
846
- type: object
847
- description: The object sent in the PUT /transfers/{ID} callback.
848
- properties: &ref_20
849
- fulfilment:
850
- title: IlpFulfilment
851
- type: string
852
- pattern: ^[A-Za-z0-9-_]{43}$
853
- maxLength: 48
854
- description: >-
855
- Fulfilment that must be attached to the transfer
856
- by the Payee.
857
- example: WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
858
- completedTimestamp:
859
- title: DateTime
860
- type: string
861
- pattern: >-
862
- ^(?:[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)$
863
- description: >-
864
- The API data type DateTime is a JSON String in a
865
- lexical format that is restricted by a regular
866
- expression for interoperability reasons. The
867
- format is according to [ISO
868
- 8601](https://www.iso.org/iso-8601-date-and-time-format.html),
869
- expressed in a combined date, time and time zone
870
- format. A more readable version of the format is
871
- yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are
872
- "2016-05-24T08:38:08.699-04:00",
873
- "2016-05-24T08:38:08.699Z" (where Z indicates Zulu
874
- time zone, same as UTC).
875
- example: '2016-05-24T08:38:08.699-04:00'
876
- transferState:
877
- title: TransferState
878
- type: string
879
- enum: &ref_67
880
- - RECEIVED
881
- - RESERVED
882
- - COMMITTED
883
- - ABORTED
884
- description: >-
885
- Below are the allowed values for the enumeration.
886
-
887
- - RECEIVED - Next ledger has received the
888
- transfer.
889
-
890
- - RESERVED - Next ledger has reserved the
891
- transfer.
892
-
893
- - COMMITTED - Next ledger has successfully
894
- performed the transfer.
895
-
896
- - ABORTED - Next ledger has aborted the transfer
897
- due to a rejection or failure to perform the
898
- transfer.
899
- example: RESERVED
900
- extensionList:
901
- title: ExtensionList
902
- type: object
903
- description: >-
904
- Data model for the complex type ExtensionList. An
905
- optional list of extensions, specific to
906
- deployment.
907
- properties: *ref_10
908
- required: *ref_11
909
- required: &ref_21
910
- - transferState
911
- headers:
912
- type: object
913
- lastError:
914
- description: >-
915
- This object represents a Mojaloop API error received at
916
- any time during the transfer process
917
- type: object
918
- properties: &ref_26
919
- httpStatusCode:
920
- type: integer
921
- description: >-
922
- The HTTP status code returned to the caller. This is
923
- the same as the actual HTTP status code returned with
924
- the response.
925
- mojaloopError:
926
- description: >-
927
- If a transfer process results in an error callback
928
- during the asynchronous Mojaloop API exchange, this
929
- property will contain the underlying Mojaloop API
930
- error object.
931
- type: object
932
- properties: &ref_39
933
- errorInformation:
934
- title: ErrorInformation
935
- type: object
936
- description: Data model for the complex type ErrorInformation.
937
- properties: &ref_56
938
- errorCode:
939
- title: ErrorCode
940
- type: string
941
- pattern: ^[1-9]\d{3}$
942
- description: >-
943
- The API data type ErrorCode is a JSON String
944
- of four characters, consisting of digits only.
945
- Negative numbers are not allowed. A leading
946
- zero is not allowed. Each error code in the
947
- API is a four-digit number, for example, 1234,
948
- where the first number (1 in the example)
949
- represents the high-level error category, the
950
- second number (2 in the example) represents
951
- the low-level error category, and the last two
952
- numbers (34 in the example) represent the
953
- specific error.
954
- example: '5100'
955
- errorDescription:
956
- title: ErrorDescription
957
- type: string
958
- minLength: 1
959
- maxLength: 128
960
- description: Error description string.
961
- extensionList:
962
- title: ExtensionList
963
- type: object
964
- description: >-
965
- Data model for the complex type ExtensionList.
966
- An optional list of extensions, specific to
967
- deployment.
968
- properties: *ref_10
969
- required: *ref_11
970
- required: &ref_57
971
- - errorCode
972
- - errorDescription
973
- skipPartyLookup:
974
- description: >-
975
- Set to true if supplying an FSPID for the payee party and
976
- no party resolution is needed. This may be useful is a
977
- previous party resolution has been performed.
978
- type: boolean
979
- '400':
980
- description: Malformed or missing required body, headers or parameters
981
- content: &ref_127
982
- application/json:
983
- schema:
984
- allOf: &ref_14
985
- - type: object
986
- properties: &ref_22
987
- statusCode:
988
- type: string
989
- description: Error code as string.
990
- message:
991
- type: string
992
- description: Error message text.
993
- - type: object
994
- required:
995
- - transferState
996
- properties:
997
- transferState:
998
- type: object
999
- required: *ref_12
1000
- properties: *ref_13
1001
- '500':
1002
- description: An error occurred processing the transfer
1003
- content: &ref_16
1004
- application/json:
1005
- schema:
1006
- allOf: *ref_14
1007
- '504':
1008
- description: Timeout occurred processing the transfer
1009
- content: &ref_17
1010
- application/json:
1011
- schema:
1012
- allOf: *ref_14
1013
- /transfers/{transferId}:
1014
- put:
1015
- summary: >-
1016
- Continues a transfer that has paused at the quote stage in order to
1017
- accept or reject payee party and/or quote
1018
- description: >
1019
- The HTTP request `PUT /transfers/{transferId}` is used to continue a
1020
- transfer initiated via the `POST /transfers` method that has halted
1021
- after party lookup and/or quotation stage.
1022
-
1023
-
1024
- The request body should contain either the "acceptParty" or
1025
- "acceptQuote" property set to `true` as required to continue the
1026
- transfer.
1027
-
1028
-
1029
- See the description of the `POST /transfers` HTTP method for more
1030
- information on modes of transfer.
1031
- tags:
1032
- - Transfers
1033
- requestBody:
1034
- content:
1035
- application/json:
1036
- schema:
1037
- oneOf:
1038
- - type: object
1039
- required: &ref_31
1040
- - acceptParty
1041
- properties: &ref_32
1042
- acceptParty:
1043
- type: boolean
1044
- enum:
1045
- - true
1046
- - type: object
1047
- required: &ref_35
1048
- - acceptQuote
1049
- properties: &ref_36
1050
- acceptQuote:
1051
- type: boolean
1052
- enum:
1053
- - true
1054
- - false
1055
- parameters:
1056
- - name: transferId
1057
- in: path
1058
- required: true
1059
- schema: &ref_18
1060
- title: CorrelationId
1061
- type: string
1062
- pattern: >-
1063
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1064
- description: >-
1065
- Identifier that correlates all messages of the same sequence. The
1066
- API data type UUID (Universally Unique Identifier) is a JSON
1067
- String in canonical format, conforming to [RFC
1068
- 4122](https://tools.ietf.org/html/rfc4122), that is restricted by
1069
- a regular expression for interoperability reasons. A UUID is
1070
- always 36 characters long, 32 hexadecimal symbols and 4 dashes
1071
- (‘-‘).
1072
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
1073
- description: >-
1074
- Identifier of the transfer to continue as returned in the response
1075
- to a `POST /transfers` request.
1076
- responses:
1077
- '200':
1078
- description: Transfer completed successfully
1079
- content: *ref_15
1080
- '500':
1081
- description: An error occurred processing the transfer
1082
- content: *ref_16
1083
- '504':
1084
- description: Timeout occurred processing the transfer
1085
- content: *ref_17
1086
- get:
1087
- summary: Retrieves information for a specific transfer
1088
- description: >-
1089
- The HTTP request `GET /transfers/{transferId}` is used to get
1090
- information regarding a transfer created or requested earlier. The
1091
- `{transferId}` in the URI should contain the `transferId` that was used
1092
- for the creation of the transfer.
1093
- tags:
1094
- - Transfers
1095
- parameters:
1096
- - name: transferId
1097
- in: path
1098
- required: true
1099
- schema: *ref_18
1100
- description: >-
1101
- Identifier of the transfer to continue as returned in the response
1102
- to a `POST /transfers` request.
1103
- responses:
1104
- '200':
1105
- description: Transfer information successfully retrieved
1106
- content:
1107
- application/json:
1108
- schema:
1109
- type: object
1110
- required: &ref_68
1111
- - transferId
1112
- - currentState
1113
- - fulfil
1114
- properties: &ref_69
1115
- transferId:
1116
- title: CorrelationId
1117
- type: string
1118
- pattern: >-
1119
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1120
- description: >-
1121
- Identifier that correlates all messages of the same
1122
- sequence. The API data type UUID (Universally Unique
1123
- Identifier) is a JSON String in canonical format,
1124
- conforming to [RFC
1125
- 4122](https://tools.ietf.org/html/rfc4122), that is
1126
- restricted by a regular expression for interoperability
1127
- reasons. A UUID is always 36 characters long, 32
1128
- hexadecimal symbols and 4 dashes (‘-‘).
1129
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
1130
- currentState:
1131
- type: string
1132
- enum: *ref_19
1133
- fulfil:
1134
- type: object
1135
- required:
1136
- - body
1137
- properties:
1138
- body:
1139
- title: TransfersIDPutResponse
1140
- type: object
1141
- description: The object sent in the PUT /transfers/{ID} callback.
1142
- properties: *ref_20
1143
- required: *ref_21
1144
- headers:
1145
- type: object
1146
- '500':
1147
- description: An error occurred processing the transfer
1148
- content:
1149
- application/json:
1150
- schema:
1151
- type: object
1152
- properties: *ref_22
1153
- /bulkTransfers:
1154
- post:
1155
- summary: Sends money from one account to multiple accounts
1156
- description: >
1157
- The HTTP request `POST /bulkTransfers` is used to request the movement
1158
- of funds from payer DFSP to payees' DFSP.
1159
- tags:
1160
- - BulkTransfers
1161
- requestBody:
1162
- description: Bulk transfer request body
1163
- content:
1164
- application/json:
1165
- schema:
1166
- type: object
1167
- required: &ref_82
1168
- - bulkHomeTransactionID
1169
- - options
1170
- - from
1171
- - individualTransfers
1172
- properties: &ref_83
1173
- bulkHomeTransactionID:
1174
- type: string
1175
- description: >-
1176
- Transaction ID from the DFSP backend, used to reconcile
1177
- transactions between the Switch and DFSP backend systems.
1178
- bulkTransactionId:
1179
- title: CorrelationId
1180
- type: string
1181
- pattern: >-
1182
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1183
- description: >-
1184
- Identifier that correlates all messages of the same
1185
- sequence. The API data type UUID (Universally Unique
1186
- Identifier) is a JSON String in canonical format, conforming
1187
- to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is
1188
- restricted by a regular expression for interoperability
1189
- reasons. A UUID is always 36 characters long, 32 hexadecimal
1190
- symbols and 4 dashes (‘-‘).
1191
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
1192
- options:
1193
- type: object
1194
- required: &ref_27
1195
- - autoAcceptParty
1196
- - autoAcceptQuote
1197
- - bulkExpiration
1198
- properties: &ref_28
1199
- onlyValidateParty:
1200
- description: >-
1201
- Set to true if only party validation is required. This
1202
- means the quotes and transfers will not run. This is
1203
- useful for only party resolution.
1204
- type: boolean
1205
- autoAcceptParty:
1206
- type: object
1207
- required: &ref_70
1208
- - enabled
1209
- properties: &ref_71
1210
- enabled:
1211
- type: boolean
1212
- enum:
1213
- - false
1214
- - true
1215
- autoAcceptQuote:
1216
- description: >-
1217
- Set to true if the quote response is accepted without
1218
- confirmation from the payer. The fees applied by the
1219
- payee will be acceptable to the payer abiding by the
1220
- limits set by optional 'perTransferFeeLimits' array.
1221
- type: object
1222
- oneOf:
1223
- - type: object
1224
- required: &ref_74
1225
- - enabled
1226
- properties: &ref_75
1227
- enabled:
1228
- type: boolean
1229
- enum:
1230
- - true
1231
- - false
1232
- perTransferFeeLimits:
1233
- type: array
1234
- minItems: 0
1235
- items:
1236
- type: object
1237
- required: &ref_72
1238
- - currency
1239
- - amount
1240
- properties: &ref_73
1241
- currency:
1242
- title: Currency
1243
- description: >-
1244
- The currency codes defined in [ISO
1245
- 4217](https://www.iso.org/iso-4217-currency-codes.html)
1246
- as three-letter alphabetic codes are used
1247
- as the standard naming representation for
1248
- currencies.
1249
- type: string
1250
- minLength: 3
1251
- maxLength: 3
1252
- enum: *ref_4
1253
- amount:
1254
- title: Amount
1255
- type: string
1256
- pattern: >-
1257
- ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
1258
- description: >-
1259
- The API data type Amount is a JSON String
1260
- in a canonical format that is restricted
1261
- by a regular expression for
1262
- interoperability reasons. This pattern
1263
- does not allow any trailing zeroes at all,
1264
- but allows an amount without a minor
1265
- currency unit. It also only allows four
1266
- digits in the minor currency unit; a
1267
- negative value is not allowed. Using more
1268
- than 18 digits in the major currency unit
1269
- is not allowed.
1270
- example: '123.45'
1271
- skipPartyLookup:
1272
- description: >-
1273
- Set to true if supplying an FSPID for the payee party
1274
- and no party resolution is needed. This may be useful if
1275
- a previous party resolution has been performed.
1276
- type: boolean
1277
- synchronous:
1278
- description: >-
1279
- Set to true if the bulkTransfer requests need be handled
1280
- synchronous. Otherwise the requests will be handled
1281
- asynchronously, meaning there will be callbacks
1282
- whenever the processing is done
1283
- type: boolean
1284
- bulkExpiration:
1285
- title: DateTime
1286
- type: string
1287
- pattern: >-
1288
- ^(?:[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)$
1289
- description: >-
1290
- The API data type DateTime is a JSON String in a lexical
1291
- format that is restricted by a regular expression for
1292
- interoperability reasons. The format is according to
1293
- [ISO
1294
- 8601](https://www.iso.org/iso-8601-date-and-time-format.html),
1295
- expressed in a combined date, time and time zone format.
1296
- A more readable version of the format is
1297
- yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are
1298
- "2016-05-24T08:38:08.699-04:00",
1299
- "2016-05-24T08:38:08.699Z" (where Z indicates Zulu time
1300
- zone, same as UTC).
1301
- example: '2016-05-24T08:38:08.699-04:00'
1302
- from:
1303
- title: Party
1304
- type: object
1305
- description: Data model for the complex type Party.
1306
- properties: &ref_24
1307
- partyIdInfo:
1308
- title: PartyIdInfo
1309
- type: object
1310
- description: >-
1311
- Data model for the complex type PartyIdInfo. An
1312
- ExtensionList element has been added to this reqeust in
1313
- version v1.1
1314
- properties: &ref_76
1315
- partyIdType:
1316
- title: PartyIdType
1317
- type: string
1318
- enum: *ref_23
1319
- description: >-
1320
- Below are the allowed values for the enumeration.
1321
-
1322
- - MSISDN - An MSISDN (Mobile Station International
1323
- Subscriber Directory Number, that is, the phone
1324
- number) is used as reference to a participant. The
1325
- MSISDN identifier should be in international format
1326
- according to the [ITU-T E.164
1327
- standard](https://www.itu.int/rec/T-REC-E.164/en).
1328
- Optionally, the MSISDN may be prefixed by a single
1329
- plus sign, indicating the international prefix.
1330
-
1331
- - EMAIL - An email is used as reference to a
1332
- participant. The format of the email should be
1333
- according to the informational [RFC
1334
- 3696](https://tools.ietf.org/html/rfc3696).
1335
-
1336
- - PERSONAL_ID - A personal identifier is used as
1337
- reference to a participant. Examples of personal
1338
- identification are passport number, birth
1339
- certificate number, and national registration
1340
- number. The identifier number is added in the
1341
- PartyIdentifier element. The personal identifier
1342
- type is added in the PartySubIdOrType element.
1343
-
1344
- - BUSINESS - A specific Business (for example, an
1345
- organization or a company) is used as reference to a
1346
- participant. The BUSINESS identifier can be in any
1347
- format. To make a transaction connected to a
1348
- specific username or bill number in a Business, the
1349
- PartySubIdOrType element should be used.
1350
-
1351
- - DEVICE - A specific device (for example, a POS or
1352
- ATM) ID connected to a specific business or
1353
- organization is used as reference to a Party. For
1354
- referencing a specific device under a specific
1355
- business or organization, use the PartySubIdOrType
1356
- element.
1357
-
1358
- - ACCOUNT_ID - A bank account number or FSP account
1359
- ID should be used as reference to a participant. The
1360
- ACCOUNT_ID identifier can be in any format, as
1361
- formats can greatly differ depending on country and
1362
- FSP.
1363
-
1364
- - IBAN - A bank account number or FSP account ID is
1365
- used as reference to a participant. The IBAN
1366
- identifier can consist of up to 34 alphanumeric
1367
- characters and should be entered without whitespace.
1368
-
1369
- - ALIAS An alias is used as reference to a
1370
- participant. The alias should be created in the FSP
1371
- as an alternative reference to an account owner.
1372
- Another example of an alias is a username in the FSP
1373
- system. The ALIAS identifier can be in any format.
1374
- It is also possible to use the PartySubIdOrType
1375
- element for identifying an account under an Alias
1376
- defined by the PartyIdentifier.
1377
- partyIdentifier:
1378
- title: PartyIdentifier
1379
- type: string
1380
- minLength: 1
1381
- maxLength: 128
1382
- description: Identifier of the Party.
1383
- example: '16135551212'
1384
- partySubIdOrType:
1385
- title: PartySubIdOrType
1386
- type: string
1387
- minLength: 1
1388
- maxLength: 128
1389
- description: >-
1390
- Either a sub-identifier of a PartyIdentifier, or a
1391
- sub-type of the PartyIdType, normally a
1392
- PersonalIdentifierType.
1393
- fspId:
1394
- title: FspId
1395
- type: string
1396
- minLength: 1
1397
- maxLength: 32
1398
- description: FSP identifier.
1399
- extensionList:
1400
- title: ExtensionList
1401
- type: object
1402
- description: >-
1403
- Data model for the complex type ExtensionList. An
1404
- optional list of extensions, specific to deployment.
1405
- properties: *ref_10
1406
- required: *ref_11
1407
- required: &ref_77
1408
- - partyIdType
1409
- - partyIdentifier
1410
- merchantClassificationCode:
1411
- title: MerchantClassificationCode
1412
- type: string
1413
- pattern: ^[\d]{1,4}$
1414
- description: >-
1415
- A limited set of pre-defined numbers. This list would be
1416
- a limited set of numbers identifying a set of popular
1417
- merchant types like School Fees, Pubs and Restaurants,
1418
- Groceries, etc.
1419
- name:
1420
- title: PartyName
1421
- type: string
1422
- minLength: 1
1423
- maxLength: 128
1424
- description: Name of the Party. Could be a real name or a nickname.
1425
- personalInfo:
1426
- title: PartyPersonalInfo
1427
- type: object
1428
- description: Data model for the complex type PartyPersonalInfo.
1429
- properties: &ref_79
1430
- complexName:
1431
- title: PartyComplexName
1432
- type: object
1433
- description: Data model for the complex type PartyComplexName.
1434
- properties: &ref_78
1435
- firstName:
1436
- title: FirstName
1437
- type: string
1438
- minLength: 1
1439
- maxLength: 128
1440
- pattern: >-
1441
- ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
1442
- .,''-]{1,128}$
1443
- description: First name of the Party (Name Type).
1444
- example: Henrik
1445
- middleName:
1446
- title: MiddleName
1447
- type: string
1448
- minLength: 1
1449
- maxLength: 128
1450
- pattern: >-
1451
- ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
1452
- .,''-]{1,128}$
1453
- description: Middle name of the Party (Name Type).
1454
- example: Johannes
1455
- lastName:
1456
- title: LastName
1457
- type: string
1458
- minLength: 1
1459
- maxLength: 128
1460
- pattern: >-
1461
- ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
1462
- .,''-]{1,128}$
1463
- description: Last name of the Party (Name Type).
1464
- example: Karlsson
1465
- dateOfBirth:
1466
- title: DateofBirth (type Date)
1467
- type: string
1468
- pattern: >-
1469
- ^(?:[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)$
1470
- description: Date of Birth of the Party.
1471
- example: '1966-06-16'
1472
- required: &ref_25
1473
- - partyIdInfo
1474
- individualTransfers:
1475
- description: List of individual transfers in a bulk transfer.
1476
- type: array
1477
- minItems: 1
1478
- maxItems: 1000
1479
- items:
1480
- title: IndividualTransfer
1481
- type: object
1482
- description: Data model for the complex type 'individualTransfer'.
1483
- properties: &ref_80
1484
- homeTransactionId:
1485
- title: CorrelationId
1486
- type: string
1487
- pattern: >-
1488
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1489
- description: >-
1490
- Identifier that correlates all messages of the same
1491
- sequence. The API data type UUID (Universally Unique
1492
- Identifier) is a JSON String in canonical format,
1493
- conforming to [RFC
1494
- 4122](https://tools.ietf.org/html/rfc4122), that is
1495
- restricted by a regular expression for
1496
- interoperability reasons. A UUID is always 36
1497
- characters long, 32 hexadecimal symbols and 4 dashes
1498
- (‘-‘).
1499
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
1500
- to:
1501
- title: Party
1502
- type: object
1503
- description: Data model for the complex type Party.
1504
- properties: *ref_24
1505
- required: *ref_25
1506
- reference:
1507
- description: Payer Loan reference
1508
- type: string
1509
- amountType:
1510
- title: AmountType
1511
- type: string
1512
- enum: *ref_3
1513
- description: >-
1514
- Below are the allowed values for the enumeration
1515
- AmountType.
1516
-
1517
- - SEND - Amount the Payer would like to send, that is,
1518
- the amount that should be withdrawn from the Payer
1519
- account including any fees.
1520
-
1521
- - RECEIVE - Amount the Payer would like the Payee to
1522
- receive, that is, the amount that should be sent to
1523
- the receiver exclusive of any fees.
1524
- example: RECEIVE
1525
- currency:
1526
- title: Currency
1527
- description: >-
1528
- The currency codes defined in [ISO
1529
- 4217](https://www.iso.org/iso-4217-currency-codes.html)
1530
- as three-letter alphabetic codes are used as the
1531
- standard naming representation for currencies.
1532
- type: string
1533
- minLength: 3
1534
- maxLength: 3
1535
- enum: *ref_4
1536
- amount:
1537
- title: Amount
1538
- type: string
1539
- pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
1540
- description: >-
1541
- The API data type Amount is a JSON String in a
1542
- canonical format that is restricted by a regular
1543
- expression for interoperability reasons. This pattern
1544
- does not allow any trailing zeroes at all, but allows
1545
- an amount without a minor currency unit. It also only
1546
- allows four digits in the minor currency unit; a
1547
- negative value is not allowed. Using more than 18
1548
- digits in the major currency unit is not allowed.
1549
- example: '123.45'
1550
- note:
1551
- title: Note
1552
- type: string
1553
- minLength: 1
1554
- maxLength: 128
1555
- description: Memo assigned to transaction.
1556
- example: Note sent to Payee.
1557
- quoteExtensions:
1558
- title: ExtensionList
1559
- type: object
1560
- description: >-
1561
- Data model for the complex type ExtensionList. An
1562
- optional list of extensions, specific to deployment.
1563
- properties: *ref_10
1564
- required: *ref_11
1565
- transferExtensions:
1566
- title: ExtensionList
1567
- type: object
1568
- description: >-
1569
- Data model for the complex type ExtensionList. An
1570
- optional list of extensions, specific to deployment.
1571
- properties: *ref_10
1572
- required: *ref_11
1573
- lastError:
1574
- type: object
1575
- description: >-
1576
- This object represents a Mojaloop API error received
1577
- at any time during the transfer process
1578
- properties: *ref_26
1579
- required: &ref_81
1580
- - homeTransactionId
1581
- - to
1582
- - amountType
1583
- - currency
1584
- - amount
1585
- extensions:
1586
- title: ExtensionList
1587
- type: object
1588
- description: >-
1589
- Data model for the complex type ExtensionList. An optional
1590
- list of extensions, specific to deployment.
1591
- properties: *ref_10
1592
- required: *ref_11
1593
- required: true
1594
- responses:
1595
- '202':
1596
- description: Bulk transfer accepted successfully
1597
- '400':
1598
- description: Malformed or missing required body, headers or parameters
1599
- content: &ref_128
1600
- application/json:
1601
- schema:
1602
- allOf: &ref_89
1603
- - type: object
1604
- properties: *ref_22
1605
- - type: object
1606
- required:
1607
- - bulkTansferState
1608
- properties:
1609
- bulkTransferState:
1610
- type: object
1611
- required: &ref_87
1612
- - bulkHomeTransactionID
1613
- - bulkTransactionId
1614
- - currentState
1615
- - individualTransferResults
1616
- properties: &ref_88
1617
- bulkHomeTransactionID:
1618
- type: string
1619
- description: >-
1620
- Transaction ID from the DFSP backend, used to
1621
- reconcile transactions between the Switch and DFSP
1622
- backend systems.
1623
- bulkTransactionId:
1624
- title: CorrelationId
1625
- type: string
1626
- pattern: >-
1627
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1628
- description: >-
1629
- Identifier that correlates all messages of the
1630
- same sequence. The API data type UUID (Universally
1631
- Unique Identifier) is a JSON String in canonical
1632
- format, conforming to [RFC
1633
- 4122](https://tools.ietf.org/html/rfc4122), that
1634
- is restricted by a regular expression for
1635
- interoperability reasons. A UUID is always 36
1636
- characters long, 32 hexadecimal symbols and 4
1637
- dashes (‘-‘).
1638
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
1639
- currentState:
1640
- type: string
1641
- enum: &ref_84
1642
- - ERROR_OCCURRED
1643
- - WAITING_FOR_PARTY_ACCEPTANCE
1644
- - WAITING_FOR_QUOTE_ACCEPTANCE
1645
- - COMPLETED
1646
- options:
1647
- type: object
1648
- required: *ref_27
1649
- properties: *ref_28
1650
- individualTransferResults:
1651
- description: >-
1652
- List of individual transfer result in a bulk
1653
- transfer response.
1654
- type: array
1655
- minItems: 1
1656
- maxItems: 1000
1657
- items:
1658
- type: object
1659
- required: &ref_85
1660
- - homeTransactionId
1661
- - transactionId
1662
- - to
1663
- - amountType
1664
- - currency
1665
- - amount
1666
- properties: &ref_86
1667
- transferId:
1668
- title: CorrelationId
1669
- type: string
1670
- pattern: >-
1671
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1672
- description: >-
1673
- Identifier that correlates all messages of
1674
- the same sequence. The API data type UUID
1675
- (Universally Unique Identifier) is a JSON
1676
- String in canonical format, conforming to
1677
- [RFC
1678
- 4122](https://tools.ietf.org/html/rfc4122),
1679
- that is restricted by a regular expression
1680
- for interoperability reasons. A UUID is
1681
- always 36 characters long, 32 hexadecimal
1682
- symbols and 4 dashes (‘-‘).
1683
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
1684
- homeTransactionId:
1685
- title: CorrelationId
1686
- type: string
1687
- pattern: >-
1688
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1689
- description: >-
1690
- Identifier that correlates all messages of
1691
- the same sequence. The API data type UUID
1692
- (Universally Unique Identifier) is a JSON
1693
- String in canonical format, conforming to
1694
- [RFC
1695
- 4122](https://tools.ietf.org/html/rfc4122),
1696
- that is restricted by a regular expression
1697
- for interoperability reasons. A UUID is
1698
- always 36 characters long, 32 hexadecimal
1699
- symbols and 4 dashes (‘-‘).
1700
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
1701
- transactionId:
1702
- title: CorrelationId
1703
- type: string
1704
- pattern: >-
1705
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1706
- description: >-
1707
- Identifier that correlates all messages of
1708
- the same sequence. The API data type UUID
1709
- (Universally Unique Identifier) is a JSON
1710
- String in canonical format, conforming to
1711
- [RFC
1712
- 4122](https://tools.ietf.org/html/rfc4122),
1713
- that is restricted by a regular expression
1714
- for interoperability reasons. A UUID is
1715
- always 36 characters long, 32 hexadecimal
1716
- symbols and 4 dashes (‘-‘).
1717
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
1718
- to:
1719
- title: Party
1720
- type: object
1721
- description: Data model for the complex type Party.
1722
- properties: *ref_24
1723
- required: *ref_25
1724
- amountType:
1725
- title: AmountType
1726
- type: string
1727
- enum: *ref_3
1728
- description: >-
1729
- Below are the allowed values for the
1730
- enumeration AmountType.
1731
-
1732
- - SEND - Amount the Payer would like to
1733
- send, that is, the amount that should be
1734
- withdrawn from the Payer account including
1735
- any fees.
1736
-
1737
- - RECEIVE - Amount the Payer would like the
1738
- Payee to receive, that is, the amount that
1739
- should be sent to the receiver exclusive of
1740
- any fees.
1741
- example: RECEIVE
1742
- currency:
1743
- title: Currency
1744
- description: >-
1745
- The currency codes defined in [ISO
1746
- 4217](https://www.iso.org/iso-4217-currency-codes.html)
1747
- as three-letter alphabetic codes are used as
1748
- the standard naming representation for
1749
- currencies.
1750
- type: string
1751
- minLength: 3
1752
- maxLength: 3
1753
- enum: *ref_4
1754
- amount:
1755
- title: Amount
1756
- type: string
1757
- pattern: >-
1758
- ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
1759
- description: >-
1760
- The API data type Amount is a JSON String in
1761
- a canonical format that is restricted by a
1762
- regular expression for interoperability
1763
- reasons. This pattern does not allow any
1764
- trailing zeroes at all, but allows an amount
1765
- without a minor currency unit. It also only
1766
- allows four digits in the minor currency
1767
- unit; a negative value is not allowed. Using
1768
- more than 18 digits in the major currency
1769
- unit is not allowed.
1770
- example: '123.45'
1771
- note:
1772
- title: Note
1773
- type: string
1774
- minLength: 1
1775
- maxLength: 128
1776
- description: Memo assigned to transaction.
1777
- example: Note sent to Payee.
1778
- quoteId:
1779
- title: CorrelationId
1780
- type: string
1781
- pattern: >-
1782
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1783
- description: >-
1784
- Identifier that correlates all messages of
1785
- the same sequence. The API data type UUID
1786
- (Universally Unique Identifier) is a JSON
1787
- String in canonical format, conforming to
1788
- [RFC
1789
- 4122](https://tools.ietf.org/html/rfc4122),
1790
- that is restricted by a regular expression
1791
- for interoperability reasons. A UUID is
1792
- always 36 characters long, 32 hexadecimal
1793
- symbols and 4 dashes (‘-‘).
1794
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
1795
- quoteResponse:
1796
- title: QuotesIDPutResponse
1797
- type: object
1798
- description: >-
1799
- The object sent in the PUT /quotes/{ID}
1800
- callback.
1801
- properties: *ref_29
1802
- required: *ref_30
1803
- fulfil:
1804
- title: TransfersIDPutResponse
1805
- type: object
1806
- description: >-
1807
- The object sent in the PUT /transfers/{ID}
1808
- callback.
1809
- properties: *ref_20
1810
- required: *ref_21
1811
- quoteExtensions:
1812
- title: ExtensionList
1813
- type: object
1814
- description: >-
1815
- Data model for the complex type
1816
- ExtensionList. An optional list of
1817
- extensions, specific to deployment.
1818
- properties: *ref_10
1819
- required: *ref_11
1820
- transferExtensions:
1821
- title: ExtensionList
1822
- type: object
1823
- description: >-
1824
- Data model for the complex type
1825
- ExtensionList. An optional list of
1826
- extensions, specific to deployment.
1827
- properties: *ref_10
1828
- required: *ref_11
1829
- lastError:
1830
- type: object
1831
- description: >-
1832
- This object represents a Mojaloop API error
1833
- received at any time during the transfer
1834
- process
1835
- properties: *ref_26
1836
- extensions:
1837
- title: ExtensionList
1838
- type: object
1839
- description: >-
1840
- Data model for the complex type ExtensionList. An
1841
- optional list of extensions, specific to
1842
- deployment.
1843
- properties: *ref_10
1844
- required: *ref_11
1845
- '500':
1846
- description: Internal Server Error
1847
- content: &ref_129
1848
- application/json:
1849
- schema:
1850
- type: object
1851
- properties: *ref_22
1852
- /bulkTransfers/{bulkTransactionId}:
1853
- put:
1854
- summary: Amends the bulk transfer request
1855
- description: >-
1856
- The HTTP request `PUT /bulkTransfers/{bulkTransactionId}` is used to
1857
- amend information regarding a bulk transfer, i.e. when autoAcceptParty
1858
- or autoAcceptQuote is false then the payer need to provide confirmation
1859
- to proceed with further processing of the request. The
1860
- `{bulkTransactionId}` in the URI should contain the `bulkTransactionId`
1861
- that was used for the creation of the bulk transfer.
1862
- tags:
1863
- - BulkTransfers
1864
- parameters:
1865
- - name: bulkTransactionId
1866
- in: path
1867
- required: true
1868
- schema: &ref_144
1869
- title: CorrelationId
1870
- type: string
1871
- pattern: >-
1872
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1873
- description: >-
1874
- Identifier that correlates all messages of the same sequence. The
1875
- API data type UUID (Universally Unique Identifier) is a JSON
1876
- String in canonical format, conforming to [RFC
1877
- 4122](https://tools.ietf.org/html/rfc4122), that is restricted by
1878
- a regular expression for interoperability reasons. A UUID is
1879
- always 36 characters long, 32 hexadecimal symbols and 4 dashes
1880
- (‘-‘).
1881
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
1882
- description: >-
1883
- Identifier of the bulk transfer to continue as returned in the
1884
- response to a `POST /bulkTransfers` request.
1885
- requestBody:
1886
- description: Bulk transfer request body
1887
- content:
1888
- application/json:
1889
- schema:
1890
- oneOf:
1891
- - description: >-
1892
- The object sent back as confirmation of payee parties when
1893
- autoAcceptParty is false.
1894
- type: object
1895
- required: &ref_37
1896
- - bulkHomeTransactionID
1897
- - individualTransfers
1898
- properties: &ref_38
1899
- bulkHomeTransactionID:
1900
- type: string
1901
- description: >-
1902
- Transaction ID from the DFSP backend, used to reconcile
1903
- transactions between the Switch and DFSP backend
1904
- systems.
1905
- individualTransfers:
1906
- description: >-
1907
- List of individual transfers in a bulk transfer with
1908
- accept party information.
1909
- type: array
1910
- minItems: 1
1911
- maxItems: 1000
1912
- items:
1913
- allOf:
1914
- - type: object
1915
- description: >-
1916
- Data model for the 'individualTransfer' while
1917
- accepting party or quote.
1918
- properties: &ref_33
1919
- homeTransactionId:
1920
- title: CorrelationId
1921
- type: string
1922
- pattern: >-
1923
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1924
- description: >-
1925
- Identifier that correlates all messages of the
1926
- same sequence. The API data type UUID
1927
- (Universally Unique Identifier) is a JSON
1928
- String in canonical format, conforming to [RFC
1929
- 4122](https://tools.ietf.org/html/rfc4122),
1930
- that is restricted by a regular expression for
1931
- interoperability reasons. A UUID is always 36
1932
- characters long, 32 hexadecimal symbols and 4
1933
- dashes (‘-‘).
1934
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
1935
- transactionId:
1936
- title: CorrelationId
1937
- type: string
1938
- pattern: >-
1939
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1940
- description: >-
1941
- Identifier that correlates all messages of the
1942
- same sequence. The API data type UUID
1943
- (Universally Unique Identifier) is a JSON
1944
- String in canonical format, conforming to [RFC
1945
- 4122](https://tools.ietf.org/html/rfc4122),
1946
- that is restricted by a regular expression for
1947
- interoperability reasons. A UUID is always 36
1948
- characters long, 32 hexadecimal symbols and 4
1949
- dashes (‘-‘).
1950
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
1951
- required: &ref_34
1952
- - homeTransactionId
1953
- - transactionId
1954
- - type: object
1955
- required: *ref_31
1956
- properties: *ref_32
1957
- - description: >-
1958
- The object sent back as confirmation of quotes when
1959
- autoAcceptQuotes is false.
1960
- type: object
1961
- required: &ref_40
1962
- - bulkHomeTransactionID
1963
- - individualTransfers
1964
- properties: &ref_41
1965
- bulkHomeTransactionID:
1966
- type: string
1967
- description: >-
1968
- Transaction ID from the DFSP backend, used to reconcile
1969
- transactions between the Switch and DFSP backend
1970
- systems.
1971
- individualTransfers:
1972
- description: List of individual transfers in a bulk transfer.
1973
- type: array
1974
- minItems: 1
1975
- maxItems: 1000
1976
- items:
1977
- allOf:
1978
- - type: object
1979
- description: >-
1980
- Data model for the 'individualTransfer' while
1981
- accepting party or quote.
1982
- properties: *ref_33
1983
- required: *ref_34
1984
- - type: object
1985
- required: *ref_35
1986
- properties: *ref_36
1987
- required: true
1988
- responses:
1989
- '202':
1990
- description: Bulk transfer information successfully amended
1991
- '400':
1992
- description: Malformed or missing required body, headers or parameters
1993
- content: &ref_130
1994
- application/json:
1995
- schema:
1996
- oneOf:
1997
- - allOf: &ref_91
1998
- - type: object
1999
- properties: *ref_22
2000
- - type: object
2001
- required:
2002
- - bulkTansferState
2003
- properties:
2004
- bulkTransferState:
2005
- allOf:
2006
- - description: >-
2007
- The object sent back as confirmation of payee
2008
- parties when autoAcceptParty is false.
2009
- type: object
2010
- required: *ref_37
2011
- properties: *ref_38
2012
- - type: object
2013
- description: >-
2014
- This object represents a Mojaloop API error
2015
- received at any time during the party
2016
- discovery process
2017
- properties: &ref_90
2018
- httpStatusCode:
2019
- type: integer
2020
- description: >-
2021
- The HTTP status code returned to the
2022
- caller. This is the same as the actual
2023
- HTTP status code returned with the
2024
- response.
2025
- mojaloopError:
2026
- description: >-
2027
- If a transfer process results in an error
2028
- callback during the asynchronous Mojaloop
2029
- API exchange, this property will contain
2030
- the underlying Mojaloop API error object.
2031
- type: object
2032
- properties: *ref_39
2033
- - allOf: &ref_92
2034
- - type: object
2035
- properties: *ref_22
2036
- - type: object
2037
- required:
2038
- - bulkTansferState
2039
- properties:
2040
- bulkTransferState:
2041
- allOf:
2042
- - description: >-
2043
- The object sent back as confirmation of quotes
2044
- when autoAcceptQuotes is false.
2045
- type: object
2046
- required: *ref_40
2047
- properties: *ref_41
2048
- - type: object
2049
- description: >-
2050
- This object represents a Mojaloop API error
2051
- received at any time during the quote process
2052
- properties: &ref_42
2053
- httpStatusCode:
2054
- type: integer
2055
- description: >-
2056
- The HTTP status code returned to the
2057
- caller. This is the same as the actual
2058
- HTTP status code returned with the
2059
- response.
2060
- mojaloopError:
2061
- description: >-
2062
- If a quote process results in an error
2063
- callback during the asynchronous Mojaloop
2064
- API exchange, this property will contain
2065
- the underlying Mojaloop API error object.
2066
- type: object
2067
- properties: *ref_39
2068
- '500':
2069
- description: An error occurred processing the bulk transfer
2070
- content:
2071
- application/json:
2072
- schema:
2073
- type: object
2074
- properties: *ref_22
2075
- /bulkQuotes:
2076
- post:
2077
- summary: Request bulk quotes for the provided financial transactions
2078
- description: >
2079
- The HTTP request `POST /bulkQuotes` is used to request a bulk quote to
2080
- fascilitate funds transfer from payer DFSP to payees' DFSP.
2081
- tags:
2082
- - BulkQuotes
2083
- requestBody:
2084
- description: Bulk quote request body
2085
- content:
2086
- application/json:
2087
- schema:
2088
- type: object
2089
- required: &ref_93
2090
- - homeTransactionId
2091
- - from
2092
- - individualQuotes
2093
- properties: &ref_94
2094
- homeTransactionId:
2095
- type: string
2096
- description: >-
2097
- Transaction ID from the DFSP backend, used to reconcile
2098
- transactions between the Switch and DFSP backend systems.
2099
- bulkQuoteId:
2100
- title: CorrelationId
2101
- type: string
2102
- pattern: >-
2103
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
2104
- description: >-
2105
- Identifier that correlates all messages of the same
2106
- sequence. The API data type UUID (Universally Unique
2107
- Identifier) is a JSON String in canonical format, conforming
2108
- to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is
2109
- restricted by a regular expression for interoperability
2110
- reasons. A UUID is always 36 characters long, 32 hexadecimal
2111
- symbols and 4 dashes (‘-‘).
2112
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
2113
- from:
2114
- type: object
2115
- required: *ref_0
2116
- properties: *ref_1
2117
- individualQuotes:
2118
- description: List of individual quotes in a bulk quote.
2119
- type: array
2120
- minItems: 1
2121
- maxItems: 1000
2122
- items:
2123
- title: IndividualQuote
2124
- type: object
2125
- description: Data model for the complex type 'individualQuote'.
2126
- properties: &ref_46
2127
- quoteId:
2128
- title: CorrelationId
2129
- type: string
2130
- pattern: >-
2131
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
2132
- description: >-
2133
- Identifier that correlates all messages of the same
2134
- sequence. The API data type UUID (Universally Unique
2135
- Identifier) is a JSON String in canonical format,
2136
- conforming to [RFC
2137
- 4122](https://tools.ietf.org/html/rfc4122), that is
2138
- restricted by a regular expression for
2139
- interoperability reasons. A UUID is always 36
2140
- characters long, 32 hexadecimal symbols and 4 dashes
2141
- (‘-‘).
2142
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
2143
- to:
2144
- type: object
2145
- required: *ref_0
2146
- properties: *ref_1
2147
- amountType:
2148
- title: AmountType
2149
- type: string
2150
- enum: *ref_3
2151
- description: >-
2152
- Below are the allowed values for the enumeration
2153
- AmountType.
2154
-
2155
- - SEND - Amount the Payer would like to send, that is,
2156
- the amount that should be withdrawn from the Payer
2157
- account including any fees.
2158
-
2159
- - RECEIVE - Amount the Payer would like the Payee to
2160
- receive, that is, the amount that should be sent to
2161
- the receiver exclusive of any fees.
2162
- example: RECEIVE
2163
- currency:
2164
- title: Currency
2165
- description: >-
2166
- The currency codes defined in [ISO
2167
- 4217](https://www.iso.org/iso-4217-currency-codes.html)
2168
- as three-letter alphabetic codes are used as the
2169
- standard naming representation for currencies.
2170
- type: string
2171
- minLength: 3
2172
- maxLength: 3
2173
- enum: *ref_4
2174
- amount:
2175
- title: Amount
2176
- type: string
2177
- pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
2178
- description: >-
2179
- The API data type Amount is a JSON String in a
2180
- canonical format that is restricted by a regular
2181
- expression for interoperability reasons. This pattern
2182
- does not allow any trailing zeroes at all, but allows
2183
- an amount without a minor currency unit. It also only
2184
- allows four digits in the minor currency unit; a
2185
- negative value is not allowed. Using more than 18
2186
- digits in the major currency unit is not allowed.
2187
- example: '123.45'
2188
- transactionType:
2189
- type: string
2190
- enum: *ref_5
2191
- description: Type of transaction.
2192
- note:
2193
- title: Note
2194
- type: string
2195
- minLength: 1
2196
- maxLength: 128
2197
- description: Memo assigned to transaction.
2198
- example: Note sent to Payee.
2199
- extensions:
2200
- title: ExtensionList
2201
- type: object
2202
- description: >-
2203
- Data model for the complex type ExtensionList. An
2204
- optional list of extensions, specific to deployment.
2205
- properties: *ref_10
2206
- required: *ref_11
2207
- required: &ref_47
2208
- - quoteId
2209
- - to
2210
- - amountType
2211
- - currency
2212
- - transactionType
2213
- extensions:
2214
- title: ExtensionList
2215
- type: object
2216
- description: >-
2217
- Data model for the complex type ExtensionList. An optional
2218
- list of extensions, specific to deployment.
2219
- properties: *ref_10
2220
- required: *ref_11
2221
- required: true
2222
- responses:
2223
- '200':
2224
- description: Bulk quote completed successfully
2225
- content: &ref_131
2226
- application/json:
2227
- schema:
2228
- type: object
2229
- required: &ref_43
2230
- - from
2231
- - individualQuoteResults
2232
- properties: &ref_44
2233
- quoteId:
2234
- title: CorrelationId
2235
- type: string
2236
- pattern: >-
2237
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
2238
- description: >-
2239
- Identifier that correlates all messages of the same
2240
- sequence. The API data type UUID (Universally Unique
2241
- Identifier) is a JSON String in canonical format,
2242
- conforming to [RFC
2243
- 4122](https://tools.ietf.org/html/rfc4122), that is
2244
- restricted by a regular expression for interoperability
2245
- reasons. A UUID is always 36 characters long, 32
2246
- hexadecimal symbols and 4 dashes (‘-‘).
2247
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
2248
- homeTransactionId:
2249
- type: string
2250
- description: >-
2251
- Transaction ID from the DFSP backend, used to reconcile
2252
- transactions between the Switch and DFSP backend systems.
2253
- from:
2254
- type: object
2255
- required: *ref_0
2256
- properties: *ref_1
2257
- individualQuoteResults:
2258
- type: array
2259
- maxItems: 1000
2260
- items:
2261
- type: object
2262
- properties: &ref_95
2263
- quoteId:
2264
- title: CorrelationId
2265
- type: string
2266
- pattern: >-
2267
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
2268
- description: >-
2269
- Identifier that correlates all messages of the same
2270
- sequence. The API data type UUID (Universally Unique
2271
- Identifier) is a JSON String in canonical format,
2272
- conforming to [RFC
2273
- 4122](https://tools.ietf.org/html/rfc4122), that is
2274
- restricted by a regular expression for
2275
- interoperability reasons. A UUID is always 36
2276
- characters long, 32 hexadecimal symbols and 4 dashes
2277
- (‘-‘).
2278
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
2279
- to:
2280
- type: object
2281
- required: *ref_0
2282
- properties: *ref_1
2283
- amountType:
2284
- title: AmountType
2285
- type: string
2286
- enum: *ref_3
2287
- description: >-
2288
- Below are the allowed values for the enumeration
2289
- AmountType.
2290
-
2291
- - SEND - Amount the Payer would like to send, that
2292
- is, the amount that should be withdrawn from the
2293
- Payer account including any fees.
2294
-
2295
- - RECEIVE - Amount the Payer would like the Payee to
2296
- receive, that is, the amount that should be sent to
2297
- the receiver exclusive of any fees.
2298
- example: RECEIVE
2299
- currency:
2300
- title: Currency
2301
- description: >-
2302
- The currency codes defined in [ISO
2303
- 4217](https://www.iso.org/iso-4217-currency-codes.html)
2304
- as three-letter alphabetic codes are used as the
2305
- standard naming representation for currencies.
2306
- type: string
2307
- minLength: 3
2308
- maxLength: 3
2309
- enum: *ref_4
2310
- amount:
2311
- title: Amount
2312
- type: string
2313
- pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
2314
- description: >-
2315
- The API data type Amount is a JSON String in a
2316
- canonical format that is restricted by a regular
2317
- expression for interoperability reasons. This
2318
- pattern does not allow any trailing zeroes at all,
2319
- but allows an amount without a minor currency unit.
2320
- It also only allows four digits in the minor
2321
- currency unit; a negative value is not allowed.
2322
- Using more than 18 digits in the major currency unit
2323
- is not allowed.
2324
- example: '123.45'
2325
- transactionType:
2326
- type: string
2327
- enum: *ref_5
2328
- description: Type of transaction.
2329
- note:
2330
- title: Note
2331
- type: string
2332
- minLength: 1
2333
- maxLength: 128
2334
- description: Memo assigned to transaction.
2335
- example: Note sent to Payee.
2336
- lastError:
2337
- description: >-
2338
- This object represents a Mojaloop API error received
2339
- at any time during the quote process
2340
- type: object
2341
- properties: *ref_42
2342
- description: >-
2343
- List of individualQuoteResults in a bulk transfer
2344
- response.
2345
- '400':
2346
- description: Malformed or missing required body, headers or parameters
2347
- content: &ref_132
2348
- application/json:
2349
- schema:
2350
- allOf: &ref_45
2351
- - type: object
2352
- properties: *ref_22
2353
- - type: object
2354
- required:
2355
- - bulkTansferState
2356
- properties:
2357
- bulkQuoteState:
2358
- type: object
2359
- required: *ref_43
2360
- properties: *ref_44
2361
- '500':
2362
- description: An error occurred processing the bulk quote
2363
- content: &ref_133
2364
- application/json:
2365
- schema:
2366
- allOf: *ref_45
2367
- '504':
2368
- description: Timeout occurred processing the bulk quote
2369
- content: &ref_134
2370
- application/json:
2371
- schema:
2372
- allOf: *ref_45
2373
- /bulkQuotes/{bulkQuoteId}:
2374
- get:
2375
- summary: Retrieves information for a specific bulk quote
2376
- description: >-
2377
- The HTTP request `GET /bulkQuotes/{bulktQuoteId}` is used to get
2378
- information regarding a bulk quote created or requested earlier. The
2379
- `{bulkQuoteId}` in the URI should contain the `bulkQuoteId` that was
2380
- used for the creation of the bulk quote.
2381
- tags:
2382
- - BulkQuotes
2383
- parameters:
2384
- - name: bulkQuoteId
2385
- in: path
2386
- required: true
2387
- schema: &ref_145
2388
- title: CorrelationId
2389
- type: string
2390
- pattern: >-
2391
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
2392
- description: >-
2393
- Identifier that correlates all messages of the same sequence. The
2394
- API data type UUID (Universally Unique Identifier) is a JSON
2395
- String in canonical format, conforming to [RFC
2396
- 4122](https://tools.ietf.org/html/rfc4122), that is restricted by
2397
- a regular expression for interoperability reasons. A UUID is
2398
- always 36 characters long, 32 hexadecimal symbols and 4 dashes
2399
- (‘-‘).
2400
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
2401
- description: >-
2402
- Identifier of the bulk transfer to continue as returned in the
2403
- response to a `POST /bulkTransfers` request.
2404
- responses:
2405
- '200':
2406
- description: Bulk quote information successfully retrieved
2407
- content:
2408
- application/json:
2409
- schema:
2410
- type: object
2411
- required: &ref_97
2412
- - bulkQuoteId
2413
- - currentState
2414
- - individualQuotes
2415
- properties: &ref_98
2416
- bulkQuoteId:
2417
- title: CorrelationId
2418
- type: string
2419
- pattern: >-
2420
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
2421
- description: >-
2422
- Identifier that correlates all messages of the same
2423
- sequence. The API data type UUID (Universally Unique
2424
- Identifier) is a JSON String in canonical format,
2425
- conforming to [RFC
2426
- 4122](https://tools.ietf.org/html/rfc4122), that is
2427
- restricted by a regular expression for interoperability
2428
- reasons. A UUID is always 36 characters long, 32
2429
- hexadecimal symbols and 4 dashes (‘-‘).
2430
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
2431
- currentState:
2432
- type: string
2433
- enum: &ref_96
2434
- - ERROR_OCCURRED
2435
- - COMPLETED
2436
- individualQuotes:
2437
- type: array
2438
- minItems: 1
2439
- maxItems: 1000
2440
- items:
2441
- title: IndividualQuote
2442
- type: object
2443
- description: Data model for the complex type 'individualQuote'.
2444
- properties: *ref_46
2445
- required: *ref_47
2446
- '500':
2447
- description: An error occurred processing the bulk quote
2448
- content:
2449
- application/json:
2450
- schema:
2451
- type: object
2452
- properties: *ref_22
2453
- /requestToPay:
2454
- post:
2455
- summary: Receiver requesting funds from Sender
2456
- description: >
2457
- The HTTP request `POST /requestToPay` is used to support Pull Funds
2458
- pattern where in a receiver can request for funds from the Sender.
2459
-
2460
- The underlying API has two stages:
2461
-
2462
- 1. Party lookup. This facilitates a check by the sending party that the destination party is correct before proceeding with a money movement.
2463
- 2. Transaction Request. This request enables a Payee to request Payer to send electronic funds to the Payee.
2464
- tags:
2465
- - RequestToPay
2466
- requestBody:
2467
- description: RequestToPay request body
2468
- content:
2469
- application/json:
2470
- schema:
2471
- type: object
2472
- required: &ref_99
2473
- - homeTransactionId
2474
- - from
2475
- - to
2476
- - amountType
2477
- - currency
2478
- - amount
2479
- - scenario
2480
- - initiator
2481
- - initiatorType
2482
- properties: &ref_100
2483
- homeTransactionId:
2484
- type: string
2485
- description: >-
2486
- Transaction ID from the DFSP backend, used to reconcile
2487
- transactions between the Switch and DFSP backend systems.
2488
- from:
2489
- type: object
2490
- required: *ref_0
2491
- properties: *ref_1
2492
- to:
2493
- type: object
2494
- required: *ref_0
2495
- properties: *ref_1
2496
- amountType:
2497
- title: AmountType
2498
- type: string
2499
- enum: *ref_3
2500
- description: >-
2501
- Below are the allowed values for the enumeration AmountType.
2502
-
2503
- - SEND - Amount the Payer would like to send, that is, the
2504
- amount that should be withdrawn from the Payer account
2505
- including any fees.
2506
-
2507
- - RECEIVE - Amount the Payer would like the Payee to
2508
- receive, that is, the amount that should be sent to the
2509
- receiver exclusive of any fees.
2510
- example: RECEIVE
2511
- currency:
2512
- title: Currency
2513
- description: >-
2514
- The currency codes defined in [ISO
2515
- 4217](https://www.iso.org/iso-4217-currency-codes.html) as
2516
- three-letter alphabetic codes are used as the standard
2517
- naming representation for currencies.
2518
- type: string
2519
- minLength: 3
2520
- maxLength: 3
2521
- enum: *ref_4
2522
- amount:
2523
- title: Amount
2524
- type: string
2525
- pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
2526
- description: >-
2527
- The API data type Amount is a JSON String in a canonical
2528
- format that is restricted by a regular expression for
2529
- interoperability reasons. This pattern does not allow any
2530
- trailing zeroes at all, but allows an amount without a minor
2531
- currency unit. It also only allows four digits in the minor
2532
- currency unit; a negative value is not allowed. Using more
2533
- than 18 digits in the major currency unit is not allowed.
2534
- example: '123.45'
2535
- scenario:
2536
- type: string
2537
- enum: &ref_49
2538
- - TRANSFER
2539
- description: Type of transaction.
2540
- initiator:
2541
- title: TransactionInitiator
2542
- type: string
2543
- enum: &ref_50
2544
- - PAYER
2545
- - PAYEE
2546
- description: >-
2547
- Below are the allowed values for the enumeration.
2548
-
2549
- - PAYER - Sender of funds is initiating the transaction. The
2550
- account to send from is either owned by the Payer or is
2551
- connected to the Payer in some way.
2552
-
2553
- - PAYEE - Recipient of the funds is initiating the
2554
- transaction by sending a transaction request. The Payer must
2555
- approve the transaction, either automatically by a
2556
- pre-generated OTP or by pre-approval of the Payee, or by
2557
- manually approving in his or her own Device.
2558
- example: PAYEE
2559
- initiatorType:
2560
- title: TransactionInitiatorType
2561
- type: string
2562
- enum: *ref_48
2563
- description: |-
2564
- Below are the allowed values for the enumeration.
2565
- - CONSUMER - Consumer is the initiator of the transaction.
2566
- - AGENT - Agent is the initiator of the transaction.
2567
- - BUSINESS - Business is the initiator of the transaction.
2568
- - DEVICE - Device is the initiator of the transaction.
2569
- example: CONSUMER
2570
- required: true
2571
- responses:
2572
- '200':
2573
- description: Request to Pay completed successfully
2574
- content: &ref_135
2575
- application/json:
2576
- schema:
2577
- type: object
2578
- required: &ref_103
2579
- - transactionRequestId
2580
- - from
2581
- - to
2582
- - amountType
2583
- - currency
2584
- - amount
2585
- - transactionType
2586
- - requestToPayState
2587
- properties: &ref_104
2588
- transactionRequestId:
2589
- title: CorrelationId
2590
- type: string
2591
- pattern: >-
2592
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
2593
- description: >-
2594
- Identifier that correlates all messages of the same
2595
- sequence. The API data type UUID (Universally Unique
2596
- Identifier) is a JSON String in canonical format,
2597
- conforming to [RFC
2598
- 4122](https://tools.ietf.org/html/rfc4122), that is
2599
- restricted by a regular expression for interoperability
2600
- reasons. A UUID is always 36 characters long, 32
2601
- hexadecimal symbols and 4 dashes (‘-‘).
2602
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
2603
- from:
2604
- type: object
2605
- required: *ref_0
2606
- properties: *ref_1
2607
- to:
2608
- type: object
2609
- required: *ref_0
2610
- properties: *ref_1
2611
- amountType:
2612
- title: AmountType
2613
- type: string
2614
- enum: *ref_3
2615
- description: >-
2616
- Below are the allowed values for the enumeration
2617
- AmountType.
2618
-
2619
- - SEND - Amount the Payer would like to send, that is, the
2620
- amount that should be withdrawn from the Payer account
2621
- including any fees.
2622
-
2623
- - RECEIVE - Amount the Payer would like the Payee to
2624
- receive, that is, the amount that should be sent to the
2625
- receiver exclusive of any fees.
2626
- example: RECEIVE
2627
- currency:
2628
- title: Currency
2629
- description: >-
2630
- The currency codes defined in [ISO
2631
- 4217](https://www.iso.org/iso-4217-currency-codes.html) as
2632
- three-letter alphabetic codes are used as the standard
2633
- naming representation for currencies.
2634
- type: string
2635
- minLength: 3
2636
- maxLength: 3
2637
- enum: *ref_4
2638
- amount:
2639
- title: Amount
2640
- type: string
2641
- pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
2642
- description: >-
2643
- The API data type Amount is a JSON String in a canonical
2644
- format that is restricted by a regular expression for
2645
- interoperability reasons. This pattern does not allow any
2646
- trailing zeroes at all, but allows an amount without a
2647
- minor currency unit. It also only allows four digits in
2648
- the minor currency unit; a negative value is not allowed.
2649
- Using more than 18 digits in the major currency unit is
2650
- not allowed.
2651
- example: '123.45'
2652
- scenario:
2653
- type: string
2654
- enum: *ref_49
2655
- description: Type of transaction.
2656
- initiator:
2657
- title: TransactionInitiator
2658
- type: string
2659
- enum: *ref_50
2660
- description: >-
2661
- Below are the allowed values for the enumeration.
2662
-
2663
- - PAYER - Sender of funds is initiating the transaction.
2664
- The account to send from is either owned by the Payer or
2665
- is connected to the Payer in some way.
2666
-
2667
- - PAYEE - Recipient of the funds is initiating the
2668
- transaction by sending a transaction request. The Payer
2669
- must approve the transaction, either automatically by a
2670
- pre-generated OTP or by pre-approval of the Payee, or by
2671
- manually approving in his or her own Device.
2672
- example: PAYEE
2673
- initiatorType:
2674
- title: TransactionInitiatorType
2675
- type: string
2676
- enum: *ref_48
2677
- description: |-
2678
- Below are the allowed values for the enumeration.
2679
- - CONSUMER - Consumer is the initiator of the transaction.
2680
- - AGENT - Agent is the initiator of the transaction.
2681
- - BUSINESS - Business is the initiator of the transaction.
2682
- - DEVICE - Device is the initiator of the transaction.
2683
- example: CONSUMER
2684
- authenticationType:
2685
- title: AuthenticationType
2686
- type: string
2687
- enum: &ref_101
2688
- - OTP
2689
- - QRCODE
2690
- - U2F
2691
- description: >-
2692
- Below are the allowed values for the enumeration
2693
- AuthenticationType.
2694
-
2695
- - OTP - One-time password generated by the Payer FSP.
2696
-
2697
- - QRCODE - QR code used as One Time Password.
2698
-
2699
- - U2F - U2F is a new addition isolated to Thirdparty
2700
- stream.
2701
- example: OTP
2702
- requestToPayState:
2703
- title: TransactionRequestState
2704
- type: string
2705
- enum: &ref_102
2706
- - RECEIVED
2707
- - PENDING
2708
- - ACCEPTED
2709
- - REJECTED
2710
- description: >-
2711
- Below are the allowed values for the enumeration.
2712
-
2713
- - RECEIVED - Payer FSP has received the transaction from
2714
- the Payee FSP.
2715
-
2716
- - PENDING - Payer FSP has sent the transaction request to
2717
- the Payer.
2718
-
2719
- - ACCEPTED - Payer has approved the transaction.
2720
-
2721
- - REJECTED - Payer has rejected the transaction.
2722
- example: RECEIVED
2723
- /requestToPayTransfer:
2724
- post:
2725
- summary: >-
2726
- Used to trigger funds from customer fsp account to merchant fsp account.
2727
- This is a follow-up request to requestToPay.
2728
- description: >
2729
- The HTTP request `POST /requestToPayTransfer` is used to request the
2730
- movement of funds from payer DFSP to payee DFSP.
2731
-
2732
- The underlying Mojaloop API has three stages for money transfer:
2733
-
2734
- 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.
2735
- 2. Authorization. This facilitates getting OTP from payee DFSP.
2736
- 3. Transfer. The enactment of the previously agreed "contract"
2737
-
2738
- This method has several modes of operation.
2739
-
2740
- - If the configuration variable `AUTO_ACCEPT_QUOTES` is set to `"false"`
2741
- this method will terminate and return the quotation when it has been
2742
- received from the payee DFSP.
2743
- 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.
2744
- The scheme adapter will then proceed with the transfer state.
2745
-
2746
- - If the configuration variable `AUTO_ACCEPT_OTP` is set to `"false"`
2747
- this method will terminate and return the otp when it has been received
2748
- from the payee DFSP.
2749
- 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.
2750
- The scheme adapter will then proceed with the transfer state.
2751
-
2752
- If the configuration variables `AUTO_ACCEPT_PARTIES` and
2753
- `AUTO_ACCEPT_QUOTES` are both set to `"true"` this method will block
2754
- until all three transfer stages are complete. Upon completion it will
2755
- return the entire set of transfer details received during the operation.
2756
-
2757
-
2758
- Combinations of settings for `AUTO_ACCEPT...` configuration variables
2759
- allow the scheme adapter user to decide which mode of operation best
2760
- suits their use cases. i.e. the scheme adapter can be configured to
2761
- "break" the three stage transfer at these points in order to execute
2762
- backend logic such as party verification, quoted fees assessments etc...
2763
- tags:
2764
- - RequestToPayTransfer
2765
- requestBody:
2766
- description: Request To Pay Transfer request body
2767
- content:
2768
- application/json:
2769
- schema:
2770
- type: object
2771
- required: &ref_105
2772
- - requestToPayTransactionId
2773
- - from
2774
- - to
2775
- - amountType
2776
- - currency
2777
- - amount
2778
- - scenario
2779
- - initiator
2780
- - initiatorType
2781
- properties: &ref_106
2782
- requestToPayTransactionId:
2783
- type: string
2784
- description: >-
2785
- Transaction ID from the DFSP backend, used to reconcile
2786
- transactions between the Switch and DFSP backend systems.
2787
- from:
2788
- type: object
2789
- required: *ref_0
2790
- properties: *ref_1
2791
- to:
2792
- type: object
2793
- required: *ref_0
2794
- properties: *ref_1
2795
- amountType:
2796
- title: AmountType
2797
- type: string
2798
- enum: *ref_3
2799
- description: >-
2800
- Below are the allowed values for the enumeration AmountType.
2801
-
2802
- - SEND - Amount the Payer would like to send, that is, the
2803
- amount that should be withdrawn from the Payer account
2804
- including any fees.
2805
-
2806
- - RECEIVE - Amount the Payer would like the Payee to
2807
- receive, that is, the amount that should be sent to the
2808
- receiver exclusive of any fees.
2809
- example: RECEIVE
2810
- currency:
2811
- title: Currency
2812
- description: >-
2813
- The currency codes defined in [ISO
2814
- 4217](https://www.iso.org/iso-4217-currency-codes.html) as
2815
- three-letter alphabetic codes are used as the standard
2816
- naming representation for currencies.
2817
- type: string
2818
- minLength: 3
2819
- maxLength: 3
2820
- enum: *ref_4
2821
- amount:
2822
- title: Amount
2823
- type: string
2824
- pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
2825
- description: >-
2826
- The API data type Amount is a JSON String in a canonical
2827
- format that is restricted by a regular expression for
2828
- interoperability reasons. This pattern does not allow any
2829
- trailing zeroes at all, but allows an amount without a minor
2830
- currency unit. It also only allows four digits in the minor
2831
- currency unit; a negative value is not allowed. Using more
2832
- than 18 digits in the major currency unit is not allowed.
2833
- example: '123.45'
2834
- scenario:
2835
- type: string
2836
- enum: *ref_49
2837
- description: Type of transaction.
2838
- initiator:
2839
- title: TransactionInitiator
2840
- type: string
2841
- enum: *ref_50
2842
- description: >-
2843
- Below are the allowed values for the enumeration.
2844
-
2845
- - PAYER - Sender of funds is initiating the transaction. The
2846
- account to send from is either owned by the Payer or is
2847
- connected to the Payer in some way.
2848
-
2849
- - PAYEE - Recipient of the funds is initiating the
2850
- transaction by sending a transaction request. The Payer must
2851
- approve the transaction, either automatically by a
2852
- pre-generated OTP or by pre-approval of the Payee, or by
2853
- manually approving in his or her own Device.
2854
- example: PAYEE
2855
- initiatorType:
2856
- title: TransactionInitiatorType
2857
- type: string
2858
- enum: *ref_48
2859
- description: |-
2860
- Below are the allowed values for the enumeration.
2861
- - CONSUMER - Consumer is the initiator of the transaction.
2862
- - AGENT - Agent is the initiator of the transaction.
2863
- - BUSINESS - Business is the initiator of the transaction.
2864
- - DEVICE - Device is the initiator of the transaction.
2865
- example: CONSUMER
2866
- note:
2867
- title: Note
2868
- type: string
2869
- minLength: 1
2870
- maxLength: 128
2871
- description: Memo assigned to transaction.
2872
- example: Note sent to Payee.
2873
- required: true
2874
- responses:
2875
- '200':
2876
- description: Transfer completed successfully
2877
- content: &ref_136
2878
- application/json:
2879
- schema:
2880
- type: object
2881
- required: &ref_107
2882
- - requestToPayTransactionId
2883
- - from
2884
- - to
2885
- - amountType
2886
- - currency
2887
- - amount
2888
- - transactionType
2889
- properties: &ref_108
2890
- transferId:
2891
- title: CorrelationId
2892
- type: string
2893
- pattern: >-
2894
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
2895
- description: >-
2896
- Identifier that correlates all messages of the same
2897
- sequence. The API data type UUID (Universally Unique
2898
- Identifier) is a JSON String in canonical format,
2899
- conforming to [RFC
2900
- 4122](https://tools.ietf.org/html/rfc4122), that is
2901
- restricted by a regular expression for interoperability
2902
- reasons. A UUID is always 36 characters long, 32
2903
- hexadecimal symbols and 4 dashes (‘-‘).
2904
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
2905
- requestToPayTransactionId:
2906
- type: string
2907
- description: >-
2908
- Transaction ID from the DFSP backend, used to reconcile
2909
- transactions between the Switch and DFSP backend systems.
2910
- from:
2911
- type: object
2912
- required: *ref_0
2913
- properties: *ref_1
2914
- to:
2915
- type: object
2916
- required: *ref_0
2917
- properties: *ref_1
2918
- amountType:
2919
- title: AmountType
2920
- type: string
2921
- enum: *ref_3
2922
- description: >-
2923
- Below are the allowed values for the enumeration
2924
- AmountType.
2925
-
2926
- - SEND - Amount the Payer would like to send, that is, the
2927
- amount that should be withdrawn from the Payer account
2928
- including any fees.
2929
-
2930
- - RECEIVE - Amount the Payer would like the Payee to
2931
- receive, that is, the amount that should be sent to the
2932
- receiver exclusive of any fees.
2933
- example: RECEIVE
2934
- currency:
2935
- title: Currency
2936
- description: >-
2937
- The currency codes defined in [ISO
2938
- 4217](https://www.iso.org/iso-4217-currency-codes.html) as
2939
- three-letter alphabetic codes are used as the standard
2940
- naming representation for currencies.
2941
- type: string
2942
- minLength: 3
2943
- maxLength: 3
2944
- enum: *ref_4
2945
- amount:
2946
- title: Amount
2947
- type: string
2948
- pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
2949
- description: >-
2950
- The API data type Amount is a JSON String in a canonical
2951
- format that is restricted by a regular expression for
2952
- interoperability reasons. This pattern does not allow any
2953
- trailing zeroes at all, but allows an amount without a
2954
- minor currency unit. It also only allows four digits in
2955
- the minor currency unit; a negative value is not allowed.
2956
- Using more than 18 digits in the major currency unit is
2957
- not allowed.
2958
- example: '123.45'
2959
- transactionType:
2960
- type: string
2961
- enum: *ref_5
2962
- description: Type of transaction.
2963
- note:
2964
- title: Note
2965
- type: string
2966
- minLength: 1
2967
- maxLength: 128
2968
- description: Memo assigned to transaction.
2969
- example: Note sent to Payee.
2970
- currentState:
2971
- type: string
2972
- enum: *ref_19
2973
- quoteId:
2974
- title: CorrelationId
2975
- type: string
2976
- pattern: >-
2977
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
2978
- description: >-
2979
- Identifier that correlates all messages of the same
2980
- sequence. The API data type UUID (Universally Unique
2981
- Identifier) is a JSON String in canonical format,
2982
- conforming to [RFC
2983
- 4122](https://tools.ietf.org/html/rfc4122), that is
2984
- restricted by a regular expression for interoperability
2985
- reasons. A UUID is always 36 characters long, 32
2986
- hexadecimal symbols and 4 dashes (‘-‘).
2987
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
2988
- quoteResponse:
2989
- title: QuotesIDPutResponse
2990
- type: object
2991
- description: The object sent in the PUT /quotes/{ID} callback.
2992
- properties: *ref_29
2993
- required: *ref_30
2994
- quoteResponseSource:
2995
- type: string
2996
- description: >
2997
- FSPID of the entity that supplied the quote response. This
2998
- may not be the same as the FSPID of the entity which owns
2999
- the end user account in the case of a FOREX transfer. i.e.
3000
- it may be a FOREX gateway.
3001
- fulfil:
3002
- title: TransfersIDPutResponse
3003
- type: object
3004
- description: The object sent in the PUT /transfers/{ID} callback.
3005
- properties: *ref_20
3006
- required: *ref_21
3007
- lastError:
3008
- description: >-
3009
- This object represents a Mojaloop API error received at
3010
- any time during the transfer process
3011
- type: object
3012
- properties: *ref_26
3013
- '400':
3014
- description: Malformed or missing required body, headers or parameters
3015
- content: &ref_137
3016
- application/json:
3017
- schema:
3018
- allOf: *ref_14
3019
- '500':
3020
- description: An error occurred processing the transfer
3021
- content: *ref_16
3022
- '504':
3023
- description: Timeout occurred processing the transfer
3024
- content: *ref_17
3025
- /requestToPayTransfer/{requestToPayTransactionId}:
3026
- put:
3027
- summary: >-
3028
- Continues a transfer that has paused at the otp stage in order to accept
3029
- or reject quote
3030
- description: >
3031
- The HTTP request `PUT /transfers/{transferId}` is used to continue a
3032
- transfer initiated via the `POST /transfers` method that has halted
3033
- after party lookup and/or quotation stage.
3034
-
3035
-
3036
- The request body should contain either the "acceptOTP" or "acceptQuote"
3037
- property set to `true` as required to continue the transfer.
3038
-
3039
-
3040
- See the description of the `POST /requestToPayTransfer` HTTP method for
3041
- more information on modes of transfer.
3042
- tags:
3043
- - RequestToPayTransferID
3044
- requestBody:
3045
- content:
3046
- application/json:
3047
- schema:
3048
- oneOf:
3049
- - type: object
3050
- required: *ref_35
3051
- properties: *ref_36
3052
- - type: object
3053
- required: &ref_109
3054
- - acceptOTP
3055
- properties: &ref_110
3056
- acceptOTP:
3057
- type: boolean
3058
- enum:
3059
- - true
3060
- - false
3061
- parameters:
3062
- - name: requestToPayTransactionId
3063
- in: path
3064
- required: true
3065
- schema: &ref_146
3066
- title: CorrelationId
3067
- type: string
3068
- pattern: >-
3069
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
3070
- description: >-
3071
- Identifier that correlates all messages of the same sequence. The
3072
- API data type UUID (Universally Unique Identifier) is a JSON
3073
- String in canonical format, conforming to [RFC
3074
- 4122](https://tools.ietf.org/html/rfc4122), that is restricted by
3075
- a regular expression for interoperability reasons. A UUID is
3076
- always 36 characters long, 32 hexadecimal symbols and 4 dashes
3077
- (‘-‘).
3078
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
3079
- description: >-
3080
- Identifier of the merchant request to pay transfer to continue as
3081
- returned in the response to a `POST /requestToPayTransfer` request.
3082
- responses:
3083
- '200':
3084
- description: Transfer completed successfully
3085
- content: *ref_15
3086
- '500':
3087
- description: An error occurred processing the transfer
3088
- content: *ref_16
3089
- '504':
3090
- description: Timeout occurred processing the transfer
3091
- content: *ref_17
3092
- /accounts:
3093
- post:
3094
- summary: Create accounts on the Account Lookup Service
3095
- description: >-
3096
- The HTTP request `POST /accounts` is used to create account information
3097
- on the Account Lookup Service (ALS) regarding the provided list of
3098
- identities.
3099
-
3100
-
3101
- Caller DFSP is used as the account source FSP information
3102
- tags:
3103
- - Accounts
3104
- requestBody:
3105
- description: Identities list request body
3106
- content:
3107
- application/json:
3108
- schema:
3109
- type: array
3110
- items: &ref_51
3111
- type: object
3112
- required:
3113
- - idType
3114
- - idValue
3115
- - currency
3116
- properties:
3117
- idType:
3118
- title: PartyIdType
3119
- type: string
3120
- enum: *ref_23
3121
- description: >-
3122
- Below are the allowed values for the enumeration.
3123
-
3124
- - MSISDN - An MSISDN (Mobile Station International
3125
- Subscriber Directory Number, that is, the phone number) is
3126
- used as reference to a participant. The MSISDN identifier
3127
- should be in international format according to the [ITU-T
3128
- E.164 standard](https://www.itu.int/rec/T-REC-E.164/en).
3129
- Optionally, the MSISDN may be prefixed by a single plus
3130
- sign, indicating the international prefix.
3131
-
3132
- - EMAIL - An email is used as reference to a participant.
3133
- The format of the email should be according to the
3134
- informational [RFC
3135
- 3696](https://tools.ietf.org/html/rfc3696).
3136
-
3137
- - PERSONAL_ID - A personal identifier is used as reference
3138
- to a participant. Examples of personal identification are
3139
- passport number, birth certificate number, and national
3140
- registration number. The identifier number is added in the
3141
- PartyIdentifier element. The personal identifier type is
3142
- added in the PartySubIdOrType element.
3143
-
3144
- - BUSINESS - A specific Business (for example, an
3145
- organization or a company) is used as reference to a
3146
- participant. The BUSINESS identifier can be in any format.
3147
- To make a transaction connected to a specific username or
3148
- bill number in a Business, the PartySubIdOrType element
3149
- should be used.
3150
-
3151
- - DEVICE - A specific device (for example, a POS or ATM)
3152
- ID connected to a specific business or organization is
3153
- used as reference to a Party. For referencing a specific
3154
- device under a specific business or organization, use the
3155
- PartySubIdOrType element.
3156
-
3157
- - ACCOUNT_ID - A bank account number or FSP account ID
3158
- should be used as reference to a participant. The
3159
- ACCOUNT_ID identifier can be in any format, as formats can
3160
- greatly differ depending on country and FSP.
3161
-
3162
- - IBAN - A bank account number or FSP account ID is used
3163
- as reference to a participant. The IBAN identifier can
3164
- consist of up to 34 alphanumeric characters and should be
3165
- entered without whitespace.
3166
-
3167
- - ALIAS An alias is used as reference to a participant.
3168
- The alias should be created in the FSP as an alternative
3169
- reference to an account owner. Another example of an alias
3170
- is a username in the FSP system. The ALIAS identifier can
3171
- be in any format. It is also possible to use the
3172
- PartySubIdOrType element for identifying an account under
3173
- an Alias defined by the PartyIdentifier.
3174
- idValue:
3175
- title: PartyIdentifier
3176
- type: string
3177
- minLength: 1
3178
- maxLength: 128
3179
- description: Identifier of the Party.
3180
- example: '16135551212'
3181
- idSubValue:
3182
- title: PartySubIdOrType
3183
- type: string
3184
- minLength: 1
3185
- maxLength: 128
3186
- description: >-
3187
- Either a sub-identifier of a PartyIdentifier, or a
3188
- sub-type of the PartyIdType, normally a
3189
- PersonalIdentifierType.
3190
- currency:
3191
- title: Currency
3192
- description: >-
3193
- The currency codes defined in [ISO
3194
- 4217](https://www.iso.org/iso-4217-currency-codes.html) as
3195
- three-letter alphabetic codes are used as the standard
3196
- naming representation for currencies.
3197
- type: string
3198
- minLength: 3
3199
- maxLength: 3
3200
- enum: *ref_4
3201
- required: true
3202
- responses:
3203
- '200':
3204
- description: Accounts creation completed
3205
- content: &ref_138
3206
- application/json:
3207
- schema:
3208
- type: object
3209
- required: &ref_52
3210
- - accounts
3211
- properties: &ref_53
3212
- modelId:
3213
- title: CorrelationId
3214
- type: string
3215
- pattern: >-
3216
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
3217
- description: >-
3218
- Identifier that correlates all messages of the same
3219
- sequence. The API data type UUID (Universally Unique
3220
- Identifier) is a JSON String in canonical format,
3221
- conforming to [RFC
3222
- 4122](https://tools.ietf.org/html/rfc4122), that is
3223
- restricted by a regular expression for interoperability
3224
- reasons. A UUID is always 36 characters long, 32
3225
- hexadecimal symbols and 4 dashes (‘-‘).
3226
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
3227
- accounts:
3228
- type: array
3229
- items: *ref_51
3230
- response:
3231
- type: array
3232
- items: &ref_111
3233
- type: object
3234
- required:
3235
- - idType
3236
- - idValue
3237
- properties:
3238
- idType:
3239
- title: PartyIdType
3240
- type: string
3241
- enum: *ref_23
3242
- description: >-
3243
- Below are the allowed values for the enumeration.
3244
-
3245
- - MSISDN - An MSISDN (Mobile Station International
3246
- Subscriber Directory Number, that is, the phone
3247
- number) is used as reference to a participant. The
3248
- MSISDN identifier should be in international format
3249
- according to the [ITU-T E.164
3250
- standard](https://www.itu.int/rec/T-REC-E.164/en).
3251
- Optionally, the MSISDN may be prefixed by a single
3252
- plus sign, indicating the international prefix.
3253
-
3254
- - EMAIL - An email is used as reference to a
3255
- participant. The format of the email should be
3256
- according to the informational [RFC
3257
- 3696](https://tools.ietf.org/html/rfc3696).
3258
-
3259
- - PERSONAL_ID - A personal identifier is used as
3260
- reference to a participant. Examples of personal
3261
- identification are passport number, birth
3262
- certificate number, and national registration
3263
- number. The identifier number is added in the
3264
- PartyIdentifier element. The personal identifier
3265
- type is added in the PartySubIdOrType element.
3266
-
3267
- - BUSINESS - A specific Business (for example, an
3268
- organization or a company) is used as reference to a
3269
- participant. The BUSINESS identifier can be in any
3270
- format. To make a transaction connected to a
3271
- specific username or bill number in a Business, the
3272
- PartySubIdOrType element should be used.
3273
-
3274
- - DEVICE - A specific device (for example, a POS or
3275
- ATM) ID connected to a specific business or
3276
- organization is used as reference to a Party. For
3277
- referencing a specific device under a specific
3278
- business or organization, use the PartySubIdOrType
3279
- element.
3280
-
3281
- - ACCOUNT_ID - A bank account number or FSP account
3282
- ID should be used as reference to a participant. The
3283
- ACCOUNT_ID identifier can be in any format, as
3284
- formats can greatly differ depending on country and
3285
- FSP.
3286
-
3287
- - IBAN - A bank account number or FSP account ID is
3288
- used as reference to a participant. The IBAN
3289
- identifier can consist of up to 34 alphanumeric
3290
- characters and should be entered without whitespace.
3291
-
3292
- - ALIAS An alias is used as reference to a
3293
- participant. The alias should be created in the FSP
3294
- as an alternative reference to an account owner.
3295
- Another example of an alias is a username in the FSP
3296
- system. The ALIAS identifier can be in any format.
3297
- It is also possible to use the PartySubIdOrType
3298
- element for identifying an account under an Alias
3299
- defined by the PartyIdentifier.
3300
- idValue:
3301
- title: PartyIdentifier
3302
- type: string
3303
- minLength: 1
3304
- maxLength: 128
3305
- description: Identifier of the Party.
3306
- example: '16135551212'
3307
- idSubValue:
3308
- title: PartySubIdOrType
3309
- type: string
3310
- minLength: 1
3311
- maxLength: 128
3312
- description: >-
3313
- Either a sub-identifier of a PartyIdentifier, or a
3314
- sub-type of the PartyIdType, normally a
3315
- PersonalIdentifierType.
3316
- error:
3317
- type: object
3318
- properties: *ref_22
3319
- currentState:
3320
- type: string
3321
- enum: &ref_112
3322
- - ERROR_OCCURRED
3323
- - COMPLETED
3324
- lastError:
3325
- type: object
3326
- description: >-
3327
- This object represents a Mojaloop API error received at
3328
- any time during the transfer process
3329
- properties: *ref_26
3330
- postAccountsResponse:
3331
- type: object
3332
- required:
3333
- - body
3334
- properties:
3335
- body:
3336
- type: object
3337
- headers:
3338
- type: object
3339
- '400':
3340
- description: An error occurred creating accounts
3341
- content: &ref_54
3342
- application/json:
3343
- schema:
3344
- allOf: &ref_55
3345
- - type: object
3346
- properties: *ref_22
3347
- - type: object
3348
- required:
3349
- - executionState
3350
- properties:
3351
- executionState:
3352
- type: object
3353
- required: *ref_52
3354
- properties: *ref_53
3355
- '500':
3356
- description: An error occurred creating accounts
3357
- content: *ref_54
3358
- '504':
3359
- description: Timeout occurred creating accounts
3360
- content: &ref_139
3361
- application/json:
3362
- schema:
3363
- allOf: *ref_55
3364
- /parties/{Type}/{ID}:
3365
- parameters:
3366
- - name: Type
3367
- in: path
3368
- required: true
3369
- schema: &ref_58
3370
- type: string
3371
- description: >-
3372
- The type of the party identifier. For example, `MSISDN`,
3373
- `PERSONAL_ID`.
3374
- - name: ID
3375
- in: path
3376
- required: true
3377
- schema: &ref_59
3378
- type: string
3379
- description: The identifier value.
3380
- get:
3381
- description: >-
3382
- The HTTP request GET /parties// (or GET /parties///) is used to lookup
3383
- information regarding the requested Party, defined by , and optionally
3384
- (for example, GET /parties/MSISDN/123456789, or GET
3385
- /parties/BUSINESS/shoecompany/employee1).
3386
- summary: PartiesByTypeAndID
3387
- tags:
3388
- - parties
3389
- operationId: PartiesByTypeAndID
3390
- responses:
3391
- '200':
3392
- description: PartiesByIdSuccess
3393
- content: &ref_60
3394
- application/json:
3395
- schema:
3396
- title: partiesByIdResponse
3397
- type: object
3398
- description: GET /parties/{Type}/{ID} response object
3399
- properties: &ref_113
3400
- party:
3401
- properties:
3402
- body:
3403
- description: Data model for the complex type Party.
3404
- title: Party
3405
- type: object
3406
- properties: *ref_24
3407
- required: *ref_25
3408
- headers:
3409
- type: object
3410
- required:
3411
- - body
3412
- - headers
3413
- currentState:
3414
- type: string
3415
- enum: &ref_64
3416
- - WAITING_FOR_ACTION
3417
- - COMPLETED
3418
- - ERROR_OCCURRED
3419
- required: &ref_114
3420
- - party
3421
- - currentState
3422
- '404':
3423
- description: PartiesByIdError404
3424
- content: &ref_61
3425
- application/json:
3426
- schema:
3427
- type: object
3428
- properties:
3429
- errorInformation:
3430
- title: ErrorInformation
3431
- type: object
3432
- description: Data model for the complex type ErrorInformation.
3433
- properties: *ref_56
3434
- required: *ref_57
3435
- /parties/{Type}/{ID}/{SubId}:
3436
- parameters:
3437
- - name: Type
3438
- in: path
3439
- required: true
3440
- schema: *ref_58
3441
- description: >-
3442
- The type of the party identifier. For example, `MSISDN`,
3443
- `PERSONAL_ID`.
3444
- - name: ID
3445
- in: path
3446
- required: true
3447
- schema: *ref_59
3448
- description: The identifier value.
3449
- - name: SubId
3450
- in: path
3451
- required: true
3452
- schema: &ref_147
3453
- type: string
3454
- description: >-
3455
- A sub-identifier of the party identifier, or a sub-type of the party
3456
- identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`.
3457
- get:
3458
- description: >-
3459
- The HTTP request GET /parties// (or GET /parties///) is used to lookup
3460
- information regarding the requested Party, defined by , and optionally
3461
- (for example, GET /parties/MSISDN/123456789, or GET
3462
- /parties/BUSINESS/shoecompany/employee1).
3463
- summary: PartiesSubIdByTypeAndID
3464
- tags:
3465
- - parties
3466
- operationId: PartiesSubIdByTypeAndID
3467
- responses:
3468
- '200':
3469
- description: PartiesByIdSuccess
3470
- content: *ref_60
3471
- '404':
3472
- description: PartiesByIdError404
3473
- content: *ref_61
3474
- /quotes:
3475
- post:
3476
- summary: Quotes endpoint
3477
- description: is used to request quotes from other DFSP
3478
- tags:
3479
- - quotes
3480
- operationId: QuotesPost
3481
- requestBody:
3482
- description: Quotes request payload
3483
- content:
3484
- application/json:
3485
- schema:
3486
- title: QuotesPostRequest
3487
- type: object
3488
- description: The object sent in the POST /quotes request.
3489
- properties: &ref_115
3490
- quoteId:
3491
- title: CorrelationId
3492
- type: string
3493
- pattern: >-
3494
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
3495
- description: >-
3496
- Identifier that correlates all messages of the same
3497
- sequence. The API data type UUID (Universally Unique
3498
- Identifier) is a JSON String in canonical format, conforming
3499
- to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is
3500
- restricted by a regular expression for interoperability
3501
- reasons. A UUID is always 36 characters long, 32 hexadecimal
3502
- symbols and 4 dashes (‘-‘).
3503
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
3504
- transactionId:
3505
- title: CorrelationId
3506
- type: string
3507
- pattern: >-
3508
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
3509
- description: >-
3510
- Identifier that correlates all messages of the same
3511
- sequence. The API data type UUID (Universally Unique
3512
- Identifier) is a JSON String in canonical format, conforming
3513
- to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is
3514
- restricted by a regular expression for interoperability
3515
- reasons. A UUID is always 36 characters long, 32 hexadecimal
3516
- symbols and 4 dashes (‘-‘).
3517
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
3518
- transactionRequestId:
3519
- title: CorrelationId
3520
- type: string
3521
- pattern: >-
3522
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
3523
- description: >-
3524
- Identifier that correlates all messages of the same
3525
- sequence. The API data type UUID (Universally Unique
3526
- Identifier) is a JSON String in canonical format, conforming
3527
- to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is
3528
- restricted by a regular expression for interoperability
3529
- reasons. A UUID is always 36 characters long, 32 hexadecimal
3530
- symbols and 4 dashes (‘-‘).
3531
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
3532
- payee:
3533
- title: Party
3534
- type: object
3535
- description: Data model for the complex type Party.
3536
- properties: *ref_24
3537
- required: *ref_25
3538
- payer:
3539
- title: Party
3540
- type: object
3541
- description: Data model for the complex type Party.
3542
- properties: *ref_24
3543
- required: *ref_25
3544
- amountType:
3545
- title: AmountType
3546
- type: string
3547
- enum: *ref_3
3548
- description: >-
3549
- Below are the allowed values for the enumeration AmountType.
3550
-
3551
- - SEND - Amount the Payer would like to send, that is, the
3552
- amount that should be withdrawn from the Payer account
3553
- including any fees.
3554
-
3555
- - RECEIVE - Amount the Payer would like the Payee to
3556
- receive, that is, the amount that should be sent to the
3557
- receiver exclusive of any fees.
3558
- example: RECEIVE
3559
- amount:
3560
- title: Money
3561
- type: object
3562
- description: Data model for the complex type Money.
3563
- properties: *ref_6
3564
- required: *ref_7
3565
- fees:
3566
- title: Money
3567
- type: object
3568
- description: Data model for the complex type Money.
3569
- properties: *ref_6
3570
- required: *ref_7
3571
- transactionType:
3572
- type: string
3573
- enum: *ref_49
3574
- description: Type of transaction.
3575
- geoCode:
3576
- title: GeoCode
3577
- type: object
3578
- description: >-
3579
- Data model for the complex type GeoCode. Indicates the
3580
- geographic location from where the transaction was
3581
- initiated.
3582
- properties: *ref_62
3583
- required: *ref_63
3584
- note:
3585
- title: Note
3586
- type: string
3587
- minLength: 1
3588
- maxLength: 128
3589
- description: Memo assigned to transaction.
3590
- example: Note sent to Payee.
3591
- expiration:
3592
- title: DateTime
3593
- type: string
3594
- pattern: >-
3595
- ^(?:[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)$
3596
- description: >-
3597
- The API data type DateTime is a JSON String in a lexical
3598
- format that is restricted by a regular expression for
3599
- interoperability reasons. The format is according to [ISO
3600
- 8601](https://www.iso.org/iso-8601-date-and-time-format.html),
3601
- expressed in a combined date, time and time zone format. A
3602
- more readable version of the format is
3603
- yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are
3604
- "2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z"
3605
- (where Z indicates Zulu time zone, same as UTC).
3606
- example: '2016-05-24T08:38:08.699-04:00'
3607
- extensionList:
3608
- title: ExtensionList
3609
- type: object
3610
- description: >-
3611
- Data model for the complex type ExtensionList. An optional
3612
- list of extensions, specific to deployment.
3613
- properties: *ref_10
3614
- required: *ref_11
3615
- required: &ref_116
3616
- - quoteId
3617
- - transactionId
3618
- - payee
3619
- - payer
3620
- - amountType
3621
- - amount
3622
- - transactionType
3623
- required: true
3624
- responses:
3625
- '200':
3626
- description: sync response from POST /quotes
3627
- content: &ref_140
3628
- application/json:
3629
- schema:
3630
- title: QuotesPostResponse
3631
- type: object
3632
- properties: &ref_117
3633
- quotes:
3634
- title: QuotesIDPutResponse
3635
- type: object
3636
- description: The object sent in the PUT /quotes/{ID} callback.
3637
- properties:
3638
- body:
3639
- type: object
3640
- properties:
3641
- transferAmount:
3642
- title: Money
3643
- type: object
3644
- description: Data model for the complex type Money.
3645
- properties: *ref_6
3646
- required: *ref_7
3647
- payeeReceiveAmount:
3648
- title: Money
3649
- type: object
3650
- description: Data model for the complex type Money.
3651
- properties: *ref_6
3652
- required: *ref_7
3653
- payeeFspFee:
3654
- title: Money
3655
- type: object
3656
- description: Data model for the complex type Money.
3657
- properties: *ref_6
3658
- required: *ref_7
3659
- payeeFspCommission:
3660
- title: Money
3661
- type: object
3662
- description: Data model for the complex type Money.
3663
- properties: *ref_6
3664
- required: *ref_7
3665
- expiration:
3666
- type: string
3667
- description: >-
3668
- Date and time until when the quotation is valid
3669
- and can be honored when used in the subsequent
3670
- transaction.
3671
- example: '2016-05-24T08:38:08.699-04:00'
3672
- geoCode:
3673
- title: GeoCode
3674
- type: object
3675
- description: >-
3676
- Data model for the complex type GeoCode. Indicates
3677
- the geographic location from where the transaction
3678
- was initiated.
3679
- properties: *ref_62
3680
- required: *ref_63
3681
- ilpPacket:
3682
- title: IlpPacket
3683
- type: string
3684
- pattern: ^[A-Za-z0-9-_]+[=]{0,2}$
3685
- minLength: 1
3686
- maxLength: 32768
3687
- description: >-
3688
- Information for recipient (transport layer
3689
- information).
3690
- example: >-
3691
- AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
3692
- condition:
3693
- title: IlpCondition
3694
- type: string
3695
- pattern: ^[A-Za-z0-9-_]{43}$
3696
- maxLength: 48
3697
- description: >-
3698
- Condition that must be attached to the transfer by
3699
- the Payer.
3700
- extensionList:
3701
- title: ExtensionList
3702
- type: object
3703
- description: >-
3704
- Data model for the complex type ExtensionList. An
3705
- optional list of extensions, specific to
3706
- deployment.
3707
- properties: *ref_10
3708
- required: *ref_11
3709
- required:
3710
- - transferAmount
3711
- - expiration
3712
- - ilpPacket
3713
- - condition
3714
- headers:
3715
- type: object
3716
- required:
3717
- - body
3718
- - headers
3719
- currentState:
3720
- type: string
3721
- enum: *ref_64
3722
- required: &ref_118
3723
- - quotes
3724
- - currentState
3725
- '500':
3726
- description: An error occurred processing the quotes request
3727
- content: &ref_141
3728
- application/json:
3729
- schema:
3730
- allOf: &ref_119
3731
- - type: object
3732
- properties: *ref_22
3733
- - type: object
3734
- /simpleTransfers:
3735
- post:
3736
- summary: Simple Transfers endpoint
3737
- description: is used to request a transfer
3738
- tags:
3739
- - transfers
3740
- operationId: SimpleTransfersPost
3741
- requestBody:
3742
- description: Simple Transfer request payload
3743
- content:
3744
- application/json:
3745
- schema:
3746
- title: SimpleTransfersPostRequest
3747
- type: object
3748
- properties: &ref_122
3749
- fspId:
3750
- title: FspId
3751
- type: string
3752
- minLength: 1
3753
- maxLength: 32
3754
- description: FSP identifier.
3755
- transfersPostRequest:
3756
- title: TransfersPostRequest
3757
- type: object
3758
- description: The object sent in the POST /transfers request.
3759
- properties: &ref_120
3760
- transferId:
3761
- title: CorrelationId
3762
- type: string
3763
- pattern: >-
3764
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
3765
- description: >-
3766
- Identifier that correlates all messages of the same
3767
- sequence. The API data type UUID (Universally Unique
3768
- Identifier) is a JSON String in canonical format,
3769
- conforming to [RFC
3770
- 4122](https://tools.ietf.org/html/rfc4122), that is
3771
- restricted by a regular expression for interoperability
3772
- reasons. A UUID is always 36 characters long, 32
3773
- hexadecimal symbols and 4 dashes (‘-‘).
3774
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
3775
- payeeFsp:
3776
- title: FspId
3777
- type: string
3778
- minLength: 1
3779
- maxLength: 32
3780
- description: FSP identifier.
3781
- payerFsp:
3782
- title: FspId
3783
- type: string
3784
- minLength: 1
3785
- maxLength: 32
3786
- description: FSP identifier.
3787
- amount:
3788
- title: Money
3789
- type: object
3790
- description: Data model for the complex type Money.
3791
- properties: *ref_6
3792
- required: *ref_7
3793
- ilpPacket:
3794
- title: IlpPacket
3795
- type: string
3796
- pattern: ^[A-Za-z0-9-_]+[=]{0,2}$
3797
- minLength: 1
3798
- maxLength: 32768
3799
- description: Information for recipient (transport layer information).
3800
- example: >-
3801
- AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
3802
- condition:
3803
- title: IlpCondition
3804
- type: string
3805
- pattern: ^[A-Za-z0-9-_]{43}$
3806
- maxLength: 48
3807
- description: >-
3808
- Condition that must be attached to the transfer by the
3809
- Payer.
3810
- expiration:
3811
- title: DateTime
3812
- type: string
3813
- pattern: >-
3814
- ^(?:[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)$
3815
- description: >-
3816
- The API data type DateTime is a JSON String in a lexical
3817
- format that is restricted by a regular expression for
3818
- interoperability reasons. The format is according to
3819
- [ISO
3820
- 8601](https://www.iso.org/iso-8601-date-and-time-format.html),
3821
- expressed in a combined date, time and time zone format.
3822
- A more readable version of the format is
3823
- yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are
3824
- "2016-05-24T08:38:08.699-04:00",
3825
- "2016-05-24T08:38:08.699Z" (where Z indicates Zulu time
3826
- zone, same as UTC).
3827
- example: '2016-05-24T08:38:08.699-04:00'
3828
- extensionList:
3829
- title: ExtensionList
3830
- type: object
3831
- description: >-
3832
- Data model for the complex type ExtensionList. An
3833
- optional list of extensions, specific to deployment.
3834
- properties: *ref_10
3835
- required: *ref_11
3836
- required: &ref_121
3837
- - transferId
3838
- - payeeFsp
3839
- - payerFsp
3840
- - amount
3841
- - ilpPacket
3842
- - condition
3843
- - expiration
3844
- required: &ref_123
3845
- - fspId
3846
- - transfersPostRequest
3847
- required: true
3848
- responses:
3849
- '200':
3850
- description: sync response from POST /simpleTransfers
3851
- content: &ref_142
3852
- application/json:
3853
- schema:
3854
- title: SimpleTransfersPostResponse
3855
- type: object
3856
- properties: &ref_124
3857
- transfer:
3858
- properties:
3859
- body:
3860
- title: TransfersIDPutResponse
3861
- type: object
3862
- description: The object sent in the PUT /transfers/{ID} callback.
3863
- properties: *ref_20
3864
- required: *ref_21
3865
- headers:
3866
- type: object
3867
- required:
3868
- - body
3869
- - headers
3870
- currentState:
3871
- type: string
3872
- enum: *ref_64
3873
- required: &ref_125
3874
- - transfer
3875
- - currentState
3876
- '500':
3877
- description: An error occurred processing the simple transfers request
3878
- content: &ref_143
3879
- application/json:
3880
- schema:
3881
- allOf: &ref_126
3882
- - type: object
3883
- properties: *ref_22
3884
- - type: object
3885
- components:
3886
- schemas:
3887
- TransactionInitiatorType:
3888
- title: TransactionInitiatorType
3889
- type: string
3890
- enum: *ref_48
3891
- description: |-
3892
- Below are the allowed values for the enumeration.
3893
- - CONSUMER - Consumer is the initiator of the transaction.
3894
- - AGENT - Agent is the initiator of the transaction.
3895
- - BUSINESS - Business is the initiator of the transaction.
3896
- - DEVICE - Device is the initiator of the transaction.
3897
- example: CONSUMER
3898
- PartyIdType:
3899
- title: PartyIdType
3900
- type: string
3901
- enum: *ref_23
3902
- description: >-
3903
- Below are the allowed values for the enumeration.
3904
-
3905
- - MSISDN - An MSISDN (Mobile Station International Subscriber Directory
3906
- Number, that is, the phone number) is used as reference to a
3907
- participant. The MSISDN identifier should be in international format
3908
- according to the [ITU-T E.164
3909
- standard](https://www.itu.int/rec/T-REC-E.164/en). Optionally, the
3910
- MSISDN may be prefixed by a single plus sign, indicating the
3911
- international prefix.
3912
-
3913
- - EMAIL - An email is used as reference to a participant. The format of
3914
- the email should be according to the informational [RFC
3915
- 3696](https://tools.ietf.org/html/rfc3696).
3916
-
3917
- - PERSONAL_ID - A personal identifier is used as reference to a
3918
- participant. Examples of personal identification are passport number,
3919
- birth certificate number, and national registration number. The
3920
- identifier number is added in the PartyIdentifier element. The personal
3921
- identifier type is added in the PartySubIdOrType element.
3922
-
3923
- - BUSINESS - A specific Business (for example, an organization or a
3924
- company) is used as reference to a participant. The BUSINESS identifier
3925
- can be in any format. To make a transaction connected to a specific
3926
- username or bill number in a Business, the PartySubIdOrType element
3927
- should be used.
3928
-
3929
- - DEVICE - A specific device (for example, a POS or ATM) ID connected to
3930
- a specific business or organization is used as reference to a Party. For
3931
- referencing a specific device under a specific business or organization,
3932
- use the PartySubIdOrType element.
3933
-
3934
- - ACCOUNT_ID - A bank account number or FSP account ID should be used as
3935
- reference to a participant. The ACCOUNT_ID identifier can be in any
3936
- format, as formats can greatly differ depending on country and FSP.
3937
-
3938
- - IBAN - A bank account number or FSP account ID is used as reference to
3939
- a participant. The IBAN identifier can consist of up to 34 alphanumeric
3940
- characters and should be entered without whitespace.
3941
-
3942
- - ALIAS An alias is used as reference to a participant. The alias should
3943
- be created in the FSP as an alternative reference to an account owner.
3944
- Another example of an alias is a username in the FSP system. The ALIAS
3945
- identifier can be in any format. It is also possible to use the
3946
- PartySubIdOrType element for identifying an account under an Alias
3947
- defined by the PartyIdentifier.
3948
- PartyIdentifier:
3949
- title: PartyIdentifier
3950
- type: string
3951
- minLength: 1
3952
- maxLength: 128
3953
- description: Identifier of the Party.
3954
- example: '16135551212'
3955
- PartySubIdOrType:
3956
- title: PartySubIdOrType
3957
- type: string
3958
- minLength: 1
3959
- maxLength: 128
3960
- description: >-
3961
- Either a sub-identifier of a PartyIdentifier, or a sub-type of the
3962
- PartyIdType, normally a PersonalIdentifierType.
3963
- Name:
3964
- title: Name
3965
- type: string
3966
- pattern: ^(?!\s*$)[\w .,'-]{1,128}$
3967
- description: >-
3968
- The API data type Name is a JSON String, restricted by a regular
3969
- expression to avoid characters which are generally not used in a name.
3970
-
3971
-
3972
- Regular Expression - The regular expression for restricting the Name
3973
- type is "^(?!\s*$)[\w .,'-]{1,128}$". The restriction does not allow a
3974
- string consisting of whitespace only, all Unicode characters are
3975
- allowed, as well as the period (.) (apostrophe (‘), dash (-), comma (,)
3976
- and space characters ( ).
3977
-
3978
-
3979
- **Note:** In some programming languages, Unicode support must be
3980
- specifically enabled. For example, if Java is used, the flag
3981
- UNICODE_CHARACTER_CLASS must be enabled to allow Unicode characters.
3982
- FirstName:
3983
- title: FirstName
3984
- type: string
3985
- minLength: 1
3986
- maxLength: 128
3987
- pattern: >-
3988
- ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
3989
- .,''-]{1,128}$
3990
- description: First name of the Party (Name Type).
3991
- example: Henrik
3992
- MiddleName:
3993
- title: MiddleName
3994
- type: string
3995
- minLength: 1
3996
- maxLength: 128
3997
- pattern: >-
3998
- ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
3999
- .,''-]{1,128}$
4000
- description: Middle name of the Party (Name Type).
4001
- example: Johannes
4002
- LastName:
4003
- title: LastName
4004
- type: string
4005
- minLength: 1
4006
- maxLength: 128
4007
- pattern: >-
4008
- ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
4009
- .,''-]{1,128}$
4010
- description: Last name of the Party (Name Type).
4011
- example: Karlsson
4012
- DateOfBirth:
4013
- title: DateofBirth (type Date)
4014
- type: string
4015
- pattern: >-
4016
- ^(?:[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)$
4017
- description: Date of Birth of the Party.
4018
- example: '1966-06-16'
4019
- MerchantClassificationCode:
4020
- title: MerchantClassificationCode
4021
- type: string
4022
- pattern: ^[\d]{1,4}$
4023
- description: >-
4024
- A limited set of pre-defined numbers. This list would be a limited set
4025
- of numbers identifying a set of popular merchant types like School Fees,
4026
- Pubs and Restaurants, Groceries, etc.
4027
- FspId:
4028
- title: FspId
4029
- type: string
4030
- minLength: 1
4031
- maxLength: 32
4032
- description: FSP identifier.
4033
- ExtensionKey:
4034
- title: ExtensionKey
4035
- type: string
4036
- minLength: 1
4037
- maxLength: 32
4038
- description: Extension key.
4039
- ExtensionValue:
4040
- title: ExtensionValue
4041
- type: string
4042
- minLength: 1
4043
- maxLength: 128
4044
- description: Extension value.
4045
- Extension:
4046
- title: Extension
4047
- type: object
4048
- description: Data model for the complex type Extension.
4049
- properties: *ref_8
4050
- required: *ref_9
4051
- extensionListEmptiable:
4052
- type: array
4053
- items: *ref_2
4054
- minItems: 0
4055
- maxItems: 16
4056
- transferParty:
4057
- type: object
4058
- required: *ref_0
4059
- properties: *ref_1
4060
- AmountType:
4061
- title: AmountType
4062
- type: string
4063
- enum: *ref_3
4064
- description: >-
4065
- Below are the allowed values for the enumeration AmountType.
4066
-
4067
- - SEND - Amount the Payer would like to send, that is, the amount that
4068
- should be withdrawn from the Payer account including any fees.
4069
-
4070
- - RECEIVE - Amount the Payer would like the Payee to receive, that is,
4071
- the amount that should be sent to the receiver exclusive of any fees.
4072
- example: RECEIVE
4073
- Currency:
4074
- title: Currency
4075
- description: >-
4076
- The currency codes defined in [ISO
4077
- 4217](https://www.iso.org/iso-4217-currency-codes.html) as three-letter
4078
- alphabetic codes are used as the standard naming representation for
4079
- currencies.
4080
- type: string
4081
- minLength: 3
4082
- maxLength: 3
4083
- enum: *ref_4
4084
- Amount:
4085
- title: Amount
4086
- type: string
4087
- pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
4088
- description: >-
4089
- The API data type Amount is a JSON String in a canonical format that is
4090
- restricted by a regular expression for interoperability reasons. This
4091
- pattern does not allow any trailing zeroes at all, but allows an amount
4092
- without a minor currency unit. It also only allows four digits in the
4093
- minor currency unit; a negative value is not allowed. Using more than 18
4094
- digits in the major currency unit is not allowed.
4095
- example: '123.45'
4096
- transactionType:
4097
- type: string
4098
- enum: *ref_5
4099
- description: Type of transaction.
4100
- Note:
4101
- title: Note
4102
- type: string
4103
- minLength: 1
4104
- maxLength: 128
4105
- description: Memo assigned to transaction.
4106
- example: Note sent to Payee.
4107
- transferRequest:
4108
- type: object
4109
- required: *ref_65
4110
- properties: *ref_66
4111
- CorrelationId:
4112
- title: CorrelationId
4113
- type: string
4114
- pattern: >-
4115
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
4116
- description: >-
4117
- Identifier that correlates all messages of the same sequence. The API
4118
- data type UUID (Universally Unique Identifier) is a JSON String in
4119
- canonical format, conforming to [RFC
4120
- 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a
4121
- regular expression for interoperability reasons. A UUID is always 36
4122
- characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
4123
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
4124
- transferStatus:
4125
- type: string
4126
- enum: *ref_19
4127
- Money:
4128
- title: Money
4129
- type: object
4130
- description: Data model for the complex type Money.
4131
- properties: *ref_6
4132
- required: *ref_7
4133
- DateTime:
4134
- title: DateTime
4135
- type: string
4136
- pattern: >-
4137
- ^(?:[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)$
4138
- description: >-
4139
- The API data type DateTime is a JSON String in a lexical format that is
4140
- restricted by a regular expression for interoperability reasons. The
4141
- format is according to [ISO
4142
- 8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed
4143
- in a combined date, time and time zone format. A more readable version
4144
- of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are
4145
- "2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where Z
4146
- indicates Zulu time zone, same as UTC).
4147
- example: '2016-05-24T08:38:08.699-04:00'
4148
- Latitude:
4149
- title: Latitude
4150
- type: string
4151
- pattern: >-
4152
- ^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$
4153
- description: >-
4154
- The API data type Latitude is a JSON String in a lexical format that is
4155
- restricted by a regular expression for interoperability reasons.
4156
- example: '+45.4215'
4157
- Longitude:
4158
- title: Longitude
4159
- type: string
4160
- pattern: >-
4161
- ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
4162
- description: >-
4163
- The API data type Longitude is a JSON String in a lexical format that is
4164
- restricted by a regular expression for interoperability reasons.
4165
- example: '+75.6972'
4166
- GeoCode:
4167
- title: GeoCode
4168
- type: object
4169
- description: >-
4170
- Data model for the complex type GeoCode. Indicates the geographic
4171
- location from where the transaction was initiated.
4172
- properties: *ref_62
4173
- required: *ref_63
4174
- IlpPacket:
4175
- title: IlpPacket
4176
- type: string
4177
- pattern: ^[A-Za-z0-9-_]+[=]{0,2}$
4178
- minLength: 1
4179
- maxLength: 32768
4180
- description: Information for recipient (transport layer information).
4181
- example: >-
4182
- AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
4183
- IlpCondition:
4184
- title: IlpCondition
4185
- type: string
4186
- pattern: ^[A-Za-z0-9-_]{43}$
4187
- maxLength: 48
4188
- description: Condition that must be attached to the transfer by the Payer.
4189
- ExtensionList:
4190
- title: ExtensionList
4191
- type: object
4192
- description: >-
4193
- Data model for the complex type ExtensionList. An optional list of
4194
- extensions, specific to deployment.
4195
- properties: *ref_10
4196
- required: *ref_11
4197
- QuotesIDPutResponse:
4198
- title: QuotesIDPutResponse
4199
- type: object
4200
- description: The object sent in the PUT /quotes/{ID} callback.
4201
- properties: *ref_29
4202
- required: *ref_30
4203
- IlpFulfilment:
4204
- title: IlpFulfilment
4205
- type: string
4206
- pattern: ^[A-Za-z0-9-_]{43}$
4207
- maxLength: 48
4208
- description: Fulfilment that must be attached to the transfer by the Payee.
4209
- example: WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
4210
- TransferState:
4211
- title: TransferState
4212
- type: string
4213
- enum: *ref_67
4214
- description: >-
4215
- Below are the allowed values for the enumeration.
4216
-
4217
- - RECEIVED - Next ledger has received the transfer.
4218
-
4219
- - RESERVED - Next ledger has reserved the transfer.
4220
-
4221
- - COMMITTED - Next ledger has successfully performed the transfer.
4222
-
4223
- - ABORTED - Next ledger has aborted the transfer due to a rejection or
4224
- failure to perform the transfer.
4225
- example: RESERVED
4226
- TransfersIDPutResponse:
4227
- title: TransfersIDPutResponse
4228
- type: object
4229
- description: The object sent in the PUT /transfers/{ID} callback.
4230
- properties: *ref_20
4231
- required: *ref_21
4232
- ErrorCode:
4233
- title: ErrorCode
4234
- type: string
4235
- pattern: ^[1-9]\d{3}$
4236
- description: >-
4237
- The API data type ErrorCode is a JSON String of four characters,
4238
- consisting of digits only. Negative numbers are not allowed. A leading
4239
- zero is not allowed. Each error code in the API is a four-digit number,
4240
- for example, 1234, where the first number (1 in the example) represents
4241
- the high-level error category, the second number (2 in the example)
4242
- represents the low-level error category, and the last two numbers (34 in
4243
- the example) represent the specific error.
4244
- example: '5100'
4245
- ErrorDescription:
4246
- title: ErrorDescription
4247
- type: string
4248
- minLength: 1
4249
- maxLength: 128
4250
- description: Error description string.
4251
- ErrorInformation:
4252
- title: ErrorInformation
4253
- type: object
4254
- description: Data model for the complex type ErrorInformation.
4255
- properties: *ref_56
4256
- required: *ref_57
4257
- mojaloopError:
4258
- type: object
4259
- properties: *ref_39
4260
- transferError:
4261
- type: object
4262
- description: >-
4263
- This object represents a Mojaloop API error received at any time during
4264
- the transfer process
4265
- properties: *ref_26
4266
- transferResponse:
4267
- type: object
4268
- required: *ref_12
4269
- properties: *ref_13
4270
- errorResponse:
4271
- type: object
4272
- properties: *ref_22
4273
- errorTransferResponse:
4274
- allOf: *ref_14
4275
- transferStatusResponse:
4276
- type: object
4277
- required: *ref_68
4278
- properties: *ref_69
4279
- transferContinuationAcceptParty:
4280
- type: object
4281
- required: *ref_31
4282
- properties: *ref_32
4283
- transferContinuationAcceptQuote:
4284
- type: object
4285
- required: *ref_35
4286
- properties: *ref_36
4287
- autoAcceptPartyOption:
4288
- type: object
4289
- required: *ref_70
4290
- properties: *ref_71
4291
- bulkPerTransferFeeLimit:
4292
- type: object
4293
- required: *ref_72
4294
- properties: *ref_73
4295
- autoAcceptQuote:
4296
- type: object
4297
- required: *ref_74
4298
- properties: *ref_75
4299
- bulkTransferOptions:
4300
- type: object
4301
- required: *ref_27
4302
- properties: *ref_28
4303
- PartyIdInfo:
4304
- title: PartyIdInfo
4305
- type: object
4306
- description: >-
4307
- Data model for the complex type PartyIdInfo. An ExtensionList element
4308
- has been added to this reqeust in version v1.1
4309
- properties: *ref_76
4310
- required: *ref_77
4311
- PartyName:
4312
- title: PartyName
4313
- type: string
4314
- minLength: 1
4315
- maxLength: 128
4316
- description: Name of the Party. Could be a real name or a nickname.
4317
- PartyComplexName:
4318
- title: PartyComplexName
4319
- type: object
4320
- description: Data model for the complex type PartyComplexName.
4321
- properties: *ref_78
4322
- PartyPersonalInfo:
4323
- title: PartyPersonalInfo
4324
- type: object
4325
- description: Data model for the complex type PartyPersonalInfo.
4326
- properties: *ref_79
4327
- Party:
4328
- title: Party
4329
- type: object
4330
- description: Data model for the complex type Party.
4331
- properties: *ref_24
4332
- required: *ref_25
4333
- individualTransfer:
4334
- title: IndividualTransfer
4335
- type: object
4336
- description: Data model for the complex type 'individualTransfer'.
4337
- properties: *ref_80
4338
- required: *ref_81
4339
- bulkTransferRequest:
4340
- type: object
4341
- required: *ref_82
4342
- properties: *ref_83
4343
- bulkTransferStatus:
4344
- type: string
4345
- enum: *ref_84
4346
- individualTransferResult:
4347
- type: object
4348
- required: *ref_85
4349
- properties: *ref_86
4350
- bulkTransferResponse:
4351
- type: object
4352
- required: *ref_87
4353
- properties: *ref_88
4354
- bulkTransferErrorResponse:
4355
- allOf: *ref_89
4356
- individualTransferAccept:
4357
- type: object
4358
- description: Data model for the 'individualTransfer' while accepting party or quote.
4359
- properties: *ref_33
4360
- required: *ref_34
4361
- bulkTransferContinuationAcceptParty:
4362
- description: >-
4363
- The object sent back as confirmation of payee parties when
4364
- autoAcceptParty is false.
4365
- type: object
4366
- required: *ref_37
4367
- properties: *ref_38
4368
- bulkTransferContinuationAcceptQuote:
4369
- description: >-
4370
- The object sent back as confirmation of quotes when autoAcceptQuotes is
4371
- false.
4372
- type: object
4373
- required: *ref_40
4374
- properties: *ref_41
4375
- partyError:
4376
- type: object
4377
- description: >-
4378
- This object represents a Mojaloop API error received at any time during
4379
- the party discovery process
4380
- properties: *ref_90
4381
- bulkAcceptPartyErrorResponse:
4382
- allOf: *ref_91
4383
- quoteError:
4384
- type: object
4385
- description: >-
4386
- This object represents a Mojaloop API error received at any time during
4387
- the quote process
4388
- properties: *ref_42
4389
- bulkAcceptQuoteErrorResponse:
4390
- allOf: *ref_92
4391
- individualQuote:
4392
- title: IndividualQuote
4393
- type: object
4394
- description: Data model for the complex type 'individualQuote'.
4395
- properties: *ref_46
4396
- required: *ref_47
4397
- bulkQuoteRequest:
4398
- type: object
4399
- required: *ref_93
4400
- properties: *ref_94
4401
- individualQuoteResult:
4402
- type: object
4403
- properties: *ref_95
4404
- bulkQuoteResponse:
4405
- type: object
4406
- required: *ref_43
4407
- properties: *ref_44
4408
- bulkQuoteErrorResponse:
4409
- allOf: *ref_45
4410
- bulkQuoteStatus:
4411
- type: string
4412
- enum: *ref_96
4413
- bulkQuoteStatusResponse:
4414
- type: object
4415
- required: *ref_97
4416
- properties: *ref_98
4417
- TransactionType:
4418
- type: string
4419
- enum: *ref_49
4420
- description: Type of transaction.
4421
- TransactionInitiator:
4422
- title: TransactionInitiator
4423
- type: string
4424
- enum: *ref_50
4425
- description: >-
4426
- Below are the allowed values for the enumeration.
4427
-
4428
- - PAYER - Sender of funds is initiating the transaction. The account to
4429
- send from is either owned by the Payer or is connected to the Payer in
4430
- some way.
4431
-
4432
- - PAYEE - Recipient of the funds is initiating the transaction by
4433
- sending a transaction request. The Payer must approve the transaction,
4434
- either automatically by a pre-generated OTP or by pre-approval of the
4435
- Payee, or by manually approving in his or her own Device.
4436
- example: PAYEE
4437
- requestToPayRequest:
4438
- type: object
4439
- required: *ref_99
4440
- properties: *ref_100
4441
- AuthenticationType:
4442
- title: AuthenticationType
4443
- type: string
4444
- enum: *ref_101
4445
- description: |-
4446
- Below are the allowed values for the enumeration AuthenticationType.
4447
- - OTP - One-time password generated by the Payer FSP.
4448
- - QRCODE - QR code used as One Time Password.
4449
- - U2F - U2F is a new addition isolated to Thirdparty stream.
4450
- example: OTP
4451
- TransactionRequestState:
4452
- title: TransactionRequestState
4453
- type: string
4454
- enum: *ref_102
4455
- description: |-
4456
- Below are the allowed values for the enumeration.
4457
- - RECEIVED - Payer FSP has received the transaction from the Payee FSP.
4458
- - PENDING - Payer FSP has sent the transaction request to the Payer.
4459
- - ACCEPTED - Payer has approved the transaction.
4460
- - REJECTED - Payer has rejected the transaction.
4461
- example: RECEIVED
4462
- requestToPayResponse:
4463
- type: object
4464
- required: *ref_103
4465
- properties: *ref_104
4466
- requestToPayTransferRequest:
4467
- type: object
4468
- required: *ref_105
4469
- properties: *ref_106
4470
- requestToPayTransferResponse:
4471
- type: object
4472
- required: *ref_107
4473
- properties: *ref_108
4474
- transferContinuationAcceptOTP:
4475
- type: object
4476
- required: *ref_109
4477
- properties: *ref_110
4478
- accountsRequest:
4479
- type: array
4480
- items: *ref_51
4481
- accountCreationStatus:
4482
- type: array
4483
- items: *ref_111
4484
- accountsCreationState:
4485
- type: string
4486
- enum: *ref_112
4487
- accountsResponse:
4488
- type: object
4489
- required: *ref_52
4490
- properties: *ref_53
4491
- errorAccountsResponse:
4492
- allOf: *ref_55
4493
- async2SyncCurrentState:
4494
- type: string
4495
- enum: *ref_64
4496
- partiesByIdResponse:
4497
- title: partiesByIdResponse
4498
- type: object
4499
- description: GET /parties/{Type}/{ID} response object
4500
- properties: *ref_113
4501
- required: *ref_114
4502
- quotesPostRequest:
4503
- title: QuotesPostRequest
4504
- type: object
4505
- description: The object sent in the POST /quotes request.
4506
- properties: *ref_115
4507
- required: *ref_116
4508
- quotesPostResponse:
4509
- title: QuotesPostResponse
4510
- type: object
4511
- properties: *ref_117
4512
- required: *ref_118
4513
- errorQuotesResponse:
4514
- allOf: *ref_119
4515
- TransfersPostRequest:
4516
- title: TransfersPostRequest
4517
- type: object
4518
- description: The object sent in the POST /transfers request.
4519
- properties: *ref_120
4520
- required: *ref_121
4521
- simpleTransfersPostRequest:
4522
- title: SimpleTransfersPostRequest
4523
- type: object
4524
- properties: *ref_122
4525
- required: *ref_123
4526
- simpleTransfersPostResponse:
4527
- title: SimpleTransfersPostResponse
4528
- type: object
4529
- properties: *ref_124
4530
- required: *ref_125
4531
- errorSimpleTransfersResponse:
4532
- allOf: *ref_126
4533
- responses:
4534
- transferSuccess:
4535
- description: Transfer completed successfully
4536
- content: *ref_15
4537
- transferBadRequest:
4538
- description: Malformed or missing required body, headers or parameters
4539
- content: *ref_127
4540
- transferServerError:
4541
- description: An error occurred processing the transfer
4542
- content: *ref_16
4543
- transferTimeout:
4544
- description: Timeout occurred processing the transfer
4545
- content: *ref_17
4546
- bulkTransferAccepted:
4547
- description: Bulk transfer accepted successfully
4548
- bulkTransferBadRequest:
4549
- description: Malformed or missing required body, headers or parameters
4550
- content: *ref_128
4551
- errorResponse:
4552
- description: Internal Server Error
4553
- content: *ref_129
4554
- bulkTransferPutBadRequest:
4555
- description: Malformed or missing required body, headers or parameters
4556
- content: *ref_130
4557
- bulkQuoteSuccess:
4558
- description: Bulk quote completed successfully
4559
- content: *ref_131
4560
- bulkQuoteBadRequest:
4561
- description: Malformed or missing required body, headers or parameters
4562
- content: *ref_132
4563
- bulkQuoteServerError:
4564
- description: An error occurred processing the bulk quote
4565
- content: *ref_133
4566
- bulkQuoteTimeout:
4567
- description: Timeout occurred processing the bulk quote
4568
- content: *ref_134
4569
- requestToPaySuccess:
4570
- description: Request to Pay completed successfully
4571
- content: *ref_135
4572
- requestToPayTransferSuccess:
4573
- description: Transfer completed successfully
4574
- content: *ref_136
4575
- requestToPayTransferBadRequest:
4576
- description: Malformed or missing required body, headers or parameters
4577
- content: *ref_137
4578
- accountsCreationCompleted:
4579
- description: Accounts creation completed
4580
- content: *ref_138
4581
- accountsCreationError:
4582
- description: An error occurred creating accounts
4583
- content: *ref_54
4584
- accountsCreationTimeout:
4585
- description: Timeout occurred creating accounts
4586
- content: *ref_139
4587
- partiesByIdSuccess:
4588
- description: PartiesByIdSuccess
4589
- content: *ref_60
4590
- partiesByIdError404:
4591
- description: PartiesByIdError404
4592
- content: *ref_61
4593
- quotesPostSuccess:
4594
- description: sync response from POST /quotes
4595
- content: *ref_140
4596
- quotesServerError:
4597
- description: An error occurred processing the quotes request
4598
- content: *ref_141
4599
- simpleTransfersPostSuccess:
4600
- description: sync response from POST /simpleTransfers
4601
- content: *ref_142
4602
- simpleTransfersServerError:
4603
- description: An error occurred processing the simple transfers request
4604
- content: *ref_143
4605
- parameters:
4606
- transferId:
4607
- name: transferId
4608
- in: path
4609
- required: true
4610
- schema: *ref_18
4611
- description: >-
4612
- Identifier of the transfer to continue as returned in the response to a
4613
- `POST /transfers` request.
4614
- bulkTransactionId:
4615
- name: bulkTransactionId
4616
- in: path
4617
- required: true
4618
- schema: *ref_144
4619
- description: >-
4620
- Identifier of the bulk transfer to continue as returned in the response
4621
- to a `POST /bulkTransfers` request.
4622
- bulkQuoteId:
4623
- name: bulkQuoteId
4624
- in: path
4625
- required: true
4626
- schema: *ref_145
4627
- description: >-
4628
- Identifier of the bulk transfer to continue as returned in the response
4629
- to a `POST /bulkTransfers` request.
4630
- requestToPayTransactionId:
4631
- name: requestToPayTransactionId
4632
- in: path
4633
- required: true
4634
- schema: *ref_146
4635
- description: >-
4636
- Identifier of the merchant request to pay transfer to continue as
4637
- returned in the response to a `POST /requestToPayTransfer` request.
4638
- Type:
4639
- name: Type
4640
- in: path
4641
- required: true
4642
- schema: *ref_58
4643
- description: The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`.
4644
- ID:
4645
- name: ID
4646
- in: path
4647
- required: true
4648
- schema: *ref_59
4649
- description: The identifier value.
4650
- SubId:
4651
- name: SubId
4652
- in: path
4653
- required: true
4654
- schema: *ref_147
4655
- description: >-
4656
- A sub-identifier of the party identifier, or a sub-type of the party
4657
- identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`.