@mojaloop/api-snippets 17.0.0-snapshot.1 → 17.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.
package/CHANGELOG.md CHANGED
@@ -1,4 +1,15 @@
1
1
  # Changelog: [mojaloop/api-snippets](https://github.com/mojaloop/api-snippets)
2
+ ## [17.0.0](https://github.com/mojaloop/api-snippets/compare/v16.0.6...v17.0.0) (2022-11-11)
3
+
4
+
5
+ ### ⚠ BREAKING CHANGES
6
+
7
+ * **mojaloop/3018:** transferId is now required on bulkTransaction Individual Transfer Accept PUT callback (for both accept parties & quotes), and bulkHomeTransaction, homeTransaction, and transaction Id' have been removed.
8
+
9
+ ### Features
10
+
11
+ * **mojaloop/3018:** [SDK-Scheme-Adapter] TransactionId is being used instead of TransferId ([#148](https://github.com/mojaloop/api-snippets/issues/148)) ([af6c1e2](https://github.com/mojaloop/api-snippets/commit/af6c1e2b39f905f77f5b44f684f8bc99634d6d38))
12
+
2
13
  ### [16.0.6](https://github.com/mojaloop/api-snippets/compare/v16.0.5...v16.0.6) (2022-11-04)
3
14
 
4
15
 
@@ -1299,6 +1299,7 @@ paths:
1299
1299
  title: BulkTransactionResponse
1300
1300
  type: object
1301
1301
  required: &ref_78
1302
+ - bulkHomeTransactionID
1302
1303
  - bulkTransactionId
1303
1304
  - currentState
1304
1305
  - individualTransferResults
@@ -1612,6 +1613,7 @@ paths:
1612
1613
  items:
1613
1614
  type: object
1614
1615
  required: &ref_76
1616
+ - homeTransactionId
1615
1617
  - transferId
1616
1618
  - to
1617
1619
  - amountType
@@ -1169,6 +1169,7 @@ paths:
1169
1169
  type: object
1170
1170
  required: &ref_88
1171
1171
  - bulkTransactionId
1172
+ - bulkHomeTransactionID
1172
1173
  - options
1173
1174
  - from
1174
1175
  - individualTransfers
@@ -1571,6 +1572,7 @@ paths:
1571
1572
  at any time during the transfer process
1572
1573
  properties: *ref_26
1573
1574
  required: &ref_87
1575
+ - homeTransactionId
1574
1576
  - to
1575
1577
  - amountType
1576
1578
  - currency
@@ -1802,12 +1804,6 @@ paths:
1802
1804
  required: &ref_34
1803
1805
  - individualTransfers
1804
1806
  properties: &ref_35
1805
- bulkHomeTransactionID:
1806
- type: string
1807
- description: >-
1808
- Transaction ID from the DFSP backend, used to reconcile
1809
- transactions between the Switch and DFSP backend
1810
- systems.
1811
1807
  individualTransfers:
1812
1808
  description: >-
1813
1809
  List of individual transfers in a bulk transfer with
@@ -1821,28 +1817,6 @@ paths:
1821
1817
  Data model for the 'individualTransfer' while
1822
1818
  accepting party or quote.
1823
1819
  properties: &ref_30
1824
- homeTransactionId:
1825
- type: string
1826
- description: >-
1827
- Transaction ID from the DFSP backend, used to
1828
- reconcile transactions between the Switch and
1829
- DFSP backend systems.
1830
- transactionId:
1831
- title: CorrelationId
1832
- type: string
1833
- pattern: >-
1834
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1835
- description: >-
1836
- Identifier that correlates all messages of the
1837
- same sequence. The API data type UUID
1838
- (Universally Unique Identifier) is a JSON
1839
- String in canonical format, conforming to [RFC
1840
- 4122](https://tools.ietf.org/html/rfc4122),
1841
- that is restricted by a regular expression for
1842
- interoperability reasons. A UUID is always 36
1843
- characters long, 32 hexadecimal symbols and 4
1844
- dashes (‘-‘).
1845
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
1846
1820
  transferId:
1847
1821
  title: CorrelationId
1848
1822
  type: string
@@ -1871,12 +1845,6 @@ paths:
1871
1845
  required: &ref_37
1872
1846
  - individualTransfers
1873
1847
  properties: &ref_38
1874
- bulkHomeTransactionID:
1875
- type: string
1876
- description: >-
1877
- Transaction ID from the DFSP backend, used to reconcile
1878
- transactions between the Switch and DFSP backend
1879
- systems.
1880
1848
  individualTransfers:
1881
1849
  description: List of individual transfers in a bulk transfer.
1882
1850
  type: array
@@ -7683,6 +7683,7 @@
7683
7683
  "bulkTransactionIndividualTransferResult": {
7684
7684
  "type": "object",
7685
7685
  "required": [
7686
+ "homeTransactionId",
7686
7687
  "transferId",
7687
7688
  "to",
7688
7689
  "amountType",
@@ -9191,6 +9192,7 @@
9191
9192
  "title": "BulkTransactionResponse",
9192
9193
  "type": "object",
9193
9194
  "required": [
9195
+ "bulkHomeTransactionID",
9194
9196
  "bulkTransactionId",
9195
9197
  "currentState",
9196
9198
  "individualTransferResults"
@@ -9481,6 +9483,7 @@
9481
9483
  "items": {
9482
9484
  "type": "object",
9483
9485
  "required": [
9486
+ "homeTransactionId",
9484
9487
  "transferId",
9485
9488
  "to",
9486
9489
  "amountType",
@@ -1109,7 +1109,7 @@ export interface paths {
1109
1109
  content: {
1110
1110
  "application/json": {
1111
1111
  /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
1112
- bulkHomeTransactionID?: string;
1112
+ bulkHomeTransactionID: string;
1113
1113
  /**
1114
1114
  * CorrelationId
1115
1115
  * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
@@ -1164,7 +1164,7 @@ export interface paths {
1164
1164
  */
1165
1165
  transferId: string;
1166
1166
  /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
1167
- homeTransactionId?: string;
1167
+ homeTransactionId: string;
1168
1168
  /**
1169
1169
  * CorrelationId
1170
1170
  * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
@@ -3397,7 +3397,7 @@ export interface components {
3397
3397
  */
3398
3398
  transferId: string;
3399
3399
  /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
3400
- homeTransactionId?: string;
3400
+ homeTransactionId: string;
3401
3401
  /**
3402
3402
  * CorrelationId
3403
3403
  * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
@@ -3812,7 +3812,7 @@ export interface components {
3812
3812
  /** BulkTransactionResponse */
3813
3813
  bulkTransactionResponse: {
3814
3814
  /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
3815
- bulkHomeTransactionID?: string;
3815
+ bulkHomeTransactionID: string;
3816
3816
  /**
3817
3817
  * CorrelationId
3818
3818
  * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
@@ -3867,7 +3867,7 @@ export interface components {
3867
3867
  */
3868
3868
  transferId: string;
3869
3869
  /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
3870
- homeTransactionId?: string;
3870
+ homeTransactionId: string;
3871
3871
  /**
3872
3872
  * CorrelationId
3873
3873
  * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
@@ -7464,6 +7464,7 @@
7464
7464
  }
7465
7465
  },
7466
7466
  "required": [
7467
+ "homeTransactionId",
7467
7468
  "to",
7468
7469
  "amountType",
7469
7470
  "currency",
@@ -7474,6 +7475,7 @@
7474
7475
  "type": "object",
7475
7476
  "required": [
7476
7477
  "bulkTransactionId",
7478
+ "bulkHomeTransactionID",
7477
7479
  "options",
7478
7480
  "from",
7479
7481
  "individualTransfers"
@@ -8449,6 +8451,7 @@
8449
8451
  }
8450
8452
  },
8451
8453
  "required": [
8454
+ "homeTransactionId",
8452
8455
  "to",
8453
8456
  "amountType",
8454
8457
  "currency",
@@ -9173,17 +9176,6 @@
9173
9176
  "type": "object",
9174
9177
  "description": "Data model for the 'individualTransfer' while accepting party or quote.",
9175
9178
  "properties": {
9176
- "homeTransactionId": {
9177
- "type": "string",
9178
- "description": "Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems."
9179
- },
9180
- "transactionId": {
9181
- "title": "CorrelationId",
9182
- "type": "string",
9183
- "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
9184
- "description": "Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).",
9185
- "example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
9186
- },
9187
9179
  "transferId": {
9188
9180
  "title": "CorrelationId",
9189
9181
  "type": "string",
@@ -9203,10 +9195,6 @@
9203
9195
  "individualTransfers"
9204
9196
  ],
9205
9197
  "properties": {
9206
- "bulkHomeTransactionID": {
9207
- "type": "string",
9208
- "description": "Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems."
9209
- },
9210
9198
  "individualTransfers": {
9211
9199
  "description": "List of individual transfers in a bulk transfer with accept party information.",
9212
9200
  "type": "array",
@@ -9217,17 +9205,6 @@
9217
9205
  "type": "object",
9218
9206
  "description": "Data model for the 'individualTransfer' while accepting party or quote.",
9219
9207
  "properties": {
9220
- "homeTransactionId": {
9221
- "type": "string",
9222
- "description": "Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems."
9223
- },
9224
- "transactionId": {
9225
- "title": "CorrelationId",
9226
- "type": "string",
9227
- "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
9228
- "description": "Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).",
9229
- "example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
9230
- },
9231
9208
  "transferId": {
9232
9209
  "title": "CorrelationId",
9233
9210
  "type": "string",
@@ -9267,10 +9244,6 @@
9267
9244
  "individualTransfers"
9268
9245
  ],
9269
9246
  "properties": {
9270
- "bulkHomeTransactionID": {
9271
- "type": "string",
9272
- "description": "Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems."
9273
- },
9274
9247
  "individualTransfers": {
9275
9248
  "description": "List of individual transfers in a bulk transfer.",
9276
9249
  "type": "array",
@@ -9281,17 +9254,6 @@
9281
9254
  "type": "object",
9282
9255
  "description": "Data model for the 'individualTransfer' while accepting party or quote.",
9283
9256
  "properties": {
9284
- "homeTransactionId": {
9285
- "type": "string",
9286
- "description": "Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems."
9287
- },
9288
- "transactionId": {
9289
- "title": "CorrelationId",
9290
- "type": "string",
9291
- "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
9292
- "description": "Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).",
9293
- "example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
9294
- },
9295
9257
  "transferId": {
9296
9258
  "title": "CorrelationId",
9297
9259
  "type": "string",
@@ -9436,10 +9398,6 @@
9436
9398
  "individualTransfers"
9437
9399
  ],
9438
9400
  "properties": {
9439
- "bulkHomeTransactionID": {
9440
- "type": "string",
9441
- "description": "Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems."
9442
- },
9443
9401
  "individualTransfers": {
9444
9402
  "description": "List of individual transfers in a bulk transfer with accept party information.",
9445
9403
  "type": "array",
@@ -9450,17 +9408,6 @@
9450
9408
  "type": "object",
9451
9409
  "description": "Data model for the 'individualTransfer' while accepting party or quote.",
9452
9410
  "properties": {
9453
- "homeTransactionId": {
9454
- "type": "string",
9455
- "description": "Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems."
9456
- },
9457
- "transactionId": {
9458
- "title": "CorrelationId",
9459
- "type": "string",
9460
- "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
9461
- "description": "Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).",
9462
- "example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
9463
- },
9464
9411
  "transferId": {
9465
9412
  "title": "CorrelationId",
9466
9413
  "type": "string",
@@ -9693,10 +9640,6 @@
9693
9640
  "individualTransfers"
9694
9641
  ],
9695
9642
  "properties": {
9696
- "bulkHomeTransactionID": {
9697
- "type": "string",
9698
- "description": "Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems."
9699
- },
9700
9643
  "individualTransfers": {
9701
9644
  "description": "List of individual transfers in a bulk transfer.",
9702
9645
  "type": "array",
@@ -9707,17 +9650,6 @@
9707
9650
  "type": "object",
9708
9651
  "description": "Data model for the 'individualTransfer' while accepting party or quote.",
9709
9652
  "properties": {
9710
- "homeTransactionId": {
9711
- "type": "string",
9712
- "description": "Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems."
9713
- },
9714
- "transactionId": {
9715
- "title": "CorrelationId",
9716
- "type": "string",
9717
- "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
9718
- "description": "Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).",
9719
- "example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
9720
- },
9721
9653
  "transferId": {
9722
9654
  "title": "CorrelationId",
9723
9655
  "type": "string",
@@ -4031,7 +4031,7 @@ export interface paths {
4031
4031
  content: {
4032
4032
  "application/json": {
4033
4033
  /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
4034
- bulkHomeTransactionID?: string;
4034
+ bulkHomeTransactionID: string;
4035
4035
  /**
4036
4036
  * CorrelationId
4037
4037
  * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
@@ -4185,7 +4185,7 @@ export interface paths {
4185
4185
  /** @description List of individual transfers in a bulk transfer. */
4186
4186
  individualTransfers: {
4187
4187
  /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
4188
- homeTransactionId?: string;
4188
+ homeTransactionId: string;
4189
4189
  /**
4190
4190
  * Party
4191
4191
  * @description Data model for the complex type Party.
@@ -4451,18 +4451,8 @@ export interface paths {
4451
4451
  message?: string;
4452
4452
  } & {
4453
4453
  bulkTransferState: {
4454
- /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
4455
- bulkHomeTransactionID?: string;
4456
4454
  /** @description List of individual transfers in a bulk transfer with accept party information. */
4457
4455
  individualTransfers: ({
4458
- /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
4459
- homeTransactionId?: string;
4460
- /**
4461
- * CorrelationId
4462
- * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
4463
- * @example b51ec534-ee48-4575-b6a9-ead2955b8069
4464
- */
4465
- transactionId?: string;
4466
4456
  /**
4467
4457
  * CorrelationId
4468
4458
  * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
@@ -4523,18 +4513,8 @@ export interface paths {
4523
4513
  message?: string;
4524
4514
  } & ({
4525
4515
  bulkTransferState?: {
4526
- /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
4527
- bulkHomeTransactionID?: string;
4528
4516
  /** @description List of individual transfers in a bulk transfer. */
4529
4517
  individualTransfers: ({
4530
- /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
4531
- homeTransactionId?: string;
4532
- /**
4533
- * CorrelationId
4534
- * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
4535
- * @example b51ec534-ee48-4575-b6a9-ead2955b8069
4536
- */
4537
- transactionId?: string;
4538
4518
  /**
4539
4519
  * CorrelationId
4540
4520
  * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
@@ -4609,18 +4589,8 @@ export interface paths {
4609
4589
  requestBody: {
4610
4590
  content: {
4611
4591
  "application/json": {
4612
- /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
4613
- bulkHomeTransactionID?: string;
4614
4592
  /** @description List of individual transfers in a bulk transfer with accept party information. */
4615
4593
  individualTransfers: ({
4616
- /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
4617
- homeTransactionId?: string;
4618
- /**
4619
- * CorrelationId
4620
- * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
4621
- * @example b51ec534-ee48-4575-b6a9-ead2955b8069
4622
- */
4623
- transactionId?: string;
4624
4594
  /**
4625
4595
  * CorrelationId
4626
4596
  * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
@@ -4632,18 +4602,8 @@ export interface paths {
4632
4602
  acceptParty: true | false;
4633
4603
  })[];
4634
4604
  } | {
4635
- /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
4636
- bulkHomeTransactionID?: string;
4637
4605
  /** @description List of individual transfers in a bulk transfer. */
4638
4606
  individualTransfers: ({
4639
- /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
4640
- homeTransactionId?: string;
4641
- /**
4642
- * CorrelationId
4643
- * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
4644
- * @example b51ec534-ee48-4575-b6a9-ead2955b8069
4645
- */
4646
- transactionId?: string;
4647
4607
  /**
4648
4608
  * CorrelationId
4649
4609
  * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
@@ -14034,7 +13994,7 @@ export interface components {
14034
13994
  */
14035
13995
  bulkTransactionIndividualTransfer: {
14036
13996
  /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
14037
- homeTransactionId?: string;
13997
+ homeTransactionId: string;
14038
13998
  /**
14039
13999
  * Party
14040
14000
  * @description Data model for the complex type Party.
@@ -14256,7 +14216,7 @@ export interface components {
14256
14216
  };
14257
14217
  bulkTransactionRequest: {
14258
14218
  /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
14259
- bulkHomeTransactionID?: string;
14219
+ bulkHomeTransactionID: string;
14260
14220
  /**
14261
14221
  * CorrelationId
14262
14222
  * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
@@ -14410,7 +14370,7 @@ export interface components {
14410
14370
  /** @description List of individual transfers in a bulk transfer. */
14411
14371
  individualTransfers: {
14412
14372
  /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
14413
- homeTransactionId?: string;
14373
+ homeTransactionId: string;
14414
14374
  /**
14415
14375
  * Party
14416
14376
  * @description Data model for the complex type Party.
@@ -15002,14 +14962,6 @@ export interface components {
15002
14962
  };
15003
14963
  /** @description Data model for the 'individualTransfer' while accepting party or quote. */
15004
14964
  bulkTransactionIndividualTransferAccept: {
15005
- /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
15006
- homeTransactionId?: string;
15007
- /**
15008
- * CorrelationId
15009
- * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
15010
- * @example b51ec534-ee48-4575-b6a9-ead2955b8069
15011
- */
15012
- transactionId?: string;
15013
14965
  /**
15014
14966
  * CorrelationId
15015
14967
  * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
@@ -15019,18 +14971,8 @@ export interface components {
15019
14971
  };
15020
14972
  /** @description The object sent back as confirmation of payee parties when autoAcceptParty is false. */
15021
14973
  bulkTransactionContinuationAcceptParty: {
15022
- /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
15023
- bulkHomeTransactionID?: string;
15024
14974
  /** @description List of individual transfers in a bulk transfer with accept party information. */
15025
14975
  individualTransfers: ({
15026
- /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
15027
- homeTransactionId?: string;
15028
- /**
15029
- * CorrelationId
15030
- * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
15031
- * @example b51ec534-ee48-4575-b6a9-ead2955b8069
15032
- */
15033
- transactionId?: string;
15034
14976
  /**
15035
14977
  * CorrelationId
15036
14978
  * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
@@ -15044,18 +14986,8 @@ export interface components {
15044
14986
  };
15045
14987
  /** @description The object sent back as confirmation of quotes when autoAcceptQuotes is false. */
15046
14988
  bulkTransactionContinuationAcceptQuote: {
15047
- /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
15048
- bulkHomeTransactionID?: string;
15049
14989
  /** @description List of individual transfers in a bulk transfer. */
15050
14990
  individualTransfers: ({
15051
- /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
15052
- homeTransactionId?: string;
15053
- /**
15054
- * CorrelationId
15055
- * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
15056
- * @example b51ec534-ee48-4575-b6a9-ead2955b8069
15057
- */
15058
- transactionId?: string;
15059
14991
  /**
15060
14992
  * CorrelationId
15061
14993
  * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
@@ -15118,18 +15050,8 @@ export interface components {
15118
15050
  message?: string;
15119
15051
  } & {
15120
15052
  bulkTransferState: {
15121
- /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
15122
- bulkHomeTransactionID?: string;
15123
15053
  /** @description List of individual transfers in a bulk transfer with accept party information. */
15124
15054
  individualTransfers: ({
15125
- /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
15126
- homeTransactionId?: string;
15127
- /**
15128
- * CorrelationId
15129
- * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
15130
- * @example b51ec534-ee48-4575-b6a9-ead2955b8069
15131
- */
15132
- transactionId?: string;
15133
15055
  /**
15134
15056
  * CorrelationId
15135
15057
  * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
@@ -15235,18 +15157,8 @@ export interface components {
15235
15157
  message?: string;
15236
15158
  } & ({
15237
15159
  bulkTransferState?: {
15238
- /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
15239
- bulkHomeTransactionID?: string;
15240
15160
  /** @description List of individual transfers in a bulk transfer. */
15241
15161
  individualTransfers: ({
15242
- /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
15243
- homeTransactionId?: string;
15244
- /**
15245
- * CorrelationId
15246
- * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
15247
- * @example b51ec534-ee48-4575-b6a9-ead2955b8069
15248
- */
15249
- transactionId?: string;
15250
15162
  /**
15251
15163
  * CorrelationId
15252
15164
  * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
@@ -22347,18 +22259,8 @@ export interface components {
22347
22259
  message?: string;
22348
22260
  } & {
22349
22261
  bulkTransferState: {
22350
- /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
22351
- bulkHomeTransactionID?: string;
22352
22262
  /** @description List of individual transfers in a bulk transfer with accept party information. */
22353
22263
  individualTransfers: ({
22354
- /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
22355
- homeTransactionId?: string;
22356
- /**
22357
- * CorrelationId
22358
- * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
22359
- * @example b51ec534-ee48-4575-b6a9-ead2955b8069
22360
- */
22361
- transactionId?: string;
22362
22264
  /**
22363
22265
  * CorrelationId
22364
22266
  * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
@@ -22419,18 +22321,8 @@ export interface components {
22419
22321
  message?: string;
22420
22322
  } & ({
22421
22323
  bulkTransferState?: {
22422
- /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
22423
- bulkHomeTransactionID?: string;
22424
22324
  /** @description List of individual transfers in a bulk transfer. */
22425
22325
  individualTransfers: ({
22426
- /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
22427
- homeTransactionId?: string;
22428
- /**
22429
- * CorrelationId
22430
- * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
22431
- * @example b51ec534-ee48-4575-b6a9-ead2955b8069
22432
- */
22433
- transactionId?: string;
22434
22326
  /**
22435
22327
  * CorrelationId
22436
22328
  * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
@@ -4648,17 +4648,6 @@ export declare namespace Schemas {
4648
4648
  type: string;
4649
4649
  description: string;
4650
4650
  properties: {
4651
- homeTransactionId: {
4652
- type: string;
4653
- description: string;
4654
- };
4655
- transactionId: {
4656
- title: string;
4657
- type: string;
4658
- pattern: string;
4659
- description: string;
4660
- example: string;
4661
- };
4662
4651
  transferId: {
4663
4652
  title: string;
4664
4653
  type: string;
@@ -4674,10 +4663,6 @@ export declare namespace Schemas {
4674
4663
  type: string;
4675
4664
  required: string[];
4676
4665
  properties: {
4677
- bulkHomeTransactionID: {
4678
- type: string;
4679
- description: string;
4680
- };
4681
4666
  individualTransfers: {
4682
4667
  description: string;
4683
4668
  type: string;
@@ -4687,17 +4672,6 @@ export declare namespace Schemas {
4687
4672
  type: string;
4688
4673
  description: string;
4689
4674
  properties: {
4690
- homeTransactionId: {
4691
- type: string;
4692
- description: string;
4693
- };
4694
- transactionId: {
4695
- title: string;
4696
- type: string;
4697
- pattern: string;
4698
- description: string;
4699
- example: string;
4700
- };
4701
4675
  transferId: {
4702
4676
  title: string;
4703
4677
  type: string;
@@ -4716,8 +4690,6 @@ export declare namespace Schemas {
4716
4690
  type: string;
4717
4691
  enum: boolean[];
4718
4692
  };
4719
- homeTransactionId?: undefined;
4720
- transactionId?: undefined;
4721
4693
  transferId?: undefined;
4722
4694
  };
4723
4695
  description?: undefined;
@@ -4731,10 +4703,6 @@ export declare namespace Schemas {
4731
4703
  type: string;
4732
4704
  required: string[];
4733
4705
  properties: {
4734
- bulkHomeTransactionID: {
4735
- type: string;
4736
- description: string;
4737
- };
4738
4706
  individualTransfers: {
4739
4707
  description: string;
4740
4708
  type: string;
@@ -4744,17 +4712,6 @@ export declare namespace Schemas {
4744
4712
  type: string;
4745
4713
  description: string;
4746
4714
  properties: {
4747
- homeTransactionId: {
4748
- type: string;
4749
- description: string;
4750
- };
4751
- transactionId: {
4752
- title: string;
4753
- type: string;
4754
- pattern: string;
4755
- description: string;
4756
- example: string;
4757
- };
4758
4715
  transferId: {
4759
4716
  title: string;
4760
4717
  type: string;
@@ -4773,8 +4730,6 @@ export declare namespace Schemas {
4773
4730
  type: string;
4774
4731
  enum: boolean[];
4775
4732
  };
4776
- homeTransactionId?: undefined;
4777
- transactionId?: undefined;
4778
4733
  transferId?: undefined;
4779
4734
  };
4780
4735
  description?: undefined;
@@ -4882,10 +4837,6 @@ export declare namespace Schemas {
4882
4837
  type: string;
4883
4838
  required: string[];
4884
4839
  properties: {
4885
- bulkHomeTransactionID: {
4886
- type: string;
4887
- description: string;
4888
- };
4889
4840
  individualTransfers: {
4890
4841
  description: string;
4891
4842
  type: string;
@@ -4895,17 +4846,6 @@ export declare namespace Schemas {
4895
4846
  type: string;
4896
4847
  description: string;
4897
4848
  properties: {
4898
- homeTransactionId: {
4899
- type: string;
4900
- description: string;
4901
- };
4902
- transactionId: {
4903
- title: string;
4904
- type: string;
4905
- pattern: string;
4906
- description: string;
4907
- example: string;
4908
- };
4909
4849
  transferId: {
4910
4850
  title: string;
4911
4851
  type: string;
@@ -4924,8 +4864,6 @@ export declare namespace Schemas {
4924
4864
  type: string;
4925
4865
  enum: boolean[];
4926
4866
  };
4927
- homeTransactionId?: undefined;
4928
- transactionId?: undefined;
4929
4867
  transferId?: undefined;
4930
4868
  };
4931
4869
  description?: undefined;
@@ -5007,7 +4945,6 @@ export declare namespace Schemas {
5007
4945
  };
5008
4946
  };
5009
4947
  };
5010
- bulkHomeTransactionID?: undefined;
5011
4948
  individualTransfers?: undefined;
5012
4949
  };
5013
4950
  required?: undefined;
@@ -5117,10 +5054,6 @@ export declare namespace Schemas {
5117
5054
  type: string;
5118
5055
  required: string[];
5119
5056
  properties: {
5120
- bulkHomeTransactionID: {
5121
- type: string;
5122
- description: string;
5123
- };
5124
5057
  individualTransfers: {
5125
5058
  description: string;
5126
5059
  type: string;
@@ -5130,17 +5063,6 @@ export declare namespace Schemas {
5130
5063
  type: string;
5131
5064
  description: string;
5132
5065
  properties: {
5133
- homeTransactionId: {
5134
- type: string;
5135
- description: string;
5136
- };
5137
- transactionId: {
5138
- title: string;
5139
- type: string;
5140
- pattern: string;
5141
- description: string;
5142
- example: string;
5143
- };
5144
5066
  transferId: {
5145
5067
  title: string;
5146
5068
  type: string;
@@ -5159,8 +5081,6 @@ export declare namespace Schemas {
5159
5081
  type: string;
5160
5082
  enum: boolean[];
5161
5083
  };
5162
- homeTransactionId?: undefined;
5163
- transactionId?: undefined;
5164
5084
  transferId?: undefined;
5165
5085
  };
5166
5086
  description?: undefined;
@@ -5242,7 +5162,6 @@ export declare namespace Schemas {
5242
5162
  };
5243
5163
  };
5244
5164
  };
5245
- bulkHomeTransactionID?: undefined;
5246
5165
  individualTransfers?: undefined;
5247
5166
  };
5248
5167
  required?: undefined;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mojaloop/api-snippets",
3
- "version": "17.0.0-snapshot.1",
3
+ "version": "17.0.0",
4
4
  "description": "Mojaloop API specification reusable snippets",
5
5
  "main": "lib/index.js",
6
6
  "types": "lib/index.d.ts",
@@ -104,7 +104,7 @@
104
104
  "jest-junit": "^14.0.1",
105
105
  "lint-staged": "^13.0.3",
106
106
  "npm-audit-resolver": "^3.0.0-7",
107
- "npm-check-updates": "^16.3.18",
107
+ "npm-check-updates": "^16.3.20",
108
108
  "prettier": "^2.7.1",
109
109
  "standard-version": "^9.5.0",
110
110
  "swagger-cli": "^4.0.4",
@@ -5,11 +5,6 @@ type: object
5
5
  required:
6
6
  - individualTransfers
7
7
  properties:
8
- bulkHomeTransactionID:
9
- type: string
10
- description: >-
11
- Transaction ID from the DFSP backend, used to reconcile transactions
12
- between the Switch and DFSP backend systems.
13
8
  individualTransfers:
14
9
  description: >-
15
10
  List of individual transfers in a bulk transfer with accept party
@@ -3,11 +3,6 @@ type: object
3
3
  required:
4
4
  - individualTransfers
5
5
  properties:
6
- bulkHomeTransactionID:
7
- type: string
8
- description: >-
9
- Transaction ID from the DFSP backend, used to reconcile transactions
10
- between the Switch and DFSP backend systems.
11
6
  individualTransfers:
12
7
  description: List of individual transfers in a bulk transfer.
13
8
  type: array
@@ -27,6 +27,7 @@ properties:
27
27
  lastError:
28
28
  $ref: ./transferError.yaml
29
29
  required:
30
+ - homeTransactionId
30
31
  - to
31
32
  - amountType
32
33
  - currency
@@ -1,13 +1,6 @@
1
1
  type: object
2
2
  description: Data model for the 'individualTransfer' while accepting party or quote.
3
3
  properties:
4
- homeTransactionId:
5
- type: string
6
- description: >-
7
- Transaction ID from the DFSP backend, used to reconcile transactions
8
- between the Switch and DFSP backend systems.
9
- transactionId:
10
- $ref: ./CorrelationId.yaml
11
4
  transferId:
12
5
  $ref: ./CorrelationId.yaml
13
6
  required:
@@ -1,5 +1,6 @@
1
1
  type: object
2
2
  required:
3
+ - homeTransactionId
3
4
  - transferId
4
5
  - to
5
6
  - amountType
@@ -1,6 +1,7 @@
1
1
  type: object
2
2
  required:
3
3
  - bulkTransactionId
4
+ - bulkHomeTransactionID
4
5
  - options
5
6
  - from
6
7
  - individualTransfers
@@ -1,6 +1,7 @@
1
1
  title: BulkTransactionResponse
2
2
  type: object
3
3
  required:
4
+ - bulkHomeTransactionID
4
5
  - bulkTransactionId
5
6
  - currentState
6
7
  - individualTransferResults