@mojaloop/api-snippets 17.1.0-snapshot.1 → 17.2.0-snapshot.0

package/CHANGELOG.md

@@ -1,4 +1,11 @@
 # Changelog: [mojaloop/api-snippets](https://github.com/mojaloop/api-snippets)
+## [17.1.0](https://github.com/mojaloop/api-snippets/compare/v17.0.4...v17.1.0) (2023-05-19)
+
+
+### Features
+
+* **mojaloop/3345:** enhance payee requesttopay apis ([#162](https://github.com/mojaloop/api-snippets/issues/162)) ([49b31e0](https://github.com/mojaloop/api-snippets/commit/49b31e0eb046483b7cdf868f0305a09a42a47889))
+
 ### [17.0.4](https://github.com/mojaloop/api-snippets/compare/v17.0.3...v17.0.4) (2023-04-26)
 
 

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

@@ -104,6 +104,29 @@ paths:
       summary: Callbacks for the bulk transaction request.
       tags:
         - BulkTransactionsPut
+  /requestToPay/{transactionRequestId}:
+    put:
+      description: >-
+        It is used to notify the DFSP backend about the status of the
+        requestToPayTransfer.
+      operationId: RequestToPayPut
+      parameters:
+        - $ref: '#/components/parameters/transactionRequestId'
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/requestToPayCallback'
+      responses:
+        '200':
+          description: OK
+        '400':
+          $ref: '#/components/responses/400'
+        '500':
+          $ref: '#/components/responses/500'
+      summary: Callback for the requestToPay request.
+      tags:
+        - RequestToPayPut
   /bulkTransfers:
     post:
       operationId: BackendBulkTransfersPost
@@ -1196,6 +1219,11 @@ components:
     quoteRequest:
       description: A request for a quote for transfer from the DFSP backend.
       properties:
+        homeR2PTransactionId:
+          type: string
+          description: >-
+            Linked homeR2PTransactionId which was generated as part of POST
+            /requestToPay to SDK incase of requestToPay transfer.
         amount:
           $ref: '#/components/schemas/money'
         amountType:
@@ -1233,6 +1261,8 @@ components:
           $ref: '#/components/schemas/transactionId'
         transactionType:
           $ref: '#/components/schemas/transactionType'
+        transactionRequestId:
+          $ref: '#/components/schemas/transactionRequestId'
       required:
         - quoteId
         - transactionId
@@ -1346,7 +1376,7 @@ components:
     transactionRequestResponse:
       description: A response to a request for a quote.
       properties:
-        homeTransactionId:
+        homeR2PTransactionId:
           type: string
           description: >-
             Transaction ID from the DFSP backend, used to reconcile transactions
@@ -1483,6 +1513,11 @@ components:
       type: object
     transferRequest:
       properties:
+        homeR2PTransactionId:
+          type: string
+          description: >-
+            Linked homeR2PTransactionId which was generated as part of POST
+            /requestToPay to SDK incase of requestToPay transfer.
         amount:
           $ref: '#/components/schemas/money'
         amountType:
@@ -1513,6 +1548,8 @@ components:
           $ref: '#/components/schemas/transactionType'
         transferId:
           $ref: '#/components/schemas/transferId'
+        transactionRequestId:
+          $ref: '#/components/schemas/transactionRequestId'
       required:
         - transferId
         - quote
@@ -1560,6 +1597,18 @@ components:
         - WAITING_FOR_QUOTE_ACCEPTANCE
         - COMPLETED
       type: string
+    requestToPayCallback:
+      description: Callback for requestToPay.
+      properties:
+        homeR2PTransactionId:
+          type: string
+          description: >-
+            Transaction ID from the DFSP backend, used to reconcile transactions
+            between the Switch and DFSP backend systems.
+        transactionRequestState:
+          $ref: '#/components/schemas/transactionRequestState'
+      required:
+        - transactionRequestState
     TransactionSubScenario:
       title: TransactionSubScenario
       type: string

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

@@ -2370,7 +2370,8 @@ components:
     requestToPayTransferRequest:
       type: object
       required:
-        - requestToPayTransactionId
+        - homeR2PTransactionId
+        - transactionRequestId
         - from
         - to
         - amountType
@@ -2380,11 +2381,13 @@ components:
         - initiator
         - initiatorType
       properties:
-        requestToPayTransactionId:
+        homeR2PTransactionId:
           type: string
           description: >-
             Transaction ID from the DFSP backend, used to reconcile transactions
             between the Switch and DFSP backend systems.
+        transactionRequestId:
+          $ref: '#/components/schemas/CorrelationId'
         from:
           $ref: '#/components/schemas/transferParty'
         to:
@@ -2403,6 +2406,8 @@ components:
           $ref: '#/components/schemas/TransactionInitiatorType'
         note:
           $ref: '#/components/schemas/Note'
+        authenticationType:
+          $ref: '#/components/schemas/AuthenticationType'
     requestToPayTransferResponse:
       type: object
       required:

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

@@ -6153,6 +6153,10 @@
     "quoteRequest": {
         "description": "A request for a quote for transfer from the DFSP backend.",
         "properties": {
+            "homeR2PTransactionId": {
+                "type": "string",
+                "description": "Linked homeR2PTransactionId which was generated as part of POST /requestToPay to SDK incase of requestToPay transfer."
+            },
             "amount": {
                 "pattern": "^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$",
                 "type": "string"
@@ -6781,6 +6785,11 @@
                     "PAYMENT"
                 ],
                 "type": "string"
+            },
+            "transactionRequestId": {
+                "description": "A Mojaloop API transaction request identifier (UUID).",
+                "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
+                "type": "string"
             }
         },
         "required": [
@@ -8037,7 +8046,7 @@
     "transactionRequestResponse": {
         "description": "A response to a request for a quote.",
         "properties": {
-            "homeTransactionId": {
+            "homeR2PTransactionId": {
                 "type": "string",
                 "description": "Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems."
             },
@@ -8659,6 +8668,10 @@
     },
     "transferRequest": {
         "properties": {
+            "homeR2PTransactionId": {
+                "type": "string",
+                "description": "Linked homeR2PTransactionId which was generated as part of POST /requestToPay to SDK incase of requestToPay transfer."
+            },
             "amount": {
                 "pattern": "^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$",
                 "type": "string"
@@ -10408,6 +10421,11 @@
                 "description": "A Mojaloop API transfer identifier (UUID).",
                 "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
                 "type": "string"
+            },
+            "transactionRequestId": {
+                "description": "A Mojaloop API transaction request identifier (UUID).",
+                "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
+                "type": "string"
             }
         },
         "required": [
@@ -10477,6 +10495,27 @@
         ],
         "type": "string"
     },
+    "requestToPayCallback": {
+        "description": "Callback for requestToPay.",
+        "properties": {
+            "homeR2PTransactionId": {
+                "type": "string",
+                "description": "Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems."
+            },
+            "transactionRequestState": {
+                "enum": [
+                    "RECEIVED",
+                    "PENDING",
+                    "ACCEPTED",
+                    "REJECTED"
+                ],
+                "type": "string"
+            }
+        },
+        "required": [
+            "transactionRequestState"
+        ]
+    },
     "TransactionSubScenario": {
         "title": "TransactionSubScenario",
         "type": "string",

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

@@ -16,6 +16,10 @@ export interface paths {
         /** The HTTP request `PUT /bulkTransactions/{bulkTransactionId}` is used to amend information regarding a bulk transaction, i.e. when autoAcceptParty or autoAcceptQuote  is false then the payer need to provide confirmation to proceed with further processing of the request. The `{bulkTransactionId}` in the URI should contain the `bulkTransactionId` that was used for the creation of the bulk transfer. */
         put: operations["BackendBulkTransactionsPut"];
     };
+    "/requestToPay/{transactionRequestId}": {
+        /** It is used to notify the DFSP backend about the status of the requestToPayTransfer. */
+        put: operations["RequestToPayPut"];
+    };
     "/bulkTransfers": {
         post: operations["BackendBulkTransfersPost"];
     };
@@ -342,6 +346,8 @@ export interface components {
         quoteId: string;
         /** @description A request for a quote for transfer from the DFSP backend. */
         quoteRequest: {
+            /** @description Linked homeR2PTransactionId which was generated as part of POST /requestToPay to SDK incase of requestToPay transfer. */
+            homeR2PTransactionId?: string;
             amount: components["schemas"]["money"];
             amountType: components["schemas"]["amountType"];
             currency: components["schemas"]["currency"];
@@ -360,6 +366,7 @@ export interface components {
             to: components["schemas"]["transferParty"];
             transactionId: components["schemas"]["transactionId"];
             transactionType: components["schemas"]["transactionType"];
+            transactionRequestId?: components["schemas"]["transactionRequestId"];
         };
         /** @description A response to a request for a quote. */
         quoteResponse: {
@@ -405,7 +412,7 @@ export interface components {
         /** @description A response to a request for a quote. */
         transactionRequestResponse: {
             /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
-            homeTransactionId?: string;
+            homeR2PTransactionId?: string;
             transactionId: components["schemas"]["transactionId"];
             transactionRequestState: components["schemas"]["transactionRequestState"];
         };
@@ -465,6 +472,8 @@ export interface components {
             type?: components["schemas"]["payerType"];
         };
         transferRequest: {
+            /** @description Linked homeR2PTransactionId which was generated as part of POST /requestToPay to SDK incase of requestToPay transfer. */
+            homeR2PTransactionId?: string;
             amount: components["schemas"]["money"];
             amountType: components["schemas"]["amountType"];
             currency: components["schemas"]["currency"];
@@ -479,6 +488,7 @@ export interface components {
             to: components["schemas"]["transferParty"];
             transactionType: components["schemas"]["transactionType"];
             transferId: components["schemas"]["transferId"];
+            transactionRequestId?: components["schemas"]["transactionRequestId"];
         };
         transferResponse: {
             completedTimestamp?: components["schemas"]["timestamp"];
@@ -495,6 +505,12 @@ export interface components {
         transferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED";
         /** @enum {string} */
         transferStatus: "ERROR_OCCURRED" | "WAITING_FOR_PARTY_ACCEPTANCE" | "WAITING_FOR_QUOTE_ACCEPTANCE" | "COMPLETED";
+        /** @description Callback for requestToPay. */
+        requestToPayCallback: {
+            /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
+            homeR2PTransactionId?: string;
+            transactionRequestState: components["schemas"]["transactionRequestState"];
+        };
         /**
          * TransactionSubScenario
          * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).
@@ -905,6 +921,25 @@ export interface operations {
             };
         };
     };
+    /** It is used to notify the DFSP backend about the status of the requestToPayTransfer. */
+    RequestToPayPut: {
+        parameters: {
+            path: {
+                transactionRequestId: components["parameters"]["transactionRequestId"];
+            };
+        };
+        responses: {
+            /** OK */
+            200: unknown;
+            400: components["responses"]["400"];
+            500: components["responses"]["500"];
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["requestToPayCallback"];
+            };
+        };
+    };
     BackendBulkTransfersPost: {
         responses: {
             /** The bulk transfer was accepted. */

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

@@ -2011,6 +2011,10 @@ export declare namespace Schemas {
     const quoteRequest: {
         description: string;
         properties: {
+            homeR2PTransactionId: {
+                type: string;
+                description: string;
+            };
             amount: {
                 pattern: string;
                 type: string;
@@ -2256,6 +2260,11 @@ export declare namespace Schemas {
                 enum: string[];
                 type: string;
             };
+            transactionRequestId: {
+                description: string;
+                pattern: string;
+                type: string;
+            };
         };
         required: string[];
         type: string;
@@ -2601,7 +2610,7 @@ export declare namespace Schemas {
     const transactionRequestResponse: {
         description: string;
         properties: {
-            homeTransactionId: {
+            homeR2PTransactionId: {
                 type: string;
                 description: string;
             };
@@ -2951,6 +2960,10 @@ export declare namespace Schemas {
     };
     const transferRequest: {
         properties: {
+            homeR2PTransactionId: {
+                type: string;
+                description: string;
+            };
             amount: {
                 pattern: string;
                 type: string;
@@ -3596,6 +3609,11 @@ export declare namespace Schemas {
                 pattern: string;
                 type: string;
             };
+            transactionRequestId: {
+                description: string;
+                pattern: string;
+                type: string;
+            };
         };
         required: string[];
         type: string;
@@ -3637,6 +3655,20 @@ export declare namespace Schemas {
         enum: string[];
         type: string;
     };
+    const requestToPayCallback: {
+        description: string;
+        properties: {
+            homeR2PTransactionId: {
+                type: string;
+                description: string;
+            };
+            transactionRequestState: {
+                enum: string[];
+                type: string;
+            };
+        };
+        required: string[];
+    };
     const TransactionSubScenario: {
         title: string;
         type: string;

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

@@ -71,6 +71,7 @@ var Schemas;
     Schemas.transferResponse = json_schemas_json_1.default.transferResponse;
     Schemas.transferState = json_schemas_json_1.default.transferState;
     Schemas.transferStatus = json_schemas_json_1.default.transferStatus;
+    Schemas.requestToPayCallback = json_schemas_json_1.default.requestToPayCallback;
     Schemas.TransactionSubScenario = json_schemas_json_1.default.TransactionSubScenario;
     Schemas.CorrelationId = json_schemas_json_1.default.CorrelationId;
     Schemas.bulkTransactionStatus = json_schemas_json_1.default.bulkTransactionStatus;

package/lib/sdk-scheme-adapter/v2_0_0/backend/schemas.js.map

@@ -1 +1 @@
-{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../../src/sdk-scheme-adapter/v2_0_0/backend/schemas.ts"],"names":[],"mappings":";AAAA,oDAAoD;;;;AAEpD,kEAAkE;AAElE,oFAA6C;AAE7C,IAAiB,OAAO,CA4GvB;AA5GD,WAAiB,OAAO;IACT,mBAAW,GAAG,2BAAW,CAAC,WAAW,CAAA;IACrC,iBAAS,GAAG,2BAAW,CAAC,SAAS,CAAA;IACjC,aAAK,GAAG,2BAAW,CAAC,KAAK,CAAA;IACzB,uBAAe,GAAG,2BAAW,CAAC,eAAe,CAAA;IAC7C,mCAA2B,GAAG,2BAAW,CAAC,2BAA2B,CAAA;IACrE,oCAA4B,GAAG,2BAAW,CAAC,4BAA4B,CAAA;IACvE,0BAAkB,GAAG,2BAAW,CAAC,kBAAkB,CAAA;IACnD,gCAAwB,GAAG,2BAAW,CAAC,wBAAwB,CAAA;IAC/D,gBAAQ,GAAG,2BAAW,CAAC,QAAQ,CAAA;IAC/B,kCAA0B,GAAG,2BAAW,CAAC,0BAA0B,CAAA;IACnE,kBAAU,GAAG,2BAAW,CAAC,UAAU,CAAA;IACnC,sBAAc,GAAG,2BAAW,CAAC,cAAc,CAAA;IAC3C,kBAAU,GAAG,2BAAW,CAAC,UAAU,CAAA;IACnC,mBAAW,GAAG,2BAAW,CAAC,WAAW,CAAA;IACrC,wBAAgB,GAAG,2BAAW,CAAC,gBAAgB,CAAA;IAC/C,yBAAiB,GAAG,2BAAW,CAAC,iBAAiB,CAAA;IACjD,sBAAc,GAAG,2BAAW,CAAC,cAAc,CAAA;IAC3C,2BAAmB,GAAG,2BAAW,CAAC,mBAAmB,CAAA;IACrD,4BAAoB,GAAG,2BAAW,CAAC,oBAAoB,CAAA;IACvD,gBAAQ,GAAG,2BAAW,CAAC,QAAQ,CAAA;IAC/B,mBAAW,GAAG,2BAAW,CAAC,WAAW,CAAA;IACrC,iBAAS,GAAG,2BAAW,CAAC,SAAS,CAAA;IACjC,wBAAgB,GAAG,2BAAW,CAAC,gBAAgB,CAAA;IAC/C,wBAAgB,GAAG,2BAAW,CAAC,gBAAgB,CAAA;IAC/C,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,4BAAoB,GAAG,2BAAW,CAAC,oBAAoB,CAAA;IACvD,aAAK,GAAG,2BAAW,CAAC,KAAK,CAAA;IACzB,0BAAkB,GAAG,2BAAW,CAAC,kBAAkB,CAAA;IACnD,oBAAY,GAAG,2BAAW,CAAC,YAAY,CAAA;IACvC,eAAO,GAAG,2BAAW,CAAC,OAAO,CAAA;IAC7B,kBAAU,GAAG,2BAAW,CAAC,UAAU,CAAA;IACnC,cAAM,GAAG,2BAAW,CAAC,MAAM,CAAA;IAC3B,eAAO,GAAG,2BAAW,CAAC,OAAO,CAAA;IAC7B,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,iBAAS,GAAG,2BAAW,CAAC,SAAS,CAAA;IACjC,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,gBAAQ,GAAG,2BAAW,CAAC,QAAQ,CAAA;IAC/B,iBAAS,GAAG,2BAAW,CAAC,SAAS,CAAA;IACjC,aAAK,GAAG,2BAAW,CAAC,KAAK,CAAA;IACzB,kBAAU,GAAG,2BAAW,CAAC,UAAU,CAAA;IACnC,4BAAoB,GAAG,2BAAW,CAAC,oBAAoB,CAAA;IACvD,iBAAS,GAAG,2BAAW,CAAC,SAAS,CAAA;IACjC,eAAO,GAAG,2BAAW,CAAC,OAAO,CAAA;IAC7B,oBAAY,GAAG,2BAAW,CAAC,YAAY,CAAA;IACvC,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,gBAAQ,GAAG,2BAAW,CAAC,QAAQ,CAAA;IAC/B,iBAAS,GAAG,2BAAW,CAAC,SAAS,CAAA;IACjC,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,0BAAkB,GAAG,2BAAW,CAAC,kBAAkB,CAAA;IACnD,4BAAoB,GAAG,2BAAW,CAAC,oBAAoB,CAAA;IACvD,kCAA0B,GAAG,2BAAW,CAAC,0BAA0B,CAAA;IACnE,+BAAuB,GAAG,2BAAW,CAAC,uBAAuB,CAAA;IAC7D,8BAAsB,GAAG,2BAAW,CAAC,sBAAsB,CAAA;IAC3D,uBAAe,GAAG,2BAAW,CAAC,eAAe,CAAA;IAC7C,6BAAqB,GAAG,2BAAW,CAAC,qBAAqB,CAAA;IACzD,+BAAuB,GAAG,2BAAW,CAAC,uBAAuB,CAAA;IAC7D,kBAAU,GAAG,2BAAW,CAAC,UAAU,CAAA;IACnC,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,uBAAe,GAAG,2BAAW,CAAC,eAAe,CAAA;IAC7C,wBAAgB,GAAG,2BAAW,CAAC,gBAAgB,CAAA;IAC/C,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,sBAAc,GAAG,2BAAW,CAAC,cAAc,CAAA;IAC3C,8BAAsB,GAAG,2BAAW,CAAC,sBAAsB,CAAA;IAC3D,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,6BAAqB,GAAG,2BAAW,CAAC,qBAAqB,CAAA;IACzD,6BAAqB,GAAG,2BAAW,CAAC,qBAAqB,CAAA;IACzD,gBAAQ,GAAG,2BAAW,CAAC,QAAQ,CAAA;IAC/B,cAAM,GAAG,2BAAW,CAAC,MAAM,CAAA;IAC3B,+BAAuB,GAAG,2BAAW,CAAC,uBAAuB,CAAA;IAC7D,uBAAe,GAAG,2BAAW,CAAC,eAAe,CAAA;IAC7C,gBAAQ,GAAG,2BAAW,CAAC,QAAQ,CAAA;IAC/B,8BAAsB,GAAG,2BAAW,CAAC,sBAAsB,CAAA;IAC3D,mBAAW,GAAG,2BAAW,CAAC,WAAW,CAAA;IACrC,uBAAe,GAAG,2BAAW,CAAC,eAAe,CAAA;IAC7C,wBAAgB,GAAG,2BAAW,CAAC,gBAAgB,CAAA;IAC/C,oBAAY,GAAG,2BAAW,CAAC,YAAY,CAAA;IACvC,sBAAc,GAAG,2BAAW,CAAC,cAAc,CAAA;IAC3C,iBAAS,GAAG,2BAAW,CAAC,SAAS,CAAA;IACjC,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,mBAAW,GAAG,2BAAW,CAAC,WAAW,CAAA;IACrC,iBAAS,GAAG,2BAAW,CAAC,SAAS,CAAA;IACjC,wBAAgB,GAAG,2BAAW,CAAC,gBAAgB,CAAA;IAC/C,yBAAiB,GAAG,2BAAW,CAAC,iBAAiB,CAAA;IACjD,aAAK,GAAG,2BAAW,CAAC,KAAK,CAAA;IACzB,kBAAU,GAAG,2BAAW,CAAC,UAAU,CAAA;IACnC,YAAI,GAAG,2BAAW,CAAC,IAAI,CAAA;IACvB,aAAK,GAAG,2BAAW,CAAC,KAAK,CAAA;IACzB,gBAAQ,GAAG,2BAAW,CAAC,QAAQ,CAAA;IAC/B,iBAAS,GAAG,2BAAW,CAAC,SAAS,CAAA;IACjC,eAAO,GAAG,2BAAW,CAAC,OAAO,CAAA;IAC7B,iBAAS,GAAG,2BAAW,CAAC,SAAS,CAAA;IACjC,oBAAY,GAAG,2BAAW,CAAC,YAAY,CAAA;IACvC,iBAAS,GAAG,2BAAW,CAAC,SAAS,CAAA;IACjC,wBAAgB,GAAG,2BAAW,CAAC,gBAAgB,CAAA;IAC/C,wBAAgB,GAAG,2BAAW,CAAC,gBAAgB,CAAA;IAC/C,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,kBAAU,GAAG,2BAAW,CAAC,UAAU,CAAA;IACnC,6BAAqB,GAAG,2BAAW,CAAC,qBAAqB,CAAA;IACzD,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,gCAAwB,GAAG,2BAAW,CAAC,wBAAwB,CAAA;IAC/D,+CAAuC,GAAG,2BAAW,CAAC,uCAAuC,CAAA;IAC7F,+BAAuB,GAAG,2BAAW,CAAC,uBAAuB,CAAA;IAC7D,0BAAkB,GAAG,2BAAW,CAAC,kBAAkB,CAAA;AAClE,CAAC,EA5GgB,OAAO,GAAP,eAAO,KAAP,eAAO,QA4GvB"}
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../../src/sdk-scheme-adapter/v2_0_0/backend/schemas.ts"],"names":[],"mappings":";AAAA,oDAAoD;;;;AAEpD,kEAAkE;AAElE,oFAA6C;AAE7C,IAAiB,OAAO,CA6GvB;AA7GD,WAAiB,OAAO;IACT,mBAAW,GAAG,2BAAW,CAAC,WAAW,CAAA;IACrC,iBAAS,GAAG,2BAAW,CAAC,SAAS,CAAA;IACjC,aAAK,GAAG,2BAAW,CAAC,KAAK,CAAA;IACzB,uBAAe,GAAG,2BAAW,CAAC,eAAe,CAAA;IAC7C,mCAA2B,GAAG,2BAAW,CAAC,2BAA2B,CAAA;IACrE,oCAA4B,GAAG,2BAAW,CAAC,4BAA4B,CAAA;IACvE,0BAAkB,GAAG,2BAAW,CAAC,kBAAkB,CAAA;IACnD,gCAAwB,GAAG,2BAAW,CAAC,wBAAwB,CAAA;IAC/D,gBAAQ,GAAG,2BAAW,CAAC,QAAQ,CAAA;IAC/B,kCAA0B,GAAG,2BAAW,CAAC,0BAA0B,CAAA;IACnE,kBAAU,GAAG,2BAAW,CAAC,UAAU,CAAA;IACnC,sBAAc,GAAG,2BAAW,CAAC,cAAc,CAAA;IAC3C,kBAAU,GAAG,2BAAW,CAAC,UAAU,CAAA;IACnC,mBAAW,GAAG,2BAAW,CAAC,WAAW,CAAA;IACrC,wBAAgB,GAAG,2BAAW,CAAC,gBAAgB,CAAA;IAC/C,yBAAiB,GAAG,2BAAW,CAAC,iBAAiB,CAAA;IACjD,sBAAc,GAAG,2BAAW,CAAC,cAAc,CAAA;IAC3C,2BAAmB,GAAG,2BAAW,CAAC,mBAAmB,CAAA;IACrD,4BAAoB,GAAG,2BAAW,CAAC,oBAAoB,CAAA;IACvD,gBAAQ,GAAG,2BAAW,CAAC,QAAQ,CAAA;IAC/B,mBAAW,GAAG,2BAAW,CAAC,WAAW,CAAA;IACrC,iBAAS,GAAG,2BAAW,CAAC,SAAS,CAAA;IACjC,wBAAgB,GAAG,2BAAW,CAAC,gBAAgB,CAAA;IAC/C,wBAAgB,GAAG,2BAAW,CAAC,gBAAgB,CAAA;IAC/C,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,4BAAoB,GAAG,2BAAW,CAAC,oBAAoB,CAAA;IACvD,aAAK,GAAG,2BAAW,CAAC,KAAK,CAAA;IACzB,0BAAkB,GAAG,2BAAW,CAAC,kBAAkB,CAAA;IACnD,oBAAY,GAAG,2BAAW,CAAC,YAAY,CAAA;IACvC,eAAO,GAAG,2BAAW,CAAC,OAAO,CAAA;IAC7B,kBAAU,GAAG,2BAAW,CAAC,UAAU,CAAA;IACnC,cAAM,GAAG,2BAAW,CAAC,MAAM,CAAA;IAC3B,eAAO,GAAG,2BAAW,CAAC,OAAO,CAAA;IAC7B,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,iBAAS,GAAG,2BAAW,CAAC,SAAS,CAAA;IACjC,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,gBAAQ,GAAG,2BAAW,CAAC,QAAQ,CAAA;IAC/B,iBAAS,GAAG,2BAAW,CAAC,SAAS,CAAA;IACjC,aAAK,GAAG,2BAAW,CAAC,KAAK,CAAA;IACzB,kBAAU,GAAG,2BAAW,CAAC,UAAU,CAAA;IACnC,4BAAoB,GAAG,2BAAW,CAAC,oBAAoB,CAAA;IACvD,iBAAS,GAAG,2BAAW,CAAC,SAAS,CAAA;IACjC,eAAO,GAAG,2BAAW,CAAC,OAAO,CAAA;IAC7B,oBAAY,GAAG,2BAAW,CAAC,YAAY,CAAA;IACvC,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,gBAAQ,GAAG,2BAAW,CAAC,QAAQ,CAAA;IAC/B,iBAAS,GAAG,2BAAW,CAAC,SAAS,CAAA;IACjC,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,0BAAkB,GAAG,2BAAW,CAAC,kBAAkB,CAAA;IACnD,4BAAoB,GAAG,2BAAW,CAAC,oBAAoB,CAAA;IACvD,kCAA0B,GAAG,2BAAW,CAAC,0BAA0B,CAAA;IACnE,+BAAuB,GAAG,2BAAW,CAAC,uBAAuB,CAAA;IAC7D,8BAAsB,GAAG,2BAAW,CAAC,sBAAsB,CAAA;IAC3D,uBAAe,GAAG,2BAAW,CAAC,eAAe,CAAA;IAC7C,6BAAqB,GAAG,2BAAW,CAAC,qBAAqB,CAAA;IACzD,+BAAuB,GAAG,2BAAW,CAAC,uBAAuB,CAAA;IAC7D,kBAAU,GAAG,2BAAW,CAAC,UAAU,CAAA;IACnC,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,uBAAe,GAAG,2BAAW,CAAC,eAAe,CAAA;IAC7C,wBAAgB,GAAG,2BAAW,CAAC,gBAAgB,CAAA;IAC/C,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,sBAAc,GAAG,2BAAW,CAAC,cAAc,CAAA;IAC3C,4BAAoB,GAAG,2BAAW,CAAC,oBAAoB,CAAA;IACvD,8BAAsB,GAAG,2BAAW,CAAC,sBAAsB,CAAA;IAC3D,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,6BAAqB,GAAG,2BAAW,CAAC,qBAAqB,CAAA;IACzD,6BAAqB,GAAG,2BAAW,CAAC,qBAAqB,CAAA;IACzD,gBAAQ,GAAG,2BAAW,CAAC,QAAQ,CAAA;IAC/B,cAAM,GAAG,2BAAW,CAAC,MAAM,CAAA;IAC3B,+BAAuB,GAAG,2BAAW,CAAC,uBAAuB,CAAA;IAC7D,uBAAe,GAAG,2BAAW,CAAC,eAAe,CAAA;IAC7C,gBAAQ,GAAG,2BAAW,CAAC,QAAQ,CAAA;IAC/B,8BAAsB,GAAG,2BAAW,CAAC,sBAAsB,CAAA;IAC3D,mBAAW,GAAG,2BAAW,CAAC,WAAW,CAAA;IACrC,uBAAe,GAAG,2BAAW,CAAC,eAAe,CAAA;IAC7C,wBAAgB,GAAG,2BAAW,CAAC,gBAAgB,CAAA;IAC/C,oBAAY,GAAG,2BAAW,CAAC,YAAY,CAAA;IACvC,sBAAc,GAAG,2BAAW,CAAC,cAAc,CAAA;IAC3C,iBAAS,GAAG,2BAAW,CAAC,SAAS,CAAA;IACjC,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,mBAAW,GAAG,2BAAW,CAAC,WAAW,CAAA;IACrC,iBAAS,GAAG,2BAAW,CAAC,SAAS,CAAA;IACjC,wBAAgB,GAAG,2BAAW,CAAC,gBAAgB,CAAA;IAC/C,yBAAiB,GAAG,2BAAW,CAAC,iBAAiB,CAAA;IACjD,aAAK,GAAG,2BAAW,CAAC,KAAK,CAAA;IACzB,kBAAU,GAAG,2BAAW,CAAC,UAAU,CAAA;IACnC,YAAI,GAAG,2BAAW,CAAC,IAAI,CAAA;IACvB,aAAK,GAAG,2BAAW,CAAC,KAAK,CAAA;IACzB,gBAAQ,GAAG,2BAAW,CAAC,QAAQ,CAAA;IAC/B,iBAAS,GAAG,2BAAW,CAAC,SAAS,CAAA;IACjC,eAAO,GAAG,2BAAW,CAAC,OAAO,CAAA;IAC7B,iBAAS,GAAG,2BAAW,CAAC,SAAS,CAAA;IACjC,oBAAY,GAAG,2BAAW,CAAC,YAAY,CAAA;IACvC,iBAAS,GAAG,2BAAW,CAAC,SAAS,CAAA;IACjC,wBAAgB,GAAG,2BAAW,CAAC,gBAAgB,CAAA;IAC/C,wBAAgB,GAAG,2BAAW,CAAC,gBAAgB,CAAA;IAC/C,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,kBAAU,GAAG,2BAAW,CAAC,UAAU,CAAA;IACnC,6BAAqB,GAAG,2BAAW,CAAC,qBAAqB,CAAA;IACzD,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,gCAAwB,GAAG,2BAAW,CAAC,wBAAwB,CAAA;IAC/D,+CAAuC,GAAG,2BAAW,CAAC,uCAAuC,CAAA;IAC7F,+BAAuB,GAAG,2BAAW,CAAC,uBAAuB,CAAA;IAC7D,0BAAkB,GAAG,2BAAW,CAAC,kBAAkB,CAAA;AAClE,CAAC,EA7GgB,OAAO,GAAP,eAAO,KAAP,eAAO,QA6GvB"}

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

@@ -65,6 +65,7 @@ export declare namespace Types {
     type transferResponse = components['schemas']['transferResponse'];
     type transferState = components['schemas']['transferState'];
     type transferStatus = components['schemas']['transferStatus'];
+    type requestToPayCallback = components['schemas']['requestToPayCallback'];
     type TransactionSubScenario = components['schemas']['TransactionSubScenario'];
     type CorrelationId = components['schemas']['CorrelationId'];
     type bulkTransactionStatus = components['schemas']['bulkTransactionStatus'];

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

@@ -20662,7 +20662,8 @@
     "requestToPayTransferRequest": {
         "type": "object",
         "required": [
-            "requestToPayTransactionId",
+            "homeR2PTransactionId",
+            "transactionRequestId",
             "from",
             "to",
             "amountType",
@@ -20673,10 +20674,17 @@
             "initiatorType"
         ],
         "properties": {
-            "requestToPayTransactionId": {
+            "homeR2PTransactionId": {
                 "type": "string",
                 "description": "Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems."
             },
+            "transactionRequestId": {
+                "title": "CorrelationId",
+                "type": "string",
+                "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
+                "description": "Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).",
+                "example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
+            },
             "from": {
                 "type": "object",
                 "required": [
@@ -21250,6 +21258,17 @@
                 "maxLength": 128,
                 "description": "Memo assigned to transaction.",
                 "example": "Note sent to Payee."
+            },
+            "authenticationType": {
+                "title": "AuthenticationType",
+                "type": "string",
+                "enum": [
+                    "OTP",
+                    "QRCODE",
+                    "U2F"
+                ],
+                "description": "Below are the allowed values for the enumeration AuthenticationType.\n- OTP - One-time password generated by the Payer FSP.\n- QRCODE - QR code used as One Time Password.\n- U2F - U2F is a new addition isolated to Thirdparty stream.",
+                "example": "OTP"
             }
         }
     },

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

@@ -1215,7 +1215,8 @@ export interface components {
         };
         requestToPayTransferRequest: {
             /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
-            requestToPayTransactionId: string;
+            homeR2PTransactionId: string;
+            transactionRequestId: components["schemas"]["CorrelationId"];
             from: components["schemas"]["transferParty"];
             to: components["schemas"]["transferParty"];
             amountType: components["schemas"]["AmountType"];
@@ -1225,6 +1226,7 @@ export interface components {
             initiator: components["schemas"]["TransactionInitiator"];
             initiatorType: components["schemas"]["TransactionInitiatorType"];
             note?: components["schemas"]["Note"];
+            authenticationType?: components["schemas"]["AuthenticationType"];
         };
         requestToPayTransferResponse: {
             transferId?: components["schemas"]["CorrelationId"];

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

@@ -10359,9 +10359,16 @@ export declare namespace Schemas {
         type: string;
         required: string[];
         properties: {
-            requestToPayTransactionId: {
+            homeR2PTransactionId: {
+                type: string;
+                description: string;
+            };
+            transactionRequestId: {
+                title: string;
                 type: string;
+                pattern: string;
                 description: string;
+                example: string;
             };
             from: {
                 type: string;
@@ -10701,6 +10708,13 @@ export declare namespace Schemas {
                 description: string;
                 example: string;
             };
+            authenticationType: {
+                title: string;
+                type: string;
+                enum: string[];
+                description: string;
+                example: string;
+            };
         };
     };
     const requestToPayTransferResponse: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/api-snippets",
-  "version": "17.1.0-snapshot.1",
+  "version": "17.2.0-snapshot.0",
   "description": "Mojaloop API specification reusable snippets",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -72,7 +72,7 @@
     "jest-ts-auto-mock": "^2.1.0",
     "js-yaml": "^4.1.0",
     "json-refs": "^3.0.15",
-    "openapi-types": "^12.1.0",
+    "openapi-types": "^12.1.3",
     "openapi-typescript": "^5.4.1",
     "ts-auto-mock": "^3.6.4",
     "ttypescript": "^1.5.15"
@@ -86,10 +86,10 @@
     "@commitlint/config-conventional": "^17.6.3",
     "@redocly/openapi-cli": "^1.0.0-beta.94",
     "@types/jest": "^29.5.1",
-    "@typescript-eslint/eslint-plugin": "^5.59.6",
-    "@typescript-eslint/parser": "^5.59.6",
+    "@typescript-eslint/eslint-plugin": "^5.59.7",
+    "@typescript-eslint/parser": "^5.59.7",
     "diff": "^5.1.0",
-    "eslint": "^8.40.0",
+    "eslint": "^8.41.0",
     "eslint-config-prettier": "^8.8.0",
     "eslint-config-standard": "^17.0.0",
     "eslint-import-resolver-typescript": "^3.5.5",
@@ -110,7 +110,7 @@
     "swagger-cli": "^4.0.4",
     "ts-jest": "^29.1.0",
     "ts-node": "^10.9.1",
-    "tslib": "^2.5.1",
+    "tslib": "^2.5.2",
     "typescript": "^4.9.4"
   },
   "publishConfig": {

package/sdk-scheme-adapter/v2_0_0/backend/openapi.yaml

@@ -89,6 +89,27 @@ paths:
       summary: Callbacks for the bulk transaction request.
       tags:
         - BulkTransactionsPut
+  /requestToPay/{transactionRequestId}:
+    put:
+      description: It is used to notify the DFSP backend about the status of the requestToPayTransfer.
+      operationId: RequestToPayPut
+      parameters:
+        - $ref: '#/components/parameters/transactionRequestId'
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/requestToPayCallback'
+      responses:
+        '200':
+          description: OK
+        '400':
+          $ref: '#/components/responses/400'
+        '500':
+          $ref: '#/components/responses/500'
+      summary: Callback for the requestToPay request.
+      tags:
+        - RequestToPayPut
   /bulkTransfers:
     post:
       operationId: BackendBulkTransfersPost
@@ -1096,6 +1117,10 @@ components:
     quoteRequest:
       description: A request for a quote for transfer from the DFSP backend.
       properties:
+        homeR2PTransactionId:
+          type: string
+          description: >-
+            Linked homeR2PTransactionId which was generated as part of POST /requestToPay to SDK incase of requestToPay transfer.
         amount:
           $ref: '#/components/schemas/money'
         amountType:
@@ -1133,6 +1158,8 @@ components:
           $ref: '#/components/schemas/transactionId'
         transactionType:
           $ref: '#/components/schemas/transactionType'
+        transactionRequestId:
+          $ref: '#/components/schemas/transactionRequestId'
       required:
         - quoteId
         - transactionId
@@ -1241,7 +1268,7 @@ components:
     transactionRequestResponse:
       description: A response to a request for a quote.
       properties:
-        homeTransactionId:
+        homeR2PTransactionId:
           type: string
           description: >-
             Transaction ID from the DFSP backend, used to reconcile transactions
@@ -1371,6 +1398,10 @@ components:
       type: object
     transferRequest:
       properties:
+        homeR2PTransactionId:
+          type: string
+          description: >-
+            Linked homeR2PTransactionId which was generated as part of POST /requestToPay to SDK incase of requestToPay transfer.
         amount:
           $ref: '#/components/schemas/money'
         amountType:
@@ -1401,6 +1432,8 @@ components:
           $ref: '#/components/schemas/transactionType'
         transferId:
           $ref: '#/components/schemas/transferId'
+        transactionRequestId:
+          $ref: '#/components/schemas/transactionRequestId'
       required:
         - transferId
         - quote
@@ -1442,3 +1475,15 @@ components:
         - WAITING_FOR_QUOTE_ACCEPTANCE
         - COMPLETED
       type: string
+    requestToPayCallback:
+      description: Callback for requestToPay.
+      properties:
+        homeR2PTransactionId:
+          type: string
+          description: >-
+            Transaction ID from the DFSP backend, used to reconcile transactions
+            between the Switch and DFSP backend systems.
+        transactionRequestState:
+          $ref: '#/components/schemas/transactionRequestState'
+      required:
+        - transactionRequestState

package/sdk-scheme-adapter/v2_0_0/components/schemas/requestToPayTransferRequest.yaml

@@ -1,6 +1,7 @@
 type: object
 required:
-  - requestToPayTransactionId
+  - homeR2PTransactionId
+  - transactionRequestId
   - from
   - to
   - amountType
@@ -10,11 +11,13 @@ required:
   - initiator
   - initiatorType
 properties:
-  requestToPayTransactionId:
+  homeR2PTransactionId:
     type: string
     description: >-
       Transaction ID from the DFSP backend, used to reconcile transactions
       between the Switch and DFSP backend systems.
+  transactionRequestId:
+    $ref: ./CorrelationId.yaml
   from:
     $ref: ./transferParty.yaml
   to:
@@ -33,3 +36,5 @@ properties:
     $ref: ./TransactionInitiatorType.yaml
   note:
     $ref: ./Note.yaml
+  authenticationType:
+    $ref: './AuthenticationType.yaml'