@mojaloop/api-snippets 17.0.4 → 17.0.5-snapshot.1

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

@@ -210,6 +210,32 @@ export interface paths {
             };
         };
     };
+    "/requestToPay/{requestToPayId}": {
+        /**
+         * The HTTP request `PUT /requestToPay/{requestToPayId}` is used to continue a transfer initiated via the `POST /requestToPay` method that has halted after party lookup stage.
+         *
+         * The request body should contain the "acceptParty" property set to `true` as required to continue the transfer.
+         * See the description of the `POST /requestToPay` HTTP method for more information on modes of transfer.
+         */
+        put: {
+            parameters: {
+                path: {
+                    /** Identifier of the merchant request to pay to continue as returned in the response to a `POST /requestToPay` request. */
+                    requestToPayId: components["parameters"]["requestToPayId"];
+                };
+            };
+            responses: {
+                200: components["responses"]["requestToPaySuccess"];
+                500: components["responses"]["transferServerError"];
+                504: components["responses"]["transferTimeout"];
+            };
+            requestBody: {
+                content: {
+                    "application/json": components["schemas"]["transferContinuationAcceptParty"];
+                };
+            };
+        };
+    };
     "/requestToPayTransfer": {
         /**
          * The HTTP request `POST /requestToPayTransfer` is used to request the movement of funds from payer DFSP to payee DFSP.
@@ -1053,29 +1079,13 @@ export interface components {
             transactionType: components["schemas"]["TransactionScenario"];
             subScenario?: components["schemas"]["TransactionSubScenario"];
         };
-        /**
-         * AuthenticationType
-         * @description Below are the allowed values for the enumeration AuthenticationType.
-         * - OTP - One-time password generated by the Payer FSP.
-         * - QRCODE - QR code used as One Time Password.
-         * - U2F - U2F is a new addition isolated to Thirdparty stream.
-         * @example OTP
-         * @enum {string}
-         */
-        AuthenticationType: "OTP" | "QRCODE" | "U2F";
-        /**
-         * TransactionRequestState
-         * @description Below are the allowed values for the enumeration.
-         * - RECEIVED - Payer FSP has received the transaction from the Payee FSP.
-         * - PENDING - Payer FSP has sent the transaction request to the Payer.
-         * - ACCEPTED - Payer has approved the transaction.
-         * - REJECTED - Payer has rejected the transaction.
-         * @example RECEIVED
-         * @enum {string}
-         */
-        TransactionRequestState: "RECEIVED" | "PENDING" | "ACCEPTED" | "REJECTED";
+        /** @enum {string} */
+        transferStatus: "ERROR_OCCURRED" | "WAITING_FOR_PARTY_ACCEPTANCE" | "WAITING_FOR_QUOTE_ACCEPTANCE" | "COMPLETED";
         requestToPayResponse: {
-            transactionRequestId: components["schemas"]["CorrelationId"];
+            requestToPayId: components["schemas"]["CorrelationId"];
+            transactionRequestId?: components["schemas"]["CorrelationId"];
+            /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
+            homeTransactionId?: string;
             from: components["schemas"]["transferParty"];
             to: components["schemas"]["transferParty"];
             amountType: components["schemas"]["AmountType"];
@@ -1083,24 +1093,18 @@ export interface components {
             amount: components["schemas"]["Amount"];
             transactionType: components["schemas"]["TransactionScenario"];
             subScenario?: components["schemas"]["TransactionSubScenario"];
-            authenticationType?: components["schemas"]["AuthenticationType"];
-            requestToPayState: components["schemas"]["TransactionRequestState"];
-        };
-        requestToPayTransferRequest: {
-            /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
-            requestToPayTransactionId: string;
-            from: components["schemas"]["transferParty"];
-            to: components["schemas"]["transferParty"];
-            amountType: components["schemas"]["AmountType"];
-            currency: components["schemas"]["Currency"];
-            amount: components["schemas"]["Amount"];
-            scenario: components["schemas"]["TransactionType"];
-            initiator: components["schemas"]["TransactionInitiator"];
-            initiatorType: components["schemas"]["TransactionInitiatorType"];
-            note?: components["schemas"]["Note"];
+            currentState: components["schemas"]["transferStatus"];
+            getPartiesResponse?: {
+                body: {
+                    [key: string]: unknown;
+                };
+                headers?: {
+                    [key: string]: unknown;
+                };
+            };
+            /** @description Object representing the last error to occur during a transfer 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"]["transferError"];
         };
-        /** @enum {string} */
-        transferStatus: "ERROR_OCCURRED" | "WAITING_FOR_PARTY_ACCEPTANCE" | "WAITING_FOR_QUOTE_ACCEPTANCE" | "COMPLETED";
         /**
          * QuotesIDPutResponse
          * @description The object sent in the PUT /quotes/{ID} callback.
@@ -1126,26 +1130,6 @@ export interface components {
             transferState: components["schemas"]["TransferState"];
             extensionList?: components["schemas"]["ExtensionList"];
         };
-        requestToPayTransferResponse: {
-            transferId?: components["schemas"]["CorrelationId"];
-            /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
-            requestToPayTransactionId: string;
-            from: components["schemas"]["transferParty"];
-            to: components["schemas"]["transferParty"];
-            amountType: components["schemas"]["AmountType"];
-            currency: components["schemas"]["Currency"];
-            amount: components["schemas"]["Amount"];
-            transactionType: components["schemas"]["transferTransactionType"];
-            note?: components["schemas"]["Note"];
-            currentState?: components["schemas"]["transferStatus"];
-            quoteId?: components["schemas"]["CorrelationId"];
-            quoteResponse?: components["schemas"]["QuotesIDPutResponse"];
-            /** @description FSPID of the entity that supplied the quote response. This may not be the same as the FSPID of the entity which owns the end user account in the case of a FOREX transfer. i.e. it may be a FOREX gateway. */
-            quoteResponseSource?: string;
-            fulfil?: components["schemas"]["TransfersIDPutResponse"];
-            /** @description Object representing the last error to occur during a transfer 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"]["transferError"];
-        };
         transferResponse: {
             transferId?: components["schemas"]["CorrelationId"];
             /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
@@ -1190,6 +1174,39 @@ export interface components {
         errorTransferResponse: components["schemas"]["errorResponse"] & {
             transferState: components["schemas"]["transferResponse"];
         };
+        requestToPayTransferRequest: {
+            /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
+            requestToPayTransactionId: string;
+            from: components["schemas"]["transferParty"];
+            to: components["schemas"]["transferParty"];
+            amountType: components["schemas"]["AmountType"];
+            currency: components["schemas"]["Currency"];
+            amount: components["schemas"]["Amount"];
+            scenario: components["schemas"]["TransactionType"];
+            initiator: components["schemas"]["TransactionInitiator"];
+            initiatorType: components["schemas"]["TransactionInitiatorType"];
+            note?: components["schemas"]["Note"];
+        };
+        requestToPayTransferResponse: {
+            transferId?: components["schemas"]["CorrelationId"];
+            /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
+            requestToPayTransactionId: string;
+            from: components["schemas"]["transferParty"];
+            to: components["schemas"]["transferParty"];
+            amountType: components["schemas"]["AmountType"];
+            currency: components["schemas"]["Currency"];
+            amount: components["schemas"]["Amount"];
+            transactionType: components["schemas"]["transferTransactionType"];
+            note?: components["schemas"]["Note"];
+            currentState?: components["schemas"]["transferStatus"];
+            quoteId?: components["schemas"]["CorrelationId"];
+            quoteResponse?: components["schemas"]["QuotesIDPutResponse"];
+            /** @description FSPID of the entity that supplied the quote response. This may not be the same as the FSPID of the entity which owns the end user account in the case of a FOREX transfer. i.e. it may be a FOREX gateway. */
+            quoteResponseSource?: string;
+            fulfil?: components["schemas"]["TransfersIDPutResponse"];
+            /** @description Object representing the last error to occur during a transfer 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"]["transferError"];
+        };
         transferContinuationAcceptOTP: {
             /** @enum {boolean} */
             acceptOTP: true | false;
@@ -1354,26 +1371,26 @@ export interface components {
                 "application/json": components["schemas"]["requestToPayResponse"];
             };
         };
-        /** Transfer completed successfully */
-        requestToPayTransferSuccess: {
+        /** An error occurred processing the transfer */
+        transferServerError: {
             content: {
-                "application/json": components["schemas"]["requestToPayTransferResponse"];
+                "application/json": components["schemas"]["errorTransferResponse"];
             };
         };
-        /** Malformed or missing required body, headers or parameters */
-        requestToPayTransferBadRequest: {
+        /** Timeout occurred processing the transfer */
+        transferTimeout: {
             content: {
                 "application/json": components["schemas"]["errorTransferResponse"];
             };
         };
-        /** An error occurred processing the transfer */
-        transferServerError: {
+        /** Transfer completed successfully */
+        requestToPayTransferSuccess: {
             content: {
-                "application/json": components["schemas"]["errorTransferResponse"];
+                "application/json": components["schemas"]["requestToPayTransferResponse"];
             };
         };
-        /** Timeout occurred processing the transfer */
-        transferTimeout: {
+        /** Malformed or missing required body, headers or parameters */
+        requestToPayTransferBadRequest: {
             content: {
                 "application/json": components["schemas"]["errorTransferResponse"];
             };
@@ -1416,6 +1433,8 @@ export interface components {
         ID: string;
         /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
         SubId: string;
+        /** @description Identifier of the merchant request to pay to continue as returned in the response to a `POST /requestToPay` request. */
+        requestToPayId: components["schemas"]["CorrelationId"];
         /** @description Identifier of the merchant request to pay transfer to continue as returned in the response to a `POST /requestToPayTransfer` request. */
         requestToPayTransactionId: components["schemas"]["CorrelationId"];
         /** @description Identifier of the transfer to continue as returned in the response to a `POST /transfers` request. */