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

package/docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml

@@ -2163,10 +2163,6 @@ components:
             The HTTP status code returned to the caller. This is the same as the
             actual HTTP status code returned with the response.
         mojaloopError:
-          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.
           $ref: '#/components/schemas/mojaloopError'
     individualQuoteResult:
       type: object
@@ -2189,19 +2185,10 @@ components:
           $ref: '#/components/schemas/IlpCondition'
         extensionList:
           $ref: '#/components/schemas/ExtensionList'
-          description: Optional extension, specific to deployment.
         lastError:
-          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.
           $ref: '#/components/schemas/quoteError'
       required:
         - quoteId
-        - transferAmount
-        - ilpPacket
-        - condition
     IlpFulfilment:
       title: IlpFulfilment
       type: string
@@ -2209,6 +2196,26 @@ components:
       maxLength: 48
       description: Fulfilment that must be attached to the transfer by the Payee.
       example: WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
+    TransferState:
+      title: TransferState
+      type: string
+      enum:
+        - RECEIVED
+        - RESERVED
+        - COMMITTED
+        - ABORTED
+      description: >-
+        Below are the allowed values for the enumeration.
+
+        - RECEIVED - Next ledger has received the transfer.
+
+        - RESERVED - Next ledger has reserved the transfer.
+
+        - COMMITTED - Next ledger has successfully performed the transfer.
+
+        - ABORTED - Next ledger has aborted the transfer due to a rejection or
+        failure to perform the transfer.
+      example: RESERVED
     transferError:
       type: object
       description: >-
@@ -2221,10 +2228,6 @@ components:
             The HTTP status code returned to the caller. This is the same as the
             actual HTTP status code returned with the response.
         mojaloopError:
-          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.
           $ref: '#/components/schemas/mojaloopError'
     individualTransferResult:
       type: object
@@ -2235,12 +2238,10 @@ components:
           $ref: '#/components/schemas/CorrelationId'
         fulfilment:
           $ref: '#/components/schemas/IlpFulfilment'
-          description: >
-            Fulfilment of the condition specified with the transaction.
-            Mandatory if transfer has completed successfully.
         extensionList:
           $ref: '#/components/schemas/ExtensionList'
-          description: Optional extension, specific to deployment.
+        transferState:
+          $ref: '#/components/schemas/TransferState'
         lastError:
           $ref: '#/components/schemas/transferError'
     bulkTransactionIndividualTransferResult:

package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml

@@ -922,10 +922,6 @@ components:
             The HTTP status code returned to the caller. This is the same as the
             actual HTTP status code returned with the response.
         mojaloopError:
-          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.
           $ref: '#/components/schemas/mojaloopError'
     accountsResponse:
       type: object
@@ -1275,10 +1271,6 @@ components:
             The HTTP status code returned to the caller. This is the same as the
             actual HTTP status code returned with the response.
         mojaloopError:
-          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.
           $ref: '#/components/schemas/mojaloopError'
     individualQuoteResult:
       type: object
@@ -1301,19 +1293,10 @@ components:
           $ref: '#/components/schemas/IlpCondition'
         extensionList:
           $ref: '#/components/schemas/ExtensionList'
-          description: Optional extension, specific to deployment.
         lastError:
-          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.
           $ref: '#/components/schemas/quoteError'
       required:
         - quoteId
-        - transferAmount
-        - ilpPacket
-        - condition
     bulkQuoteResponse:
       type: object
       required:
@@ -1605,12 +1588,10 @@ components:
           $ref: '#/components/schemas/CorrelationId'
         fulfilment:
           $ref: '#/components/schemas/IlpFulfilment'
-          description: >
-            Fulfilment of the condition specified with the transaction.
-            Mandatory if transfer has completed successfully.
         extensionList:
           $ref: '#/components/schemas/ExtensionList'
-          description: Optional extension, specific to deployment.
+        transferState:
+          $ref: '#/components/schemas/TransferState'
         lastError:
           $ref: '#/components/schemas/transferError'
     bulkTransferResponse:
@@ -1726,10 +1707,6 @@ components:
             The HTTP status code returned to the caller. This is the same as the
             actual HTTP status code returned with the response.
         mojaloopError:
-          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.
           $ref: '#/components/schemas/mojaloopError'
     bulkTransactionAcceptPartyErrorResponse:
       allOf:
@@ -1825,12 +1802,8 @@ components:
       properties:
         fulfilment:
           $ref: '#/components/schemas/IlpFulfilment'
-          description: >
-            Fulfilment of the condition specified with the transaction.
-            Mandatory if transfer has completed successfully.
         extensionList:
           $ref: '#/components/schemas/ExtensionList'
-          description: Optional extension, specific to deployment.
     bulkTransferStatusResponse:
       type: object
       required:

package/lib/sdk-scheme-adapter/v2_0_0/backend/json-schemas.json

@@ -5331,7 +5331,6 @@
                         "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
                     },
                     "mojaloopError": {
-                        "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.",
                         "type": "object",
                         "properties": {
                             "errorInformation": {
@@ -12215,7 +12214,6 @@
                 "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
             },
             "mojaloopError": {
-                "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.",
                 "type": "object",
                 "properties": {
                     "errorInformation": {
@@ -13145,15 +13143,14 @@
                 ]
             },
             "lastError": {
-                "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",
                 "type": "object",
+                "description": "This object represents a Mojaloop API error received at any time during the quote process",
                 "properties": {
                     "httpStatusCode": {
                         "type": "integer",
                         "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
                     },
                     "mojaloopError": {
-                        "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.",
                         "type": "object",
                         "properties": {
                             "errorInformation": {
@@ -13228,10 +13225,7 @@
             }
         },
         "required": [
-            "quoteId",
-            "transferAmount",
-            "ilpPacket",
-            "condition"
+            "quoteId"
         ]
     },
     "IlpFulfilment": {
@@ -13242,6 +13236,18 @@
         "description": "Fulfilment that must be attached to the transfer by the Payee.",
         "example": "WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8"
     },
+    "TransferState": {
+        "title": "TransferState",
+        "type": "string",
+        "enum": [
+            "RECEIVED",
+            "RESERVED",
+            "COMMITTED",
+            "ABORTED"
+        ],
+        "description": "Below are the allowed values for the enumeration.\n- RECEIVED - Next ledger has received the transfer.\n- RESERVED - Next ledger has reserved the transfer.\n- COMMITTED - Next ledger has successfully performed the transfer.\n- ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.",
+        "example": "RESERVED"
+    },
     "transferError": {
         "type": "object",
         "description": "This object represents a Mojaloop API error received at any time during the transfer process",
@@ -13251,7 +13257,6 @@
                 "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
             },
             "mojaloopError": {
-                "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.",
                 "type": "object",
                 "properties": {
                     "errorInformation": {
@@ -13338,11 +13343,11 @@
                 "example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
             },
             "fulfilment": {
-                "description": "Fulfilment of the condition specified with the transaction. Mandatory if transfer has completed successfully.\n",
                 "title": "IlpFulfilment",
                 "type": "string",
                 "pattern": "^[A-Za-z0-9-_]{43}$",
                 "maxLength": 48,
+                "description": "Fulfilment that must be attached to the transfer by the Payee.",
                 "example": "WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8"
             },
             "extensionList": {
@@ -13386,6 +13391,18 @@
                     "extension"
                 ]
             },
+            "transferState": {
+                "title": "TransferState",
+                "type": "string",
+                "enum": [
+                    "RECEIVED",
+                    "RESERVED",
+                    "COMMITTED",
+                    "ABORTED"
+                ],
+                "description": "Below are the allowed values for the enumeration.\n- RECEIVED - Next ledger has received the transfer.\n- RESERVED - Next ledger has reserved the transfer.\n- COMMITTED - Next ledger has successfully performed the transfer.\n- ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.",
+                "example": "RESERVED"
+            },
             "lastError": {
                 "type": "object",
                 "description": "This object represents a Mojaloop API error received at any time during the transfer process",
@@ -13395,7 +13412,6 @@
                         "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
                     },
                     "mojaloopError": {
-                        "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.",
                         "type": "object",
                         "properties": {
                             "errorInformation": {
@@ -14720,15 +14736,14 @@
                         ]
                     },
                     "lastError": {
-                        "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",
                         "type": "object",
+                        "description": "This object represents a Mojaloop API error received at any time during the quote process",
                         "properties": {
                             "httpStatusCode": {
                                 "type": "integer",
                                 "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
                             },
                             "mojaloopError": {
-                                "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.",
                                 "type": "object",
                                 "properties": {
                                     "errorInformation": {
@@ -14803,10 +14818,7 @@
                     }
                 },
                 "required": [
-                    "quoteId",
-                    "transferAmount",
-                    "ilpPacket",
-                    "condition"
+                    "quoteId"
                 ]
             },
             "fulfil": {
@@ -14823,11 +14835,11 @@
                         "example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
                     },
                     "fulfilment": {
-                        "description": "Fulfilment of the condition specified with the transaction. Mandatory if transfer has completed successfully.\n",
                         "title": "IlpFulfilment",
                         "type": "string",
                         "pattern": "^[A-Za-z0-9-_]{43}$",
                         "maxLength": 48,
+                        "description": "Fulfilment that must be attached to the transfer by the Payee.",
                         "example": "WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8"
                     },
                     "extensionList": {
@@ -14871,6 +14883,18 @@
                             "extension"
                         ]
                     },
+                    "transferState": {
+                        "title": "TransferState",
+                        "type": "string",
+                        "enum": [
+                            "RECEIVED",
+                            "RESERVED",
+                            "COMMITTED",
+                            "ABORTED"
+                        ],
+                        "description": "Below are the allowed values for the enumeration.\n- RECEIVED - Next ledger has received the transfer.\n- RESERVED - Next ledger has reserved the transfer.\n- COMMITTED - Next ledger has successfully performed the transfer.\n- ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.",
+                        "example": "RESERVED"
+                    },
                     "lastError": {
                         "type": "object",
                         "description": "This object represents a Mojaloop API error received at any time during the transfer process",
@@ -14880,7 +14904,6 @@
                                 "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
                             },
                             "mojaloopError": {
-                                "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.",
                                 "type": "object",
                                 "properties": {
                                     "errorInformation": {
@@ -15046,7 +15069,6 @@
                         "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
                     },
                     "mojaloopError": {
-                        "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.",
                         "type": "object",
                         "properties": {
                             "errorInformation": {
@@ -16663,15 +16685,14 @@
                                     ]
                                 },
                                 "lastError": {
-                                    "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",
                                     "type": "object",
+                                    "description": "This object represents a Mojaloop API error received at any time during the quote process",
                                     "properties": {
                                         "httpStatusCode": {
                                             "type": "integer",
                                             "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
                                         },
                                         "mojaloopError": {
-                                            "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.",
                                             "type": "object",
                                             "properties": {
                                                 "errorInformation": {
@@ -16746,10 +16767,7 @@
                                 }
                             },
                             "required": [
-                                "quoteId",
-                                "transferAmount",
-                                "ilpPacket",
-                                "condition"
+                                "quoteId"
                             ]
                         },
                         "fulfil": {
@@ -16766,11 +16784,11 @@
                                     "example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
                                 },
                                 "fulfilment": {
-                                    "description": "Fulfilment of the condition specified with the transaction. Mandatory if transfer has completed successfully.\n",
                                     "title": "IlpFulfilment",
                                     "type": "string",
                                     "pattern": "^[A-Za-z0-9-_]{43}$",
                                     "maxLength": 48,
+                                    "description": "Fulfilment that must be attached to the transfer by the Payee.",
                                     "example": "WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8"
                                 },
                                 "extensionList": {
@@ -16814,6 +16832,18 @@
                                         "extension"
                                     ]
                                 },
+                                "transferState": {
+                                    "title": "TransferState",
+                                    "type": "string",
+                                    "enum": [
+                                        "RECEIVED",
+                                        "RESERVED",
+                                        "COMMITTED",
+                                        "ABORTED"
+                                    ],
+                                    "description": "Below are the allowed values for the enumeration.\n- RECEIVED - Next ledger has received the transfer.\n- RESERVED - Next ledger has reserved the transfer.\n- COMMITTED - Next ledger has successfully performed the transfer.\n- ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.",
+                                    "example": "RESERVED"
+                                },
                                 "lastError": {
                                     "type": "object",
                                     "description": "This object represents a Mojaloop API error received at any time during the transfer process",
@@ -16823,7 +16853,6 @@
                                             "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
                                         },
                                         "mojaloopError": {
-                                            "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.",
                                             "type": "object",
                                             "properties": {
                                                 "errorInformation": {
@@ -16989,7 +17018,6 @@
                                     "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
                                 },
                                 "mojaloopError": {
-                                    "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.",
                                     "type": "object",
                                     "properties": {
                                         "errorInformation": {

package/lib/sdk-scheme-adapter/v2_0_0/backend/openapi.d.ts

@@ -726,21 +726,18 @@ export interface components {
         quoteError: {
             /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */
             httpStatusCode?: number;
-            /** @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. */
             mojaloopError?: components["schemas"]["mojaloopError"];
         };
         individualQuoteResult: {
             quoteId: components["schemas"]["CorrelationId"];
-            transferAmount: components["schemas"]["Money"];
+            transferAmount?: components["schemas"]["Money"];
             payeeReceiveAmount?: components["schemas"]["Money"];
             payeeFspFee?: components["schemas"]["Money"];
             payeeFspCommission?: components["schemas"]["Money"];
             geoCode?: components["schemas"]["GeoCode"];
-            ilpPacket: components["schemas"]["IlpPacket"];
-            condition: components["schemas"]["IlpCondition"];
-            /** @description Optional extension, specific to deployment. */
+            ilpPacket?: components["schemas"]["IlpPacket"];
+            condition?: components["schemas"]["IlpCondition"];
             extensionList?: components["schemas"]["ExtensionList"];
-            /** @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. */
             lastError?: components["schemas"]["quoteError"];
         };
         /**
@@ -749,19 +746,28 @@ export interface components {
          * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
          */
         IlpFulfilment: string;
+        /**
+         * TransferState
+         * @description Below are the allowed values for the enumeration.
+         * - RECEIVED - Next ledger has received the transfer.
+         * - RESERVED - Next ledger has reserved the transfer.
+         * - COMMITTED - Next ledger has successfully performed the transfer.
+         * - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.
+         * @example RESERVED
+         * @enum {string}
+         */
+        TransferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED";
         /** @description This object represents a Mojaloop API error received at any time during the transfer process */
         transferError: {
             /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */
             httpStatusCode?: number;
-            /** @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. */
             mojaloopError?: components["schemas"]["mojaloopError"];
         };
         individualTransferResult: {
             transferId: components["schemas"]["CorrelationId"];
-            /** @description Fulfilment of the condition specified with the transaction. Mandatory if transfer has completed successfully. */
             fulfilment?: components["schemas"]["IlpFulfilment"];
-            /** @description Optional extension, specific to deployment. */
             extensionList?: components["schemas"]["ExtensionList"];
+            transferState?: components["schemas"]["TransferState"];
             lastError?: components["schemas"]["transferError"];
         };
         bulkTransactionIndividualTransferResult: {