Updated Docs

schemas/RepaymentRequest.json

@@ -1,44 +1,97 @@
 {
     "type": "object",
     "required": [
+        "requestId",
+        "countryCode",
         "transactionId",
-        "customerId",
         "debtId",
+        "customerId",
+        "accountId",
         "productId",
-        "channel"
+        "collectAmount",
+        "collectionMethod",
+        "lienAmount"
     ],
     "properties": {
+        "requestId": {
+            "type": "string",
+            "description": "Unique identifier of request",
+            "example": "R02802"
+        },
+        "countryCode": {
+            "type": "string",
+            "description": "Unique country code. Please refer to Country Codes table",
+            "example": "NGR"
+        },
         "transactionId": {
             "type": "string",
-            "description": "Unique identifier of transaction. This transaction Id must be consistent across all platforms",
+            "description": "Unique identifier of transaction in Simbrella system",
             "example": "Tr201712RK9232P115"
         },
-        "msisdn": {
-            "type": "string",
-            "description": "User's mobile number in an international format",
-            "example": "3451342"
-        },
         "debtId": {
             "type": "string",
-            "description": "Debt identifier provided in 'Current Loans' response",
+            "description": "Unique identifier of a loan in Simbrella system that is going to be collected (it correlates with provision request)",
             "example": "273194670"
         },
-        "productId": {
-            "type": "string",
-            "description": "Identifier of a product that user is repaying for",
-            "example": "101"
-        },
         "customerId": {
             "type": "string",
-            "description": "Unique identifier of a customer",
+            "description": "Unique identifier of a user",
             "example": "CN621868"
         },
-        "channel": {
+        "accountId": {
             "type": "string",
-            "description": "Request channel: USSD or APP",
-            "example": "100"
+            "description": "Specific identifier of a user's account",
+            "example": "2017821799"
+        },
+        "productId": {
+            "type": "string",
+            "description": "Identifier of a product for which collection to be made",
+            "example": "101"
+        },
+        "collectAmount": {
+            "type": "number",
+            "format": "double",
+            "description": "Amount to be collected from user's account (penalCharge is not included)",
+            "example": 80000.00
+        },
+        "penalCharge": {
+            "type": "number",
+            "format": "double",
+            "description": "Amount of penalty to be collected from user's account. If there is no penalty, amount is '0'",
+            "example": 0
+        },
+        "collectionMethod": {
+            "type": "integer",
+            "description": "1 - on deposit of salary. the collection was triggered after a salary inflow to account, 2 - on due date. the collection was triggered on due date, 3 - initiated by user. the debtor initiated the collection from the request channel (USSD, Web or App)",
+            "enum": [1, 2, 3],
+            "example": 1
+        },
+        "lienAmount": {
+            "type": "number",
+            "format": "double",
+            "description": "Aggregated (summed up) lien amount",
+            "example": 80000.00
+        },
+        "comment": {
+            "type": "string",
+            "description": "Any additional comment for provided loan operation",
+            "example": "Testing CollectionLoanRequest"
         }
     },
+    "example": {
+        "requestId": "R02802",
+        "countryCode": "NGR",
+        "transactionId": "Tr201712RK9232P115",
+        "debtId": "273194670",
+        "customerId": "CN621868",
+        "accountId": "2017821799",
+        "productId": "101",
+        "collectAmount": 80000.00,
+        "penalCharge": 0,
+        "collectionMethod": 1,
+        "lienAmount": 80000.00,
+        "comment": "Testing CollectionLoanRequest"
+    },
     "xml": {
         "name": "RepaymentRequest"
     }