Loan Products

Create Loan Product

POST {base url}/v1/loanProducts

Body

{
        "name": "test product",
        "type": "FIXED_TERM_LOAN",
        "currency": "NGN",
        "initialState": "PENDING_APPROVAL",
        "description": "test product",
        "userType": [
            "clients",
            "companies"
        ],
        "branch": [
            "all_branches or id of the individual branches the product will be available to"
        ],
        "enableLinking": false,
        "minAmount": 10000,
        "maxAmount": 10000000,
        "interest": {
            "daysInAYear": 365,
            "interestType": "SIMPLE_INTEREST",
            "interestCharged": "%_PER_YEAR",
            "interestPosting": "ON_DISBURSEMENT",
            "maxInterestRate": 40,
            "minInterestRate": 30,
            "repaymentInterest": "REPAYMENT_PERIOD",
            "defaultInterestRate": 35,
            "interestCalculation": "DECLINING_BALANCE"
        },
        "scheduling": {
            "paymentMade": {
                "value": 1,
                "period": "WEEK/MONTH/YEAR"
            },
            "paymentMethod": "STANDARD_PAYMENT",
            "maxGracePeriod": 5,
            "minGracePeriod": 2,
            "maxInstallments": 10,
            "minInstallments": 4,
            "paymentInterval": "INTERVAL",
            "maxDueDateOffset": 3,
            "minDueDateOffset": 1,
            "enableGracePeriod": true,
            "defaultGracePeriod": 3,
            "principalCollected": 1,
            "defaultInstallments": 6,
            "defaultDueDateOffset": 2,
            "currencyRoundingSchedule": "NO_ROUNDING",
            "principalRoundingSchedule": "NO_ROUNDING"
        },
        "collection": {
            "acceptPrepayment": false,
            "paymentAllocation": "HORIZONTAL",
            "prepaymentAllocationOrder": {
                "fee": 0,
                "penalty": 1,
                "interest": 2,
                "principal": 3
            }
        },
        "penalty": {
            "enablePenalty": false
        },
        "security": {
            "enableCollateral": false,
            "enableFundingSource": false
        },
        "accounting": {
            "feeIncome": "2029427635",
            "methodology": "ACCRUAL",
            "feeReceivable": "4048468827",
            "penaltyIncome": "2029427635",
            "interestIncome": "2029427635",
            "writeOffExpense": "1014905527",
            "portfolioControl": "4048468827",
            "penaltyReceivable": "4048468827",
            "transactionSource": "4048468827",
            "interestReceivable": "4048468827"
        },
        "fees": [
            {
                "value": 75,
                "feeName": "management fee",
                "feeType": "ON_DISBURSEMENT",
                "feePayment": "FLAT or PERCENTAGE_0F_DISBURSE_AMOUNT"
            }
        ]
        ]
    }

Update loan product

PATH /api/v1/loanProducts/{loanId}

Update single loan product

Headers

Body

Response

{
        "name": "test product",
        "type": "FIXED_TERM_LOAN",
        "currency": "NGN",
        "initialState": "PENDING_APPROVAL",
        "description": "test product",
        "userType": [
            "clients",
            "companies"
        ],
        "branch": [
            "all_branches or id of the individual branches the product will be available to"
        ],
        "enableLinking": false,
        "minAmount": 10000,
        "maxAmount": 10000000,
        "interest": {
            "daysInAYear": 365,
            "interestType": "SIMPLE_INTEREST",
            "interestCharged": "%_PER_YEAR",
            "interestPosting": "ON_DISBURSEMENT",
            "maxInterestRate": 40,
            "minInterestRate": 30,
            "repaymentInterest": "REPAYMENT_PERIOD",
            "defaultInterestRate": 35,
            "interestCalculation": "DECLINING_BALANCE"
        },
        "scheduling": {
            "paymentMade": {
                "value": 1,
                "period": "WEEK/MONTH/YEAR"
            },
            "paymentMethod": "STANDARD_PAYMENT",
            "maxGracePeriod": 5,
            "minGracePeriod": 2,
            "maxInstallments": 10,
            "minInstallments": 4,
            "paymentInterval": "INTERVAL",
            "maxDueDateOffset": 3,
            "minDueDateOffset": 1,
            "enableGracePeriod": true,
            "defaultGracePeriod": 3,
            "principalCollected": 1,
            "defaultInstallments": 6,
            "defaultDueDateOffset": 2,
            "currencyRoundingSchedule": "NO_ROUNDING",
            "principalRoundingSchedule": "NO_ROUNDING"
        },
        "collection": {
            "acceptPrepayment": false,
            "paymentAllocation": "HORIZONTAL",
            "prepaymentAllocationOrder": {
                "fee": 0,
                "penalty": 1,
                "interest": 2,
                "principal": 3
            }
        },
        "penalty": {
            "enablePenalty": false
        },
        "security": {
            "enableCollateral": false,
            "enableFundingSource": false
        },
        "accounting": {
            "feeIncome": "2029427635",
            "methodology": "ACCRUAL",
            "feeReceivable": "4048468827",
            "penaltyIncome": "2029427635",
            "interestIncome": "2029427635",
            "writeOffExpense": "1014905527",
            "portfolioControl": "4048468827",
            "penaltyReceivable": "4048468827",
            "transactionSource": "4048468827",
            "interestReceivable": "4048468827"
        },
        "fees": [
            {
                "value": 75,
                "feeName": "management fee",
                "feeType": "ON_DISBURSEMENT",
                "feePayment": "FLAT or PERCENTAGE_0F_DISBURSE_AMOUNT"
            }
        ]
        ]
    }

Get all loan products

GET {base url}/v1/loanProducts?page={page}&perPage={perPage}

Get all company loan products

Query Parameters

Headers

{
    "message": "unauthorized",
    "code": 92
}