Loan Calculator

This API returns retail loan cost rate according to inputs. Also returns payment plan.

API Information

URL

 /loanCalculator

Method

 POST

Version

 1.0

Scope

 public

Authorization Flow

 Client Credentials


Input Information

Name Format Description Required/Optional

LoanProductId

 String Loan product id Required

LoanTerm

 Number Loan term Required

LoanAmount

 Decimal Loan amount Required

GracePeriod

 Number Grace period Required

InstallmentPeriod

 Number Installment period Required


Output Information

Loan

Name Format Description

KKDF

 Decimal Resource utilization support fund (rusf)

ExpertisePrice

 Decimal Expertise price

LoanProductId

 String Loan product id

LoanAllocationPrice

 Decimal Loan allocation price

BSMV

 Decimal Banking and insurance transaction tax

YearlyCostRate

 Decimal Annual cost rate

InstallmentAmount

 Decimal Installment amount

TotalAmount

 Decimal Total payback amount

LoanTerm

 Number Loan term

LoanAmount

 Decimal Loan amount

GracePeriod

 Number Grace period

InstallmentPeriod

 Number Installment period

InterestRate

 Decimal Interest rate

PaymentPlan

 List< PaymentPlan > Payment plan


PaymentPlan

Name Format Description

PrincipalBalance

 Decimal Principal balance

KKDF

 Decimal Resource utilization support fund (rusf)

InstallmentInterest

 Decimal Installment interest

InstallmentPrincipal

 Decimal Installment principal

BSMV

 Decimal Banking and insurance transaction tax

InstallmentAmount

 Decimal Installment amount

ExpiryDate

 yyyy-MM-ddTHH24:mm:ss Expiry date


Message Codes

Message Code Description

ACBH000030

 Loan product id cannot be empty.

ACBH000031

 Loan product id must only consist of numerical data.

ACBH000032

 Installment period cannot be empty.

ACBH000060

 Loan product can't be founded.

ACBH000061

 Loan term cannot be empty.

ACBH000063

 Loan amount cannot be empty.

ACBH000130

 Maximum amount should be {0}{1}.

ACBH000131

 Minimum amount should be {0}{1}.

ACBH000132

 Maximum term should be {0} months.

ACBH000133

Minimum term should be {0} months.

Example

Request:

{
    "LoanProductId": "35009",
    "LoanTerm": 3,
    "LoanAmount":  10000,
    "GracePeriod": 0,
    "InstallmentPeriod": 1
}

Response:

{
    "Header": {
        "StatusCode": "APIGW000000",
        "StatusDescription": "Completed",
        "ObjectID": "1bb495ff-f6bd-47b1-8439-d506cd517bd4"
    },
    "Data": {
        "Loan": {
            "KKDF": "15.0",
            "ExpertisePrice": "",
            "LoanAllocationPrice": "25.0",
            "BSMV": "5.0",
            "YearlyCostRate": "45.3922",
            "InstallmentAmount": "3546.73",
            "TotalAmount": "10000.0",
            "LoanAmount": "10000.0",
            "LoanTerm": "3",
            "PaymentPlan": [
                {
                    "PrincipalBalance": "10000.0",
                    "KKDF": "",
                    "ExpiryDate": "2020-06-15T16:02:35.9138674",
                    "InstallmentInterest": "",
                    "InstallmentPrincipal": "",
                    "BSMV": "",
                    "InstallmentAmount": ""
                },
                {
                    "PrincipalBalance": "6770.07",
                    "KKDF": "39.6",
                    "ExpiryDate": "2020-07-15T00:00:00",
                    "InstallmentInterest": "",
                    "InstallmentPrincipal": "3229.93",
                    "BSMV": "13.2",
                    "InstallmentAmount": ""
                },
                {
                    "PrincipalBalance": "3437.82",
                    "KKDF": "26.81",
                    "ExpiryDate": "2020-08-15T00:00:00",
                    "InstallmentInterest": "",
                    "InstallmentPrincipal": "3332.25",
                    "BSMV": "8.94",
                    "InstallmentAmount": ""
                },
                {
                    "PrincipalBalance": "",
                    "KKDF": "13.61",
                    "ExpiryDate": "2020-09-15T00:00:00",
                    "InstallmentInterest": "",
                    "InstallmentPrincipal": "3437.82",
                    "BSMV": "4.54",
                    "InstallmentAmount": ""
                }
            ],
            "LoanProductId": "35009",
            "GracePeriod": "",
            "InstallmentPeriod": "1",
            "InterestRate": "2.64"
        }
    }
}