@mojaloop/api-snippets 17.0.3-snapshot.2 → 17.0.3-snapshot.3

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 (15) hide show
  1. package/docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml +0 -21
  2. package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml +0 -29
  3. package/lib/sdk-scheme-adapter/v2_0_0/backend/json-schemas.json +9 -29
  4. package/lib/sdk-scheme-adapter/v2_0_0/backend/openapi.d.ts +3 -9
  5. package/lib/sdk-scheme-adapter/v2_0_0/backend/schemas.d.ts +6 -17
  6. package/lib/sdk-scheme-adapter/v2_0_0/outbound/json-schemas.json +11 -38
  7. package/lib/sdk-scheme-adapter/v2_0_0/outbound/openapi.d.ts +3 -12
  8. package/lib/sdk-scheme-adapter/v2_0_0/outbound/schemas.d.ts +8 -26
  9. package/package.json +1 -1
  10. package/sdk-scheme-adapter/v2_0_0/components/schemas/individualQuoteResult.yaml +1 -10
  11. package/sdk-scheme-adapter/v2_0_0/components/schemas/individualTransferFulfilment.yaml +0 -4
  12. package/sdk-scheme-adapter/v2_0_0/components/schemas/individualTransferResult.yaml +0 -4
  13. package/sdk-scheme-adapter/v2_0_0/components/schemas/partyError.yaml +0 -4
  14. package/sdk-scheme-adapter/v2_0_0/components/schemas/quoteError.yaml +0 -4
  15. package/sdk-scheme-adapter/v2_0_0/components/schemas/transferError.yaml +0 -4
package/docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml CHANGED
@@ -2163,10 +2163,6 @@ components:
2163
2163
  The HTTP status code returned to the caller. This is the same as the
2164
2164
  actual HTTP status code returned with the response.
2165
2165
  mojaloopError:
2166
- description: >-
2167
- If a quote process results in an error callback during the
2168
- asynchronous Mojaloop API exchange, this property will contain the
2169
- underlying Mojaloop API error object.
2170
2166
  $ref: '#/components/schemas/mojaloopError'
2171
2167
  individualQuoteResult:
2172
2168
  type: object
@@ -2189,19 +2185,10 @@ components:
2189
2185
  $ref: '#/components/schemas/IlpCondition'
2190
2186
  extensionList:
2191
2187
  $ref: '#/components/schemas/ExtensionList'
2192
- description: Optional extension, specific to deployment.
2193
2188
  lastError:
2194
- description: >
2195
- Object representing the last error to occur during a quote process.
2196
- This may be a Mojaloop API error returned from another entity in the
2197
- scheme or an object representing other types of error e.g.
2198
- exceptions that may occur inside the scheme adapter.
2199
2189
  $ref: '#/components/schemas/quoteError'
2200
2190
  required:
2201
2191
  - quoteId
2202
- - transferAmount
2203
- - ilpPacket
2204
- - condition
2205
2192
  IlpFulfilment:
2206
2193
  title: IlpFulfilment
2207
2194
  type: string
@@ -2241,10 +2228,6 @@ components:
2241
2228
  The HTTP status code returned to the caller. This is the same as the
2242
2229
  actual HTTP status code returned with the response.
2243
2230
  mojaloopError:
2244
- description: >-
2245
- If a transfer process results in an error callback during the
2246
- asynchronous Mojaloop API exchange, this property will contain the
2247
- underlying Mojaloop API error object.
2248
2231
  $ref: '#/components/schemas/mojaloopError'
2249
2232
  individualTransferResult:
2250
2233
  type: object
@@ -2255,12 +2238,8 @@ components:
2255
2238
  $ref: '#/components/schemas/CorrelationId'
2256
2239
  fulfilment:
2257
2240
  $ref: '#/components/schemas/IlpFulfilment'
2258
- description: >
2259
- Fulfilment of the condition specified with the transaction.
2260
- Mandatory if transfer has completed successfully.
2261
2241
  extensionList:
2262
2242
  $ref: '#/components/schemas/ExtensionList'
2263
- description: Optional extension, specific to deployment.
2264
2243
  transferState:
2265
2244
  $ref: '#/components/schemas/TransferState'
2266
2245
  lastError:
package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml CHANGED
@@ -922,10 +922,6 @@ components:
922
922
  The HTTP status code returned to the caller. This is the same as the
923
923
  actual HTTP status code returned with the response.
924
924
  mojaloopError:
925
- description: >-
926
- If a transfer process results in an error callback during the
927
- asynchronous Mojaloop API exchange, this property will contain the
928
- underlying Mojaloop API error object.
929
925
  $ref: '#/components/schemas/mojaloopError'
930
926
  accountsResponse:
931
927
  type: object
@@ -1275,10 +1271,6 @@ components:
1275
1271
  The HTTP status code returned to the caller. This is the same as the
1276
1272
  actual HTTP status code returned with the response.
1277
1273
  mojaloopError:
1278
- description: >-
1279
- If a quote process results in an error callback during the
1280
- asynchronous Mojaloop API exchange, this property will contain the
1281
- underlying Mojaloop API error object.
1282
1274
  $ref: '#/components/schemas/mojaloopError'
1283
1275
  individualQuoteResult:
1284
1276
  type: object
@@ -1301,19 +1293,10 @@ components:
1301
1293
  $ref: '#/components/schemas/IlpCondition'
1302
1294
  extensionList:
1303
1295
  $ref: '#/components/schemas/ExtensionList'
1304
- description: Optional extension, specific to deployment.
1305
1296
  lastError:
1306
- description: >
1307
- Object representing the last error to occur during a quote process.
1308
- This may be a Mojaloop API error returned from another entity in the
1309
- scheme or an object representing other types of error e.g.
1310
- exceptions that may occur inside the scheme adapter.
1311
1297
  $ref: '#/components/schemas/quoteError'
1312
1298
  required:
1313
1299
  - quoteId
1314
- - transferAmount
1315
- - ilpPacket
1316
- - condition
1317
1300
  bulkQuoteResponse:
1318
1301
  type: object
1319
1302
  required:
@@ -1605,12 +1588,8 @@ components:
1605
1588
  $ref: '#/components/schemas/CorrelationId'
1606
1589
  fulfilment:
1607
1590
  $ref: '#/components/schemas/IlpFulfilment'
1608
- description: >
1609
- Fulfilment of the condition specified with the transaction.
1610
- Mandatory if transfer has completed successfully.
1611
1591
  extensionList:
1612
1592
  $ref: '#/components/schemas/ExtensionList'
1613
- description: Optional extension, specific to deployment.
1614
1593
  transferState:
1615
1594
  $ref: '#/components/schemas/TransferState'
1616
1595
  lastError:
@@ -1728,10 +1707,6 @@ components:
1728
1707
  The HTTP status code returned to the caller. This is the same as the
1729
1708
  actual HTTP status code returned with the response.
1730
1709
  mojaloopError:
1731
- description: >-
1732
- If a transfer process results in an error callback during the
1733
- asynchronous Mojaloop API exchange, this property will contain the
1734
- underlying Mojaloop API error object.
1735
1710
  $ref: '#/components/schemas/mojaloopError'
1736
1711
  bulkTransactionAcceptPartyErrorResponse:
1737
1712
  allOf:
@@ -1827,12 +1802,8 @@ components:
1827
1802
  properties:
1828
1803
  fulfilment:
1829
1804
  $ref: '#/components/schemas/IlpFulfilment'
1830
- description: >
1831
- Fulfilment of the condition specified with the transaction.
1832
- Mandatory if transfer has completed successfully.
1833
1805
  extensionList:
1834
1806
  $ref: '#/components/schemas/ExtensionList'
1835
- description: Optional extension, specific to deployment.
1836
1807
  bulkTransferStatusResponse:
1837
1808
  type: object
1838
1809
  required:
package/lib/sdk-scheme-adapter/v2_0_0/backend/json-schemas.json CHANGED
@@ -5331,7 +5331,6 @@
5331
5331
  "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
5332
5332
  },
5333
5333
  "mojaloopError": {
5334
- "description": "If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
5335
5334
  "type": "object",
5336
5335
  "properties": {
5337
5336
  "errorInformation": {
@@ -12215,7 +12214,6 @@
12215
12214
  "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
12216
12215
  },
12217
12216
  "mojaloopError": {
12218
- "description": "If a quote process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
12219
12217
  "type": "object",
12220
12218
  "properties": {
12221
12219
  "errorInformation": {
@@ -13145,15 +13143,14 @@
13145
13143
  ]
13146
13144
  },
13147
13145
  "lastError": {
13148
- "description": "Object representing the last error to occur during a quote process. This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.\n",
13149
13146
  "type": "object",
13147
+ "description": "This object represents a Mojaloop API error received at any time during the quote process",
13150
13148
  "properties": {
13151
13149
  "httpStatusCode": {
13152
13150
  "type": "integer",
13153
13151
  "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
13154
13152
  },
13155
13153
  "mojaloopError": {
13156
- "description": "If a quote process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
13157
13154
  "type": "object",
13158
13155
  "properties": {
13159
13156
  "errorInformation": {
@@ -13228,10 +13225,7 @@
13228
13225
  }
13229
13226
  },
13230
13227
  "required": [
13231
- "quoteId",
13232
- "transferAmount",
13233
- "ilpPacket",
13234
- "condition"
13228
+ "quoteId"
13235
13229
  ]
13236
13230
  },
13237
13231
  "IlpFulfilment": {
@@ -13263,7 +13257,6 @@
13263
13257
  "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
13264
13258
  },
13265
13259
  "mojaloopError": {
13266
- "description": "If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
13267
13260
  "type": "object",
13268
13261
  "properties": {
13269
13262
  "errorInformation": {
@@ -13350,11 +13343,11 @@
13350
13343
  "example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
13351
13344
  },
13352
13345
  "fulfilment": {
13353
- "description": "Fulfilment of the condition specified with the transaction. Mandatory if transfer has completed successfully.\n",
13354
13346
  "title": "IlpFulfilment",
13355
13347
  "type": "string",
13356
13348
  "pattern": "^[A-Za-z0-9-_]{43}$",
13357
13349
  "maxLength": 48,
13350
+ "description": "Fulfilment that must be attached to the transfer by the Payee.",
13358
13351
  "example": "WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8"
13359
13352
  },
13360
13353
  "extensionList": {
@@ -13419,7 +13412,6 @@
13419
13412
  "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
13420
13413
  },
13421
13414
  "mojaloopError": {
13422
- "description": "If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
13423
13415
  "type": "object",
13424
13416
  "properties": {
13425
13417
  "errorInformation": {
@@ -14744,15 +14736,14 @@
14744
14736
  ]
14745
14737
  },
14746
14738
  "lastError": {
14747
- "description": "Object representing the last error to occur during a quote process. This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.\n",
14748
14739
  "type": "object",
14740
+ "description": "This object represents a Mojaloop API error received at any time during the quote process",
14749
14741
  "properties": {
14750
14742
  "httpStatusCode": {
14751
14743
  "type": "integer",
14752
14744
  "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
14753
14745
  },
14754
14746
  "mojaloopError": {
14755
- "description": "If a quote process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
14756
14747
  "type": "object",
14757
14748
  "properties": {
14758
14749
  "errorInformation": {
@@ -14827,10 +14818,7 @@
14827
14818
  }
14828
14819
  },
14829
14820
  "required": [
14830
- "quoteId",
14831
- "transferAmount",
14832
- "ilpPacket",
14833
- "condition"
14821
+ "quoteId"
14834
14822
  ]
14835
14823
  },
14836
14824
  "fulfil": {
@@ -14847,11 +14835,11 @@
14847
14835
  "example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
14848
14836
  },
14849
14837
  "fulfilment": {
14850
- "description": "Fulfilment of the condition specified with the transaction. Mandatory if transfer has completed successfully.\n",
14851
14838
  "title": "IlpFulfilment",
14852
14839
  "type": "string",
14853
14840
  "pattern": "^[A-Za-z0-9-_]{43}$",
14854
14841
  "maxLength": 48,
14842
+ "description": "Fulfilment that must be attached to the transfer by the Payee.",
14855
14843
  "example": "WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8"
14856
14844
  },
14857
14845
  "extensionList": {
@@ -14916,7 +14904,6 @@
14916
14904
  "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
14917
14905
  },
14918
14906
  "mojaloopError": {
14919
- "description": "If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
14920
14907
  "type": "object",
14921
14908
  "properties": {
14922
14909
  "errorInformation": {
@@ -15082,7 +15069,6 @@
15082
15069
  "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
15083
15070
  },
15084
15071
  "mojaloopError": {
15085
- "description": "If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
15086
15072
  "type": "object",
15087
15073
  "properties": {
15088
15074
  "errorInformation": {
@@ -16699,15 +16685,14 @@
16699
16685
  ]
16700
16686
  },
16701
16687
  "lastError": {
16702
- "description": "Object representing the last error to occur during a quote process. This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.\n",
16703
16688
  "type": "object",
16689
+ "description": "This object represents a Mojaloop API error received at any time during the quote process",
16704
16690
  "properties": {
16705
16691
  "httpStatusCode": {
16706
16692
  "type": "integer",
16707
16693
  "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
16708
16694
  },
16709
16695
  "mojaloopError": {
16710
- "description": "If a quote process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
16711
16696
  "type": "object",
16712
16697
  "properties": {
16713
16698
  "errorInformation": {
@@ -16782,10 +16767,7 @@
16782
16767
  }
16783
16768
  },
16784
16769
  "required": [
16785
- "quoteId",
16786
- "transferAmount",
16787
- "ilpPacket",
16788
- "condition"
16770
+ "quoteId"
16789
16771
  ]
16790
16772
  },
16791
16773
  "fulfil": {
@@ -16802,11 +16784,11 @@
16802
16784
  "example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
16803
16785
  },
16804
16786
  "fulfilment": {
16805
- "description": "Fulfilment of the condition specified with the transaction. Mandatory if transfer has completed successfully.\n",
16806
16787
  "title": "IlpFulfilment",
16807
16788
  "type": "string",
16808
16789
  "pattern": "^[A-Za-z0-9-_]{43}$",
16809
16790
  "maxLength": 48,
16791
+ "description": "Fulfilment that must be attached to the transfer by the Payee.",
16810
16792
  "example": "WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8"
16811
16793
  },
16812
16794
  "extensionList": {
@@ -16871,7 +16853,6 @@
16871
16853
  "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
16872
16854
  },
16873
16855
  "mojaloopError": {
16874
- "description": "If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
16875
16856
  "type": "object",
16876
16857
  "properties": {
16877
16858
  "errorInformation": {
@@ -17037,7 +17018,6 @@
17037
17018
  "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
17038
17019
  },
17039
17020
  "mojaloopError": {
17040
- "description": "If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
17041
17021
  "type": "object",
17042
17022
  "properties": {
17043
17023
  "errorInformation": {
package/lib/sdk-scheme-adapter/v2_0_0/backend/openapi.d.ts CHANGED
@@ -726,21 +726,18 @@ export interface components {
726
726
  quoteError: {
727
727
  /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */
728
728
  httpStatusCode?: number;
729
- /** @description If a quote process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object. */
730
729
  mojaloopError?: components["schemas"]["mojaloopError"];
731
730
  };
732
731
  individualQuoteResult: {
733
732
  quoteId: components["schemas"]["CorrelationId"];
734
- transferAmount: components["schemas"]["Money"];
733
+ transferAmount?: components["schemas"]["Money"];
735
734
  payeeReceiveAmount?: components["schemas"]["Money"];
736
735
  payeeFspFee?: components["schemas"]["Money"];
737
736
  payeeFspCommission?: components["schemas"]["Money"];
738
737
  geoCode?: components["schemas"]["GeoCode"];
739
- ilpPacket: components["schemas"]["IlpPacket"];
740
- condition: components["schemas"]["IlpCondition"];
741
- /** @description Optional extension, specific to deployment. */
738
+ ilpPacket?: components["schemas"]["IlpPacket"];
739
+ condition?: components["schemas"]["IlpCondition"];
742
740
  extensionList?: components["schemas"]["ExtensionList"];
743
- /** @description Object representing the last error to occur during a quote process. This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter. */
744
741
  lastError?: components["schemas"]["quoteError"];
745
742
  };
746
743
  /**
@@ -764,14 +761,11 @@ export interface components {
764
761
  transferError: {
765
762
  /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */
766
763
  httpStatusCode?: number;
767
- /** @description If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object. */
768
764
  mojaloopError?: components["schemas"]["mojaloopError"];
769
765
  };
770
766
  individualTransferResult: {
771
767
  transferId: components["schemas"]["CorrelationId"];
772
- /** @description Fulfilment of the condition specified with the transaction. Mandatory if transfer has completed successfully. */
773
768
  fulfilment?: components["schemas"]["IlpFulfilment"];
774
- /** @description Optional extension, specific to deployment. */
775
769
  extensionList?: components["schemas"]["ExtensionList"];
776
770
  transferState?: components["schemas"]["TransferState"];
777
771
  lastError?: components["schemas"]["transferError"];
package/lib/sdk-scheme-adapter/v2_0_0/backend/schemas.d.ts CHANGED
@@ -1452,7 +1452,6 @@ export declare namespace Schemas {
1452
1452
  description: string;
1453
1453
  };
1454
1454
  mojaloopError: {
1455
- description: string;
1456
1455
  type: string;
1457
1456
  properties: {
1458
1457
  errorInformation: {
@@ -4436,7 +4435,6 @@ export declare namespace Schemas {
4436
4435
  description: string;
4437
4436
  };
4438
4437
  mojaloopError: {
4439
- description: string;
4440
4438
  type: string;
4441
4439
  properties: {
4442
4440
  errorInformation: {
@@ -4678,15 +4676,14 @@ export declare namespace Schemas {
4678
4676
  required: string[];
4679
4677
  };
4680
4678
  lastError: {
4681
- description: string;
4682
4679
  type: string;
4680
+ description: string;
4683
4681
  properties: {
4684
4682
  httpStatusCode: {
4685
4683
  type: string;
4686
4684
  description: string;
4687
4685
  };
4688
4686
  mojaloopError: {
4689
- description: string;
4690
4687
  type: string;
4691
4688
  properties: {
4692
4689
  errorInformation: {
@@ -4778,7 +4775,6 @@ export declare namespace Schemas {
4778
4775
  description: string;
4779
4776
  };
4780
4777
  mojaloopError: {
4781
- description: string;
4782
4778
  type: string;
4783
4779
  properties: {
4784
4780
  errorInformation: {
@@ -4855,11 +4851,11 @@ export declare namespace Schemas {
4855
4851
  example: string;
4856
4852
  };
4857
4853
  fulfilment: {
4858
- description: string;
4859
4854
  title: string;
4860
4855
  type: string;
4861
4856
  pattern: string;
4862
4857
  maxLength: number;
4858
+ description: string;
4863
4859
  example: string;
4864
4860
  };
4865
4861
  extensionList: {
@@ -4914,7 +4910,6 @@ export declare namespace Schemas {
4914
4910
  description: string;
4915
4911
  };
4916
4912
  mojaloopError: {
4917
- description: string;
4918
4913
  type: string;
4919
4914
  properties: {
4920
4915
  errorInformation: {
@@ -5362,15 +5357,14 @@ export declare namespace Schemas {
5362
5357
  required: string[];
5363
5358
  };
5364
5359
  lastError: {
5365
- description: string;
5366
5360
  type: string;
5361
+ description: string;
5367
5362
  properties: {
5368
5363
  httpStatusCode: {
5369
5364
  type: string;
5370
5365
  description: string;
5371
5366
  };
5372
5367
  mojaloopError: {
5373
- description: string;
5374
5368
  type: string;
5375
5369
  properties: {
5376
5370
  errorInformation: {
@@ -5450,11 +5444,11 @@ export declare namespace Schemas {
5450
5444
  example: string;
5451
5445
  };
5452
5446
  fulfilment: {
5453
- description: string;
5454
5447
  title: string;
5455
5448
  type: string;
5456
5449
  pattern: string;
5457
5450
  maxLength: number;
5451
+ description: string;
5458
5452
  example: string;
5459
5453
  };
5460
5454
  extensionList: {
@@ -5509,7 +5503,6 @@ export declare namespace Schemas {
5509
5503
  description: string;
5510
5504
  };
5511
5505
  mojaloopError: {
5512
- description: string;
5513
5506
  type: string;
5514
5507
  properties: {
5515
5508
  errorInformation: {
@@ -5657,7 +5650,6 @@ export declare namespace Schemas {
5657
5650
  description: string;
5658
5651
  };
5659
5652
  mojaloopError: {
5660
- description: string;
5661
5653
  type: string;
5662
5654
  properties: {
5663
5655
  errorInformation: {
@@ -6203,15 +6195,14 @@ export declare namespace Schemas {
6203
6195
  required: string[];
6204
6196
  };
6205
6197
  lastError: {
6206
- description: string;
6207
6198
  type: string;
6199
+ description: string;
6208
6200
  properties: {
6209
6201
  httpStatusCode: {
6210
6202
  type: string;
6211
6203
  description: string;
6212
6204
  };
6213
6205
  mojaloopError: {
6214
- description: string;
6215
6206
  type: string;
6216
6207
  properties: {
6217
6208
  errorInformation: {
@@ -6291,11 +6282,11 @@ export declare namespace Schemas {
6291
6282
  example: string;
6292
6283
  };
6293
6284
  fulfilment: {
6294
- description: string;
6295
6285
  title: string;
6296
6286
  type: string;
6297
6287
  pattern: string;
6298
6288
  maxLength: number;
6289
+ description: string;
6299
6290
  example: string;
6300
6291
  };
6301
6292
  extensionList: {
@@ -6350,7 +6341,6 @@ export declare namespace Schemas {
6350
6341
  description: string;
6351
6342
  };
6352
6343
  mojaloopError: {
6353
- description: string;
6354
6344
  type: string;
6355
6345
  properties: {
6356
6346
  errorInformation: {
@@ -6498,7 +6488,6 @@ export declare namespace Schemas {
6498
6488
  description: string;
6499
6489
  };
6500
6490
  mojaloopError: {
6501
- description: string;
6502
6491
  type: string;
6503
6492
  properties: {
6504
6493
  errorInformation: {
package/lib/sdk-scheme-adapter/v2_0_0/outbound/json-schemas.json CHANGED
@@ -740,7 +740,6 @@
740
740
  "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
741
741
  },
742
742
  "mojaloopError": {
743
- "description": "If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
744
743
  "type": "object",
745
744
  "properties": {
746
745
  "errorInformation": {
@@ -1113,7 +1112,6 @@
1113
1112
  "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
1114
1113
  },
1115
1114
  "mojaloopError": {
1116
- "description": "If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
1117
1115
  "type": "object",
1118
1116
  "properties": {
1119
1117
  "errorInformation": {
@@ -1523,7 +1521,6 @@
1523
1521
  "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
1524
1522
  },
1525
1523
  "mojaloopError": {
1526
- "description": "If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
1527
1524
  "type": "object",
1528
1525
  "properties": {
1529
1526
  "errorInformation": {
@@ -3176,7 +3173,6 @@
3176
3173
  "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
3177
3174
  },
3178
3175
  "mojaloopError": {
3179
- "description": "If a quote process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
3180
3176
  "type": "object",
3181
3177
  "properties": {
3182
3178
  "errorInformation": {
@@ -4106,15 +4102,14 @@
4106
4102
  ]
4107
4103
  },
4108
4104
  "lastError": {
4109
- "description": "Object representing the last error to occur during a quote process. This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.\n",
4110
4105
  "type": "object",
4106
+ "description": "This object represents a Mojaloop API error received at any time during the quote process",
4111
4107
  "properties": {
4112
4108
  "httpStatusCode": {
4113
4109
  "type": "integer",
4114
4110
  "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
4115
4111
  },
4116
4112
  "mojaloopError": {
4117
- "description": "If a quote process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
4118
4113
  "type": "object",
4119
4114
  "properties": {
4120
4115
  "errorInformation": {
@@ -4189,10 +4184,7 @@
4189
4184
  }
4190
4185
  },
4191
4186
  "required": [
4192
- "quoteId",
4193
- "transferAmount",
4194
- "ilpPacket",
4195
- "condition"
4187
+ "quoteId"
4196
4188
  ]
4197
4189
  },
4198
4190
  "bulkQuoteResponse": {
@@ -5130,15 +5122,14 @@
5130
5122
  ]
5131
5123
  },
5132
5124
  "lastError": {
5133
- "description": "Object representing the last error to occur during a quote process. This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.\n",
5134
5125
  "type": "object",
5126
+ "description": "This object represents a Mojaloop API error received at any time during the quote process",
5135
5127
  "properties": {
5136
5128
  "httpStatusCode": {
5137
5129
  "type": "integer",
5138
5130
  "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
5139
5131
  },
5140
5132
  "mojaloopError": {
5141
- "description": "If a quote process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
5142
5133
  "type": "object",
5143
5134
  "properties": {
5144
5135
  "errorInformation": {
@@ -5213,10 +5204,7 @@
5213
5204
  }
5214
5205
  },
5215
5206
  "required": [
5216
- "quoteId",
5217
- "transferAmount",
5218
- "ilpPacket",
5219
- "condition"
5207
+ "quoteId"
5220
5208
  ]
5221
5209
  },
5222
5210
  "description": "List of individualQuoteResults in a bulk transfer response."
@@ -6179,15 +6167,14 @@
6179
6167
  ]
6180
6168
  },
6181
6169
  "lastError": {
6182
- "description": "Object representing the last error to occur during a quote process. This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.\n",
6183
6170
  "type": "object",
6171
+ "description": "This object represents a Mojaloop API error received at any time during the quote process",
6184
6172
  "properties": {
6185
6173
  "httpStatusCode": {
6186
6174
  "type": "integer",
6187
6175
  "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
6188
6176
  },
6189
6177
  "mojaloopError": {
6190
- "description": "If a quote process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
6191
6178
  "type": "object",
6192
6179
  "properties": {
6193
6180
  "errorInformation": {
@@ -6262,10 +6249,7 @@
6262
6249
  }
6263
6250
  },
6264
6251
  "required": [
6265
- "quoteId",
6266
- "transferAmount",
6267
- "ilpPacket",
6268
- "condition"
6252
+ "quoteId"
6269
6253
  ]
6270
6254
  },
6271
6255
  "description": "List of individualQuoteResults in a bulk transfer response."
@@ -8192,7 +8176,6 @@
8192
8176
  "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
8193
8177
  },
8194
8178
  "mojaloopError": {
8195
- "description": "If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
8196
8179
  "type": "object",
8197
8180
  "properties": {
8198
8181
  "errorInformation": {
@@ -9179,7 +9162,6 @@
9179
9162
  "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
9180
9163
  },
9181
9164
  "mojaloopError": {
9182
- "description": "If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
9183
9165
  "type": "object",
9184
9166
  "properties": {
9185
9167
  "errorInformation": {
@@ -9339,11 +9321,11 @@
9339
9321
  "example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
9340
9322
  },
9341
9323
  "fulfilment": {
9342
- "description": "Fulfilment of the condition specified with the transaction. Mandatory if transfer has completed successfully.\n",
9343
9324
  "title": "IlpFulfilment",
9344
9325
  "type": "string",
9345
9326
  "pattern": "^[A-Za-z0-9-_]{43}$",
9346
9327
  "maxLength": 48,
9328
+ "description": "Fulfilment that must be attached to the transfer by the Payee.",
9347
9329
  "example": "WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8"
9348
9330
  },
9349
9331
  "extensionList": {
@@ -9408,7 +9390,6 @@
9408
9390
  "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
9409
9391
  },
9410
9392
  "mojaloopError": {
9411
- "description": "If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
9412
9393
  "type": "object",
9413
9394
  "properties": {
9414
9395
  "errorInformation": {
@@ -9593,11 +9574,11 @@
9593
9574
  "example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
9594
9575
  },
9595
9576
  "fulfilment": {
9596
- "description": "Fulfilment of the condition specified with the transaction. Mandatory if transfer has completed successfully.\n",
9597
9577
  "title": "IlpFulfilment",
9598
9578
  "type": "string",
9599
9579
  "pattern": "^[A-Za-z0-9-_]{43}$",
9600
9580
  "maxLength": 48,
9581
+ "description": "Fulfilment that must be attached to the transfer by the Payee.",
9601
9582
  "example": "WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8"
9602
9583
  },
9603
9584
  "extensionList": {
@@ -9662,7 +9643,6 @@
9662
9643
  "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
9663
9644
  },
9664
9645
  "mojaloopError": {
9665
- "description": "If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
9666
9646
  "type": "object",
9667
9647
  "properties": {
9668
9648
  "errorInformation": {
@@ -9872,11 +9852,11 @@
9872
9852
  "example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
9873
9853
  },
9874
9854
  "fulfilment": {
9875
- "description": "Fulfilment of the condition specified with the transaction. Mandatory if transfer has completed successfully.\n",
9876
9855
  "title": "IlpFulfilment",
9877
9856
  "type": "string",
9878
9857
  "pattern": "^[A-Za-z0-9-_]{43}$",
9879
9858
  "maxLength": 48,
9859
+ "description": "Fulfilment that must be attached to the transfer by the Payee.",
9880
9860
  "example": "WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8"
9881
9861
  },
9882
9862
  "extensionList": {
@@ -9941,7 +9921,6 @@
9941
9921
  "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
9942
9922
  },
9943
9923
  "mojaloopError": {
9944
- "description": "If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
9945
9924
  "type": "object",
9946
9925
  "properties": {
9947
9926
  "errorInformation": {
@@ -10177,7 +10156,6 @@
10177
10156
  "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
10178
10157
  },
10179
10158
  "mojaloopError": {
10180
- "description": "If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
10181
10159
  "type": "object",
10182
10160
  "properties": {
10183
10161
  "errorInformation": {
@@ -10331,7 +10309,6 @@
10331
10309
  "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
10332
10310
  },
10333
10311
  "mojaloopError": {
10334
- "description": "If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
10335
10312
  "type": "object",
10336
10313
  "properties": {
10337
10314
  "errorInformation": {
@@ -10491,7 +10468,6 @@
10491
10468
  "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
10492
10469
  },
10493
10470
  "mojaloopError": {
10494
- "description": "If a quote process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
10495
10471
  "type": "object",
10496
10472
  "properties": {
10497
10473
  "errorInformation": {
@@ -11640,11 +11616,11 @@
11640
11616
  "description": "A Mojaloop API transfer fulfilment for individual transfers in a bulk transfer",
11641
11617
  "properties": {
11642
11618
  "fulfilment": {
11643
- "description": "Fulfilment of the condition specified with the transaction. Mandatory if transfer has completed successfully.\n",
11644
11619
  "title": "IlpFulfilment",
11645
11620
  "type": "string",
11646
11621
  "pattern": "^[A-Za-z0-9-_]{43}$",
11647
11622
  "maxLength": 48,
11623
+ "description": "Fulfilment that must be attached to the transfer by the Payee.",
11648
11624
  "example": "WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8"
11649
11625
  },
11650
11626
  "extensionList": {
@@ -11721,11 +11697,11 @@
11721
11697
  "description": "A Mojaloop API transfer fulfilment for individual transfers in a bulk transfer",
11722
11698
  "properties": {
11723
11699
  "fulfilment": {
11724
- "description": "Fulfilment of the condition specified with the transaction. Mandatory if transfer has completed successfully.\n",
11725
11700
  "title": "IlpFulfilment",
11726
11701
  "type": "string",
11727
11702
  "pattern": "^[A-Za-z0-9-_]{43}$",
11728
11703
  "maxLength": 48,
11704
+ "description": "Fulfilment that must be attached to the transfer by the Payee.",
11729
11705
  "example": "WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8"
11730
11706
  },
11731
11707
  "extensionList": {
@@ -19121,7 +19097,6 @@
19121
19097
  "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
19122
19098
  },
19123
19099
  "mojaloopError": {
19124
- "description": "If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
19125
19100
  "type": "object",
19126
19101
  "properties": {
19127
19102
  "errorInformation": {
@@ -20709,7 +20684,6 @@
20709
20684
  "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
20710
20685
  },
20711
20686
  "mojaloopError": {
20712
- "description": "If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
20713
20687
  "type": "object",
20714
20688
  "properties": {
20715
20689
  "errorInformation": {
@@ -22322,7 +22296,6 @@
22322
22296
  "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
22323
22297
  },
22324
22298
  "mojaloopError": {
22325
- "description": "If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
22326
22299
  "type": "object",
22327
22300
  "properties": {
22328
22301
  "errorInformation": {
package/lib/sdk-scheme-adapter/v2_0_0/outbound/openapi.d.ts CHANGED
@@ -478,7 +478,6 @@ export interface components {
478
478
  transferError: {
479
479
  /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */
480
480
  httpStatusCode?: number;
481
- /** @description If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object. */
482
481
  mojaloopError?: components["schemas"]["mojaloopError"];
483
482
  };
484
483
  accountsResponse: {
@@ -676,21 +675,18 @@ export interface components {
676
675
  quoteError: {
677
676
  /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */
678
677
  httpStatusCode?: number;
679
- /** @description If a quote process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object. */
680
678
  mojaloopError?: components["schemas"]["mojaloopError"];
681
679
  };
682
680
  individualQuoteResult: {
683
681
  quoteId: components["schemas"]["CorrelationId"];
684
- transferAmount: components["schemas"]["Money"];
682
+ transferAmount?: components["schemas"]["Money"];
685
683
  payeeReceiveAmount?: components["schemas"]["Money"];
686
684
  payeeFspFee?: components["schemas"]["Money"];
687
685
  payeeFspCommission?: components["schemas"]["Money"];
688
686
  geoCode?: components["schemas"]["GeoCode"];
689
- ilpPacket: components["schemas"]["IlpPacket"];
690
- condition: components["schemas"]["IlpCondition"];
691
- /** @description Optional extension, specific to deployment. */
687
+ ilpPacket?: components["schemas"]["IlpPacket"];
688
+ condition?: components["schemas"]["IlpCondition"];
692
689
  extensionList?: components["schemas"]["ExtensionList"];
693
- /** @description Object representing the last error to occur during a quote process. This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter. */
694
690
  lastError?: components["schemas"]["quoteError"];
695
691
  };
696
692
  bulkQuoteResponse: {
@@ -828,9 +824,7 @@ export interface components {
828
824
  IlpFulfilment: string;
829
825
  individualTransferResult: {
830
826
  transferId: components["schemas"]["CorrelationId"];
831
- /** @description Fulfilment of the condition specified with the transaction. Mandatory if transfer has completed successfully. */
832
827
  fulfilment?: components["schemas"]["IlpFulfilment"];
833
- /** @description Optional extension, specific to deployment. */
834
828
  extensionList?: components["schemas"]["ExtensionList"];
835
829
  transferState?: components["schemas"]["TransferState"];
836
830
  lastError?: components["schemas"]["transferError"];
@@ -876,7 +870,6 @@ export interface components {
876
870
  partyError: {
877
871
  /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */
878
872
  httpStatusCode?: number;
879
- /** @description If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object. */
880
873
  mojaloopError?: components["schemas"]["mojaloopError"];
881
874
  };
882
875
  bulkTransactionAcceptPartyErrorResponse: components["schemas"]["errorResponse"] & {
@@ -916,9 +909,7 @@ export interface components {
916
909
  };
917
910
  /** @description A Mojaloop API transfer fulfilment for individual transfers in a bulk transfer */
918
911
  individualTransferFulfilment: {
919
- /** @description Fulfilment of the condition specified with the transaction. Mandatory if transfer has completed successfully. */
920
912
  fulfilment?: components["schemas"]["IlpFulfilment"];
921
- /** @description Optional extension, specific to deployment. */
922
913
  extensionList?: components["schemas"]["ExtensionList"];
923
914
  };
924
915
  bulkTransferStatusResponse: {
package/lib/sdk-scheme-adapter/v2_0_0/outbound/schemas.d.ts CHANGED
@@ -349,7 +349,6 @@ export declare namespace Schemas {
349
349
  description: string;
350
350
  };
351
351
  mojaloopError: {
352
- description: string;
353
352
  type: string;
354
353
  properties: {
355
354
  errorInformation: {
@@ -519,7 +518,6 @@ export declare namespace Schemas {
519
518
  description: string;
520
519
  };
521
520
  mojaloopError: {
522
- description: string;
523
521
  type: string;
524
522
  properties: {
525
523
  errorInformation: {
@@ -722,7 +720,6 @@ export declare namespace Schemas {
722
720
  description: string;
723
721
  };
724
722
  mojaloopError: {
725
- description: string;
726
723
  type: string;
727
724
  properties: {
728
725
  errorInformation: {
@@ -1726,7 +1723,6 @@ export declare namespace Schemas {
1726
1723
  description: string;
1727
1724
  };
1728
1725
  mojaloopError: {
1729
- description: string;
1730
1726
  type: string;
1731
1727
  properties: {
1732
1728
  errorInformation: {
@@ -1968,15 +1964,14 @@ export declare namespace Schemas {
1968
1964
  required: string[];
1969
1965
  };
1970
1966
  lastError: {
1971
- description: string;
1972
1967
  type: string;
1968
+ description: string;
1973
1969
  properties: {
1974
1970
  httpStatusCode: {
1975
1971
  type: string;
1976
1972
  description: string;
1977
1973
  };
1978
1974
  mojaloopError: {
1979
- description: string;
1980
1975
  type: string;
1981
1976
  properties: {
1982
1977
  errorInformation: {
@@ -2286,15 +2281,14 @@ export declare namespace Schemas {
2286
2281
  required: string[];
2287
2282
  };
2288
2283
  lastError: {
2289
- description: string;
2290
2284
  type: string;
2285
+ description: string;
2291
2286
  properties: {
2292
2287
  httpStatusCode: {
2293
2288
  type: string;
2294
2289
  description: string;
2295
2290
  };
2296
2291
  mojaloopError: {
2297
- description: string;
2298
2292
  type: string;
2299
2293
  properties: {
2300
2294
  errorInformation: {
@@ -2627,15 +2621,14 @@ export declare namespace Schemas {
2627
2621
  required: string[];
2628
2622
  };
2629
2623
  lastError: {
2630
- description: string;
2631
2624
  type: string;
2625
+ description: string;
2632
2626
  properties: {
2633
2627
  httpStatusCode: {
2634
2628
  type: string;
2635
2629
  description: string;
2636
2630
  };
2637
2631
  mojaloopError: {
2638
- description: string;
2639
2632
  type: string;
2640
2633
  properties: {
2641
2634
  errorInformation: {
@@ -3653,7 +3646,6 @@ export declare namespace Schemas {
3653
3646
  description: string;
3654
3647
  };
3655
3648
  mojaloopError: {
3656
- description: string;
3657
3649
  type: string;
3658
3650
  properties: {
3659
3651
  errorInformation: {
@@ -4220,7 +4212,6 @@ export declare namespace Schemas {
4220
4212
  description: string;
4221
4213
  };
4222
4214
  mojaloopError: {
4223
- description: string;
4224
4215
  type: string;
4225
4216
  properties: {
4226
4217
  errorInformation: {
@@ -4354,11 +4345,11 @@ export declare namespace Schemas {
4354
4345
  example: string;
4355
4346
  };
4356
4347
  fulfilment: {
4357
- description: string;
4358
4348
  title: string;
4359
4349
  type: string;
4360
4350
  pattern: string;
4361
4351
  maxLength: number;
4352
+ description: string;
4362
4353
  example: string;
4363
4354
  };
4364
4355
  extensionList: {
@@ -4413,7 +4404,6 @@ export declare namespace Schemas {
4413
4404
  description: string;
4414
4405
  };
4415
4406
  mojaloopError: {
4416
- description: string;
4417
4407
  type: string;
4418
4408
  properties: {
4419
4409
  errorInformation: {
@@ -4571,11 +4561,11 @@ export declare namespace Schemas {
4571
4561
  example: string;
4572
4562
  };
4573
4563
  fulfilment: {
4574
- description: string;
4575
4564
  title: string;
4576
4565
  type: string;
4577
4566
  pattern: string;
4578
4567
  maxLength: number;
4568
+ description: string;
4579
4569
  example: string;
4580
4570
  };
4581
4571
  extensionList: {
@@ -4630,7 +4620,6 @@ export declare namespace Schemas {
4630
4620
  description: string;
4631
4621
  };
4632
4622
  mojaloopError: {
4633
- description: string;
4634
4623
  type: string;
4635
4624
  properties: {
4636
4625
  errorInformation: {
@@ -4811,11 +4800,11 @@ export declare namespace Schemas {
4811
4800
  example: string;
4812
4801
  };
4813
4802
  fulfilment: {
4814
- description: string;
4815
4803
  title: string;
4816
4804
  type: string;
4817
4805
  pattern: string;
4818
4806
  maxLength: number;
4807
+ description: string;
4819
4808
  example: string;
4820
4809
  };
4821
4810
  extensionList: {
@@ -4870,7 +4859,6 @@ export declare namespace Schemas {
4870
4859
  description: string;
4871
4860
  };
4872
4861
  mojaloopError: {
4873
- description: string;
4874
4862
  type: string;
4875
4863
  properties: {
4876
4864
  errorInformation: {
@@ -5069,7 +5057,6 @@ export declare namespace Schemas {
5069
5057
  description: string;
5070
5058
  };
5071
5059
  mojaloopError: {
5072
- description: string;
5073
5060
  type: string;
5074
5061
  properties: {
5075
5062
  errorInformation: {
@@ -5204,7 +5191,6 @@ export declare namespace Schemas {
5204
5191
  description: string;
5205
5192
  };
5206
5193
  mojaloopError: {
5207
- description: string;
5208
5194
  type: string;
5209
5195
  properties: {
5210
5196
  errorInformation: {
@@ -5347,7 +5333,6 @@ export declare namespace Schemas {
5347
5333
  description: string;
5348
5334
  };
5349
5335
  mojaloopError: {
5350
- description: string;
5351
5336
  type: string;
5352
5337
  properties: {
5353
5338
  errorInformation: {
@@ -6053,11 +6038,11 @@ export declare namespace Schemas {
6053
6038
  description: string;
6054
6039
  properties: {
6055
6040
  fulfilment: {
6056
- description: string;
6057
6041
  title: string;
6058
6042
  type: string;
6059
6043
  pattern: string;
6060
6044
  maxLength: number;
6045
+ description: string;
6061
6046
  example: string;
6062
6047
  };
6063
6048
  extensionList: {
@@ -6122,11 +6107,11 @@ export declare namespace Schemas {
6122
6107
  description: string;
6123
6108
  properties: {
6124
6109
  fulfilment: {
6125
- description: string;
6126
6110
  title: string;
6127
6111
  type: string;
6128
6112
  pattern: string;
6129
6113
  maxLength: number;
6114
+ description: string;
6130
6115
  example: string;
6131
6116
  };
6132
6117
  extensionList: {
@@ -9550,7 +9535,6 @@ export declare namespace Schemas {
9550
9535
  description: string;
9551
9536
  };
9552
9537
  mojaloopError: {
9553
- description: string;
9554
9538
  type: string;
9555
9539
  properties: {
9556
9540
  errorInformation: {
@@ -10204,7 +10188,6 @@ export declare namespace Schemas {
10204
10188
  description: string;
10205
10189
  };
10206
10190
  mojaloopError: {
10207
- description: string;
10208
10191
  type: string;
10209
10192
  properties: {
10210
10193
  errorInformation: {
@@ -10881,7 +10864,6 @@ export declare namespace Schemas {
10881
10864
  description: string;
10882
10865
  };
10883
10866
  mojaloopError: {
10884
- description: string;
10885
10867
  type: string;
10886
10868
  properties: {
10887
10869
  errorInformation: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mojaloop/api-snippets",
3
- "version": "17.0.3-snapshot.2",
3
+ "version": "17.0.3-snapshot.3",
4
4
  "description": "Mojaloop API specification reusable snippets",
5
5
  "main": "lib/index.js",
6
6
  "types": "lib/index.d.ts",
package/sdk-scheme-adapter/v2_0_0/components/schemas/individualQuoteResult.yaml CHANGED
@@ -18,17 +18,8 @@ properties:
18
18
  $ref: ./IlpCondition.yaml
19
19
  extensionList:
20
20
  $ref: ./ExtensionList.yaml
21
- description: 'Optional extension, specific to deployment.'
22
21
  lastError:
23
- description: >
24
- Object representing the last error to occur during a quote process. This
25
- may be a Mojaloop API error returned from another entity in the scheme or
26
- an object representing other types of error e.g. exceptions that may occur
27
- inside the scheme adapter.
28
22
  $ref: ./quoteError.yaml
29
-
30
23
  required:
31
24
  - quoteId
32
- - transferAmount
33
- - ilpPacket
34
- - condition
25
+
package/sdk-scheme-adapter/v2_0_0/components/schemas/individualTransferFulfilment.yaml CHANGED
@@ -5,9 +5,5 @@ description: >-
5
5
  properties:
6
6
  fulfilment:
7
7
  $ref: ./IlpFulfilment.yaml
8
- description: >
9
- Fulfilment of the condition specified with the transaction.
10
- Mandatory if transfer has completed successfully.
11
8
  extensionList:
12
9
  $ref: ./ExtensionList.yaml
13
- description: 'Optional extension, specific to deployment.'
package/sdk-scheme-adapter/v2_0_0/components/schemas/individualTransferResult.yaml CHANGED
@@ -6,12 +6,8 @@ properties:
6
6
  $ref: ./CorrelationId.yaml
7
7
  fulfilment:
8
8
  $ref: ./IlpFulfilment.yaml
9
- description: >
10
- Fulfilment of the condition specified with the transaction.
11
- Mandatory if transfer has completed successfully.
12
9
  extensionList:
13
10
  $ref: ./ExtensionList.yaml
14
- description: 'Optional extension, specific to deployment.'
15
11
  transferState:
16
12
  $ref: ./TransferState.yaml
17
13
  lastError:
package/sdk-scheme-adapter/v2_0_0/components/schemas/partyError.yaml CHANGED
@@ -9,8 +9,4 @@ properties:
9
9
  The HTTP status code returned to the caller. This is the same as the
10
10
  actual HTTP status code returned with the response.
11
11
  mojaloopError:
12
- description: >-
13
- If a transfer process results in an error callback during the asynchronous
14
- Mojaloop API exchange, this property will contain the underlying Mojaloop
15
- API error object.
16
12
  $ref: ./mojaloopError.yaml
package/sdk-scheme-adapter/v2_0_0/components/schemas/quoteError.yaml CHANGED
@@ -9,8 +9,4 @@ properties:
9
9
  The HTTP status code returned to the caller. This is the same as the
10
10
  actual HTTP status code returned with the response.
11
11
  mojaloopError:
12
- description: >-
13
- If a quote process results in an error callback during the asynchronous
14
- Mojaloop API exchange, this property will contain the underlying Mojaloop
15
- API error object.
16
12
  $ref: ./mojaloopError.yaml
package/sdk-scheme-adapter/v2_0_0/components/schemas/transferError.yaml CHANGED
@@ -9,8 +9,4 @@ properties:
9
9
  The HTTP status code returned to the caller. This is the same as the
10
10
  actual HTTP status code returned with the response.
11
11
  mojaloopError:
12
- description: >-
13
- If a transfer process results in an error callback during the asynchronous
14
- Mojaloop API exchange, this property will contain the underlying Mojaloop
15
- API error object.
16
12
  $ref: ./mojaloopError.yaml