Updated Docs

2025-03-26 14:48:32 +01:00
parent 9ed359d307
commit 183c1bf46f
59 changed files with 2513 additions and 390 deletions
@@ -0,0 +1,96 @@
+{
+    "type": "object",
+    "required": [
+        "customerId",
+        "transactionId",
+        "loans",
+        "resultCode",
+        "resultDescription"
+    ],
+    "properties": {
+        "customerId": {
+            "type": "string",
+            "description": "Unique identifier of a user",
+            "example": "CN621868"
+        },
+        "transactionId": {
+            "type": "string",
+            "description": "Unique identifier of transaction. This transaction Id must be consistent across all platforms",
+            "example": "Tr201712RK9232P115"
+        },
+        "loans": {
+            "type": "array",
+            "description": "Array of loan entities. If customer doesn't have a loan, this array will be empty",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "debtId": {
+                        "type": "string",
+                        "description": "Unique identifier of a debt of a user",
+                        "example": "123456789"
+                    },
+                    "loanDate": {
+                        "type": "string",
+                        "format": "date-time",
+                        "description": "Date and time of provided loan",
+                        "example": "2019-10-18 14:26:21.063"
+                    },
+                    "dueDate": {
+                        "type": "string",
+                        "format": "date-time",
+                        "description": "Due date of provided loan",
+                        "example": "2019-11-20 14:26:21.063"
+                    },
+                    "currentLoanAmount": {
+                        "type": "number",
+                        "format": "double",
+                        "description": "Outstanding debt amount of the user",
+                        "example": 8500.0
+                    },
+                    "initialLoanAmount": {
+                        "type": "number",
+                        "format": "double",
+                        "description": "Initial loan amount",
+                        "example": 10000.0
+                    },
+                    "defaultPenaltyFee": {
+                        "type": "number",
+                        "format": "double",
+                        "description": "Penalty fee amount",
+                        "example": 0.0
+                    },
+                    "continuousFee": {
+                        "type": "number",
+                        "format": "double",
+                        "description": "Interest fee charged continuously. First occurs when payment is delayed",
+                        "example": 0.0
+                    },
+                    "productId": {
+                        "type": "string",
+                        "description": "Identifier of a provided product to a user",
+                        "example": "101"
+                    }
+                }
+            }
+        },
+        "totalDebtAmount": {
+            "type": "number",
+            "format": "double",
+            "description": "Sum amount of all existing debts of a user",
+            "example": 8500.0
+        },
+        "resultCode": {
+            "type": "string",
+            "description": "Result code of executed transaction, e.g. (00 – Success etc.) see result codes table",
+            "example": "00"
+        },
+        "resultDescription": {
+            "type": "string",
+            "description": "Description of provided result code",
+            "example": "Successful"
+        }
+    },
+    "xml": {
+        "name": "LoanStatusResponse"
+    }
+}