@mojaloop/api-snippets 17.0.1 → 17.0.2-snapshot.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 (20) hide show
  1. package/docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml +71 -0
  2. package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml +40 -8
  3. package/lib/sdk-scheme-adapter/v2_0_0/backend/json-schemas.json +84 -0
  4. package/lib/sdk-scheme-adapter/v2_0_0/backend/openapi.d.ts +114 -0
  5. package/lib/sdk-scheme-adapter/v2_0_0/backend/schemas.d.ts +84 -0
  6. package/lib/sdk-scheme-adapter/v2_0_0/backend/schemas.js +1 -0
  7. package/lib/sdk-scheme-adapter/v2_0_0/backend/schemas.js.map +1 -1
  8. package/lib/sdk-scheme-adapter/v2_0_0/backend/types.d.ts +1 -0
  9. package/lib/sdk-scheme-adapter/v2_0_0/outbound/json-schemas.json +63 -7
  10. package/lib/sdk-scheme-adapter/v2_0_0/outbound/openapi.d.ts +186 -6
  11. package/lib/sdk-scheme-adapter/v2_0_0/outbound/schemas.d.ts +63 -7
  12. package/lib/sdk-scheme-adapter/v2_0_0/outbound/schemas.js +1 -1
  13. package/lib/sdk-scheme-adapter/v2_0_0/outbound/schemas.js.map +1 -1
  14. package/lib/sdk-scheme-adapter/v2_0_0/outbound/types.d.ts +1 -1
  15. package/package.json +9 -9
  16. package/sdk-scheme-adapter/v2_0_0/backend/openapi.yaml +20 -1
  17. package/sdk-scheme-adapter/v2_0_0/components/schemas/individualQuote.yaml +2 -0
  18. package/sdk-scheme-adapter/v2_0_0/components/schemas/individualTransfer.yaml +2 -0
  19. package/sdk-scheme-adapter/v2_0_0/components/schemas/transferRequest.yaml +2 -0
  20. package/sdk-scheme-adapter/v2_0_0/components/schemas/transferResponse.yaml +2 -0
package/docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml CHANGED
@@ -360,6 +360,15 @@ paths:
360
360
  pattern: >-
361
361
  ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
362
362
  type: string
363
+ subScenario:
364
+ description: >-
365
+ Possible sub-scenario, defined locally within the
366
+ scheme (UndefinedEnum Type). Based on FSPIOP
367
+ TransactionSubScenario.
368
+ example: LOCALLY_DEFINED_SUBSCENARIO
369
+ pattern: ^[A-Z_]{1,32}$
370
+ title: transactionSubScenario
371
+ type: string
363
372
  to:
364
373
  properties: *ref_1
365
374
  required: *ref_2
@@ -705,6 +714,15 @@ paths:
705
714
  maxLength: 128
706
715
  minLength: 1
707
716
  type: string
717
+ subScenario:
718
+ description: >-
719
+ Possible sub-scenario, defined locally within the
720
+ scheme (UndefinedEnum Type). Based on FSPIOP
721
+ TransactionSubScenario.
722
+ example: LOCALLY_DEFINED_SUBSCENARIO
723
+ pattern: ^[A-Z_]{1,32}$
724
+ title: transactionSubScenario
725
+ type: string
708
726
  to:
709
727
  properties: *ref_1
710
728
  required: *ref_2
@@ -1140,6 +1158,15 @@ paths:
1140
1158
  pattern: >-
1141
1159
  ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1142
1160
  type: string
1161
+ subScenario:
1162
+ description: >-
1163
+ Possible sub-scenario, defined locally within the scheme
1164
+ (UndefinedEnum Type). Based on FSPIOP
1165
+ TransactionSubScenario.
1166
+ example: LOCALLY_DEFINED_SUBSCENARIO
1167
+ pattern: ^[A-Z_]{1,32}$
1168
+ title: transactionSubScenario
1169
+ type: string
1143
1170
  to:
1144
1171
  description: >-
1145
1172
  Information about the Payee in the proposed financial
@@ -1324,6 +1351,15 @@ paths:
1324
1351
  transactionType:
1325
1352
  enum: *ref_11
1326
1353
  type: string
1354
+ subScenario:
1355
+ description: >-
1356
+ Possible sub-scenario, defined locally within the scheme
1357
+ (UndefinedEnum Type). Based on FSPIOP
1358
+ TransactionSubScenario.
1359
+ example: LOCALLY_DEFINED_SUBSCENARIO
1360
+ pattern: ^[A-Z_]{1,32}$
1361
+ title: transactionSubScenario
1362
+ type: string
1327
1363
  required: &ref_71
1328
1364
  - transactionRequestId
1329
1365
  - to
@@ -1737,6 +1773,15 @@ paths:
1737
1773
  enum: &ref_69
1738
1774
  - TRANSFER
1739
1775
  type: string
1776
+ subScenario:
1777
+ description: >-
1778
+ Possible sub-scenario, defined locally within
1779
+ the scheme (UndefinedEnum Type). Based on FSPIOP
1780
+ TransactionSubScenario.
1781
+ example: LOCALLY_DEFINED_SUBSCENARIO
1782
+ pattern: ^[A-Z_]{1,32}$
1783
+ title: transactionSubScenario
1784
+ type: string
1740
1785
  required: &ref_76
1741
1786
  - scenario
1742
1787
  - initiator
@@ -1766,6 +1811,15 @@ paths:
1766
1811
  maxItems: 16
1767
1812
  minItems: 0
1768
1813
  type: array
1814
+ subScenario:
1815
+ description: >-
1816
+ Possible sub-scenario, defined locally within the scheme
1817
+ (UndefinedEnum Type). Based on FSPIOP
1818
+ TransactionSubScenario.
1819
+ example: LOCALLY_DEFINED_SUBSCENARIO
1820
+ pattern: ^[A-Z_]{1,32}$
1821
+ title: transactionSubScenario
1822
+ type: string
1769
1823
  to:
1770
1824
  properties: *ref_1
1771
1825
  required: *ref_2
@@ -1892,6 +1946,15 @@ paths:
1892
1946
  note:
1893
1947
  maxLength: 128
1894
1948
  type: string
1949
+ subScenario:
1950
+ description: >-
1951
+ Possible sub-scenario, defined locally within the scheme
1952
+ (UndefinedEnum Type). Based on FSPIOP
1953
+ TransactionSubScenario.
1954
+ example: LOCALLY_DEFINED_SUBSCENARIO
1955
+ pattern: ^[A-Z_]{1,32}$
1956
+ title: transactionSubScenario
1957
+ type: string
1895
1958
  timestamp:
1896
1959
  description: An ISO-8601 formatted timestamp.
1897
1960
  pattern: >-
@@ -2624,6 +2687,14 @@ components:
2624
2687
  transactionRequestState:
2625
2688
  enum: *ref_74
2626
2689
  type: string
2690
+ transactionSubScenario:
2691
+ description: >-
2692
+ Possible sub-scenario, defined locally within the scheme (UndefinedEnum
2693
+ Type). Based on FSPIOP TransactionSubScenario.
2694
+ example: LOCALLY_DEFINED_SUBSCENARIO
2695
+ pattern: ^[A-Z_]{1,32}$
2696
+ title: transactionSubScenario
2697
+ type: string
2627
2698
  transactionType:
2628
2699
  enum: *ref_11
2629
2700
  type: string
package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml CHANGED
@@ -516,6 +516,14 @@ paths:
516
516
  enum: &ref_5
517
517
  - TRANSFER
518
518
  description: Type of transaction.
519
+ subScenario:
520
+ title: TransactionSubScenario
521
+ type: string
522
+ pattern: ^[A-Z_]{1,32}$
523
+ description: >-
524
+ Possible sub-scenario, defined locally within the scheme
525
+ (UndefinedEnum Type).
526
+ example: LOCALLY_DEFINED_SUBSCENARIO
519
527
  note:
520
528
  title: Note
521
529
  type: string
@@ -630,6 +638,14 @@ paths:
630
638
  type: string
631
639
  enum: *ref_5
632
640
  description: Type of transaction.
641
+ subScenario:
642
+ title: TransactionSubScenario
643
+ type: string
644
+ pattern: ^[A-Z_]{1,32}$
645
+ description: >-
646
+ Possible sub-scenario, defined locally within the scheme
647
+ (UndefinedEnum Type).
648
+ example: LOCALLY_DEFINED_SUBSCENARIO
633
649
  note:
634
650
  title: Note
635
651
  type: string
@@ -2082,6 +2098,14 @@ paths:
2082
2098
  type: string
2083
2099
  enum: *ref_5
2084
2100
  description: Type of transaction.
2101
+ subScenario:
2102
+ title: TransactionSubScenario
2103
+ type: string
2104
+ pattern: ^[A-Z_]{1,32}$
2105
+ description: >-
2106
+ Possible sub-scenario, defined locally within the
2107
+ scheme (UndefinedEnum Type).
2108
+ example: LOCALLY_DEFINED_SUBSCENARIO
2085
2109
  ilpPacket:
2086
2110
  title: IlpPacket
2087
2111
  type: string
@@ -2361,6 +2385,14 @@ paths:
2361
2385
  type: string
2362
2386
  enum: *ref_5
2363
2387
  description: Type of transaction.
2388
+ subScenario:
2389
+ title: TransactionSubScenario
2390
+ type: string
2391
+ pattern: ^[A-Z_]{1,32}$
2392
+ description: >-
2393
+ Possible sub-scenario, defined locally within the
2394
+ scheme (UndefinedEnum Type).
2395
+ example: LOCALLY_DEFINED_SUBSCENARIO
2364
2396
  note:
2365
2397
  title: Note
2366
2398
  type: string
@@ -4455,6 +4487,14 @@ components:
4455
4487
  type: string
4456
4488
  enum: *ref_5
4457
4489
  description: Type of transaction.
4490
+ TransactionSubScenario:
4491
+ title: TransactionSubScenario
4492
+ type: string
4493
+ pattern: ^[A-Z_]{1,32}$
4494
+ description: >-
4495
+ Possible sub-scenario, defined locally within the scheme (UndefinedEnum
4496
+ Type).
4497
+ example: LOCALLY_DEFINED_SUBSCENARIO
4458
4498
  Note:
4459
4499
  title: Note
4460
4500
  type: string
@@ -4821,14 +4861,6 @@ components:
4821
4861
 
4822
4862
  - REFUND - Used for performing a refund of transaction.
4823
4863
  example: DEPOSIT
4824
- TransactionSubScenario:
4825
- title: TransactionSubScenario
4826
- type: string
4827
- pattern: ^[A-Z_]{1,32}$
4828
- description: >-
4829
- Possible sub-scenario, defined locally within the scheme (UndefinedEnum
4830
- Type).
4831
- example: LOCALLY_DEFINED_SUBSCENARIO
4832
4864
  TransactionInitiator:
4833
4865
  title: TransactionInitiator
4834
4866
  type: string
package/lib/sdk-scheme-adapter/v2_0_0/backend/json-schemas.json CHANGED
@@ -489,6 +489,13 @@
489
489
  "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
490
490
  "type": "string"
491
491
  },
492
+ "subScenario": {
493
+ "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.",
494
+ "example": "LOCALLY_DEFINED_SUBSCENARIO",
495
+ "pattern": "^[A-Z_]{1,32}$",
496
+ "title": "transactionSubScenario",
497
+ "type": "string"
498
+ },
492
499
  "to": {
493
500
  "properties": {
494
501
  "dateOfBirth": {
@@ -1730,6 +1737,13 @@
1730
1737
  "minLength": 1,
1731
1738
  "type": "string"
1732
1739
  },
1740
+ "subScenario": {
1741
+ "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.",
1742
+ "example": "LOCALLY_DEFINED_SUBSCENARIO",
1743
+ "pattern": "^[A-Z_]{1,32}$",
1744
+ "title": "transactionSubScenario",
1745
+ "type": "string"
1746
+ },
1733
1747
  "to": {
1734
1748
  "properties": {
1735
1749
  "dateOfBirth": {
@@ -3102,6 +3116,13 @@
3102
3116
  "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
3103
3117
  "type": "string"
3104
3118
  },
3119
+ "subScenario": {
3120
+ "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.",
3121
+ "example": "LOCALLY_DEFINED_SUBSCENARIO",
3122
+ "pattern": "^[A-Z_]{1,32}$",
3123
+ "title": "transactionSubScenario",
3124
+ "type": "string"
3125
+ },
3105
3126
  "to": {
3106
3127
  "properties": {
3107
3128
  "dateOfBirth": {
@@ -5260,6 +5281,13 @@
5260
5281
  "minLength": 1,
5261
5282
  "type": "string"
5262
5283
  },
5284
+ "subScenario": {
5285
+ "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.",
5286
+ "example": "LOCALLY_DEFINED_SUBSCENARIO",
5287
+ "pattern": "^[A-Z_]{1,32}$",
5288
+ "title": "transactionSubScenario",
5289
+ "type": "string"
5290
+ },
5263
5291
  "to": {
5264
5292
  "properties": {
5265
5293
  "dateOfBirth": {
@@ -6667,6 +6695,13 @@
6667
6695
  "TRANSFER"
6668
6696
  ],
6669
6697
  "type": "string"
6698
+ },
6699
+ "subScenario": {
6700
+ "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.",
6701
+ "example": "LOCALLY_DEFINED_SUBSCENARIO",
6702
+ "pattern": "^[A-Z_]{1,32}$",
6703
+ "title": "transactionSubScenario",
6704
+ "type": "string"
6670
6705
  }
6671
6706
  },
6672
6707
  "required": [
@@ -7341,6 +7376,13 @@
7341
7376
  "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
7342
7377
  "type": "string"
7343
7378
  },
7379
+ "subScenario": {
7380
+ "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.",
7381
+ "example": "LOCALLY_DEFINED_SUBSCENARIO",
7382
+ "pattern": "^[A-Z_]{1,32}$",
7383
+ "title": "transactionSubScenario",
7384
+ "type": "string"
7385
+ },
7344
7386
  "to": {
7345
7387
  "description": "Information about the Payee in the proposed financial transaction.",
7346
7388
  "properties": {
@@ -8669,6 +8711,13 @@
8669
8711
  "PAYMENT"
8670
8712
  ],
8671
8713
  "type": "string"
8714
+ },
8715
+ "subScenario": {
8716
+ "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.",
8717
+ "example": "LOCALLY_DEFINED_SUBSCENARIO",
8718
+ "pattern": "^[A-Z_]{1,32}$",
8719
+ "title": "transactionSubScenario",
8720
+ "type": "string"
8672
8721
  }
8673
8722
  },
8674
8723
  "required": [
@@ -8721,6 +8770,13 @@
8721
8770
  ],
8722
8771
  "type": "string"
8723
8772
  },
8773
+ "transactionSubScenario": {
8774
+ "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.",
8775
+ "example": "LOCALLY_DEFINED_SUBSCENARIO",
8776
+ "pattern": "^[A-Z_]{1,32}$",
8777
+ "title": "transactionSubScenario",
8778
+ "type": "string"
8779
+ },
8724
8780
  "transactionType": {
8725
8781
  "enum": [
8726
8782
  "TRANSFER",
@@ -8754,6 +8810,13 @@
8754
8810
  "TRANSFER"
8755
8811
  ],
8756
8812
  "type": "string"
8813
+ },
8814
+ "subScenario": {
8815
+ "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.",
8816
+ "example": "LOCALLY_DEFINED_SUBSCENARIO",
8817
+ "pattern": "^[A-Z_]{1,32}$",
8818
+ "title": "transactionSubScenario",
8819
+ "type": "string"
8757
8820
  }
8758
8821
  },
8759
8822
  "required": [
@@ -9065,6 +9128,13 @@
9065
9128
  "maxLength": 128,
9066
9129
  "type": "string"
9067
9130
  },
9131
+ "subScenario": {
9132
+ "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.",
9133
+ "example": "LOCALLY_DEFINED_SUBSCENARIO",
9134
+ "pattern": "^[A-Z_]{1,32}$",
9135
+ "title": "transactionSubScenario",
9136
+ "type": "string"
9137
+ },
9068
9138
  "timestamp": {
9069
9139
  "description": "An ISO-8601 formatted timestamp.",
9070
9140
  "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$",
@@ -10252,6 +10322,13 @@
10252
10322
  "TRANSFER"
10253
10323
  ],
10254
10324
  "type": "string"
10325
+ },
10326
+ "subScenario": {
10327
+ "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.",
10328
+ "example": "LOCALLY_DEFINED_SUBSCENARIO",
10329
+ "pattern": "^[A-Z_]{1,32}$",
10330
+ "title": "transactionSubScenario",
10331
+ "type": "string"
10255
10332
  }
10256
10333
  },
10257
10334
  "required": [
@@ -11077,6 +11154,13 @@
11077
11154
  "minItems": 0,
11078
11155
  "type": "array"
11079
11156
  },
11157
+ "subScenario": {
11158
+ "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.",
11159
+ "example": "LOCALLY_DEFINED_SUBSCENARIO",
11160
+ "pattern": "^[A-Z_]{1,32}$",
11161
+ "title": "transactionSubScenario",
11162
+ "type": "string"
11163
+ },
11080
11164
  "to": {
11081
11165
  "properties": {
11082
11166
  "dateOfBirth": {
package/lib/sdk-scheme-adapter/v2_0_0/backend/openapi.d.ts CHANGED
@@ -141,6 +141,12 @@ export interface components {
141
141
  note?: string;
142
142
  /** @description A Mojaloop API quote identifier (UUID). */
143
143
  quoteId: string;
144
+ /**
145
+ * transactionSubScenario
146
+ * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.
147
+ * @example LOCALLY_DEFINED_SUBSCENARIO
148
+ */
149
+ subScenario?: string;
144
150
  to: {
145
151
  /** @description Date of birth in the form YYYY-MM-DD. */
146
152
  dateOfBirth?: string;
@@ -220,6 +226,12 @@ export interface components {
220
226
  initiatorType?: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE";
221
227
  /** @description An optional note associated with the quote. */
222
228
  note?: string;
229
+ /**
230
+ * transactionSubScenario
231
+ * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.
232
+ * @example LOCALLY_DEFINED_SUBSCENARIO
233
+ */
234
+ subScenario?: string;
223
235
  to?: {
224
236
  /** @description Date of birth in the form YYYY-MM-DD. */
225
237
  dateOfBirth?: string;
@@ -735,6 +747,12 @@ export interface components {
735
747
  note?: string;
736
748
  /** @description A Mojaloop API quote identifier (UUID). */
737
749
  quoteId: string;
750
+ /**
751
+ * transactionSubScenario
752
+ * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.
753
+ * @example LOCALLY_DEFINED_SUBSCENARIO
754
+ */
755
+ subScenario?: string;
738
756
  to: {
739
757
  /** @description Date of birth in the form YYYY-MM-DD. */
740
758
  dateOfBirth?: string;
@@ -887,6 +905,12 @@ export interface components {
887
905
  initiatorType?: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE";
888
906
  /** @description An optional note associated with the quote. */
889
907
  note?: string;
908
+ /**
909
+ * transactionSubScenario
910
+ * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.
911
+ * @example LOCALLY_DEFINED_SUBSCENARIO
912
+ */
913
+ subScenario?: string;
890
914
  to?: {
891
915
  /** @description Date of birth in the form YYYY-MM-DD. */
892
916
  dateOfBirth?: string;
@@ -1465,6 +1489,12 @@ export interface components {
1465
1489
  initiatorType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE";
1466
1490
  /** @enum {string} */
1467
1491
  scenario: "TRANSFER";
1492
+ /**
1493
+ * transactionSubScenario
1494
+ * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.
1495
+ * @example LOCALLY_DEFINED_SUBSCENARIO
1496
+ */
1497
+ subScenario?: string;
1468
1498
  };
1469
1499
  };
1470
1500
  /** @enum {string} */
@@ -1584,6 +1614,12 @@ export interface components {
1584
1614
  note?: string;
1585
1615
  /** @description A Mojaloop API quote identifier (UUID). */
1586
1616
  quoteId: string;
1617
+ /**
1618
+ * transactionSubScenario
1619
+ * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.
1620
+ * @example LOCALLY_DEFINED_SUBSCENARIO
1621
+ */
1622
+ subScenario?: string;
1587
1623
  /** @description Information about the Payee in the proposed financial transaction. */
1588
1624
  to: {
1589
1625
  /** @description Date of birth in the form YYYY-MM-DD. */
@@ -1752,6 +1788,12 @@ export interface components {
1752
1788
  transactionRequestId: string;
1753
1789
  /** @enum {string} */
1754
1790
  transactionType: "TRANSFER" | "DEPOSIT" | "PAYMENT";
1791
+ /**
1792
+ * transactionSubScenario
1793
+ * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.
1794
+ * @example LOCALLY_DEFINED_SUBSCENARIO
1795
+ */
1796
+ subScenario?: string;
1755
1797
  };
1756
1798
  /** @description A Mojaloop API transaction request identifier (UUID). */
1757
1799
  transactionRequestId: string;
@@ -1766,6 +1808,12 @@ export interface components {
1766
1808
  };
1767
1809
  /** @enum {string} */
1768
1810
  transactionRequestState: "RECEIVED" | "PENDING" | "ACCEPTED" | "REJECTED";
1811
+ /**
1812
+ * transactionSubScenario
1813
+ * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.
1814
+ * @example LOCALLY_DEFINED_SUBSCENARIO
1815
+ */
1816
+ transactionSubScenario: string;
1769
1817
  /** @enum {string} */
1770
1818
  transactionType: "TRANSFER" | "DEPOSIT" | "PAYMENT";
1771
1819
  /** @description Object containing transfer object. */
@@ -1779,6 +1827,12 @@ export interface components {
1779
1827
  initiatorType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE";
1780
1828
  /** @enum {string} */
1781
1829
  scenario: "TRANSFER";
1830
+ /**
1831
+ * transactionSubScenario
1832
+ * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.
1833
+ * @example LOCALLY_DEFINED_SUBSCENARIO
1834
+ */
1835
+ subScenario?: string;
1782
1836
  };
1783
1837
  transferDetailsResponse: {
1784
1838
  amount: string;
@@ -1820,6 +1874,12 @@ export interface components {
1820
1874
  /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
1821
1875
  homeTransactionId: string;
1822
1876
  note?: string;
1877
+ /**
1878
+ * transactionSubScenario
1879
+ * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.
1880
+ * @example LOCALLY_DEFINED_SUBSCENARIO
1881
+ */
1882
+ subScenario?: string;
1823
1883
  /** @description An ISO-8601 formatted timestamp. */
1824
1884
  timestamp: string;
1825
1885
  to: {
@@ -2276,6 +2336,12 @@ export interface components {
2276
2336
  initiatorType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE";
2277
2337
  /** @enum {string} */
2278
2338
  scenario: "TRANSFER";
2339
+ /**
2340
+ * transactionSubScenario
2341
+ * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.
2342
+ * @example LOCALLY_DEFINED_SUBSCENARIO
2343
+ */
2344
+ subScenario?: string;
2279
2345
  };
2280
2346
  };
2281
2347
  };
@@ -2332,6 +2398,12 @@ export interface components {
2332
2398
  key?: string;
2333
2399
  value?: string;
2334
2400
  }[];
2401
+ /**
2402
+ * transactionSubScenario
2403
+ * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.
2404
+ * @example LOCALLY_DEFINED_SUBSCENARIO
2405
+ */
2406
+ subScenario?: string;
2335
2407
  to: {
2336
2408
  /** @description Date of birth in the form YYYY-MM-DD. */
2337
2409
  dateOfBirth?: string;
@@ -2577,6 +2649,12 @@ export interface operations {
2577
2649
  note?: string;
2578
2650
  /** @description A Mojaloop API quote identifier (UUID). */
2579
2651
  quoteId: string;
2652
+ /**
2653
+ * transactionSubScenario
2654
+ * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.
2655
+ * @example LOCALLY_DEFINED_SUBSCENARIO
2656
+ */
2657
+ subScenario?: string;
2580
2658
  to: {
2581
2659
  /** @description Date of birth in the form YYYY-MM-DD. */
2582
2660
  dateOfBirth?: string;
@@ -2897,6 +2975,12 @@ export interface operations {
2897
2975
  initiatorType?: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE";
2898
2976
  /** @description An optional note associated with the quote. */
2899
2977
  note?: string;
2978
+ /**
2979
+ * transactionSubScenario
2980
+ * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.
2981
+ * @example LOCALLY_DEFINED_SUBSCENARIO
2982
+ */
2983
+ subScenario?: string;
2900
2984
  to?: {
2901
2985
  /** @description Date of birth in the form YYYY-MM-DD. */
2902
2986
  dateOfBirth?: string;
@@ -3463,6 +3547,12 @@ export interface operations {
3463
3547
  note?: string;
3464
3548
  /** @description A Mojaloop API quote identifier (UUID). */
3465
3549
  quoteId: string;
3550
+ /**
3551
+ * transactionSubScenario
3552
+ * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.
3553
+ * @example LOCALLY_DEFINED_SUBSCENARIO
3554
+ */
3555
+ subScenario?: string;
3466
3556
  /** @description Information about the Payee in the proposed financial transaction. */
3467
3557
  to: {
3468
3558
  /** @description Date of birth in the form YYYY-MM-DD. */
@@ -3626,6 +3716,12 @@ export interface operations {
3626
3716
  transactionRequestId: string;
3627
3717
  /** @enum {string} */
3628
3718
  transactionType: "TRANSFER" | "DEPOSIT" | "PAYMENT";
3719
+ /**
3720
+ * transactionSubScenario
3721
+ * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.
3722
+ * @example LOCALLY_DEFINED_SUBSCENARIO
3723
+ */
3724
+ subScenario?: string;
3629
3725
  };
3630
3726
  };
3631
3727
  };
@@ -4049,6 +4145,12 @@ export interface operations {
4049
4145
  initiatorType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE";
4050
4146
  /** @enum {string} */
4051
4147
  scenario: "TRANSFER";
4148
+ /**
4149
+ * transactionSubScenario
4150
+ * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.
4151
+ * @example LOCALLY_DEFINED_SUBSCENARIO
4152
+ */
4153
+ subScenario?: string;
4052
4154
  };
4053
4155
  };
4054
4156
  };
@@ -4105,6 +4207,12 @@ export interface operations {
4105
4207
  key?: string;
4106
4208
  value?: string;
4107
4209
  }[];
4210
+ /**
4211
+ * transactionSubScenario
4212
+ * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.
4213
+ * @example LOCALLY_DEFINED_SUBSCENARIO
4214
+ */
4215
+ subScenario?: string;
4108
4216
  to: {
4109
4217
  /** @description Date of birth in the form YYYY-MM-DD. */
4110
4218
  dateOfBirth?: string;
@@ -4191,6 +4299,12 @@ export interface operations {
4191
4299
  /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
4192
4300
  homeTransactionId: string;
4193
4301
  note?: string;
4302
+ /**
4303
+ * transactionSubScenario
4304
+ * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.
4305
+ * @example LOCALLY_DEFINED_SUBSCENARIO
4306
+ */
4307
+ subScenario?: string;
4194
4308
  /** @description An ISO-8601 formatted timestamp. */
4195
4309
  timestamp: string;
4196
4310
  to: {