@mojaloop/api-snippets 14.2.3 → 15.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (22) hide show
  1. package/CHANGELOG.md +18 -0
  2. package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml +185 -193
  3. package/lib/sdk-scheme-adapter/outbound/v2_0_0/json-schemas.json +67 -52
  4. package/lib/sdk-scheme-adapter/outbound/v2_0_0/openapi.d.ts +104 -156
  5. package/lib/sdk-scheme-adapter/outbound/v2_0_0/schemas.d.ts +22 -27
  6. package/lib/sdk-scheme-adapter/outbound/v2_0_0/schemas.js +3 -3
  7. package/lib/sdk-scheme-adapter/outbound/v2_0_0/schemas.js.map +1 -1
  8. package/lib/sdk-scheme-adapter/outbound/v2_0_0/types.d.ts +3 -3
  9. package/package.json +19 -15
  10. package/sdk-bulk.yaml +1 -1
  11. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/bulkQuoteResponse.yaml +3 -0
  12. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/bulkTransactionContinuationAcceptParty.yaml +1 -1
  13. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/bulkTransactionContinuationAcceptQuote.yaml +1 -1
  14. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/{individualTransaction.yaml → bulkTransactionIndividualTransfer.yaml} +6 -3
  15. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/{individualTransactionAccept.yaml → bulkTransactionIndividualTransferAccept.yaml} +4 -1
  16. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/{individualTransactionResult.yaml → bulkTransactionIndividualTransferResult.yaml} +4 -1
  17. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/bulkTransactionRequest.yaml +2 -1
  18. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/bulkTransactionResponse.yaml +1 -1
  19. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/bulkTransferErrorResponse.yaml +1 -1
  20. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/bulkTransferResponse.yaml +3 -0
  21. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/individualQuote.yaml +1 -0
  22. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/individualQuoteResult.yaml +1 -1
package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml CHANGED
@@ -79,7 +79,7 @@ paths:
79
79
  application/json:
80
80
  schema:
81
81
  type: object
82
- required: &ref_69
82
+ required: &ref_70
83
83
  - homeTransactionId
84
84
  - from
85
85
  - to
@@ -87,7 +87,7 @@ paths:
87
87
  - currency
88
88
  - amount
89
89
  - transactionType
90
- properties: &ref_70
90
+ properties: &ref_71
91
91
  homeTransactionId:
92
92
  type: string
93
93
  description: >-
@@ -102,7 +102,7 @@ paths:
102
102
  type:
103
103
  title: TransactionInitiatorType
104
104
  type: string
105
- enum: &ref_51
105
+ enum: &ref_52
106
106
  - CONSUMER
107
107
  - AGENT
108
108
  - BUSINESS
@@ -677,7 +677,7 @@ paths:
677
677
  title: QuotesIDPutResponse
678
678
  type: object
679
679
  description: The object sent in the PUT /quotes/{ID} callback.
680
- properties: &ref_55
680
+ properties: &ref_56
681
681
  transferAmount:
682
682
  title: Money
683
683
  type: object
@@ -758,7 +758,7 @@ paths:
758
758
  Data model for the complex type GeoCode. Indicates
759
759
  the geographic location from where the transaction
760
760
  was initiated.
761
- properties: &ref_43
761
+ properties: &ref_44
762
762
  latitude:
763
763
  title: Latitude
764
764
  type: string
@@ -781,7 +781,7 @@ paths:
781
781
  regular expression for interoperability
782
782
  reasons.
783
783
  example: '+75.6972'
784
- required: &ref_44
784
+ required: &ref_45
785
785
  - latitude
786
786
  - longitude
787
787
  ilpPacket:
@@ -824,7 +824,7 @@ paths:
824
824
  description: Number of Extension elements.
825
825
  required: &ref_11
826
826
  - extension
827
- required: &ref_56
827
+ required: &ref_57
828
828
  - transferAmount
829
829
  - expiration
830
830
  - ilpPacket
@@ -936,7 +936,7 @@ paths:
936
936
  title: ErrorInformation
937
937
  type: object
938
938
  description: Data model for the complex type ErrorInformation.
939
- properties: &ref_62
939
+ properties: &ref_63
940
940
  errorCode:
941
941
  title: ErrorCode
942
942
  type: string
@@ -969,7 +969,7 @@ paths:
969
969
  deployment.
970
970
  properties: *ref_10
971
971
  required: *ref_11
972
- required: &ref_63
972
+ required: &ref_64
973
973
  - errorCode
974
974
  - errorDescription
975
975
  skipPartyLookup:
@@ -1109,11 +1109,11 @@ paths:
1109
1109
  application/json:
1110
1110
  schema:
1111
1111
  type: object
1112
- required: &ref_71
1112
+ required: &ref_72
1113
1113
  - transferId
1114
1114
  - currentState
1115
1115
  - fulfil
1116
- properties: &ref_72
1116
+ properties: &ref_73
1117
1117
  transferId:
1118
1118
  title: CorrelationId
1119
1119
  type: string
@@ -1166,12 +1166,13 @@ paths:
1166
1166
  application/json:
1167
1167
  schema:
1168
1168
  type: object
1169
- required: &ref_87
1169
+ required: &ref_88
1170
+ - bulkTransactionId
1170
1171
  - bulkHomeTransactionID
1171
1172
  - options
1172
1173
  - from
1173
1174
  - individualTransfers
1174
- properties: &ref_88
1175
+ properties: &ref_89
1175
1176
  bulkHomeTransactionID:
1176
1177
  type: string
1177
1178
  description: >-
@@ -1193,11 +1194,11 @@ paths:
1193
1194
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
1194
1195
  options:
1195
1196
  type: object
1196
- required: &ref_79
1197
+ required: &ref_80
1197
1198
  - autoAcceptParty
1198
1199
  - autoAcceptQuote
1199
1200
  - bulkExpiration
1200
- properties: &ref_80
1201
+ properties: &ref_81
1201
1202
  onlyValidateParty:
1202
1203
  description: >-
1203
1204
  Set to true if only party validation is required. This
@@ -1206,9 +1207,9 @@ paths:
1206
1207
  type: boolean
1207
1208
  autoAcceptParty:
1208
1209
  type: object
1209
- required: &ref_73
1210
+ required: &ref_74
1210
1211
  - enabled
1211
- properties: &ref_74
1212
+ properties: &ref_75
1212
1213
  enabled:
1213
1214
  type: boolean
1214
1215
  enum:
@@ -1223,9 +1224,9 @@ paths:
1223
1224
  type: object
1224
1225
  oneOf:
1225
1226
  - type: object
1226
- required: &ref_77
1227
+ required: &ref_78
1227
1228
  - enabled
1228
- properties: &ref_78
1229
+ properties: &ref_79
1229
1230
  enabled:
1230
1231
  type: boolean
1231
1232
  enum:
@@ -1236,10 +1237,10 @@ paths:
1236
1237
  minItems: 0
1237
1238
  items:
1238
1239
  type: object
1239
- required: &ref_75
1240
+ required: &ref_76
1240
1241
  - currency
1241
1242
  - amount
1242
- properties: &ref_76
1243
+ properties: &ref_77
1243
1244
  currency:
1244
1245
  title: Currency
1245
1246
  description: >-
@@ -1313,7 +1314,7 @@ paths:
1313
1314
  Data model for the complex type PartyIdInfo. An
1314
1315
  ExtensionList element has been added to this reqeust in
1315
1316
  version v1.1
1316
- properties: &ref_81
1317
+ properties: &ref_82
1317
1318
  partyIdType:
1318
1319
  title: PartyIdType
1319
1320
  type: string
@@ -1406,7 +1407,7 @@ paths:
1406
1407
  optional list of extensions, specific to deployment.
1407
1408
  properties: *ref_10
1408
1409
  required: *ref_11
1409
- required: &ref_82
1410
+ required: &ref_83
1410
1411
  - partyIdType
1411
1412
  - partyIdentifier
1412
1413
  merchantClassificationCode:
@@ -1428,12 +1429,12 @@ paths:
1428
1429
  title: PartyPersonalInfo
1429
1430
  type: object
1430
1431
  description: Data model for the complex type PartyPersonalInfo.
1431
- properties: &ref_84
1432
+ properties: &ref_85
1432
1433
  complexName:
1433
1434
  title: PartyComplexName
1434
1435
  type: object
1435
1436
  description: Data model for the complex type PartyComplexName.
1436
- properties: &ref_83
1437
+ properties: &ref_84
1437
1438
  firstName:
1438
1439
  title: FirstName
1439
1440
  type: string
@@ -1479,26 +1480,18 @@ paths:
1479
1480
  minItems: 1
1480
1481
  maxItems: 1000
1481
1482
  items:
1482
- title: IndividualTransaction
1483
+ title: BulkTransactionIndividualTransfer
1483
1484
  type: object
1484
- description: Data model for the complex type 'individualTransaction'.
1485
- properties: &ref_85
1485
+ description: >-
1486
+ Data model for the complex type
1487
+ 'bulkTransactionIndividualTransfer'.
1488
+ properties: &ref_86
1486
1489
  homeTransactionId:
1487
- title: CorrelationId
1488
1490
  type: string
1489
- pattern: >-
1490
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1491
1491
  description: >-
1492
- Identifier that correlates all messages of the same
1493
- sequence. The API data type UUID (Universally Unique
1494
- Identifier) is a JSON String in canonical format,
1495
- conforming to [RFC
1496
- 4122](https://tools.ietf.org/html/rfc4122), that is
1497
- restricted by a regular expression for
1498
- interoperability reasons. A UUID is always 36
1499
- characters long, 32 hexadecimal symbols and 4 dashes
1500
- (‘-‘).
1501
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
1492
+ Transaction ID from the DFSP backend, used to
1493
+ reconcile transactions between the Switch and DFSP
1494
+ backend systems.
1502
1495
  to:
1503
1496
  title: Party
1504
1497
  type: object
@@ -1578,7 +1571,7 @@ paths:
1578
1571
  This object represents a Mojaloop API error received
1579
1572
  at any time during the transfer process
1580
1573
  properties: *ref_26
1581
- required: &ref_86
1574
+ required: &ref_87
1582
1575
  - homeTransactionId
1583
1576
  - to
1584
1577
  - amountType
@@ -1601,18 +1594,19 @@ paths:
1601
1594
  content: &ref_41
1602
1595
  application/json:
1603
1596
  schema:
1604
- allOf: &ref_91
1597
+ allOf: &ref_92
1605
1598
  - type: object
1606
1599
  properties: *ref_22
1607
1600
  - type: object
1608
1601
  required:
1609
- - bulkTansferState
1602
+ - bulkTransferState
1610
1603
  properties:
1611
1604
  bulkTransferState:
1612
1605
  type: object
1613
1606
  required: &ref_39
1614
1607
  - bulkTransferId
1615
1608
  - individualTransferResults
1609
+ - currentState
1616
1610
  properties: &ref_40
1617
1611
  bulkTransferId:
1618
1612
  title: CorrelationId
@@ -1699,14 +1693,19 @@ paths:
1699
1693
  deployment.
1700
1694
  properties: *ref_10
1701
1695
  required: *ref_11
1696
+ currentState:
1697
+ type: string
1698
+ enum: &ref_43
1699
+ - ERROR_OCCURRED
1700
+ - COMPLETED
1702
1701
  individualTransferResults:
1703
1702
  type: array
1704
1703
  maxItems: 1000
1705
1704
  items:
1706
1705
  type: object
1707
- required: &ref_89
1706
+ required: &ref_90
1708
1707
  - transferId
1709
- properties: &ref_90
1708
+ properties: &ref_91
1710
1709
  transferId:
1711
1710
  title: CorrelationId
1712
1711
  type: string
@@ -1827,21 +1826,11 @@ paths:
1827
1826
  accepting party or quote.
1828
1827
  properties: &ref_30
1829
1828
  homeTransactionId:
1830
- title: CorrelationId
1831
1829
  type: string
1832
- pattern: >-
1833
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1834
1830
  description: >-
1835
- Identifier that correlates all messages of the
1836
- same sequence. The API data type UUID
1837
- (Universally Unique Identifier) is a JSON
1838
- String in canonical format, conforming to [RFC
1839
- 4122](https://tools.ietf.org/html/rfc4122),
1840
- that is restricted by a regular expression for
1841
- interoperability reasons. A UUID is always 36
1842
- characters long, 32 hexadecimal symbols and 4
1843
- dashes (‘-‘).
1844
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
1831
+ Transaction ID from the DFSP backend, used to
1832
+ reconcile transactions between the Switch and
1833
+ DFSP backend systems.
1845
1834
  transactionId:
1846
1835
  title: CorrelationId
1847
1836
  type: string
@@ -1904,7 +1893,7 @@ paths:
1904
1893
  application/json:
1905
1894
  schema:
1906
1895
  oneOf:
1907
- - allOf: &ref_93
1896
+ - allOf: &ref_94
1908
1897
  - type: object
1909
1898
  properties: *ref_22
1910
1899
  - type: object
@@ -1924,7 +1913,7 @@ paths:
1924
1913
  This object represents a Mojaloop API error
1925
1914
  received at any time during the party
1926
1915
  discovery process
1927
- properties: &ref_92
1916
+ properties: &ref_93
1928
1917
  httpStatusCode:
1929
1918
  type: integer
1930
1919
  description: >-
@@ -1940,7 +1929,7 @@ paths:
1940
1929
  the underlying Mojaloop API error object.
1941
1930
  type: object
1942
1931
  properties: *ref_36
1943
- - allOf: &ref_94
1932
+ - allOf: &ref_95
1944
1933
  - type: object
1945
1934
  properties: *ref_22
1946
1935
  - type: object
@@ -1959,7 +1948,7 @@ paths:
1959
1948
  description: >-
1960
1949
  This object represents a Mojaloop API error
1961
1950
  received at any time during the quote process
1962
- properties: &ref_45
1951
+ properties: &ref_46
1963
1952
  httpStatusCode:
1964
1953
  type: integer
1965
1954
  description: >-
@@ -1996,11 +1985,11 @@ paths:
1996
1985
  application/json:
1997
1986
  schema:
1998
1987
  type: object
1999
- required: &ref_97
1988
+ required: &ref_98
2000
1989
  - homeTransactionId
2001
1990
  - from
2002
1991
  - individualTransfers
2003
- properties: &ref_98
1992
+ properties: &ref_99
2004
1993
  homeTransactionId:
2005
1994
  type: string
2006
1995
  description: >-
@@ -2033,7 +2022,7 @@ paths:
2033
2022
  title: IndividualTransfer
2034
2023
  type: object
2035
2024
  description: Data model for the complex type 'individualTransfer'.
2036
- properties: &ref_95
2025
+ properties: &ref_96
2037
2026
  transferId:
2038
2027
  title: CorrelationId
2039
2028
  type: string
@@ -2115,7 +2104,7 @@ paths:
2115
2104
  optional list of extensions, specific to deployment.
2116
2105
  properties: *ref_10
2117
2106
  required: *ref_11
2118
- required: &ref_96
2107
+ required: &ref_97
2119
2108
  - transferId
2120
2109
  - to
2121
2110
  - amountType
@@ -2205,9 +2194,7 @@ paths:
2205
2194
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
2206
2195
  currentState:
2207
2196
  type: string
2208
- enum: &ref_99
2209
- - ERROR_OCCURRED
2210
- - COMPLETED
2197
+ enum: *ref_43
2211
2198
  fulfils:
2212
2199
  type: array
2213
2200
  minItems: 1
@@ -2293,7 +2280,7 @@ paths:
2293
2280
  title: IndividualQuote
2294
2281
  type: object
2295
2282
  description: Data model for the complex type 'individualQuote'.
2296
- properties: &ref_49
2283
+ properties: &ref_50
2297
2284
  quoteId:
2298
2285
  title: CorrelationId
2299
2286
  type: string
@@ -2375,12 +2362,13 @@ paths:
2375
2362
  optional list of extensions, specific to deployment.
2376
2363
  properties: *ref_10
2377
2364
  required: *ref_11
2378
- required: &ref_50
2365
+ required: &ref_51
2379
2366
  - quoteId
2380
2367
  - to
2381
2368
  - amountType
2382
2369
  - currency
2383
2370
  - transactionType
2371
+ - amount
2384
2372
  extensions:
2385
2373
  title: ExtensionList
2386
2374
  type: object
@@ -2397,10 +2385,11 @@ paths:
2397
2385
  application/json:
2398
2386
  schema:
2399
2387
  type: object
2400
- required: &ref_46
2388
+ required: &ref_47
2401
2389
  - bulkQuoteId
2402
2390
  - individualQuoteResults
2403
- properties: &ref_47
2391
+ - currentState
2392
+ properties: &ref_48
2404
2393
  bulkQuoteId:
2405
2394
  title: CorrelationId
2406
2395
  type: string
@@ -2446,6 +2435,9 @@ paths:
2446
2435
  list of extensions, specific to deployment.
2447
2436
  properties: *ref_10
2448
2437
  required: *ref_11
2438
+ currentState:
2439
+ type: string
2440
+ enum: *ref_43
2449
2441
  individualQuoteResults:
2450
2442
  type: array
2451
2443
  maxItems: 1000
@@ -2499,8 +2491,8 @@ paths:
2499
2491
  Data model for the complex type GeoCode. Indicates
2500
2492
  the geographic location from where the transaction
2501
2493
  was initiated.
2502
- properties: *ref_43
2503
- required: *ref_44
2494
+ properties: *ref_44
2495
+ required: *ref_45
2504
2496
  ilpPacket:
2505
2497
  title: IlpPacket
2506
2498
  type: string
@@ -2533,10 +2525,10 @@ paths:
2533
2525
  This object represents a Mojaloop API error received
2534
2526
  at any time during the quote process
2535
2527
  type: object
2536
- properties: *ref_45
2528
+ properties: *ref_46
2537
2529
  required: &ref_106
2530
+ - quoteId
2538
2531
  - transferAmount
2539
- - expiration
2540
2532
  - ilpPacket
2541
2533
  - condition
2542
2534
  description: >-
@@ -2547,7 +2539,7 @@ paths:
2547
2539
  content: &ref_147
2548
2540
  application/json:
2549
2541
  schema:
2550
- allOf: &ref_48
2542
+ allOf: &ref_49
2551
2543
  - type: object
2552
2544
  properties: *ref_22
2553
2545
  - type: object
@@ -2556,20 +2548,20 @@ paths:
2556
2548
  properties:
2557
2549
  bulkQuoteState:
2558
2550
  type: object
2559
- required: *ref_46
2560
- properties: *ref_47
2551
+ required: *ref_47
2552
+ properties: *ref_48
2561
2553
  '500':
2562
2554
  description: An error occurred processing the bulk quote
2563
2555
  content: &ref_148
2564
2556
  application/json:
2565
2557
  schema:
2566
- allOf: *ref_48
2558
+ allOf: *ref_49
2567
2559
  '504':
2568
2560
  description: Timeout occurred processing the bulk quote
2569
2561
  content: &ref_149
2570
2562
  application/json:
2571
2563
  schema:
2572
- allOf: *ref_48
2564
+ allOf: *ref_49
2573
2565
  /bulkQuotes/{bulkQuoteId}:
2574
2566
  get:
2575
2567
  summary: Retrieves information for a specific bulk quote
@@ -2641,8 +2633,8 @@ paths:
2641
2633
  title: IndividualQuote
2642
2634
  type: object
2643
2635
  description: Data model for the complex type 'individualQuote'.
2644
- properties: *ref_49
2645
- required: *ref_50
2636
+ properties: *ref_50
2637
+ required: *ref_51
2646
2638
  '500':
2647
2639
  description: An error occurred processing the bulk quote
2648
2640
  content:
@@ -2736,7 +2728,7 @@ paths:
2736
2728
  title: TransactionType
2737
2729
  type: object
2738
2730
  description: Data model for the complex type TransactionType.
2739
- properties: &ref_53
2731
+ properties: &ref_54
2740
2732
  scenario:
2741
2733
  title: TransactionScenario
2742
2734
  type: string
@@ -2785,7 +2777,7 @@ paths:
2785
2777
  initiator:
2786
2778
  title: TransactionInitiator
2787
2779
  type: string
2788
- enum: &ref_52
2780
+ enum: &ref_53
2789
2781
  - PAYER
2790
2782
  - PAYEE
2791
2783
  description: >-
@@ -2804,7 +2796,7 @@ paths:
2804
2796
  initiatorType:
2805
2797
  title: TransactionInitiatorType
2806
2798
  type: string
2807
- enum: *ref_51
2799
+ enum: *ref_52
2808
2800
  description: >-
2809
2801
  Below are the allowed values for the enumeration.
2810
2802
 
@@ -2859,14 +2851,14 @@ paths:
2859
2851
  only. Negative numbers are not allowed. A leading zero
2860
2852
  is not allowed.
2861
2853
  example: '123'
2862
- required: &ref_54
2854
+ required: &ref_55
2863
2855
  - scenario
2864
2856
  - initiator
2865
2857
  - initiatorType
2866
2858
  initiator:
2867
2859
  title: TransactionInitiator
2868
2860
  type: string
2869
- enum: *ref_52
2861
+ enum: *ref_53
2870
2862
  description: >-
2871
2863
  Below are the allowed values for the enumeration.
2872
2864
 
@@ -2883,7 +2875,7 @@ paths:
2883
2875
  initiatorType:
2884
2876
  title: TransactionInitiatorType
2885
2877
  type: string
2886
- enum: *ref_51
2878
+ enum: *ref_52
2887
2879
  description: |-
2888
2880
  Below are the allowed values for the enumeration.
2889
2881
  - CONSUMER - Consumer is the initiator of the transaction.
@@ -2977,12 +2969,12 @@ paths:
2977
2969
  title: TransactionType
2978
2970
  type: object
2979
2971
  description: Data model for the complex type TransactionType.
2980
- properties: *ref_53
2981
- required: *ref_54
2972
+ properties: *ref_54
2973
+ required: *ref_55
2982
2974
  initiator:
2983
2975
  title: TransactionInitiator
2984
2976
  type: string
2985
- enum: *ref_52
2977
+ enum: *ref_53
2986
2978
  description: >-
2987
2979
  Below are the allowed values for the enumeration.
2988
2980
 
@@ -2999,7 +2991,7 @@ paths:
2999
2991
  initiatorType:
3000
2992
  title: TransactionInitiatorType
3001
2993
  type: string
3002
- enum: *ref_51
2994
+ enum: *ref_52
3003
2995
  description: |-
3004
2996
  Below are the allowed values for the enumeration.
3005
2997
  - CONSUMER - Consumer is the initiator of the transaction.
@@ -3161,12 +3153,12 @@ paths:
3161
3153
  title: TransactionType
3162
3154
  type: object
3163
3155
  description: Data model for the complex type TransactionType.
3164
- properties: *ref_53
3165
- required: *ref_54
3156
+ properties: *ref_54
3157
+ required: *ref_55
3166
3158
  initiator:
3167
3159
  title: TransactionInitiator
3168
3160
  type: string
3169
- enum: *ref_52
3161
+ enum: *ref_53
3170
3162
  description: >-
3171
3163
  Below are the allowed values for the enumeration.
3172
3164
 
@@ -3183,7 +3175,7 @@ paths:
3183
3175
  initiatorType:
3184
3176
  title: TransactionInitiatorType
3185
3177
  type: string
3186
- enum: *ref_51
3178
+ enum: *ref_52
3187
3179
  description: |-
3188
3180
  Below are the allowed values for the enumeration.
3189
3181
  - CONSUMER - Consumer is the initiator of the transaction.
@@ -3318,8 +3310,8 @@ paths:
3318
3310
  title: QuotesIDPutResponse
3319
3311
  type: object
3320
3312
  description: The object sent in the PUT /quotes/{ID} callback.
3321
- properties: *ref_55
3322
- required: *ref_56
3313
+ properties: *ref_56
3314
+ required: *ref_57
3323
3315
  quoteResponseSource:
3324
3316
  type: string
3325
3317
  description: >
@@ -3436,7 +3428,7 @@ paths:
3436
3428
  application/json:
3437
3429
  schema:
3438
3430
  type: array
3439
- items: &ref_57
3431
+ items: &ref_58
3440
3432
  type: object
3441
3433
  required:
3442
3434
  - idType
@@ -3535,9 +3527,9 @@ paths:
3535
3527
  application/json:
3536
3528
  schema:
3537
3529
  type: object
3538
- required: &ref_58
3530
+ required: &ref_59
3539
3531
  - accounts
3540
- properties: &ref_59
3532
+ properties: &ref_60
3541
3533
  modelId:
3542
3534
  title: CorrelationId
3543
3535
  type: string
@@ -3555,7 +3547,7 @@ paths:
3555
3547
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
3556
3548
  accounts:
3557
3549
  type: array
3558
- items: *ref_57
3550
+ items: *ref_58
3559
3551
  response:
3560
3552
  type: array
3561
3553
  items: &ref_125
@@ -3667,10 +3659,10 @@ paths:
3667
3659
  type: object
3668
3660
  '400':
3669
3661
  description: An error occurred creating accounts
3670
- content: &ref_60
3662
+ content: &ref_61
3671
3663
  application/json:
3672
3664
  schema:
3673
- allOf: &ref_61
3665
+ allOf: &ref_62
3674
3666
  - type: object
3675
3667
  properties: *ref_22
3676
3668
  - type: object
@@ -3679,23 +3671,23 @@ paths:
3679
3671
  properties:
3680
3672
  executionState:
3681
3673
  type: object
3682
- required: *ref_58
3683
- properties: *ref_59
3674
+ required: *ref_59
3675
+ properties: *ref_60
3684
3676
  '500':
3685
3677
  description: An error occurred creating accounts
3686
- content: *ref_60
3678
+ content: *ref_61
3687
3679
  '504':
3688
3680
  description: Timeout occurred creating accounts
3689
3681
  content: &ref_154
3690
3682
  application/json:
3691
3683
  schema:
3692
- allOf: *ref_61
3684
+ allOf: *ref_62
3693
3685
  /parties/{Type}/{ID}:
3694
3686
  parameters:
3695
3687
  - name: Type
3696
3688
  in: path
3697
3689
  required: true
3698
- schema: &ref_64
3690
+ schema: &ref_65
3699
3691
  type: string
3700
3692
  description: >-
3701
3693
  The type of the party identifier. For example, `MSISDN`,
@@ -3703,7 +3695,7 @@ paths:
3703
3695
  - name: ID
3704
3696
  in: path
3705
3697
  required: true
3706
- schema: &ref_65
3698
+ schema: &ref_66
3707
3699
  type: string
3708
3700
  description: The identifier value.
3709
3701
  get:
@@ -3719,7 +3711,7 @@ paths:
3719
3711
  responses:
3720
3712
  '200':
3721
3713
  description: PartiesByIdSuccess
3722
- content: &ref_66
3714
+ content: &ref_67
3723
3715
  application/json:
3724
3716
  schema:
3725
3717
  title: partiesByIdResponse
@@ -3741,7 +3733,7 @@ paths:
3741
3733
  - headers
3742
3734
  currentState:
3743
3735
  type: string
3744
- enum: &ref_68
3736
+ enum: &ref_69
3745
3737
  - WAITING_FOR_ACTION
3746
3738
  - COMPLETED
3747
3739
  - ERROR_OCCURRED
@@ -3750,7 +3742,7 @@ paths:
3750
3742
  - currentState
3751
3743
  '404':
3752
3744
  description: PartiesByIdError404
3753
- content: &ref_67
3745
+ content: &ref_68
3754
3746
  application/json:
3755
3747
  schema:
3756
3748
  type: object
@@ -3759,21 +3751,21 @@ paths:
3759
3751
  title: ErrorInformation
3760
3752
  type: object
3761
3753
  description: Data model for the complex type ErrorInformation.
3762
- properties: *ref_62
3763
- required: *ref_63
3754
+ properties: *ref_63
3755
+ required: *ref_64
3764
3756
  /parties/{Type}/{ID}/{SubId}:
3765
3757
  parameters:
3766
3758
  - name: Type
3767
3759
  in: path
3768
3760
  required: true
3769
- schema: *ref_64
3761
+ schema: *ref_65
3770
3762
  description: >-
3771
3763
  The type of the party identifier. For example, `MSISDN`,
3772
3764
  `PERSONAL_ID`.
3773
3765
  - name: ID
3774
3766
  in: path
3775
3767
  required: true
3776
- schema: *ref_65
3768
+ schema: *ref_66
3777
3769
  description: The identifier value.
3778
3770
  - name: SubId
3779
3771
  in: path
@@ -3796,10 +3788,10 @@ paths:
3796
3788
  responses:
3797
3789
  '200':
3798
3790
  description: PartiesByIdSuccess
3799
- content: *ref_66
3791
+ content: *ref_67
3800
3792
  '404':
3801
3793
  description: PartiesByIdError404
3802
- content: *ref_67
3794
+ content: *ref_68
3803
3795
  /quotes:
3804
3796
  post:
3805
3797
  summary: Quotes endpoint
@@ -3915,8 +3907,8 @@ paths:
3915
3907
  title: TransactionType
3916
3908
  type: object
3917
3909
  description: Data model for the complex type TransactionType.
3918
- properties: *ref_53
3919
- required: *ref_54
3910
+ properties: *ref_54
3911
+ required: *ref_55
3920
3912
  geoCode:
3921
3913
  title: GeoCode
3922
3914
  type: object
@@ -3924,8 +3916,8 @@ paths:
3924
3916
  Data model for the complex type GeoCode. Indicates the
3925
3917
  geographic location from where the transaction was
3926
3918
  initiated.
3927
- properties: *ref_43
3928
- required: *ref_44
3919
+ properties: *ref_44
3920
+ required: *ref_45
3929
3921
  note:
3930
3922
  title: Note
3931
3923
  type: string
@@ -4026,8 +4018,8 @@ paths:
4026
4018
  Data model for the complex type GeoCode. Indicates
4027
4019
  the geographic location from where the transaction
4028
4020
  was initiated.
4029
- properties: *ref_43
4030
- required: *ref_44
4021
+ properties: *ref_44
4022
+ required: *ref_45
4031
4023
  ilpPacket:
4032
4024
  title: IlpPacket
4033
4025
  type: string
@@ -4068,7 +4060,7 @@ paths:
4068
4060
  - headers
4069
4061
  currentState:
4070
4062
  type: string
4071
- enum: *ref_68
4063
+ enum: *ref_69
4072
4064
  required: &ref_134
4073
4065
  - quotes
4074
4066
  - currentState
@@ -4219,7 +4211,7 @@ paths:
4219
4211
  - headers
4220
4212
  currentState:
4221
4213
  type: string
4222
- enum: *ref_68
4214
+ enum: *ref_69
4223
4215
  required: &ref_141
4224
4216
  - transfer
4225
4217
  - currentState
@@ -4237,7 +4229,7 @@ components:
4237
4229
  TransactionInitiatorType:
4238
4230
  title: TransactionInitiatorType
4239
4231
  type: string
4240
- enum: *ref_51
4232
+ enum: *ref_52
4241
4233
  description: |-
4242
4234
  Below are the allowed values for the enumeration.
4243
4235
  - CONSUMER - Consumer is the initiator of the transaction.
@@ -4457,8 +4449,8 @@ components:
4457
4449
  example: Note sent to Payee.
4458
4450
  transferRequest:
4459
4451
  type: object
4460
- required: *ref_69
4461
- properties: *ref_70
4452
+ required: *ref_70
4453
+ properties: *ref_71
4462
4454
  CorrelationId:
4463
4455
  title: CorrelationId
4464
4456
  type: string
@@ -4520,8 +4512,8 @@ components:
4520
4512
  description: >-
4521
4513
  Data model for the complex type GeoCode. Indicates the geographic
4522
4514
  location from where the transaction was initiated.
4523
- properties: *ref_43
4524
- required: *ref_44
4515
+ properties: *ref_44
4516
+ required: *ref_45
4525
4517
  IlpPacket:
4526
4518
  title: IlpPacket
4527
4519
  type: string
@@ -4549,8 +4541,8 @@ components:
4549
4541
  title: QuotesIDPutResponse
4550
4542
  type: object
4551
4543
  description: The object sent in the PUT /quotes/{ID} callback.
4552
- properties: *ref_55
4553
- required: *ref_56
4544
+ properties: *ref_56
4545
+ required: *ref_57
4554
4546
  IlpFulfilment:
4555
4547
  title: IlpFulfilment
4556
4548
  type: string
@@ -4603,8 +4595,8 @@ components:
4603
4595
  title: ErrorInformation
4604
4596
  type: object
4605
4597
  description: Data model for the complex type ErrorInformation.
4606
- properties: *ref_62
4607
- required: *ref_63
4598
+ properties: *ref_63
4599
+ required: *ref_64
4608
4600
  mojaloopError:
4609
4601
  type: object
4610
4602
  properties: *ref_36
@@ -4625,8 +4617,8 @@ components:
4625
4617
  allOf: *ref_14
4626
4618
  transferStatusResponse:
4627
4619
  type: object
4628
- required: *ref_71
4629
- properties: *ref_72
4620
+ required: *ref_72
4621
+ properties: *ref_73
4630
4622
  transferContinuationAcceptParty:
4631
4623
  type: object
4632
4624
  required: *ref_28
@@ -4637,28 +4629,28 @@ components:
4637
4629
  properties: *ref_33
4638
4630
  autoAcceptPartyOption:
4639
4631
  type: object
4640
- required: *ref_73
4641
- properties: *ref_74
4632
+ required: *ref_74
4633
+ properties: *ref_75
4642
4634
  bulkPerTransferFeeLimit:
4643
4635
  type: object
4644
- required: *ref_75
4645
- properties: *ref_76
4636
+ required: *ref_76
4637
+ properties: *ref_77
4646
4638
  autoAcceptQuote:
4647
4639
  type: object
4648
- required: *ref_77
4649
- properties: *ref_78
4640
+ required: *ref_78
4641
+ properties: *ref_79
4650
4642
  bulkTransactionOptions:
4651
4643
  type: object
4652
- required: *ref_79
4653
- properties: *ref_80
4644
+ required: *ref_80
4645
+ properties: *ref_81
4654
4646
  PartyIdInfo:
4655
4647
  title: PartyIdInfo
4656
4648
  type: object
4657
4649
  description: >-
4658
4650
  Data model for the complex type PartyIdInfo. An ExtensionList element
4659
4651
  has been added to this reqeust in version v1.1
4660
- properties: *ref_81
4661
- required: *ref_82
4652
+ properties: *ref_82
4653
+ required: *ref_83
4662
4654
  PartyName:
4663
4655
  title: PartyName
4664
4656
  type: string
@@ -4669,39 +4661,42 @@ components:
4669
4661
  title: PartyComplexName
4670
4662
  type: object
4671
4663
  description: Data model for the complex type PartyComplexName.
4672
- properties: *ref_83
4664
+ properties: *ref_84
4673
4665
  PartyPersonalInfo:
4674
4666
  title: PartyPersonalInfo
4675
4667
  type: object
4676
4668
  description: Data model for the complex type PartyPersonalInfo.
4677
- properties: *ref_84
4669
+ properties: *ref_85
4678
4670
  Party:
4679
4671
  title: Party
4680
4672
  type: object
4681
4673
  description: Data model for the complex type Party.
4682
4674
  properties: *ref_24
4683
4675
  required: *ref_25
4684
- individualTransaction:
4685
- title: IndividualTransaction
4676
+ bulkTransactionIndividualTransfer:
4677
+ title: BulkTransactionIndividualTransfer
4686
4678
  type: object
4687
- description: Data model for the complex type 'individualTransaction'.
4688
- properties: *ref_85
4689
- required: *ref_86
4679
+ description: Data model for the complex type 'bulkTransactionIndividualTransfer'.
4680
+ properties: *ref_86
4681
+ required: *ref_87
4690
4682
  bulkTransactionRequest:
4691
4683
  type: object
4692
- required: *ref_87
4693
- properties: *ref_88
4684
+ required: *ref_88
4685
+ properties: *ref_89
4686
+ bulkTransferStatus:
4687
+ type: string
4688
+ enum: *ref_43
4694
4689
  individualTransferResult:
4695
4690
  type: object
4696
- required: *ref_89
4697
- properties: *ref_90
4691
+ required: *ref_90
4692
+ properties: *ref_91
4698
4693
  bulkTransferResponse:
4699
4694
  type: object
4700
4695
  required: *ref_39
4701
4696
  properties: *ref_40
4702
4697
  bulkTransferErrorResponse:
4703
- allOf: *ref_91
4704
- individualTransactionAccept:
4698
+ allOf: *ref_92
4699
+ bulkTransactionIndividualTransferAccept:
4705
4700
  type: object
4706
4701
  description: Data model for the 'individualTransfer' while accepting party or quote.
4707
4702
  properties: *ref_30
@@ -4725,30 +4720,27 @@ components:
4725
4720
  description: >-
4726
4721
  This object represents a Mojaloop API error received at any time during
4727
4722
  the party discovery process
4728
- properties: *ref_92
4723
+ properties: *ref_93
4729
4724
  bulkTransactionAcceptPartyErrorResponse:
4730
- allOf: *ref_93
4725
+ allOf: *ref_94
4731
4726
  quoteError:
4732
4727
  type: object
4733
4728
  description: >-
4734
4729
  This object represents a Mojaloop API error received at any time during
4735
4730
  the quote process
4736
- properties: *ref_45
4731
+ properties: *ref_46
4737
4732
  bulkTransactionAcceptQuoteErrorResponse:
4738
- allOf: *ref_94
4733
+ allOf: *ref_95
4739
4734
  individualTransfer:
4740
4735
  title: IndividualTransfer
4741
4736
  type: object
4742
4737
  description: Data model for the complex type 'individualTransfer'.
4743
- properties: *ref_95
4744
- required: *ref_96
4738
+ properties: *ref_96
4739
+ required: *ref_97
4745
4740
  bulkTransferRequest:
4746
4741
  type: object
4747
- required: *ref_97
4748
- properties: *ref_98
4749
- bulkTransferStatus:
4750
- type: string
4751
- enum: *ref_99
4742
+ required: *ref_98
4743
+ properties: *ref_99
4752
4744
  individualTransferFulfilment:
4753
4745
  type: object
4754
4746
  description: >-
@@ -4763,8 +4755,8 @@ components:
4763
4755
  title: IndividualQuote
4764
4756
  type: object
4765
4757
  description: Data model for the complex type 'individualQuote'.
4766
- properties: *ref_49
4767
- required: *ref_50
4758
+ properties: *ref_50
4759
+ required: *ref_51
4768
4760
  bulkQuoteRequest:
4769
4761
  type: object
4770
4762
  required: *ref_103
@@ -4775,10 +4767,10 @@ components:
4775
4767
  required: *ref_106
4776
4768
  bulkQuoteResponse:
4777
4769
  type: object
4778
- required: *ref_46
4779
- properties: *ref_47
4770
+ required: *ref_47
4771
+ properties: *ref_48
4780
4772
  bulkQuoteErrorResponse:
4781
- allOf: *ref_48
4773
+ allOf: *ref_49
4782
4774
  bulkQuoteStatus:
4783
4775
  type: string
4784
4776
  enum: *ref_107
@@ -4825,7 +4817,7 @@ components:
4825
4817
  TransactionInitiator:
4826
4818
  title: TransactionInitiator
4827
4819
  type: string
4828
- enum: *ref_52
4820
+ enum: *ref_53
4829
4821
  description: >-
4830
4822
  Below are the allowed values for the enumeration.
4831
4823
 
@@ -4865,8 +4857,8 @@ components:
4865
4857
  title: TransactionType
4866
4858
  type: object
4867
4859
  description: Data model for the complex type TransactionType.
4868
- properties: *ref_53
4869
- required: *ref_54
4860
+ properties: *ref_54
4861
+ required: *ref_55
4870
4862
  requestToPayRequest:
4871
4863
  type: object
4872
4864
  required: *ref_113
@@ -4910,7 +4902,7 @@ components:
4910
4902
  properties: *ref_124
4911
4903
  accountsRequest:
4912
4904
  type: array
4913
- items: *ref_57
4905
+ items: *ref_58
4914
4906
  accountCreationStatus:
4915
4907
  type: array
4916
4908
  items: *ref_125
@@ -4919,13 +4911,13 @@ components:
4919
4911
  enum: *ref_126
4920
4912
  accountsResponse:
4921
4913
  type: object
4922
- required: *ref_58
4923
- properties: *ref_59
4914
+ required: *ref_59
4915
+ properties: *ref_60
4924
4916
  errorAccountsResponse:
4925
- allOf: *ref_61
4917
+ allOf: *ref_62
4926
4918
  async2SyncCurrentState:
4927
4919
  type: string
4928
- enum: *ref_68
4920
+ enum: *ref_69
4929
4921
  partiesByIdResponse:
4930
4922
  title: partiesByIdResponse
4931
4923
  type: object
@@ -5021,16 +5013,16 @@ components:
5021
5013
  content: *ref_153
5022
5014
  accountsCreationError:
5023
5015
  description: An error occurred creating accounts
5024
- content: *ref_60
5016
+ content: *ref_61
5025
5017
  accountsCreationTimeout:
5026
5018
  description: Timeout occurred creating accounts
5027
5019
  content: *ref_154
5028
5020
  partiesByIdSuccess:
5029
5021
  description: PartiesByIdSuccess
5030
- content: *ref_66
5022
+ content: *ref_67
5031
5023
  partiesByIdError404:
5032
5024
  description: PartiesByIdError404
5033
- content: *ref_67
5025
+ content: *ref_68
5034
5026
  quotesPostSuccess:
5035
5027
  description: sync response from POST /quotes
5036
5028
  content: *ref_155
@@ -5088,13 +5080,13 @@ components:
5088
5080
  name: Type
5089
5081
  in: path
5090
5082
  required: true
5091
- schema: *ref_64
5083
+ schema: *ref_65
5092
5084
  description: The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`.
5093
5085
  ID:
5094
5086
  name: ID
5095
5087
  in: path
5096
5088
  required: true
5097
- schema: *ref_65
5089
+ schema: *ref_66
5098
5090
  description: The identifier value.
5099
5091
  SubId:
5100
5092
  name: SubId