Updated Swagger Documentation

2025-03-24 15:15:31 +01:00
parent 67dfc32e4a
commit 9684d6dd29
56 changed files with 1344 additions and 349 deletions
@@ -1,29 +1,73 @@
 {
    "type": "object",
+    "required": [
+        "customerId",
+        "transactionId",
+        "eligibleOffers",
+        "resultCode",
+        "resultDescription"
+    ],
    "properties": {
-        "eligibleOffers": {
-            "type": "string",
-            "example": "OFFERS ARRAY HERE"
-        },
-        "resultDescription": {
-            "type": "string",
-            "example": "Successful"
-        },
        "customerId": {
            "type": "string",
+            "description": "Unique identifier of a customer",
            "example": "CN621868"
        },
+        "transactionId": {
+            "type": "string",
+            "description": "Unique identifier of transaction in FIRSTBANK system",
+            "example": "Tr201712RK9232P115"
+        },
        "msisdn": {
            "type": "string",
-            "example": "3451342"
+            "description": "User's mobile number in an international format",
+            "example": "2348012345678"
+        },
+        "eligibleOffers": {
+            "type": "array",
+            "description": "Array of loan offers the customer is eligible for",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "minamount": {
+                        "type": "number",
+                        "format": "double",
+                        "description": "Minimum loan amount",
+                        "example": 5000
+                    },
+                    "maxamount": {
+                        "type": "number",
+                        "format": "double",
+                        "description": "Maximum loan amount",
+                        "example": 20000
+                    },
+                    "productId": {
+                        "type": "string",
+                        "description": "Product identifier",
+                        "example": "101"
+                    },
+                    "offerid": {
+                        "type": "string",
+                        "description": "Offer identifier",
+                        "example": "101"
+                    },
+                    "Tenor": {
+                        "type": "integer",
+                        "description": "Loan tenor in days",
+                        "example": 30
+                    }
+                }
+            }
        },
        "resultCode": {
            "type": "string",
+            "description": "Result code of executed transaction, e.g. (00 – Success etc.) see result codes table",
            "example": "00"
        },
-        "accountId": {
+        "resultDescription": {
            "type": "string",
-            "example": "ACN8263457"
+            "description": "Textual description of provided result code. In case if customer is not eligible (where resultCode is «05») this parameter contains end-user message that can be show directly to the customer.",
+            "example": "Successful"
        }
    },
    "xml": {