API Reference›LMS API›Loans›Create a loan application

Create a loan application

POSThttps://sandbox.api.lendeasy.ai/v1/loans Bearer token · CREATE_LOAN

Creates a loan application for a customer against an active product; the clientId is the numeric value of the LendEasy customerId. Dates are parsed with the supplied dateFormat and locale. With command=calculateLoanSchedule the same body returns the computed amortization schedule — periods and totals — without persisting anything, which is how schedules are previewed before origination.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/loans \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "clientId": 412,
  "productId": 3,
  "loanType": "individual",
  "principal": 8400,
  "loanTermFrequency": 18,
  "loanTermFrequencyType": 2,
  "numberOfRepayments": 18,
  "repaymentEvery": 1,
  "repaymentFrequencyType": 2,
  "interestRatePerPeriod": 13.25,
  "interestType": 0,
  "interestCalculationPeriodType": 1,
  "amortizationType": 1,
  "transactionProcessingStrategyCode": "advanced-payment-allocation-strategy",
  "expectedDisbursementDate": "2026-08-12",
  "submittedOnDate": "2026-08-11",
  "externalId": "origination-HBR-2026-001",
  "dateFormat": "yyyy-MM-dd",
  "locale": "en",
  "charges": [
    {
      "chargeId": 12,
      "amount": 252
    }
  ]
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/loans`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "clientId": 412,
  "productId": 3,
  "loanType": "individual",
  "principal": 8400,
  "loanTermFrequency": 18,
  "loanTermFrequencyType": 2,
  "numberOfRepayments": 18,
  "repaymentEvery": 1,
  "repaymentFrequencyType": 2,
  "interestRatePerPeriod": 13.25,
  "interestType": 0,
  "interestCalculationPeriodType": 1,
  "amortizationType": 1,
  "transactionProcessingStrategyCode": "advanced-payment-allocation-strategy",
  "expectedDisbursementDate": "2026-08-12",
  "submittedOnDate": "2026-08-11",
  "externalId": "origination-HBR-2026-001",
  "dateFormat": "yyyy-MM-dd",
  "locale": "en",
  "charges": [
    {
      "chargeId": 12,
      "amount": 252
    }
  ]
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/loans",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "clientId": 412,
  "productId": 3,
  "loanType": "individual",
  "principal": 8400,
  "loanTermFrequency": 18,
  "loanTermFrequencyType": 2,
  "numberOfRepayments": 18,
  "repaymentEvery": 1,
  "repaymentFrequencyType": 2,
  "interestRatePerPeriod": 13.25,
  "interestType": 0,
  "interestCalculationPeriodType": 1,
  "amortizationType": 1,
  "transactionProcessingStrategyCode": "advanced-payment-allocation-strategy",
  "expectedDisbursementDate": "2026-08-12",
  "submittedOnDate": "2026-08-11",
  "externalId": "origination-HBR-2026-001",
  "dateFormat": "yyyy-MM-dd",
  "locale": "en",
  "charges": [
    {
      "chargeId": 12,
      "amount": 252
    }
  ]
},
)

{
  "officeId": 1,
  "clientId": 412,
  "loanId": 7204,
  "resourceId": 7204
}

{
  "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.
command optional in query	string	Omit to create the application; calculateLoanSchedule returns a non-persisting schedule preview. One of `calculateLoanSchedule`.
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
clientId required	integer
productId required	integer
loanType required	string
principal required	integer
loanTermFrequency required	integer
loanTermFrequencyType required	integer
numberOfRepayments required	integer
repaymentEvery required	integer
repaymentFrequencyType required	integer
interestRatePerPeriod required	number
interestType required	integer
interestCalculationPeriodType required	integer
amortizationType required	integer
transactionProcessingStrategyCode required	string
expectedDisbursementDate required	string
submittedOnDate required	string
externalId required	string	Caller-controlled identifier unique within the tenant and resource type.
dateFormat required	string
locale required	string
charges required	array<object>
chargeId	integer
amount	integer	Decimal monetary amount encoded as a string.

Recipes using this endpoint

📘 Originate a loan →

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/loans \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "clientId": 412,
  "productId": 3,
  "loanType": "individual",
  "principal": 8400,
  "loanTermFrequency": 18,
  "loanTermFrequencyType": 2,
  "numberOfRepayments": 18,
  "repaymentEvery": 1,
  "repaymentFrequencyType": 2,
  "interestRatePerPeriod": 13.25,
  "interestType": 0,
  "interestCalculationPeriodType": 1,
  "amortizationType": 1,
  "transactionProcessingStrategyCode": "advanced-payment-allocation-strategy",
  "expectedDisbursementDate": "2026-08-12",
  "submittedOnDate": "2026-08-11",
  "externalId": "origination-HBR-2026-001",
  "dateFormat": "yyyy-MM-dd",
  "locale": "en",
  "charges": [
    {
      "chargeId": 12,
      "amount": 252
    }
  ]
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/loans`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "clientId": 412,
  "productId": 3,
  "loanType": "individual",
  "principal": 8400,
  "loanTermFrequency": 18,
  "loanTermFrequencyType": 2,
  "numberOfRepayments": 18,
  "repaymentEvery": 1,
  "repaymentFrequencyType": 2,
  "interestRatePerPeriod": 13.25,
  "interestType": 0,
  "interestCalculationPeriodType": 1,
  "amortizationType": 1,
  "transactionProcessingStrategyCode": "advanced-payment-allocation-strategy",
  "expectedDisbursementDate": "2026-08-12",
  "submittedOnDate": "2026-08-11",
  "externalId": "origination-HBR-2026-001",
  "dateFormat": "yyyy-MM-dd",
  "locale": "en",
  "charges": [
    {
      "chargeId": 12,
      "amount": 252
    }
  ]
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/loans",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "clientId": 412,
  "productId": 3,
  "loanType": "individual",
  "principal": 8400,
  "loanTermFrequency": 18,
  "loanTermFrequencyType": 2,
  "numberOfRepayments": 18,
  "repaymentEvery": 1,
  "repaymentFrequencyType": 2,
  "interestRatePerPeriod": 13.25,
  "interestType": 0,
  "interestCalculationPeriodType": 1,
  "amortizationType": 1,
  "transactionProcessingStrategyCode": "advanced-payment-allocation-strategy",
  "expectedDisbursementDate": "2026-08-12",
  "submittedOnDate": "2026-08-11",
  "externalId": "origination-HBR-2026-001",
  "dateFormat": "yyyy-MM-dd",
  "locale": "en",
  "charges": [
    {
      "chargeId": 12,
      "amount": 252
    }
  ]
},
)

{
  "officeId": 1,
  "clientId": 412,
  "loanId": 7204,
  "resourceId": 7204
}

{
  "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": []
}