Updated Docs

This commit is contained in:
Azeez Muibi
2025-03-25 12:36:41 +01:00
parent e6c537ccff
commit 730d97fafa
6 changed files with 267 additions and 98 deletions
+61 -31
View File
@@ -4,7 +4,7 @@
"requestId": {
"type": "string",
"description": "Unique identifier of request",
"example": "REQ12345"
"example": "R02802"
},
"countryCode": {
"type": "string",
@@ -13,7 +13,7 @@
},
"transactionId": {
"type": "string",
"description": "Unique identifier of transaction in Simbrella system",
"description": "Unique ID of customers USSD session. Must be consistent throughout whole USSD journey",
"example": "Tr201712RK9232P115"
},
"debtId": {
@@ -42,34 +42,47 @@
"description": "Amount of loan (including service fee) to be provided on a specific account of a user",
"example": 100000.0
},
"collectAmountInterest": {
"totalFees": {
"type": "number",
"format": "double",
"description": "Interest Amount to be collected immediately after loan is provided (Only for 30 days)",
"example": 5000.0
"description": "Total amount of all fees combined",
"example": 7075
},
"collectAmountMgtFee": {
"type": "number",
"format": "double",
"description": "Management Fee Amount to be collected immediately after loan is provided",
"example": 1000.0
},
"collectAmountInsurance": {
"type": "number",
"format": "double",
"description": "Insurance Amount to be collected immediately after loan is provided",
"example": 1000.0
},
"collectAmountVAT": {
"type": "number",
"format": "double",
"description": "VAT Amount to be collected immediately after loan is provided",
"example": 75.0
},
"countryId": {
"type": "string",
"description": "Set to static value '01'",
"example": "01"
"feesDetails": {
"type": "object",
"description": "Detailed breakdown of all fees",
"properties": {
"collectAmountInterest": {
"type": "number",
"format": "double",
"description": "Interest Amount to be collected immediately after loan is provided (Only for 30 days)",
"example": 5000
},
"collectAmountMgtFee": {
"type": "number",
"format": "double",
"description": "Management Fee Amount to be collected immediately after loan is provided",
"example": 1000
},
"collectAmountInsurance": {
"type": "number",
"format": "double",
"description": "Insurance Amount to be collected immediately after loan is provided",
"example": 1000
},
"collectAmountVAT": {
"type": "number",
"format": "double",
"description": "VAT Amount to be collected immediately after loan is provided",
"example": 75
}
},
"required": [
"collectAmountInterest",
"collectAmountMgtFee",
"collectAmountInsurance",
"collectAmountVAT"
]
},
"resultCode": {
"type": "string",
@@ -91,13 +104,30 @@
"accountId",
"productId",
"provideAmount",
"collectAmountMgtFee",
"collectAmountInsurance",
"collectAmountVAT",
"countryId",
"totalFees",
"feesDetails",
"resultCode",
"resultDescription"
],
"example": {
"requestId": "R02802",
"countryCode": "NGR",
"transactionId": "Tr201712RK9232P115",
"debtId": "273194670",
"customerId": "CN621868",
"accountId": "2017821799",
"productId": "101",
"provideAmount": 100000.0,
"totalFees": 7075,
"feesDetails": {
"collectAmountInterest": 5000,
"collectAmountMgtFee": 1000,
"collectAmountInsurance": 1000,
"collectAmountVAT": 75
},
"resultCode": "00",
"resultDescription": "Loan Request Completed Successfully!"
},
"xml": {
"name": "DisbursementResponse"
}