DigiFi/digifi-swagger
1
0
Fork 0
Code Issues Pull Requests Releases Activity

Updated Swagger Documentation

Browse Source
This commit is contained in:
Azeez Muibi
2025-03-24 15:15:31 +01:00
parent 67dfc32e4a
commit 9684d6dd29
56 changed files with 1344 additions and 349 deletions
Download Patch File Download Diff File Expand all files Collapse all files
schemas/SelectOfferResponse.json
+121 -5
View File
@@ -1,36 +1,152 @@
{
"type": "object",
"required": [
"requestId",
"transactionId",
"customerId",
"accountId",
"offers",
"resultCode",
"resultDescription"
],
"properties": {
"requestId": {
"type": "string",
"description": "Unique identifier of request",
"example": "202111170001371256908"
},
"transactionId": {
"type": "string",
"description": "Unique ID of customer's USSD session",
"example": "1231231321232"
},
"customerId": {
"type": "string",
"example": "CN621868"
"description": "Unique identifier of a customer",
"example": "1256907"
},
"accountId": {
"type": "string",
"example": "ACN8263457"
"description": "Specific identifier of a user's account",
"example": "5948306019"
},
"outstandingDebtAmount": {
"type": "number",
"format": "double",
"description": "Outstanding debt amount if any",
"example": 0
},
"offers": {
"type": "string",
"example": "ARRAY of Offers"
"type": "array",
"description": "Array of loan offers",
"items": {
"type": "object",
"properties": {
"offerId": {
"type": "string",
"description": "Unique identifier of the offer",
"example": "14451"
},
"productId": {
"type": "string",
"description": "Product identifier",
"example": "2030"
},
"amount": {
"type": "number",
"format": "double",
"description": "Amount of loan customer is eligible for",
"example": 10000.0
},
"upfrontPayment": {
"type": "number",
"format": "double",
"description": "Amount to be deducted upfront",
"example": 1000.0
},
"interestRate": {
"type": "number",
"format": "double",
"description": "Percentage of interest rate",
"example": 3.0
},
"Interest": {
"type": "number",
"format": "double",
"description": "Amount of interest",
"example": 300.0
},
"ManagementRate": {
"type": "number",
"format": "double",
"description": "Percentage of management fee",
"example": 1.0
},
"ManagementFee": {
"type": "number",
"format": "double",
"description": "Amount of management fee",
"example": 100.0
},
"InsuranceRate": {
"type": "number",
"format": "double",
"description": "Percentage of insurance",
"example": 1.0
},
"InsuranceFee": {
"type": "number",
"format": "double",
"description": "Amount of insurance",
"example": 100.0
},
"VATRate": {
"type": "number",
"format": "double",
"description": "Percentage of VAT",
"example": 7.5
},
"VATamount": {
"type": "number",
"format": "double",
"description": "Amount of VAT",
"example": 100.0
},
"recommendedRepaymentDates": {
"type": "array",
"description": "Array of recommended payment dates for all installments in yyyy-mm-dd format",
"items": {
"type": "string",
"example": "2022-11-30"
}
},
"installmentAmount": {
"type": "number",
"format": "double",
"description": "Amount to be paid each month (upfrontPayment not included)",
"example": 11000.0
},
"totalRepaymentAmount": {
"type": "number",
"format": "double",
"description": "Total amount to be paid by customer. All installment amounts + upfront payment",
"example": 11000.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": "SelectOffersResponse"
"name": "SelectOfferResponse"
}
}