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

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

@@ -2078,7 +2078,7 @@ components:
         amount:
           $ref: '#/components/schemas/Amount'
         transactionType:
-          $ref: '#/components/schemas/transferTransactionType'
+          $ref: '#/components/schemas/TransactionScenario'
         subScenario:
           $ref: '#/components/schemas/TransactionSubScenario'
     AuthenticationType:
@@ -2134,7 +2134,7 @@ components:
         amount:
           $ref: '#/components/schemas/Amount'
         transactionType:
-          $ref: '#/components/schemas/transferTransactionType'
+          $ref: '#/components/schemas/TransactionScenario'
         subScenario:
           $ref: '#/components/schemas/TransactionSubScenario'
         authenticationType:

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

@@ -15335,12 +15335,17 @@
                 "example": "123.45"
             },
             "transactionType": {
-                "title": "transferTransactionType",
+                "title": "TransactionScenario",
                 "type": "string",
                 "enum": [
-                    "TRANSFER"
+                    "DEPOSIT",
+                    "WITHDRAWAL",
+                    "TRANSFER",
+                    "PAYMENT",
+                    "REFUND"
                 ],
-                "description": "Type of transaction."
+                "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",
@@ -15853,12 +15858,17 @@
                 "example": "123.45"
             },
             "transactionType": {
-                "title": "transferTransactionType",
+                "title": "TransactionScenario",
                 "type": "string",
                 "enum": [
-                    "TRANSFER"
+                    "DEPOSIT",
+                    "WITHDRAWAL",
+                    "TRANSFER",
+                    "PAYMENT",
+                    "REFUND"
                 ],
-                "description": "Type of transaction."
+                "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",

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

@@ -1050,7 +1050,7 @@ export interface components {
             amountType: components["schemas"]["AmountType"];
             currency: components["schemas"]["Currency"];
             amount: components["schemas"]["Amount"];
-            transactionType: components["schemas"]["transferTransactionType"];
+            transactionType: components["schemas"]["TransactionScenario"];
             subScenario?: components["schemas"]["TransactionSubScenario"];
         };
         /**
@@ -1081,7 +1081,7 @@ export interface components {
             amountType: components["schemas"]["AmountType"];
             currency: components["schemas"]["Currency"];
             amount: components["schemas"]["Amount"];
-            transactionType: components["schemas"]["transferTransactionType"];
+            transactionType: components["schemas"]["TransactionScenario"];
             subScenario?: components["schemas"]["TransactionSubScenario"];
             authenticationType?: components["schemas"]["AuthenticationType"];
             requestToPayState: components["schemas"]["TransactionRequestState"];

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

@@ -7938,6 +7938,7 @@ export declare namespace Schemas {
                 type: string;
                 enum: string[];
                 description: string;
+                example: string;
             };
             subScenario: {
                 title: string;
@@ -8228,6 +8229,7 @@ export declare namespace Schemas {
                 type: string;
                 enum: string[];
                 description: string;
+                example: string;
             };
             subScenario: {
                 title: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/api-snippets",
-  "version": "17.0.4-snapshot.0",
+  "version": "17.0.4-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/requestToPayRequest.yaml

@@ -24,7 +24,7 @@ properties:
   amount:
     $ref: ./Amount.yaml
   transactionType:
-    $ref: ./transferTransactionType.yaml
+    $ref: ./TransactionScenario.yaml
   subScenario:
     $ref: ./TransactionSubScenario.yaml
 

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

@@ -22,7 +22,7 @@ properties:
   amount:
     $ref: ./Amount.yaml
   transactionType:
-    $ref: ./transferTransactionType.yaml
+    $ref: ./TransactionScenario.yaml
   subScenario:
     $ref: ./TransactionSubScenario.yaml
   authenticationType: