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

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'
@@ -2399,7 +2399,9 @@ components:
         amount:
           $ref: '#/components/schemas/Amount'
         scenario:
-          $ref: '#/components/schemas/TransactionType'
+          $ref: '#/components/schemas/TransactionScenario'
+        subScenario:
+          $ref: '#/components/schemas/TransactionSubScenario'
         initiator:
           $ref: '#/components/schemas/TransactionInitiator'
         initiatorType:
@@ -2411,7 +2413,7 @@ components:
     requestToPayTransferResponse:
       type: object
       required:
-        - requestToPayTransactionId
+        - transactionRequestId
         - from
         - to
         - amountType
@@ -2421,11 +2423,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 +2812,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

@@ -21144,90 +21144,24 @@
                 "example": "123.45"
             },
             "scenario": {
-                "title": "TransactionType",
-                "type": "object",
-                "description": "Data model for the complex type TransactionType.",
-                "properties": {
-                    "scenario": {
-                        "title": "TransactionScenario",
-                        "type": "string",
-                        "enum": [
-                            "DEPOSIT",
-                            "WITHDRAWAL",
-                            "TRANSFER",
-                            "PAYMENT",
-                            "REFUND"
-                        ],
-                        "description": "Below are the allowed values for the enumeration.\n- DEPOSIT - Used for performing a Cash-In (deposit) transaction. In a normal scenario, electronic funds are transferred from a Business account to a Consumer account, and physical cash is given from the Consumer to the Business User.\n- WITHDRAWAL - Used for performing a Cash-Out (withdrawal) transaction. In a normal scenario, electronic funds are transferred from a Consumer’s account to a Business account, and physical cash is given from the Business User to the Consumer.\n- TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer) transaction.\n- PAYMENT - Usually used for performing a transaction from a Consumer to a Merchant or Organization, but could also be for a B2B (Business to Business) payment. The transaction could be online for a purchase in an Internet store, in a physical store where both the Consumer and Business User are present, a bill payment, a donation, and so on.\n- REFUND - Used for performing a refund of transaction.",
-                        "example": "DEPOSIT"
-                    },
-                    "subScenario": {
-                        "title": "TransactionSubScenario",
-                        "type": "string",
-                        "pattern": "^[A-Z_]{1,32}$",
-                        "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).",
-                        "example": "LOCALLY_DEFINED_SUBSCENARIO"
-                    },
-                    "initiator": {
-                        "title": "TransactionInitiator",
-                        "type": "string",
-                        "enum": [
-                            "PAYER",
-                            "PAYEE"
-                        ],
-                        "description": "Below are the allowed values for the enumeration.\n- PAYER - Sender of funds is initiating the transaction. The account to send from is either owned by the Payer or is connected to the Payer in some way.\n- PAYEE - Recipient of the funds is initiating the transaction by sending a transaction request. The Payer must approve the transaction, either automatically by a pre-generated OTP or by pre-approval of the Payee, or by manually approving in his or her own Device.",
-                        "example": "PAYEE"
-                    },
-                    "initiatorType": {
-                        "title": "TransactionInitiatorType",
-                        "type": "string",
-                        "enum": [
-                            "CONSUMER",
-                            "AGENT",
-                            "BUSINESS",
-                            "DEVICE"
-                        ],
-                        "description": "Below are the allowed values for the enumeration.\n- CONSUMER - Consumer is the initiator of the transaction.\n- AGENT - Agent is the initiator of the transaction.\n- BUSINESS - Business is the initiator of the transaction.\n- DEVICE - Device is the initiator of the transaction.",
-                        "example": "CONSUMER"
-                    },
-                    "refundInfo": {
-                        "title": "Refund",
-                        "type": "object",
-                        "description": "Data model for the complex type Refund.",
-                        "properties": {
-                            "originalTransactionId": {
-                                "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"
-                            },
-                            "refundReason": {
-                                "title": "RefundReason",
-                                "type": "string",
-                                "minLength": 1,
-                                "maxLength": 128,
-                                "description": "Reason for the refund.",
-                                "example": "Free text indicating reason for the refund."
-                            }
-                        },
-                        "required": [
-                            "originalTransactionId"
-                        ]
-                    },
-                    "balanceOfPayments": {
-                        "title": "BalanceOfPayments",
-                        "type": "string",
-                        "pattern": "^[1-9]\\d{2}$",
-                        "description": "(BopCode) The API data type [BopCode](https://www.imf.org/external/np/sta/bopcode/) is a JSON String of 3 characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed.",
-                        "example": "123"
-                    }
-                },
-                "required": [
-                    "scenario",
-                    "initiator",
-                    "initiatorType"
-                ]
+                "title": "TransactionScenario",
+                "type": "string",
+                "enum": [
+                    "DEPOSIT",
+                    "WITHDRAWAL",
+                    "TRANSFER",
+                    "PAYMENT",
+                    "REFUND"
+                ],
+                "description": "Below are the allowed values for the enumeration.\n- DEPOSIT - Used for performing a Cash-In (deposit) transaction. In a normal scenario, electronic funds are transferred from a Business account to a Consumer account, and physical cash is given from the Consumer to the Business User.\n- WITHDRAWAL - Used for performing a Cash-Out (withdrawal) transaction. In a normal scenario, electronic funds are transferred from a Consumer’s account to a Business account, and physical cash is given from the Business User to the Consumer.\n- TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer) transaction.\n- PAYMENT - Usually used for performing a transaction from a Consumer to a Merchant or Organization, but could also be for a B2B (Business to Business) payment. The transaction could be online for a purchase in an Internet store, in a physical store where both the Consumer and Business User are present, a bill payment, a donation, and so on.\n- REFUND - Used for performing a refund of transaction.",
+                "example": "DEPOSIT"
+            },
+            "subScenario": {
+                "title": "TransactionSubScenario",
+                "type": "string",
+                "pattern": "^[A-Z_]{1,32}$",
+                "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).",
+                "example": "LOCALLY_DEFINED_SUBSCENARIO"
             },
             "initiator": {
                 "title": "TransactionInitiator",
@@ -21275,7 +21209,7 @@
     "requestToPayTransferResponse": {
         "type": "object",
         "required": [
-            "requestToPayTransactionId",
+            "transactionRequestId",
             "from",
             "to",
             "amountType",
@@ -21291,10 +21225,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: {
@@ -1222,7 +1222,8 @@ export interface components {
             amountType: components["schemas"]["AmountType"];
             currency: components["schemas"]["Currency"];
             amount: components["schemas"]["Amount"];
-            scenario: components["schemas"]["TransactionType"];
+            scenario: components["schemas"]["TransactionScenario"];
+            subScenario?: components["schemas"]["TransactionSubScenario"];
             initiator: components["schemas"]["TransactionInitiator"];
             initiatorType: components["schemas"]["TransactionInitiatorType"];
             note?: components["schemas"]["Note"];
@@ -1231,7 +1232,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 +1478,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

@@ -10623,68 +10623,16 @@ export declare namespace Schemas {
             scenario: {
                 title: string;
                 type: string;
+                enum: string[];
                 description: string;
-                properties: {
-                    scenario: {
-                        title: string;
-                        type: string;
-                        enum: string[];
-                        description: string;
-                        example: string;
-                    };
-                    subScenario: {
-                        title: string;
-                        type: string;
-                        pattern: string;
-                        description: string;
-                        example: string;
-                    };
-                    initiator: {
-                        title: string;
-                        type: string;
-                        enum: string[];
-                        description: string;
-                        example: string;
-                    };
-                    initiatorType: {
-                        title: string;
-                        type: string;
-                        enum: string[];
-                        description: string;
-                        example: string;
-                    };
-                    refundInfo: {
-                        title: string;
-                        type: string;
-                        description: string;
-                        properties: {
-                            originalTransactionId: {
-                                title: string;
-                                type: string;
-                                pattern: string;
-                                description: string;
-                                example: string;
-                            };
-                            refundReason: {
-                                title: string;
-                                type: string;
-                                minLength: number;
-                                maxLength: number;
-                                description: string;
-                                example: string;
-                            };
-                        };
-                        required: string[];
-                    };
-                    balanceOfPayments: {
-                        title: string;
-                        type: string;
-                        pattern: string;
-                        description: string;
-                        example: string;
-                    };
-                };
-                required: string[];
+                example: string;
+            };
+            subScenario: {
+                title: string;
+                type: string;
+                pattern: string;
+                description: string;
+                example: string;
             };
             initiator: {
                 title: string;
@@ -10728,10 +10676,17 @@ 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;
                 required: string[];

package/package.json

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

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

@@ -29,7 +29,9 @@ properties:
   amount:
     $ref: ./Amount.yaml
   scenario:
-    $ref: ./TransactionType.yaml
+    $ref: ./TransactionScenario.yaml
+  subScenario:
+    $ref: ./TransactionSubScenario.yaml
   initiator:
     $ref: ./TransactionInitiator.yaml
   initiatorType:

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.