API Reference›LMS API›Restrictions›Apply a restriction

Apply a restriction

POSThttps://sandbox.api.lendeasy.ai/v1/customers/{customerId}/restrictions Bearer token · APPLY_LMS_RESTRICTION

Applies a typed hold at customer scope, or loan scope when loanRef is supplied. The server derives the effective time; applying an already-active restriction of the same type and scope is idempotent. AUTOPAY_HOLD and COLLECTIONS_HOLD pause affected autopay enrollments in the same transaction.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/customers/$CUSTOMER_ID/restrictions \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "restrictionType": "PAYMENT_HOLD",
  "loanRef": "7204",
  "source": "bankruptcy-notice-91"
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/customers/${customerId}/restrictions`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "restrictionType": "PAYMENT_HOLD",
  "loanRef": "7204",
  "source": "bankruptcy-notice-91"
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/customers/{customer_id}/restrictions",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "restrictionType": "PAYMENT_HOLD",
  "loanRef": "7204",
  "source": "bankruptcy-notice-91"
},
)

{
  "resourceId": 41
}

{
  "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.
customerId required in path	string	Stable opaque customer identifier.
LendEasy-Case optional in header	string	Open servicing-case reference for this borrower. Required on human servicing mutations when case management is enabled; automation never sends it.
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
restrictionType required	string
loanRef required	string
source required	string	System or actor that originated the record.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/customers/$CUSTOMER_ID/restrictions \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "restrictionType": "PAYMENT_HOLD",
  "loanRef": "7204",
  "source": "bankruptcy-notice-91"
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/customers/${customerId}/restrictions`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "restrictionType": "PAYMENT_HOLD",
  "loanRef": "7204",
  "source": "bankruptcy-notice-91"
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/customers/{customer_id}/restrictions",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "restrictionType": "PAYMENT_HOLD",
  "loanRef": "7204",
  "source": "bankruptcy-notice-91"
},
)

{
  "resourceId": 41
}

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