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

Updated Docs

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files
schemas/DisbursementRequest.json
+63 -35
View File
@@ -11,16 +11,16 @@
"description": "Unique country code. Please refer to Country Codes table", "description": "Unique country code. Please refer to Country Codes table",
"example": "NGR" "example": "NGR"
}, },
"transactionId": {
"type": "string",
"description": "Unique identifier of transaction in Simbrella system",
"example": "Tr201712RK9232P115"
},
"debtId": { "debtId": {
"type": "string", "type": "string",
"description": "Unique identifier of a loan in Simbrella system that is going to be collected (it correlates with provision request)", "description": "Unique identifier of a loan in Simbrella system that is going to be collected (it correlates with provision request)",
"example": "273194670" "example": "273194670"
}, },
"transactionId": {
"type": "string",
"description": "Unique identifier of transaction in Simbrella system",
"example": "T001"
},
"customerId": { "customerId": {
"type": "string", "type": "string",
"description": "Unique identifier of a user", "description": "Unique identifier of a user",
@@ -42,55 +42,83 @@
"description": "Amount of loan (including service fee) to be provided on a specific account of a user", "description": "Amount of loan (including service fee) to be provided on a specific account of a user",
"example": 100000.0 "example": 100000.0
}, },
"collectAmountInterest": { "totalFees": {
"type": "number", "type": "number",
"format": "double", "format": "double",
"description": "Interest Amount to be collected immediately after loan is provided (Only for 30 days)", "description": "Total amount of all fees combined",
"example": 5000.0 "example": 7075
}, },
"collectAmountMgtFee": { "feesDetails": {
"type": "number", "type": "object",
"format": "double", "description": "Detailed breakdown of all fees",
"description": "Management Fee Amount to be collected immediately after loan is provided", "properties": {
"example": 1000.0 "collectAmountInterest": {
}, "type": "number",
"collectAmountInsurance": { "format": "double",
"type": "number", "description": "Interest Amount to be collected immediately after loan is provided (Only for 30 days)",
"format": "double", "example": 5000
"description": "Insurance Amount to be collected immediately after loan is provided", },
"example": 1000.0 "collectAmountMgtFee": {
}, "type": "number",
"collectAmountVAT": { "format": "double",
"type": "number", "description": "Management Fee Amount to be collected immediately after loan is provided",
"format": "double", "example": 1000
"description": "VAT Amount to be collected immediately after loan is provided", },
"example": 75.0 "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"
]
}, },
"countryId": { "countryId": {
"type": "string", "type": "string",
"description": "Set to static value '01'", "description": "Set to static value '01'",
"example": "01" "example": "01"
},
"comment": {
"type": "string",
"description": "Any additional comment for provided loan operation",
"example": "Testing LoanRequest"
} }
}, },
"required": [ "required": [
"requestId", "requestId",
"countryCode", "countryCode",
"debtId",
"transactionId", "transactionId",
"debtId",
"customerId", "customerId",
"accountId", "accountId",
"productId", "productId",
"provideAmount", "provideAmount",
"collectAmountMgtFee", "totalFees",
"collectAmountInsurance", "feesDetails"
"collectAmountVAT",
"countryId"
], ],
"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
}
},
"xml": { "xml": {
"name": "DisbursementRequest" "name": "DisbursementRequest"
} }
schemas/DisbursementResponse.json
+61 -31
View File
@@ -4,7 +4,7 @@
"requestId": { "requestId": {
"type": "string", "type": "string",
"description": "Unique identifier of request", "description": "Unique identifier of request",
"example": "REQ12345" "example": "R02802"
}, },
"countryCode": { "countryCode": {
"type": "string", "type": "string",
@@ -13,7 +13,7 @@
}, },
"transactionId": { "transactionId": {
"type": "string", "type": "string",
"description": "Unique identifier of transaction in Simbrella system", "description": "Unique ID of customer’s USSD session. Must be consistent throughout whole USSD journey",
"example": "Tr201712RK9232P115" "example": "Tr201712RK9232P115"
}, },
"debtId": { "debtId": {
@@ -42,34 +42,47 @@
"description": "Amount of loan (including service fee) to be provided on a specific account of a user", "description": "Amount of loan (including service fee) to be provided on a specific account of a user",
"example": 100000.0 "example": 100000.0
}, },
"collectAmountInterest": { "totalFees": {
"type": "number", "type": "number",
"format": "double", "format": "double",
"description": "Interest Amount to be collected immediately after loan is provided (Only for 30 days)", "description": "Total amount of all fees combined",
"example": 5000.0 "example": 7075
}, },
"collectAmountMgtFee": { "feesDetails": {
"type": "number", "type": "object",
"format": "double", "description": "Detailed breakdown of all fees",
"description": "Management Fee Amount to be collected immediately after loan is provided", "properties": {
"example": 1000.0 "collectAmountInterest": {
}, "type": "number",
"collectAmountInsurance": { "format": "double",
"type": "number", "description": "Interest Amount to be collected immediately after loan is provided (Only for 30 days)",
"format": "double", "example": 5000
"description": "Insurance Amount to be collected immediately after loan is provided", },
"example": 1000.0 "collectAmountMgtFee": {
}, "type": "number",
"collectAmountVAT": { "format": "double",
"type": "number", "description": "Management Fee Amount to be collected immediately after loan is provided",
"format": "double", "example": 1000
"description": "VAT Amount to be collected immediately after loan is provided", },
"example": 75.0 "collectAmountInsurance": {
}, "type": "number",
"countryId": { "format": "double",
"type": "string", "description": "Insurance Amount to be collected immediately after loan is provided",
"description": "Set to static value '01'", "example": 1000
"example": "01" },
"collectAmountVAT": {
"type": "number",
"format": "double",
"description": "VAT Amount to be collected immediately after loan is provided",
"example": 75
}
},
"required": [
"collectAmountInterest",
"collectAmountMgtFee",
"collectAmountInsurance",
"collectAmountVAT"
]
}, },
"resultCode": { "resultCode": {
"type": "string", "type": "string",
@@ -91,13 +104,30 @@
"accountId", "accountId",
"productId", "productId",
"provideAmount", "provideAmount",
"collectAmountMgtFee", "totalFees",
"collectAmountInsurance", "feesDetails",
"collectAmountVAT",
"countryId",
"resultCode", "resultCode",
"resultDescription" "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": { "xml": {
"name": "DisbursementResponse" "name": "DisbursementResponse"
} }
schemas/ProvideLoanRequest.json
+2 -2
View File
@@ -43,7 +43,7 @@
"enum": [0, 1], "enum": [0, 1],
"example": 1 "example": 1
}, },
"offerID": { "offerId": {
"type": "integer", "type": "integer",
"description": "Offer ID of the loan selected by Customer", "description": "Offer ID of the loan selected by Customer",
"example": 1127 "example": 1127
@@ -63,7 +63,7 @@
"productId", "productId",
"requestedAmount", "requestedAmount",
"collectionType", "collectionType",
"offerID", "offerId",
"channel" "channel"
], ],
"xml": { "xml": {
schemas/RACCheckResponse.json
+2 -2
View File
@@ -30,7 +30,7 @@
"description": "BVN Ok (1 = Yes, 0 = No)", "description": "BVN Ok (1 = Yes, 0 = No)",
"example": "1" "example": "1"
}, },
"BVNAttachedtoAccount": { "BVNAttachedToAccount": {
"type": "string", "type": "string",
"description": "BVN attached to account (1 = Yes, 0 = No)", "description": "BVN attached to account (1 = Yes, 0 = No)",
"example": "1" "example": "1"
@@ -78,7 +78,7 @@
}, },
"required": [ "required": [
"Salary account", "Salary account",
"BVNAttachedtoAccount", "BVNAttachedToAccount",
"CRC", "CRC",
"CRMS", "CRMS",
"AccountStatus", "AccountStatus",
schemas/RepaymentRequest.json
+71 -18
View File
@@ -1,44 +1,97 @@
{ {
"type": "object", "type": "object",
"required": [ "required": [
"requestId",
"countryCode",
"transactionId", "transactionId",
"customerId",
"debtId", "debtId",
"customerId",
"accountId",
"productId", "productId",
"channel" "collectAmount",
"collectionMethod",
"lienAmount"
], ],
"properties": { "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": { "transactionId": {
"type": "string", "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" "example": "Tr201712RK9232P115"
}, },
"msisdn": {
"type": "string",
"description": "User's mobile number in an international format",
"example": "3451342"
},
"debtId": { "debtId": {
"type": "string", "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" "example": "273194670"
}, },
"productId": {
"type": "string",
"description": "Identifier of a product that user is repaying for",
"example": "101"
},
"customerId": { "customerId": {
"type": "string", "type": "string",
"description": "Unique identifier of a customer", "description": "Unique identifier of a user",
"example": "CN621868" "example": "CN621868"
}, },
"channel": { "accountId": {
"type": "string", "type": "string",
"description": "Request channel: USSD or APP", "description": "Specific identifier of a user's account",
"example": "100" "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": { "xml": {
"name": "RepaymentRequest" "name": "RepaymentRequest"
} }
schemas/RepaymentResponse.json
+68 -10
View File
@@ -1,33 +1,76 @@
{ {
"type": "object", "type": "object",
"required": [ "required": [
"customerId", "requestId",
"countryCode",
"transactionId", "transactionId",
"productId",
"debtId", "debtId",
"customerId",
"accountId",
"productId",
"collectAmount",
"lienAmount",
"resultCode", "resultCode",
"resultDescription" "resultDescription"
], ],
"properties": { "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 in Simbrella system",
"example": "Tr201712RK9232P115"
},
"debtId": {
"type": "string",
"description": "Unique identifier of a loan in Simbrella system that is going to be collected (it correlates with provision request)",
"example": "273194670"
},
"customerId": { "customerId": {
"type": "string", "type": "string",
"description": "Unique identifier of a user", "description": "Unique identifier of a user",
"example": "CN621868" "example": "CN621868"
}, },
"transactionId": { "accountId": {
"type": "string", "type": "string",
"description": "Unique identifier of transaction. This transaction Id must be consistent across all platforms", "description": "Specific identifier of a user's account",
"example": "Tr201712RK9232P115" "example": "2017821799"
}, },
"productId": { "productId": {
"type": "string", "type": "string",
"description": "Identifier of a product that user is payed for", "description": "Identifier of a product for which collection to be made",
"example": "101" "example": "101"
}, },
"debtId": { "collectAmount": {
"type": "number",
"format": "double",
"description": "Amount to be collected from user's account (penalCharge is not included)",
"example": 60000.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
},
"lienAmount": {
"type": "number",
"format": "double",
"description": "Aggregated (summed up) lien amount",
"example": 20000
},
"comment": {
"type": "string", "type": "string",
"description": "Unique identifier of an existing debt of a user", "description": "Any additional comment for provided loan operation",
"example": "273194670" "example": "Testing CollectionLoanRequest"
}, },
"resultCode": { "resultCode": {
"type": "string", "type": "string",
@@ -37,9 +80,24 @@
"resultDescription": { "resultDescription": {
"type": "string", "type": "string",
"description": "Description of provided result code", "description": "Description of provided result code",
"example": "Successful" "example": "Loan Collection Successful"
} }
}, },
"example": {
"requestId": "R02802",
"countryCode": "NGR",
"transactionId": "Tr201712RK9232P115",
"debtId": "273194670",
"customerId": "CN621868",
"accountId": "2017821799",
"productId": "101",
"collectAmount": 60000.00,
"penalCharge": 0,
"lienAmount": 20000,
"comment": "Testing CollectionLoanRequest",
"resultCode": "00",
"resultDescription": "Loan Collection Successful"
},
"xml": { "xml": {
"name": "RepaymentResponse" "name": "RepaymentResponse"
} }