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,105 @@
+{
+    "type": "object",
+    "required": [
+        "customerId",
+        "transactionId",
+        "countryCode",
+        "eligibleOffers",
+        "resultCode",
+        "resultDescription"
+    ],
+    "properties": {
+        "customerId": {
+            "type": "string",
+            "description": "Unique identifier of a customer",
+            "example": "CN621868"
+        },
+        "transactionId": {
+            "type": "string",
+            "description": "Unique identifier of transaction. This transaction Id must be consistent across all platforms",
+            "example": "Tr201712RK9232P115"
+        },
+        "countryCode": {
+            "type": "string",
+            "description": "Unique country code. Please refer to “Country Codes” table",
+            "example": "NGR"
+        },
+        "msisdn": {
+            "type": "string",
+            "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": {
+                    "offerId": {
+                        "type": "integer",
+                        "description": "Offer identifier",
+                        "example": 101
+                    },
+                    "minAmount": {
+                        "type": "number",
+                        "format": "double",
+                        "description": "Minimum loan amount",
+                        "example": 5000
+                    },
+                    "maxAmount": {
+                        "type": "number",
+                        "format": "double",
+                        "description": "Maximum loan amount",
+                        "example": 20000
+                    },
+                    "productId": {
+                        "type": "integer",
+                        "description": "Product identifier",
+                        "example": 2030101
+                    },
+                    "tenor": {
+                        "type": "integer",
+                        "description": "Loan tenor in days",
+                        "example": 30
+                    }
+                },
+                "required": [
+                    "offerId",
+                    "minAmount",
+                    "maxAmount",
+                    "productId",
+                    "tenor"
+                ]
+            },
+            "example": [
+                {
+                    "offerId": 101,
+                    "minAmount": 5000,
+                    "maxAmount": 20000,
+                    "productId": 2030,
+                    "tenor": 30
+                },
+                {
+                    "offerId": 102,
+                    "minAmount": 20000,
+                    "maxAmount": 50000,
+                    "productId": 2090,
+                    "tenor": 90
+                }
+            ]
+        },
+        "resultCode": {
+            "type": "string",
+            "description": "Result code of executed transaction, e.g. (00 – Success etc.) see result codes table",
+            "example": "00"
+        },
+        "resultDescription": {
+            "type": "string",
+            "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": {
+        "name": "EligibilityCheckResponse"
+    }
+}