API Reference›Servicing Plane›Promises›Cancel a promise

Cancel a promise

POSThttps://sandbox.api.lendeasy.ai/v1/servicing/cases/{caseId}/promises/{promiseId}/cancelRoadmapBearer token ·CANCEL_PROMISE

Cancels an active promise with effective time and structured reason.

Roadmap contract. This operation is published product direction and is not registered by the current servicing runtime. Check API availability before building an integration.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/cases/$CASE_ID/promises/$PROMISE_ID/cancel \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "reasonCode": "borrower_withdrew_commitment",
  "effectiveAt": "2027-05-03T11: 20: 00-07: 00",
  "expectedVersion": 1
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/cases/${caseId}/promises/${promiseId}/cancel`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "reasonCode": "borrower_withdrew_commitment",
  "effectiveAt": "2027-05-03T11: 20: 00-07: 00",
  "expectedVersion": 1
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/cases/{case_id}/promises/{promise_id}/cancel",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "reasonCode": "borrower_withdrew_commitment",
  "effectiveAt": "2027-05-03T11: 20: 00-07: 00",
  "expectedVersion": 1
},
)

{
  "promiseId": "ptp_HBR_71",
  "status": "cancelled",
  "version": 2
}

{
  "type": "https://docs.lendeasy.ai/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthorized",
  "detail": "The request could not be applied.",
  "requestId": "req_01J2R8M6YQ3C7K2N"
}

{
  "type": "https://docs.lendeasy.ai/errors/forbidden",
  "title": "Forbidden",
  "status": 403,
  "code": "forbidden",
  "detail": "The request could not be applied.",
  "requestId": "req_01J2R8M6YQ3C7K2N"
}

{
  "type": "https://docs.lendeasy.ai/errors/version_conflict",
  "title": "Version Conflict",
  "status": 409,
  "code": "version_conflict",
  "detail": "The request could not be applied.",
  "requestId": "req_01J2R8M6YQ3C7K2N"
}

{
  "type": "https://docs.lendeasy.ai/errors/validation_error",
  "title": "Validation Error",
  "status": 422,
  "code": "validation_error",
  "detail": "The request could not be applied.",
  "requestId": "req_01J2R8M6YQ3C7K2N"
}

{
  "type": "https://docs.lendeasy.ai/errors/rate_limited",
  "title": "Rate Limited",
  "status": 429,
  "code": "rate_limited",
  "detail": "The request could not be applied.",
  "requestId": "req_01J2R8M6YQ3C7K2N"
}

Path & query parameters

Field	Type	Description
caseId required in path	string	Stable opaque servicing case identifier.
promiseId required in path	string	Stable opaque promise identifier.
Idempotency-Key required in header	string	Stable key for this one logical mutation. Reuse it for retries; reusing it with a different request returns 409.

Body parameters

Field	Type	Description
reasonCode required	string	Configured structured reason code.
effectiveAt required	string
expectedVersion required	integer

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/cases/$CASE_ID/promises/$PROMISE_ID/cancel \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "reasonCode": "borrower_withdrew_commitment",
  "effectiveAt": "2027-05-03T11: 20: 00-07: 00",
  "expectedVersion": 1
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/cases/${caseId}/promises/${promiseId}/cancel`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "reasonCode": "borrower_withdrew_commitment",
  "effectiveAt": "2027-05-03T11: 20: 00-07: 00",
  "expectedVersion": 1
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/cases/{case_id}/promises/{promise_id}/cancel",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "reasonCode": "borrower_withdrew_commitment",
  "effectiveAt": "2027-05-03T11: 20: 00-07: 00",
  "expectedVersion": 1
},
)

{
  "promiseId": "ptp_HBR_71",
  "status": "cancelled",
  "version": 2
}

{
  "type": "https://docs.lendeasy.ai/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthorized",
  "detail": "The request could not be applied.",
  "requestId": "req_01J2R8M6YQ3C7K2N"
}

{
  "type": "https://docs.lendeasy.ai/errors/forbidden",
  "title": "Forbidden",
  "status": 403,
  "code": "forbidden",
  "detail": "The request could not be applied.",
  "requestId": "req_01J2R8M6YQ3C7K2N"
}

{
  "type": "https://docs.lendeasy.ai/errors/version_conflict",
  "title": "Version Conflict",
  "status": 409,
  "code": "version_conflict",
  "detail": "The request could not be applied.",
  "requestId": "req_01J2R8M6YQ3C7K2N"
}

{
  "type": "https://docs.lendeasy.ai/errors/validation_error",
  "title": "Validation Error",
  "status": 422,
  "code": "validation_error",
  "detail": "The request could not be applied.",
  "requestId": "req_01J2R8M6YQ3C7K2N"
}

{
  "type": "https://docs.lendeasy.ai/errors/rate_limited",
  "title": "Rate Limited",
  "status": 429,
  "code": "rate_limited",
  "detail": "The request could not be applied.",
  "requestId": "req_01J2R8M6YQ3C7K2N"
}