Updated Swagger Documentation

2025-03-24 15:15:31 +01:00
parent 67dfc32e4a
commit 9684d6dd29
56 changed files with 1344 additions and 349 deletions
@@ -0,0 +1,73 @@
+{
+    "type": "object",
+    "properties": {
+        "fbnTransactionId": {
+            "type": "string",
+            "description": "Unique id of the transaction received from FBN in Eligibility or Provision requests",
+            "example": "123456789"
+        },
+        "transactionId": {
+            "type": "string",
+            "description": "Unique identifier of transaction in FIRSTBANK system",
+            "example": "123456789"
+        },
+        "customerId": {
+            "type": "string",
+            "description": "Unique identifier of a customer",
+            "example": "CN621868"
+        },
+        "accountId": {
+            "type": "string",
+            "description": "Specific identifier of a user's account",
+            "example": "ACN8263457"
+        },
+        "debtId": {
+            "type": "string",
+            "description": "Unique identifier of providing loan in Simbrella system",
+            "example": "987654321"
+        },
+        "transactionType": {
+            "type": "string",
+            "description": "Type of transaction initiated by Simbrella",
+            "enum": ["Disbursement", "Collection", "PenalCharge"],
+            "example": "Disbursement"
+        },
+        "amountProvided": {
+            "type": "number",
+            "format": "double",
+            "description": "Amount provided to customer within Disbursement operation. Will be 0 for Collection or PenalCharge transactions.",
+            "example": 1000.00
+        },
+        "amountCollected": {
+            "type": "number",
+            "format": "double",
+            "description": "Amount collected during execution of operation. 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
+        },
+        "responseCode": {
+            "type": "string",
+            "description": "Result code of the notification, e.g. (00 – Success etc.) see result codes table",
+            "example": "00"
+        },
+        "responseDescription": {
+            "type": "string",
+            "description": "Result description of the notification, detailing status of the transaction",
+            "example": "Successful"
+        }
+    },
+    "required": [
+        "fbnTransactionId",
+        "transactionId",
+        "customerId",
+        "accountId",
+        "debtId",
+        "transactionType",
+        "amountProvided",
+        "amountCollected",
+        "responseCode",
+        "responseDescription"
+    ],
+    "xml": {
+        "name": "NotificationCallbackRequest"
+    }
+}