API Reference›Servicing Plane›Promises›Create a promise to pay

Create a promise to pay

POSThttps://sandbox.api.lendeasy.ai/v1/servicing/cases/{caseId}/promisesImplementedBearer token ·CREATE_SERVICING_PROMISE

Creates an in-policy promise immediately or materializes the exact approval request when terms exceed configured guardrails. A promise never authorizes a debit.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/cases/$CASE_ID/promises \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "loanRef": "456",
  "planType": "SINGLE",
  "promiseDate": "2026-08-01",
  "promiseAmount": {
    "amount": 250,
    "currency": "USD"
  },
  "reason": "Customer committed to pay on 2026-08-01.",
  "evidenceIds": [
    8801
  ]
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/cases/${caseId}/promises`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "loanRef": "456",
  "planType": "SINGLE",
  "promiseDate": "2026-08-01",
  "promiseAmount": {
    "amount": 250,
    "currency": "USD"
  },
  "reason": "Customer committed to pay on 2026-08-01.",
  "evidenceIds": [
    8801
  ]
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/cases/{case_id}/promises",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "loanRef": "456",
  "planType": "SINGLE",
  "promiseDate": "2026-08-01",
  "promiseAmount": {
    "amount": 250,
    "currency": "USD"
  },
  "reason": "Customer committed to pay on 2026-08-01.",
  "evidenceIds": [
    8801
  ]
},
)

{
  "outcome": "COMPLETED",
  "promise": {
    "promiseId": 6101,
    "loanRef": "456",
    "planType": "SINGLE",
    "state": "ACTIVE",
    "amount": {
      "amount": 250,
      "currency": "USD"
    },
    "promiseDate": "2026-08-01",
    "reason": "Customer committed to pay on 2026-08-01.",
    "evaluatedAgainstAsOf": "2026-07-25T18: 30:00Z",
    "createdAt": "2026-07-25T18: 30:00Z"
  },
  "resourceId": 6101
}

{
  "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.
caseId required in path	integer	Positive numeric case identifier.
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
loanRef required	string
planType required	string
promiseDate optional	string
promiseAmount optional	object
amount	integer	Decimal monetary value using the representation declared by this operation.
currency	string	ISO 4217 currency code.
reason required	string
evidenceIds optional	array<integer>	Evidence records supporting the request.

Recipes using this endpoint

📘 Record a promise-to-pay →

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/cases/$CASE_ID/promises \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "loanRef": "456",
  "planType": "SINGLE",
  "promiseDate": "2026-08-01",
  "promiseAmount": {
    "amount": 250,
    "currency": "USD"
  },
  "reason": "Customer committed to pay on 2026-08-01.",
  "evidenceIds": [
    8801
  ]
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/cases/${caseId}/promises`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "loanRef": "456",
  "planType": "SINGLE",
  "promiseDate": "2026-08-01",
  "promiseAmount": {
    "amount": 250,
    "currency": "USD"
  },
  "reason": "Customer committed to pay on 2026-08-01.",
  "evidenceIds": [
    8801
  ]
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/cases/{case_id}/promises",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "loanRef": "456",
  "planType": "SINGLE",
  "promiseDate": "2026-08-01",
  "promiseAmount": {
    "amount": 250,
    "currency": "USD"
  },
  "reason": "Customer committed to pay on 2026-08-01.",
  "evidenceIds": [
    8801
  ]
},
)

{
  "outcome": "COMPLETED",
  "promise": {
    "promiseId": 6101,
    "loanRef": "456",
    "planType": "SINGLE",
    "state": "ACTIVE",
    "amount": {
      "amount": 250,
      "currency": "USD"
    },
    "promiseDate": "2026-08-01",
    "reason": "Customer committed to pay on 2026-08-01.",
    "evaluatedAgainstAsOf": "2026-07-25T18: 30:00Z",
    "createdAt": "2026-07-25T18: 30:00Z"
  },
  "resourceId": 6101
}

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