Files
digifi-swagger/schemas/SelectOfferResponse.json
Azeez Muibi e2755349b8 Updated Docs
2025-03-25 10:16:17 +01:00

147 lines
5.5 KiB
JSON
Raw Permalink 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",
"required": [
"requestId",
"transactionId",
"customerId",
"accountId",
"loan",
"resultCode",
"resultDescription"
],
"properties": {
"transactionId": {
"type": "string",
"description": "Unique identifier of transaction. This transaction Id must be consistent across all platform",
"example": "1231231321232"
},
"customerId": {
"type": "string",
"description": "Unique identifier of a customer",
"example": "1256907"
},
"accountId": {
"type": "string",
"description": "Specific identifier of a user's account",
"example": "5948306019"
},
"outstandingDebtAmount": {
"type": "number",
"format": "double",
"description": "Outstanding debt amount if any",
"example": 0
},
"loan": {
"type": "array",
"description": "Array of loan loan",
"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": "SelectOfferResponse"
}
}