Updated Docs

This commit is contained in:
Azeez Muibi
2025-03-25 10:53:48 +01:00
parent e2755349b8
commit e6c537ccff
3 changed files with 42 additions and 26 deletions
+31 -8
View File
@@ -35,6 +35,11 @@
"items": {
"type": "object",
"properties": {
"offerId": {
"type": "integer",
"description": "Offer identifier",
"example": 101
},
"minAmount": {
"type": "number",
"format": "double",
@@ -48,22 +53,40 @@
"example": 20000
},
"productId": {
"type": "string",
"type": "integer",
"description": "Product identifier",
"example": "2030"
},
"offerId": {
"type": "string",
"description": "Offer identifier",
"example": "101"
"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",
+6 -13
View File
@@ -31,12 +31,6 @@
"description": "Identifier of a product chosen by user",
"example": "101"
},
"lienAmount": {
"type": "number",
"format": "double",
"description": "Amount of lien placed on user's account",
"example": 400
},
"requestedAmount": {
"type": "number",
"format": "double",
@@ -49,17 +43,16 @@
"enum": [0, 1],
"example": 1
},
"loanType": {
"offerID": {
"type": "integer",
"description": "Type of loan. 0 simple; 1 refinance.",
"enum": [0, 1],
"example": 0
"description": "Offer ID of the loan selected by Customer",
"example": 1127
},
"channel": {
"type": "string",
"description": "Request channel: 'USSD' or 'MobileApp' or 'Web'",
"description": "Request channel: USSD or MobileApp or Web” - Reference Channel types",
"enum": ["USSD", "MobileApp", "Web"],
"example": "USSD"
"example": "100"
}
},
"required": [
@@ -70,7 +63,7 @@
"productId",
"requestedAmount",
"collectionType",
"loanType",
"offerID",
"channel"
],
"xml": {
+5 -5
View File
@@ -8,6 +8,11 @@
"channel"
],
"properties": {
"transactionId": {
"type": "string",
"description": "Unique identifier of transaction. This transaction Id must be consistent across all platforms",
"example": "Tr201712RK9232P115"
},
"msisdn": {
"type": "string",
"description": "User's mobile number in an international format",
@@ -23,11 +28,6 @@
"description": "Identifier of a product that user is repaying for",
"example": "101"
},
"transactionId": {
"type": "string",
"description": "Unique identifier of transaction. This transaction Id must be consistent across all platforms",
"example": "Tr201712RK9232P115"
},
"customerId": {
"type": "string",
"description": "Unique identifier of a customer",