@mojaloop/api-snippets 17.0.0-snapshot.0 → 17.0.0-snapshot.2

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.
@@ -1614,6 +1614,7 @@ paths:
1614
1614
  type: object
1615
1615
  required: &ref_76
1616
1616
  - homeTransactionId
1617
+ - transferId
1617
1618
  - to
1618
1619
  - amountType
1619
1620
  - currency
@@ -1802,15 +1802,8 @@ paths:
1802
1802
  autoAcceptParty is false.
1803
1803
  type: object
1804
1804
  required: &ref_34
1805
- - bulkHomeTransactionID
1806
1805
  - individualTransfers
1807
1806
  properties: &ref_35
1808
- bulkHomeTransactionID:
1809
- type: string
1810
- description: >-
1811
- Transaction ID from the DFSP backend, used to reconcile
1812
- transactions between the Switch and DFSP backend
1813
- systems.
1814
1807
  individualTransfers:
1815
1808
  description: >-
1816
1809
  List of individual transfers in a bulk transfer with
@@ -1824,28 +1817,6 @@ paths:
1824
1817
  Data model for the 'individualTransfer' while
1825
1818
  accepting party or quote.
1826
1819
  properties: &ref_30
1827
- homeTransactionId:
1828
- type: string
1829
- description: >-
1830
- Transaction ID from the DFSP backend, used to
1831
- reconcile transactions between the Switch and
1832
- DFSP backend systems.
1833
- transactionId:
1834
- title: CorrelationId
1835
- type: string
1836
- pattern: >-
1837
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1838
- description: >-
1839
- Identifier that correlates all messages of the
1840
- same sequence. The API data type UUID
1841
- (Universally Unique Identifier) is a JSON
1842
- String in canonical format, conforming to [RFC
1843
- 4122](https://tools.ietf.org/html/rfc4122),
1844
- that is restricted by a regular expression for
1845
- interoperability reasons. A UUID is always 36
1846
- characters long, 32 hexadecimal symbols and 4
1847
- dashes (‘-‘).
1848
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
1849
1820
  transferId:
1850
1821
  title: CorrelationId
1851
1822
  type: string
@@ -1863,7 +1834,6 @@ paths:
1863
1834
  dashes (‘-‘).
1864
1835
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
1865
1836
  required: &ref_31
1866
- - homeTransactionId
1867
1837
  - transferId
1868
1838
  - type: object
1869
1839
  required: *ref_28
@@ -1873,15 +1843,8 @@ paths:
1873
1843
  autoAcceptQuotes is false.
1874
1844
  type: object
1875
1845
  required: &ref_37
1876
- - bulkHomeTransactionID
1877
1846
  - individualTransfers
1878
1847
  properties: &ref_38
1879
- bulkHomeTransactionID:
1880
- type: string
1881
- description: >-
1882
- Transaction ID from the DFSP backend, used to reconcile
1883
- transactions between the Switch and DFSP backend
1884
- systems.
1885
1848
  individualTransfers:
1886
1849
  description: List of individual transfers in a bulk transfer.
1887
1850
  type: array
@@ -7684,6 +7684,7 @@
7684
7684
  "type": "object",
7685
7685
  "required": [
7686
7686
  "homeTransactionId",
7687
+ "transferId",
7687
7688
  "to",
7688
7689
  "amountType",
7689
7690
  "currency",
@@ -9483,6 +9484,7 @@
9483
9484
  "type": "object",
9484
9485
  "required": [
9485
9486
  "homeTransactionId",
9487
+ "transferId",
9486
9488
  "to",
9487
9489
  "amountType",
9488
9490
  "currency",
@@ -1162,7 +1162,7 @@ export interface paths {
1162
1162
  * @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 (‘-‘).
1163
1163
  * @example b51ec534-ee48-4575-b6a9-ead2955b8069
1164
1164
  */
1165
- transferId?: string;
1165
+ transferId: string;
1166
1166
  /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
1167
1167
  homeTransactionId: string;
1168
1168
  /**
@@ -3395,7 +3395,7 @@ export interface components {
3395
3395
  * @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 (‘-‘).
3396
3396
  * @example b51ec534-ee48-4575-b6a9-ead2955b8069
3397
3397
  */
3398
- transferId?: string;
3398
+ transferId: string;
3399
3399
  /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
3400
3400
  homeTransactionId: string;
3401
3401
  /**
@@ -3865,7 +3865,7 @@ export interface components {
3865
3865
  * @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 (‘-‘).
3866
3866
  * @example b51ec534-ee48-4575-b6a9-ead2955b8069
3867
3867
  */
3868
- transferId?: string;
3868
+ transferId: string;
3869
3869
  /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
3870
3870
  homeTransactionId: string;
3871
3871
  /**
@@ -9176,17 +9176,6 @@
9176
9176
  "type": "object",
9177
9177
  "description": "Data model for the 'individualTransfer' while accepting party or quote.",
9178
9178
  "properties": {
9179
- "homeTransactionId": {
9180
- "type": "string",
9181
- "description": "Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems."
9182
- },
9183
- "transactionId": {
9184
- "title": "CorrelationId",
9185
- "type": "string",
9186
- "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
9187
- "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 (‘-‘).",
9188
- "example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
9189
- },
9190
9179
  "transferId": {
9191
9180
  "title": "CorrelationId",
9192
9181
  "type": "string",
@@ -9196,7 +9185,6 @@
9196
9185
  }
9197
9186
  },
9198
9187
  "required": [
9199
- "homeTransactionId",
9200
9188
  "transferId"
9201
9189
  ]
9202
9190
  },
@@ -9204,14 +9192,9 @@
9204
9192
  "description": "The object sent back as confirmation of payee parties when autoAcceptParty is false.",
9205
9193
  "type": "object",
9206
9194
  "required": [
9207
- "bulkHomeTransactionID",
9208
9195
  "individualTransfers"
9209
9196
  ],
9210
9197
  "properties": {
9211
- "bulkHomeTransactionID": {
9212
- "type": "string",
9213
- "description": "Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems."
9214
- },
9215
9198
  "individualTransfers": {
9216
9199
  "description": "List of individual transfers in a bulk transfer with accept party information.",
9217
9200
  "type": "array",
@@ -9222,17 +9205,6 @@
9222
9205
  "type": "object",
9223
9206
  "description": "Data model for the 'individualTransfer' while accepting party or quote.",
9224
9207
  "properties": {
9225
- "homeTransactionId": {
9226
- "type": "string",
9227
- "description": "Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems."
9228
- },
9229
- "transactionId": {
9230
- "title": "CorrelationId",
9231
- "type": "string",
9232
- "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
9233
- "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 (‘-‘).",
9234
- "example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
9235
- },
9236
9208
  "transferId": {
9237
9209
  "title": "CorrelationId",
9238
9210
  "type": "string",
@@ -9242,7 +9214,6 @@
9242
9214
  }
9243
9215
  },
9244
9216
  "required": [
9245
- "homeTransactionId",
9246
9217
  "transferId"
9247
9218
  ]
9248
9219
  },
@@ -9270,14 +9241,9 @@
9270
9241
  "description": "The object sent back as confirmation of quotes when autoAcceptQuotes is false.",
9271
9242
  "type": "object",
9272
9243
  "required": [
9273
- "bulkHomeTransactionID",
9274
9244
  "individualTransfers"
9275
9245
  ],
9276
9246
  "properties": {
9277
- "bulkHomeTransactionID": {
9278
- "type": "string",
9279
- "description": "Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems."
9280
- },
9281
9247
  "individualTransfers": {
9282
9248
  "description": "List of individual transfers in a bulk transfer.",
9283
9249
  "type": "array",
@@ -9288,17 +9254,6 @@
9288
9254
  "type": "object",
9289
9255
  "description": "Data model for the 'individualTransfer' while accepting party or quote.",
9290
9256
  "properties": {
9291
- "homeTransactionId": {
9292
- "type": "string",
9293
- "description": "Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems."
9294
- },
9295
- "transactionId": {
9296
- "title": "CorrelationId",
9297
- "type": "string",
9298
- "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
9299
- "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 (‘-‘).",
9300
- "example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
9301
- },
9302
9257
  "transferId": {
9303
9258
  "title": "CorrelationId",
9304
9259
  "type": "string",
@@ -9308,7 +9263,6 @@
9308
9263
  }
9309
9264
  },
9310
9265
  "required": [
9311
- "homeTransactionId",
9312
9266
  "transferId"
9313
9267
  ]
9314
9268
  },
@@ -9441,14 +9395,9 @@
9441
9395
  "description": "The object sent back as confirmation of payee parties when autoAcceptParty is false.",
9442
9396
  "type": "object",
9443
9397
  "required": [
9444
- "bulkHomeTransactionID",
9445
9398
  "individualTransfers"
9446
9399
  ],
9447
9400
  "properties": {
9448
- "bulkHomeTransactionID": {
9449
- "type": "string",
9450
- "description": "Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems."
9451
- },
9452
9401
  "individualTransfers": {
9453
9402
  "description": "List of individual transfers in a bulk transfer with accept party information.",
9454
9403
  "type": "array",
@@ -9459,17 +9408,6 @@
9459
9408
  "type": "object",
9460
9409
  "description": "Data model for the 'individualTransfer' while accepting party or quote.",
9461
9410
  "properties": {
9462
- "homeTransactionId": {
9463
- "type": "string",
9464
- "description": "Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems."
9465
- },
9466
- "transactionId": {
9467
- "title": "CorrelationId",
9468
- "type": "string",
9469
- "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
9470
- "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 (‘-‘).",
9471
- "example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
9472
- },
9473
9411
  "transferId": {
9474
9412
  "title": "CorrelationId",
9475
9413
  "type": "string",
@@ -9479,7 +9417,6 @@
9479
9417
  }
9480
9418
  },
9481
9419
  "required": [
9482
- "homeTransactionId",
9483
9420
  "transferId"
9484
9421
  ]
9485
9422
  },
@@ -9700,14 +9637,9 @@
9700
9637
  "description": "The object sent back as confirmation of quotes when autoAcceptQuotes is false.",
9701
9638
  "type": "object",
9702
9639
  "required": [
9703
- "bulkHomeTransactionID",
9704
9640
  "individualTransfers"
9705
9641
  ],
9706
9642
  "properties": {
9707
- "bulkHomeTransactionID": {
9708
- "type": "string",
9709
- "description": "Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems."
9710
- },
9711
9643
  "individualTransfers": {
9712
9644
  "description": "List of individual transfers in a bulk transfer.",
9713
9645
  "type": "array",
@@ -9718,17 +9650,6 @@
9718
9650
  "type": "object",
9719
9651
  "description": "Data model for the 'individualTransfer' while accepting party or quote.",
9720
9652
  "properties": {
9721
- "homeTransactionId": {
9722
- "type": "string",
9723
- "description": "Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems."
9724
- },
9725
- "transactionId": {
9726
- "title": "CorrelationId",
9727
- "type": "string",
9728
- "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
9729
- "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 (‘-‘).",
9730
- "example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
9731
- },
9732
9653
  "transferId": {
9733
9654
  "title": "CorrelationId",
9734
9655
  "type": "string",
@@ -9738,7 +9659,6 @@
9738
9659
  }
9739
9660
  },
9740
9661
  "required": [
9741
- "homeTransactionId",
9742
9662
  "transferId"
9743
9663
  ]
9744
9664
  },
@@ -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 (‘-‘).
@@ -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.0",
3
+ "version": "17.0.0-snapshot.2",
4
4
  "description": "Mojaloop API specification reusable snippets",
5
5
  "main": "lib/index.js",
6
6
  "types": "lib/index.d.ts",
@@ -3,14 +3,8 @@ description: >-
3
3
  false.
4
4
  type: object
5
5
  required:
6
- - bulkHomeTransactionID
7
6
  - individualTransfers
8
7
  properties:
9
- bulkHomeTransactionID:
10
- type: string
11
- description: >-
12
- Transaction ID from the DFSP backend, used to reconcile transactions
13
- between the Switch and DFSP backend systems.
14
8
  individualTransfers:
15
9
  description: >-
16
10
  List of individual transfers in a bulk transfer with accept party
@@ -1,14 +1,8 @@
1
1
  description: The object sent back as confirmation of quotes when autoAcceptQuotes is false.
2
2
  type: object
3
3
  required:
4
- - bulkHomeTransactionID
5
4
  - individualTransfers
6
5
  properties:
7
- bulkHomeTransactionID:
8
- type: string
9
- description: >-
10
- Transaction ID from the DFSP backend, used to reconcile transactions
11
- between the Switch and DFSP backend systems.
12
6
  individualTransfers:
13
7
  description: List of individual transfers in a bulk transfer.
14
8
  type: array
@@ -1,15 +1,7 @@
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:
14
- - homeTransactionId
15
7
  - transferId
@@ -1,6 +1,7 @@
1
1
  type: object
2
2
  required:
3
3
  - homeTransactionId
4
+ - transferId
4
5
  - to
5
6
  - amountType
6
7
  - currency