Updated Docs

2025-03-25 10:10:29 +01:00
parent ce4079b2d2
commit 4e8fc9cd34
8 changed files with 51 additions and 57 deletions
@@ -0,0 +1,69 @@
+{
+    "type": "object",
+    "properties": {
+        "transactionId": {
+            "type": "string",
+            "description": "Unique identifier of request in Simbrella system",
+            "example": "24110114545374721"
+        },
+        "data": {
+            "type": "object",
+            "description": "Object containing details of transaction Simbrella querying",
+            "properties": {
+                "transactionId": {
+                    "type": "string",
+                    "description": "Unique identifier of transaction in Simbrella system that was sent for transaction check",
+                    "example": "241101"
+                },
+                "providedAmount": {
+                    "type": "number",
+                    "format": "double",
+                    "description": "Amount collected from user's account within disbursement operation. Amount should always be equal to zero if operation is of any type other than Disbursement",
+                    "example": 1000.00
+                },
+                "collectedAmount": {
+                    "type": "number",
+                    "format": "double",
+                    "description": "Amount collected from user's account. In case of Disbursement this value will be equal to 0. In case of Collection this value will represent amount successfully collected from customers account. In case of Penal charge this value will represent penalty amount collected from customer's account.",
+                    "example": 0.00
+                },
+                "resultCode": {
+                    "type": "string",
+                    "description": "Result code of the operation one sent for transaction check, e.g. (00 – Success etc.)",
+                    "example": "00"
+                },
+                "resultDescription": {
+                    "type": "string",
+                    "description": "Description of provided result code that was sent for transaction check",
+                    "example": "Loan Provision is successful"
+                }
+            },
+            "required": [
+                "transactionId",
+                "providedAmount",
+                "collectedAmount",
+                "resultCode",
+                "resultDescription"
+            ]
+        },
+        "resultCode": {
+            "type": "string",
+            "description": "Result code of executed transaction, e.g. (00 – Success etc.)",
+            "example": "00"
+        },
+        "resultDescription": {
+            "type": "string",
+            "description": "Description of provided result code",
+            "example": "SUCCESS"
+        }
+    },
+    "required": [
+        "transactionId",
+        "data",
+        "resultCode",
+        "resultDescription"
+    ],
+    "xml": {
+        "name": "StatusCallResponse"
+    }
+}