API Reference›Servicing Plane›Portal contracts›Ask for different terms

Ask for different terms

POSThttps://sandbox.api.lendeasy.ai/v1/servicing/portal-agreements/{agreementRef}/change-requestsImplementedBearer token ·RECORD_PORTAL_AGREEMENT_RESPONSE

Records a structured request for different terms and moves the live offer to UNDER_CHANGE_REVIEW. No terms are returned; policy and human approval decide what is offerable.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/portal-agreements/$AGREEMENT_REF/change-requests \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "requestedDeferredPayments": 5,
  "note": "Two more months of pause would let me recover."
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/portal-agreements/${agreementRef}/change-requests`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "requestedDeferredPayments": 5,
  "note": "Two more months of pause would let me recover."
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/portal-agreements/{agreement_ref}/change-requests",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "requestedDeferredPayments": 5,
  "note": "Two more months of pause would let me recover."
},
)

{
  "acknowledged": true
}

{
  "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	Opaque active LendEasy tenant-registry identifier. Supply exactly one instance; no alternate tenant selector is accepted.
agreementRef required in path	string	Stable opaque agreementRef identifier.
customerRef optional in query	string	Customer the agreement is addressed to.
Idempotency-Key optional in header	string	Optional replay key for this logical mutation. Omission creates a fresh server-owned key for this attempt; blank, repeated, or longer-than-50-character values are rejected.

Body parameters

Field	Type	Description
requestedDeferredPayments required	integer
note optional	string

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/portal-agreements/$AGREEMENT_REF/change-requests \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "requestedDeferredPayments": 5,
  "note": "Two more months of pause would let me recover."
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/portal-agreements/${agreementRef}/change-requests`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "requestedDeferredPayments": 5,
  "note": "Two more months of pause would let me recover."
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/portal-agreements/{agreement_ref}/change-requests",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "requestedDeferredPayments": 5,
  "note": "Two more months of pause would let me recover."
},
)

{
  "acknowledged": true
}

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