API Reference›LMS API›Charges›Create a charge definition

Create a charge definition

POSThttps://sandbox.api.lendeasy.ai/v1/charges Bearer token · CREATE_LMS_CHARGE

Creates a loan charge definition and its required LendEasy classification atomically. The body has two blocks: the native charge settings and lmsConfig with the Regulation Z finance-charge flag and legal basis.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/charges \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "fineract": {
    "name": "Late fee",
    "currencyCode": "USD",
    "amount": 18,
    "chargeAppliesTo": 1,
    "chargeTimeType": 9,
    "chargeCalculationType": 1,
    "penalty": true,
    "active": true
  },
  "lmsConfig": {
    "financeChargeFlag": "EXCLUDED",
    "legalBasis": "CA Fin. Code §22307"
  }
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/charges`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "fineract": {
    "name": "Late fee",
    "currencyCode": "USD",
    "amount": 18,
    "chargeAppliesTo": 1,
    "chargeTimeType": 9,
    "chargeCalculationType": 1,
    "penalty": true,
    "active": true
  },
  "lmsConfig": {
    "financeChargeFlag": "EXCLUDED",
    "legalBasis": "CA Fin. Code §22307"
  }
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/charges",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "fineract": {
    "name": "Late fee",
    "currencyCode": "USD",
    "amount": 18,
    "chargeAppliesTo": 1,
    "chargeTimeType": 9,
    "chargeCalculationType": 1,
    "penalty": true,
    "active": true
  },
  "lmsConfig": {
    "financeChargeFlag": "EXCLUDED",
    "legalBasis": "CA Fin. Code §22307"
  }
},
)

{
  "resourceId": 21
}

{
  "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
currencyCode	string
amount	integer	Decimal monetary amount encoded as a string.
chargeAppliesTo	integer
chargeTimeType	integer
chargeCalculationType	integer
penalty	boolean
active	boolean
lmsConfig required	object
financeChargeFlag	string
legalBasis	string

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/charges \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "fineract": {
    "name": "Late fee",
    "currencyCode": "USD",
    "amount": 18,
    "chargeAppliesTo": 1,
    "chargeTimeType": 9,
    "chargeCalculationType": 1,
    "penalty": true,
    "active": true
  },
  "lmsConfig": {
    "financeChargeFlag": "EXCLUDED",
    "legalBasis": "CA Fin. Code §22307"
  }
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/charges`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "fineract": {
    "name": "Late fee",
    "currencyCode": "USD",
    "amount": 18,
    "chargeAppliesTo": 1,
    "chargeTimeType": 9,
    "chargeCalculationType": 1,
    "penalty": true,
    "active": true
  },
  "lmsConfig": {
    "financeChargeFlag": "EXCLUDED",
    "legalBasis": "CA Fin. Code §22307"
  }
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/charges",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "fineract": {
    "name": "Late fee",
    "currencyCode": "USD",
    "amount": 18,
    "chargeAppliesTo": 1,
    "chargeTimeType": 9,
    "chargeCalculationType": 1,
    "penalty": true,
    "active": true
  },
  "lmsConfig": {
    "financeChargeFlag": "EXCLUDED",
    "legalBasis": "CA Fin. Code §22307"
  }
},
)

{
  "resourceId": 21
}

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