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

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

@@ -383,15 +383,15 @@ paths:
           $ref: '#/components/responses/transferServerError'
         '504':
           $ref: '#/components/responses/transferTimeout'
-  /requestToPayTransfer/{requestToPayTransactionId}:
+  /requestToPayTransfer/{transactionRequestId}:
     put:
       summary: >-
         Continues a transfer that has paused at the otp stage in order to accept
         or reject quote
       description: >
-        The HTTP request `PUT /transfers/{transferId}` is used to continue a
-        transfer initiated via the `POST /transfers` method that has halted
-        after party lookup and/or quotation stage.
+        This request is used to continue a requestToPayTransfer initiated via
+        the `POST /requestToPayTransfer` method that has halted after quotation
+        stage and/or otp stage.
 
 
         The request body should contain either the "acceptOTP" or "acceptQuote"
@@ -410,7 +410,7 @@ paths:
                 - $ref: '#/components/schemas/transferContinuationAcceptQuote'
                 - $ref: '#/components/schemas/transferContinuationAcceptOTP'
       parameters:
-        - $ref: '#/components/parameters/requestToPayTransactionId'
+        - $ref: '#/components/parameters/transactionRequestId'
       responses:
         '200':
           $ref: '#/components/responses/transferSuccess'
@@ -2411,7 +2411,7 @@ components:
     requestToPayTransferResponse:
       type: object
       required:
-        - requestToPayTransactionId
+        - transactionRequestId
         - from
         - to
         - amountType
@@ -2421,11 +2421,13 @@ components:
       properties:
         transferId:
           $ref: '#/components/schemas/CorrelationId'
-        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:
@@ -2808,15 +2810,6 @@ components:
       description: >-
         Identifier of the merchant request to pay to continue as returned in the
         response to a `POST /requestToPay` request.
-    requestToPayTransactionId:
-      name: requestToPayTransactionId
-      in: path
-      required: true
-      schema:
-        $ref: '#/components/schemas/CorrelationId'
-      description: >-
-        Identifier of the merchant request to pay transfer to continue as
-        returned in the response to a `POST /requestToPayTransfer` request.
     transferId:
       name: transferId
       in: path

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

@@ -21275,7 +21275,7 @@
     "requestToPayTransferResponse": {
         "type": "object",
         "required": [
-            "requestToPayTransactionId",
+            "transactionRequestId",
             "from",
             "to",
             "amountType",
@@ -21291,10 +21291,17 @@
                 "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"
             },
-            "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": [

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

@@ -272,9 +272,9 @@ export interface paths {
             };
         };
     };
-    "/requestToPayTransfer/{requestToPayTransactionId}": {
+    "/requestToPayTransfer/{transactionRequestId}": {
         /**
-         * The HTTP request `PUT /transfers/{transferId}` is used to continue a transfer initiated via the `POST /transfers` method that has halted after party lookup and/or quotation stage.
+         * This request is used to continue a requestToPayTransfer initiated via the `POST /requestToPayTransfer` method that has halted after quotation stage and/or otp stage.
          *
          * The request body should contain either the "acceptOTP" or "acceptQuote" property set to `true` as required to continue the transfer.
          *
@@ -283,8 +283,8 @@ export interface paths {
         put: {
             parameters: {
                 path: {
-                    /** Identifier of the merchant request to pay transfer to continue as returned in the response to a `POST /requestToPayTransfer` request. */
-                    requestToPayTransactionId: components["parameters"]["requestToPayTransactionId"];
+                    /** Identifier of the merchant request to pay to continue as returned in the response to a `POST /requestToPay` request. */
+                    transactionRequestId: components["parameters"]["transactionRequestId"];
                 };
             };
             responses: {
@@ -1231,7 +1231,8 @@ export interface components {
         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;
+            homeR2PTransactionId?: string;
+            transactionRequestId: components["schemas"]["CorrelationId"];
             from: components["schemas"]["transferParty"];
             to: components["schemas"]["transferParty"];
             amountType: components["schemas"]["AmountType"];
@@ -1476,8 +1477,6 @@ export interface components {
         SubId: string;
         /** @description Identifier of the merchant request to pay to continue as returned in the response to a `POST /requestToPay` request. */
         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. */
         transferId: components["schemas"]["CorrelationId"];
     };

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

@@ -10728,9 +10728,16 @@ export declare namespace Schemas {
                 description: string;
                 example: string;
             };
-            requestToPayTransactionId: {
+            homeR2PTransactionId: {
+                type: string;
+                description: string;
+            };
+            transactionRequestId: {
+                title: string;
                 type: string;
+                pattern: string;
                 description: string;
+                example: string;
             };
             from: {
                 type: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/api-snippets",
-  "version": "17.2.0-snapshot.0",
+  "version": "17.2.0-snapshot.1",
   "description": "Mojaloop API specification reusable snippets",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

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

@@ -1,6 +1,6 @@
 type: object
 required:
-  - requestToPayTransactionId
+  - transactionRequestId
   - from
   - to
   - amountType
@@ -10,11 +10,13 @@ required:
 properties:
   transferId:
     $ref: ./CorrelationId.yaml
-  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:

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

@@ -48,8 +48,8 @@ paths:
     $ref: paths/requestToPay_transactionRequestId.yaml
   /requestToPayTransfer:
     $ref: paths/requestToPayTransfer.yaml
-  /requestToPayTransfer/{requestToPayTransactionId}:
-    $ref: paths/requestToPayTransfer_requestToPayTransactionId.yaml
+  /requestToPayTransfer/{transactionRequestId}:
+    $ref: paths/requestToPayTransfer_transactionRequestId.yaml
   /simpleTransfers:
     $ref: paths/simpleTransfers.yaml
   /transfers:

package/sdk-scheme-adapter/v2_0_0/outbound/paths/{requestToPayTransfer_requestToPayTransactionId.yaml → requestToPayTransfer_transactionRequestId.yaml}

@@ -3,9 +3,9 @@ put:
     Continues a transfer that has paused at the otp stage in order to accept or
     reject quote
   description: >
-    The HTTP request `PUT /transfers/{transferId}` is used to continue a
-    transfer initiated via the `POST /transfers` method that has halted after
-    party lookup and/or quotation stage.
+    This request is used to continue a
+    requestToPayTransfer initiated via the `POST /requestToPayTransfer` method that has halted after
+    quotation stage and/or otp stage.
 
 
     The request body should contain either the "acceptOTP" or "acceptQuote"
@@ -24,7 +24,7 @@ put:
             - $ref: ../../components/schemas/transferContinuationAcceptQuote.yaml
             - $ref: ../../components/schemas/transferContinuationAcceptOTP.yaml
   parameters:
-    - $ref: ../../components/parameters/requestToPayTransactionId.yaml
+    - $ref: ../../components/parameters/transactionRequestId.yaml
   responses:
     '200':
       $ref: ../../components/responses/transferSuccess.yaml

package/sdk-scheme-adapter/v2_0_0/components/parameters/requestToPayTransactionId.yaml

@@ -1,8 +0,0 @@
-name: requestToPayTransactionId
-in: path
-required: true
-schema:
-  $ref: ../schemas/CorrelationId.yaml
-description: >-
-  Identifier of the merchant request to pay transfer to continue as returned in
-  the response to a `POST /requestToPayTransfer` request.