Skip to content
NexumAPI Docs

ProjectionService⁠

Perform projection calculations.

Operations⁠

calculatePaymentAmount⁠

POST

Computes the payment amount for a loan considering relevant factors.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
InterestRatenumber · floatoptional
InterestTypeintegeroptional
PaymentFrequencyintegeroptional
MAprPrepaidFinanceChgnumber · floatoptional
MilitaryAprLoanbooleanoptional
DqCalculationMethodintegeroptional
DueDateAdvanceCodeintegeroptional
LoanDatestring · dateoptional
PaymentTypeintegeroptional
PaymentCalculationTypeintegeroptional
AmortizeScheduleintegeroptional
AmortizeScheduleTypeintegeroptional
PaymentSkipsintegeroptional
PaymentSkipStartDayintegeroptional
DueDay1integeroptional
DueDay2integeroptional
FirstDueDatestring · dateoptional
BalloonDatestring · dateoptional
BalloonAmountnumber · floatoptional
FirstInsuredBirthDatestring · dateoptional
SecondInsuredBirthDatestring · dateoptional
InsuranceTypeintegeroptional
EscrowAmountnumber · floatoptional
PrepaidFinanceChgnumber · floatoptional
LoanAmountnumber · floatoptional
MaturityDatestring · dateoptional
Path Parameters
symstringrequired
Sym number
Responses
StatusMessagestringoptional
Paymentnumber · floatoptional
LoanAmountnumber · floatoptional
PaymentCountintegeroptional
FinalPaymentnumber · floatoptional
FinalDueDatestring · dateoptional
FirstPaymentDatestring · dateoptional
TotalInterestnumber · floatoptional
TotalPaymentsnumber · floatoptional
TotalEscrownumber · floatoptional
TotalMaprFeesnumber · floatoptional
Lifenumber · floatoptional
Disabilitynumber · floatoptional
LifeErrorstringoptional
DisabilityErrorstringoptional
Aprnumber · floatoptional
Maprnumber · floatoptional
POST/nexum/{sym}/2022.01/projection/calculatePaymentAmount
POST /nexum/627/2022.01/projection/calculatePaymentAmount HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "InterestRate": "string",
  "InterestType": 0,
  "PaymentFrequency": 0,
  "LoanDate": "2026-01-01",
  "FirstDueDate": "2026-01-01",
  "LoanAmount": "string",
  "MaturityDate": "2026-01-01",
  "PaymentType": 0,
  "PaymentCalculationType": 0
}

calculateLoanAmount⁠

POST

Determines the loan amount based on specified parameters.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
InterestRatenumber · floatoptional
InterestTypeintegeroptional
PaymentFrequencyintegeroptional
MAprPrepaidFinanceChgnumber · floatoptional
MilitaryAprLoanbooleanoptional
DqCalculationMethodintegeroptional
DueDateAdvanceCodeintegeroptional
LoanDatestring · dateoptional
PaymentTypeintegeroptional
PaymentCalculationTypeintegeroptional
AmortizeScheduleintegeroptional
AmortizeScheduleTypeintegeroptional
PaymentSkipsintegeroptional
PaymentSkipStartDayintegeroptional
DueDay1integeroptional
DueDay2integeroptional
FirstDueDatestring · dateoptional
BalloonDatestring · dateoptional
BalloonAmountnumber · floatoptional
FirstInsuredBirthDatestring · dateoptional
SecondInsuredBirthDatestring · dateoptional
InsuranceTypeintegeroptional
EscrowAmountnumber · floatoptional
PrepaidFinanceChgnumber · floatoptional
MaturityDatestring · dateoptional
Paymentnumber · floatoptional
Path Parameters
symstringrequired
Sym number
Responses
StatusMessagestringoptional
Paymentnumber · floatoptional
LoanAmountnumber · floatoptional
PaymentCountintegeroptional
FinalPaymentnumber · floatoptional
FinalDueDatestring · dateoptional
FirstPaymentDatestring · dateoptional
TotalInterestnumber · floatoptional
TotalPaymentsnumber · floatoptional
TotalEscrownumber · floatoptional
TotalMaprFeesnumber · floatoptional
Lifenumber · floatoptional
Disabilitynumber · floatoptional
LifeErrorstringoptional
DisabilityErrorstringoptional
Aprnumber · floatoptional
Maprnumber · floatoptional
POST/nexum/{sym}/2022.01/projection/calculateLoanAmount
POST /nexum/627/2022.01/projection/calculateLoanAmount HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "InterestRate": "string",
  "InterestType": 0,
  "PaymentFrequency": 0,
  "LoanDate": "2026-01-01",
  "FirstDueDate": "2026-01-01",
  "Payment": "string",
  "MaturityDate": "2026-01-01",
  "PaymentType": 0,
  "PaymentCalculationType": 0
}

calculateLoanTerm⁠

POST

Calculates the loan term (duration) based on given criteria.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
InterestRatenumber · floatoptional
InterestTypeintegeroptional
PaymentFrequencyintegeroptional
MAprPrepaidFinanceChgnumber · floatoptional
MilitaryAprLoanbooleanoptional
DqCalculationMethodintegeroptional
DueDateAdvanceCodeintegeroptional
LoanDatestring · dateoptional
PaymentTypeintegeroptional
PaymentCalculationTypeintegeroptional
AmortizeScheduleintegeroptional
AmortizeScheduleTypeintegeroptional
PaymentSkipsintegeroptional
PaymentSkipStartDayintegeroptional
DueDay1integeroptional
DueDay2integeroptional
FirstDueDatestring · dateoptional
BalloonDatestring · dateoptional
BalloonAmountnumber · floatoptional
FirstInsuredBirthDatestring · dateoptional
SecondInsuredBirthDatestring · dateoptional
InsuranceTypeintegeroptional
EscrowAmountnumber · floatoptional
PrepaidFinanceChgnumber · floatoptional
LoanAmountnumber · floatoptional
Paymentnumber · floatoptional
Path Parameters
symstringrequired
Sym number
Responses
StatusMessagestringoptional
Paymentnumber · floatoptional
LoanAmountnumber · floatoptional
PaymentCountintegeroptional
FinalPaymentnumber · floatoptional
FinalDueDatestring · dateoptional
FirstPaymentDatestring · dateoptional
TotalInterestnumber · floatoptional
TotalPaymentsnumber · floatoptional
TotalEscrownumber · floatoptional
TotalMaprFeesnumber · floatoptional
Lifenumber · floatoptional
Disabilitynumber · floatoptional
LifeErrorstringoptional
DisabilityErrorstringoptional
Aprnumber · floatoptional
Maprnumber · floatoptional
POST/nexum/{sym}/2022.01/projection/calculateLoanTerm
POST /nexum/627/2022.01/projection/calculateLoanTerm HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "InterestRate": "string",
  "InterestType": 0,
  "PaymentFrequency": 0,
  "LoanDate": "2026-01-01",
  "FirstDueDate": "2026-01-01",
  "LoanAmount": "string",
  "Payment": "string",
  "PaymentType": 0,
  "PaymentCalculationType": 0
}