@mojaloop/api-snippets 17.0.5-snapshot.0 → 17.1.0-snapshot.0

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

@@ -210,10 +210,9 @@ export interface paths {
             };
         };
     };
-    "/requestToPay/{requestToPayId}": {
+    "/requestToPay/{transactionRequestId}": {
         /**
-         * 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 HTTP request `PUT /requestToPay/{transactionRequestId}` 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.
          */
@@ -221,7 +220,7 @@ export interface paths {
             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"];
+                    transactionRequestId: components["parameters"]["transactionRequestId"];
                 };
             };
             responses: {
@@ -1068,9 +1067,19 @@ export interface components {
         errorQuotesResponse: components["schemas"]["errorResponse"] & {
             [key: string]: unknown;
         };
+        /**
+         * 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";
         requestToPayRequest: {
             /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
-            homeTransactionId: string;
+            homeR2PTransactionId: string;
             from: components["schemas"]["transferParty"];
             to: components["schemas"]["transferParty"];
             amountType: components["schemas"]["AmountType"];
@@ -1078,14 +1087,48 @@ export interface components {
             amount: components["schemas"]["Amount"];
             transactionType: components["schemas"]["TransactionScenario"];
             subScenario?: components["schemas"]["TransactionSubScenario"];
+            authenticationType?: components["schemas"]["AuthenticationType"];
         };
         /** @enum {string} */
-        transferStatus: "ERROR_OCCURRED" | "WAITING_FOR_PARTY_ACCEPTANCE" | "WAITING_FOR_QUOTE_ACCEPTANCE" | "COMPLETED";
+        requestToPayStatus: "ERROR_OCCURRED" | "WAITING_FOR_PARTY_ACCEPTANCE" | "COMPLETED";
+        /**
+         * getPartiesResponse
+         * @description The object sent in the GET /parties/{Type}/{ID} callback.
+         */
+        getPartiesResponse: {
+            /** @description Information regarding the requested Party. */
+            body: components["schemas"]["Party"];
+            headers: {
+                [key: string]: unknown;
+            };
+        };
+        /**
+         * 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";
+        /**
+         * TransactionRequestResponse
+         * @description The object sent in the PUT /transactionRequests/{ID} callback.
+         */
+        TransactionRequestResponse: {
+            body: {
+                transactionId?: components["schemas"]["CorrelationId"];
+                transactionRequestState: components["schemas"]["TransactionRequestState"];
+                extensionList?: components["schemas"]["ExtensionList"];
+            };
+            headers: {
+                [key: string]: unknown;
+            };
+        };
         requestToPayResponse: {
-            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;
+            transactionRequestId: components["schemas"]["CorrelationId"];
             from: components["schemas"]["transferParty"];
             to: components["schemas"]["transferParty"];
             amountType: components["schemas"]["AmountType"];
@@ -1093,18 +1136,14 @@ export interface components {
             amount: components["schemas"]["Amount"];
             transactionType: components["schemas"]["TransactionScenario"];
             subScenario?: components["schemas"]["TransactionSubScenario"];
-            currentState: components["schemas"]["transferStatus"];
-            getPartiesResponse?: {
-                body: {
-                    [key: string]: unknown;
-                };
-                headers?: {
-                    [key: string]: unknown;
-                };
-            };
+            currentState: components["schemas"]["requestToPayStatus"];
+            getPartiesResponse?: components["schemas"]["getPartiesResponse"];
+            transactionRequestResponse?: components["schemas"]["TransactionRequestResponse"];
             /** @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.
@@ -1434,7 +1473,7 @@ export interface components {
         /** @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"];
+        transactionRequestId: 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. */

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

@@ -7675,11 +7675,18 @@ export declare namespace Schemas {
             properties?: undefined;
         })[];
     };
+    const AuthenticationType: {
+        title: string;
+        type: string;
+        enum: string[];
+        description: string;
+        example: string;
+    };
     const requestToPayRequest: {
         type: string;
         required: string[];
         properties: {
-            homeTransactionId: {
+            homeR2PTransactionId: {
                 type: string;
                 description: string;
             };
@@ -7947,23 +7954,249 @@ export declare namespace Schemas {
                 description: string;
                 example: string;
             };
+            authenticationType: {
+                title: string;
+                type: string;
+                enum: string[];
+                description: string;
+                example: string;
+            };
         };
     };
-    const transferStatus: {
+    const requestToPayStatus: {
         type: string;
         enum: string[];
     };
-    const requestToPayResponse: {
+    const getPartiesResponse: {
+        title: string;
         type: string;
-        required: string[];
+        description: string;
         properties: {
-            requestToPayId: {
+            body: {
                 title: string;
                 type: string;
-                pattern: string;
                 description: string;
-                example: string;
+                properties: {
+                    partyIdInfo: {
+                        title: string;
+                        type: string;
+                        description: string;
+                        properties: {
+                            partyIdType: {
+                                title: string;
+                                type: string;
+                                enum: string[];
+                                description: string;
+                            };
+                            partyIdentifier: {
+                                title: string;
+                                type: string;
+                                minLength: number;
+                                maxLength: number;
+                                description: string;
+                                example: string;
+                            };
+                            partySubIdOrType: {
+                                title: string;
+                                type: string;
+                                minLength: number;
+                                maxLength: number;
+                                description: string;
+                            };
+                            fspId: {
+                                title: string;
+                                type: string;
+                                minLength: number;
+                                maxLength: number;
+                                description: string;
+                            };
+                            extensionList: {
+                                title: string;
+                                type: string;
+                                description: string;
+                                properties: {
+                                    extension: {
+                                        type: string;
+                                        items: {
+                                            title: string;
+                                            type: string;
+                                            description: string;
+                                            properties: {
+                                                key: {
+                                                    title: string;
+                                                    type: string;
+                                                    minLength: number;
+                                                    maxLength: number;
+                                                    description: string;
+                                                };
+                                                value: {
+                                                    title: string;
+                                                    type: string;
+                                                    minLength: number;
+                                                    maxLength: number;
+                                                    description: string;
+                                                };
+                                            };
+                                            required: string[];
+                                        };
+                                        minItems: number;
+                                        maxItems: number;
+                                        description: string;
+                                    };
+                                };
+                                required: string[];
+                            };
+                        };
+                        required: string[];
+                    };
+                    merchantClassificationCode: {
+                        title: string;
+                        type: string;
+                        pattern: string;
+                        description: string;
+                    };
+                    name: {
+                        title: string;
+                        type: string;
+                        minLength: number;
+                        maxLength: number;
+                        description: string;
+                    };
+                    personalInfo: {
+                        title: string;
+                        type: string;
+                        description: string;
+                        properties: {
+                            complexName: {
+                                title: string;
+                                type: string;
+                                description: string;
+                                properties: {
+                                    firstName: {
+                                        title: string;
+                                        type: string;
+                                        minLength: number;
+                                        maxLength: number;
+                                        pattern: string;
+                                        description: string;
+                                        example: string;
+                                    };
+                                    middleName: {
+                                        title: string;
+                                        type: string;
+                                        minLength: number;
+                                        maxLength: number;
+                                        pattern: string;
+                                        description: string;
+                                        example: string;
+                                    };
+                                    lastName: {
+                                        title: string;
+                                        type: string;
+                                        minLength: number;
+                                        maxLength: number;
+                                        pattern: string;
+                                        description: string;
+                                        example: string;
+                                    };
+                                };
+                            };
+                            dateOfBirth: {
+                                title: string;
+                                type: string;
+                                pattern: string;
+                                description: string;
+                                example: string;
+                            };
+                        };
+                    };
+                };
+                required: string[];
+            };
+            headers: {
+                type: string;
+            };
+        };
+        required: string[];
+    };
+    const TransactionRequestState: {
+        title: string;
+        type: string;
+        enum: string[];
+        description: string;
+        example: string;
+    };
+    const TransactionRequestResponse: {
+        title: string;
+        type: string;
+        description: string;
+        properties: {
+            body: {
+                type: string;
+                properties: {
+                    transactionId: {
+                        title: string;
+                        type: string;
+                        pattern: string;
+                        description: string;
+                        example: string;
+                    };
+                    transactionRequestState: {
+                        title: string;
+                        type: string;
+                        enum: string[];
+                        description: string;
+                        example: string;
+                    };
+                    extensionList: {
+                        title: string;
+                        type: string;
+                        description: string;
+                        properties: {
+                            extension: {
+                                type: string;
+                                items: {
+                                    title: string;
+                                    type: string;
+                                    description: string;
+                                    properties: {
+                                        key: {
+                                            title: string;
+                                            type: string;
+                                            minLength: number;
+                                            maxLength: number;
+                                            description: string;
+                                        };
+                                        value: {
+                                            title: string;
+                                            type: string;
+                                            minLength: number;
+                                            maxLength: number;
+                                            description: string;
+                                        };
+                                    };
+                                    required: string[];
+                                };
+                                minItems: number;
+                                maxItems: number;
+                                description: string;
+                            };
+                        };
+                        required: string[];
+                    };
+                };
+                required: string[];
+            };
+            headers: {
+                type: string;
             };
+        };
+        required: string[];
+    };
+    const requestToPayResponse: {
+        type: string;
+        required: string[];
+        properties: {
             transactionRequestId: {
                 title: string;
                 type: string;
@@ -7971,10 +8204,6 @@ export declare namespace Schemas {
                 description: string;
                 example: string;
             };
-            homeTransactionId: {
-                type: string;
-                description: string;
-            };
             from: {
                 type: string;
                 required: string[];
@@ -8244,16 +8473,223 @@ export declare namespace Schemas {
                 enum: string[];
             };
             getPartiesResponse: {
+                title: string;
                 type: string;
+                description: string;
+                properties: {
+                    body: {
+                        title: string;
+                        type: string;
+                        description: string;
+                        properties: {
+                            partyIdInfo: {
+                                title: string;
+                                type: string;
+                                description: string;
+                                properties: {
+                                    partyIdType: {
+                                        title: string;
+                                        type: string;
+                                        enum: string[];
+                                        description: string;
+                                    };
+                                    partyIdentifier: {
+                                        title: string;
+                                        type: string;
+                                        minLength: number;
+                                        maxLength: number;
+                                        description: string;
+                                        example: string;
+                                    };
+                                    partySubIdOrType: {
+                                        title: string;
+                                        type: string;
+                                        minLength: number;
+                                        maxLength: number;
+                                        description: string;
+                                    };
+                                    fspId: {
+                                        title: string;
+                                        type: string;
+                                        minLength: number;
+                                        maxLength: number;
+                                        description: string;
+                                    };
+                                    extensionList: {
+                                        title: string;
+                                        type: string;
+                                        description: string;
+                                        properties: {
+                                            extension: {
+                                                type: string;
+                                                items: {
+                                                    title: string;
+                                                    type: string;
+                                                    description: string;
+                                                    properties: {
+                                                        key: {
+                                                            title: string;
+                                                            type: string;
+                                                            minLength: number;
+                                                            maxLength: number;
+                                                            description: string;
+                                                        };
+                                                        value: {
+                                                            title: string;
+                                                            type: string;
+                                                            minLength: number;
+                                                            maxLength: number;
+                                                            description: string;
+                                                        };
+                                                    };
+                                                    required: string[];
+                                                };
+                                                minItems: number;
+                                                maxItems: number;
+                                                description: string;
+                                            };
+                                        };
+                                        required: string[];
+                                    };
+                                };
+                                required: string[];
+                            };
+                            merchantClassificationCode: {
+                                title: string;
+                                type: string;
+                                pattern: string;
+                                description: string;
+                            };
+                            name: {
+                                title: string;
+                                type: string;
+                                minLength: number;
+                                maxLength: number;
+                                description: string;
+                            };
+                            personalInfo: {
+                                title: string;
+                                type: string;
+                                description: string;
+                                properties: {
+                                    complexName: {
+                                        title: string;
+                                        type: string;
+                                        description: string;
+                                        properties: {
+                                            firstName: {
+                                                title: string;
+                                                type: string;
+                                                minLength: number;
+                                                maxLength: number;
+                                                pattern: string;
+                                                description: string;
+                                                example: string;
+                                            };
+                                            middleName: {
+                                                title: string;
+                                                type: string;
+                                                minLength: number;
+                                                maxLength: number;
+                                                pattern: string;
+                                                description: string;
+                                                example: string;
+                                            };
+                                            lastName: {
+                                                title: string;
+                                                type: string;
+                                                minLength: number;
+                                                maxLength: number;
+                                                pattern: string;
+                                                description: string;
+                                                example: string;
+                                            };
+                                        };
+                                    };
+                                    dateOfBirth: {
+                                        title: string;
+                                        type: string;
+                                        pattern: string;
+                                        description: string;
+                                        example: string;
+                                    };
+                                };
+                            };
+                        };
+                        required: string[];
+                    };
+                    headers: {
+                        type: string;
+                    };
+                };
                 required: string[];
+            };
+            transactionRequestResponse: {
+                title: string;
+                type: string;
+                description: string;
                 properties: {
                     body: {
                         type: string;
+                        properties: {
+                            transactionId: {
+                                title: string;
+                                type: string;
+                                pattern: string;
+                                description: string;
+                                example: string;
+                            };
+                            transactionRequestState: {
+                                title: string;
+                                type: string;
+                                enum: string[];
+                                description: string;
+                                example: string;
+                            };
+                            extensionList: {
+                                title: string;
+                                type: string;
+                                description: string;
+                                properties: {
+                                    extension: {
+                                        type: string;
+                                        items: {
+                                            title: string;
+                                            type: string;
+                                            description: string;
+                                            properties: {
+                                                key: {
+                                                    title: string;
+                                                    type: string;
+                                                    minLength: number;
+                                                    maxLength: number;
+                                                    description: string;
+                                                };
+                                                value: {
+                                                    title: string;
+                                                    type: string;
+                                                    minLength: number;
+                                                    maxLength: number;
+                                                    description: string;
+                                                };
+                                            };
+                                            required: string[];
+                                        };
+                                        minItems: number;
+                                        maxItems: number;
+                                        description: string;
+                                    };
+                                };
+                                required: string[];
+                            };
+                        };
+                        required: string[];
                     };
                     headers: {
                         type: string;
                     };
                 };
+                required: string[];
             };
             lastError: {
                 type: string;
@@ -8330,6 +8766,10 @@ export declare namespace Schemas {
             };
         };
     };
+    const transferStatus: {
+        type: string;
+        enum: string[];
+    };
     const QuotesIDPutResponse: {
         title: string;
         type: string;

package/lib/sdk-scheme-adapter/v2_0_0/outbound/schemas.js

@@ -98,9 +98,14 @@ var Schemas;
     Schemas.simpleQuotesPostRequest = json_schemas_json_1.default.simpleQuotesPostRequest;
     Schemas.quotesPostResponse = json_schemas_json_1.default.quotesPostResponse;
     Schemas.errorQuotesResponse = json_schemas_json_1.default.errorQuotesResponse;
+    Schemas.AuthenticationType = json_schemas_json_1.default.AuthenticationType;
     Schemas.requestToPayRequest = json_schemas_json_1.default.requestToPayRequest;
-    Schemas.transferStatus = json_schemas_json_1.default.transferStatus;
+    Schemas.requestToPayStatus = json_schemas_json_1.default.requestToPayStatus;
+    Schemas.getPartiesResponse = json_schemas_json_1.default.getPartiesResponse;
+    Schemas.TransactionRequestState = json_schemas_json_1.default.TransactionRequestState;
+    Schemas.TransactionRequestResponse = json_schemas_json_1.default.TransactionRequestResponse;
     Schemas.requestToPayResponse = json_schemas_json_1.default.requestToPayResponse;
+    Schemas.transferStatus = json_schemas_json_1.default.transferStatus;
     Schemas.QuotesIDPutResponse = json_schemas_json_1.default.QuotesIDPutResponse;
     Schemas.TransfersIDPutResponse = json_schemas_json_1.default.TransfersIDPutResponse;
     Schemas.transferResponse = json_schemas_json_1.default.transferResponse;