Files
digifi-swagger/schemas/DisbursementResponse.json
T
Azeez Muibi 730d97fafa Updated Docs
2025-03-25 12:36:41 +01:00

134 lines
4.5 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
{
"type": "object",
"properties": {
"requestId": {
"type": "string",
"description": "Unique identifier of request",
"example": "R02802"
},
"countryCode": {
"type": "string",
"description": "Unique country code.",
"example": "NGR"
},
"transactionId": {
"type": "string",
"description": "Unique ID of customers USSD session. Must be consistent throughout whole USSD journey",
"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": {
"type": "string",
"description": "Unique identifier of a user",
"example": "CN621868"
},
"accountId": {
"type": "string",
"description": "Specific identifier of a user's account",
"example": "2017821799"
},
"productId": {
"type": "string",
"description": "Identifier of a product to be provided to a user",
"example": "101"
},
"provideAmount": {
"type": "number",
"format": "double",
"description": "Amount of loan (including service fee) to be provided on a specific account of a user",
"example": 100000.0
},
"totalFees": {
"type": "number",
"format": "double",
"description": "Total amount of all fees combined",
"example": 7075
},
"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",
"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": "Loan Request Completed Successfully!"
}
},
"required": [
"requestId",
"countryCode",
"transactionId",
"debtId",
"customerId",
"accountId",
"productId",
"provideAmount",
"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"
}
}