API Reference›LMS API›Loan products›Create a loan product

Create a loan product

POSThttps://sandbox.api.lendeasy.ai/v1/loanproducts Bearer token · CREATE_LMS_LOAN_PRODUCT

Creates a progressive loan product and its required LendEasy configuration atomically. The body has two blocks: the native product settings — progressive schedule, no interest recalculation, charges referenced by id — and lmsConfig with product class, APR policy, statement policy, and optional overpayment tolerance. The server owns the payment-allocation order.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/loanproducts \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "fineract": {
    "name": "Harbor 18-month personal loan",
    "shortName": "HBR18",
    "currencyCode": "USD",
    "principal": 8400,
    "numberOfRepayments": 18,
    "repaymentEvery": 1,
    "repaymentFrequencyType": 2,
    "interestRatePerPeriod": 13.25,
    "interestRateFrequencyType": 3,
    "amortizationType": 1,
    "interestType": 0,
    "interestCalculationPeriodType": 1,
    "transactionProcessingStrategyCode": "advanced-payment-allocation-strategy",
    "loanScheduleType": "PROGRESSIVE",
    "isInterestRecalculationEnabled": false,
    "accountingRule": 1,
    "charges": [
      {
        "id": 12
      }
    ]
  },
  "lmsConfig": {
    "productClass": "COVERED_CONSUMER",
    "aprEnabled": true,
    "aprRounding": "NEAREST_0_01_PERCENT_HALF_UP",
    "aprTolerancePolicy": "REGULAR",
    "statementEnabled": true,
    "statementLeadDays": 10
  }
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/loanproducts`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "fineract": {
    "name": "Harbor 18-month personal loan",
    "shortName": "HBR18",
    "currencyCode": "USD",
    "principal": 8400,
    "numberOfRepayments": 18,
    "repaymentEvery": 1,
    "repaymentFrequencyType": 2,
    "interestRatePerPeriod": 13.25,
    "interestRateFrequencyType": 3,
    "amortizationType": 1,
    "interestType": 0,
    "interestCalculationPeriodType": 1,
    "transactionProcessingStrategyCode": "advanced-payment-allocation-strategy",
    "loanScheduleType": "PROGRESSIVE",
    "isInterestRecalculationEnabled": false,
    "accountingRule": 1,
    "charges": [
      {
        "id": 12
      }
    ]
  },
  "lmsConfig": {
    "productClass": "COVERED_CONSUMER",
    "aprEnabled": true,
    "aprRounding": "NEAREST_0_01_PERCENT_HALF_UP",
    "aprTolerancePolicy": "REGULAR",
    "statementEnabled": true,
    "statementLeadDays": 10
  }
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/loanproducts",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "fineract": {
    "name": "Harbor 18-month personal loan",
    "shortName": "HBR18",
    "currencyCode": "USD",
    "principal": 8400,
    "numberOfRepayments": 18,
    "repaymentEvery": 1,
    "repaymentFrequencyType": 2,
    "interestRatePerPeriod": 13.25,
    "interestRateFrequencyType": 3,
    "amortizationType": 1,
    "interestType": 0,
    "interestCalculationPeriodType": 1,
    "transactionProcessingStrategyCode": "advanced-payment-allocation-strategy",
    "loanScheduleType": "PROGRESSIVE",
    "isInterestRecalculationEnabled": false,
    "accountingRule": 1,
    "charges": [
      {
        "id": 12
      }
    ]
  },
  "lmsConfig": {
    "productClass": "COVERED_CONSUMER",
    "aprEnabled": true,
    "aprRounding": "NEAREST_0_01_PERCENT_HALF_UP",
    "aprTolerancePolicy": "REGULAR",
    "statementEnabled": true,
    "statementLeadDays": 10
  }
},
)

{
  "resourceId": 3
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "400",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "validation.msg.validation.errors.exist",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "401",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authenticated",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "403",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authorized",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "404",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.resource.not.found",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "409",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "idempotency.request.in.flight",
  "errors": []
}

Path & query parameters

Field	Type	Description
LendEasy-Tenant required in header	string	Tenant selector: lowercase letters, digits, and hyphens, 1-64 characters. Exactly one instance; the only tenant selector honored.
Idempotency-Key optional in header	string	Optional stable key (1-50 chars) for this one logical mutation. Replays of a completed request return the original result with x-served-from-cache: true; an in-flight duplicate returns 409 with Retry-After. Omitted keys are server-generated per attempt.

Body parameters

Field	Type	Description
fineract required	object
name	string
shortName	string
currencyCode	string
principal	integer
numberOfRepayments	integer
repaymentEvery	integer
repaymentFrequencyType	integer
interestRatePerPeriod	number
interestRateFrequencyType	integer
amortizationType	integer
interestType	integer
interestCalculationPeriodType	integer
transactionProcessingStrategyCode	string
loanScheduleType	string
isInterestRecalculationEnabled	boolean
accountingRule	integer
charges	array<object>
lmsConfig required	object
productClass	string
aprEnabled	boolean
aprRounding	string
aprTolerancePolicy	string
statementEnabled	boolean
statementLeadDays	integer

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/loanproducts \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "fineract": {
    "name": "Harbor 18-month personal loan",
    "shortName": "HBR18",
    "currencyCode": "USD",
    "principal": 8400,
    "numberOfRepayments": 18,
    "repaymentEvery": 1,
    "repaymentFrequencyType": 2,
    "interestRatePerPeriod": 13.25,
    "interestRateFrequencyType": 3,
    "amortizationType": 1,
    "interestType": 0,
    "interestCalculationPeriodType": 1,
    "transactionProcessingStrategyCode": "advanced-payment-allocation-strategy",
    "loanScheduleType": "PROGRESSIVE",
    "isInterestRecalculationEnabled": false,
    "accountingRule": 1,
    "charges": [
      {
        "id": 12
      }
    ]
  },
  "lmsConfig": {
    "productClass": "COVERED_CONSUMER",
    "aprEnabled": true,
    "aprRounding": "NEAREST_0_01_PERCENT_HALF_UP",
    "aprTolerancePolicy": "REGULAR",
    "statementEnabled": true,
    "statementLeadDays": 10
  }
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/loanproducts`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "fineract": {
    "name": "Harbor 18-month personal loan",
    "shortName": "HBR18",
    "currencyCode": "USD",
    "principal": 8400,
    "numberOfRepayments": 18,
    "repaymentEvery": 1,
    "repaymentFrequencyType": 2,
    "interestRatePerPeriod": 13.25,
    "interestRateFrequencyType": 3,
    "amortizationType": 1,
    "interestType": 0,
    "interestCalculationPeriodType": 1,
    "transactionProcessingStrategyCode": "advanced-payment-allocation-strategy",
    "loanScheduleType": "PROGRESSIVE",
    "isInterestRecalculationEnabled": false,
    "accountingRule": 1,
    "charges": [
      {
        "id": 12
      }
    ]
  },
  "lmsConfig": {
    "productClass": "COVERED_CONSUMER",
    "aprEnabled": true,
    "aprRounding": "NEAREST_0_01_PERCENT_HALF_UP",
    "aprTolerancePolicy": "REGULAR",
    "statementEnabled": true,
    "statementLeadDays": 10
  }
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/loanproducts",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "fineract": {
    "name": "Harbor 18-month personal loan",
    "shortName": "HBR18",
    "currencyCode": "USD",
    "principal": 8400,
    "numberOfRepayments": 18,
    "repaymentEvery": 1,
    "repaymentFrequencyType": 2,
    "interestRatePerPeriod": 13.25,
    "interestRateFrequencyType": 3,
    "amortizationType": 1,
    "interestType": 0,
    "interestCalculationPeriodType": 1,
    "transactionProcessingStrategyCode": "advanced-payment-allocation-strategy",
    "loanScheduleType": "PROGRESSIVE",
    "isInterestRecalculationEnabled": false,
    "accountingRule": 1,
    "charges": [
      {
        "id": 12
      }
    ]
  },
  "lmsConfig": {
    "productClass": "COVERED_CONSUMER",
    "aprEnabled": true,
    "aprRounding": "NEAREST_0_01_PERCENT_HALF_UP",
    "aprTolerancePolicy": "REGULAR",
    "statementEnabled": true,
    "statementLeadDays": 10
  }
},
)

{
  "resourceId": 3
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "400",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "validation.msg.validation.errors.exist",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "401",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authenticated",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "403",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authorized",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "404",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.resource.not.found",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "409",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "idempotency.request.in.flight",
  "errors": []
}