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

Create a promise-to-pay

POSThttps://sandbox.api.lendeasy.ai/v1/servicing/cases/{caseId}/promises Bearer token · CREATE_PROMISE

Creates a structured payment commitment and returns its guardrail and approval outcome.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/cases/$CASE_ID/promises \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "loanId": "loan_harbor_7X2K",
  "commitments": [
    {
      "amount": "260.00",
      "dueDate": "2027-05-08"
    },
    {
      "amount": "257.14",
      "dueDate": "2027-05-22"
    }
  ],
  "sourceInteractionId": "int_HBR_CALL_91",
  "borrowerConfirmedAt": "2027-05-01T10: 18: 42-07: 00"
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/cases/${caseId}/promises`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "loanId": "loan_harbor_7X2K",
  "commitments": [
    {
      "amount": "260.00",
      "dueDate": "2027-05-08"
    },
    {
      "amount": "257.14",
      "dueDate": "2027-05-22"
    }
  ],
  "sourceInteractionId": "int_HBR_CALL_91",
  "borrowerConfirmedAt": "2027-05-01T10: 18: 42-07: 00"
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/cases/{case_id}/promises",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "loanId": "loan_harbor_7X2K",
  "commitments": [
    {
      "amount": "260.00",
      "dueDate": "2027-05-08"
    },
    {
      "amount": "257.14",
      "dueDate": "2027-05-22"
    }
  ],
  "sourceInteractionId": "int_HBR_CALL_91",
  "borrowerConfirmedAt": "2027-05-01T10: 18: 42-07: 00"
},
)

{
  "promiseId": "ptp_HBR_71",
  "caseId": "case_HBR_COL_51",
  "loanId": "loan_harbor_7X2K",
  "status": "active",
  "commitments": [
    {
      "amount": "260.00",
      "dueDate": "2027-05-08"
    },
    {
      "amount": "257.14",
      "dueDate": "2027-05-22"
    }
  ],
  "guardrailDecision": "within_policy",
  "version": 1
}

{
  "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.
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
loanId required	string	Stable opaque loan identifier.
commitments required	array<object>
amount	string	Decimal monetary amount encoded as a string.
dueDate	string
sourceInteractionId required	string
borrowerConfirmedAt required	string

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 "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "loanId": "loan_harbor_7X2K",
  "commitments": [
    {
      "amount": "260.00",
      "dueDate": "2027-05-08"
    },
    {
      "amount": "257.14",
      "dueDate": "2027-05-22"
    }
  ],
  "sourceInteractionId": "int_HBR_CALL_91",
  "borrowerConfirmedAt": "2027-05-01T10: 18: 42-07: 00"
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/cases/${caseId}/promises`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "loanId": "loan_harbor_7X2K",
  "commitments": [
    {
      "amount": "260.00",
      "dueDate": "2027-05-08"
    },
    {
      "amount": "257.14",
      "dueDate": "2027-05-22"
    }
  ],
  "sourceInteractionId": "int_HBR_CALL_91",
  "borrowerConfirmedAt": "2027-05-01T10: 18: 42-07: 00"
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/cases/{case_id}/promises",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "loanId": "loan_harbor_7X2K",
  "commitments": [
    {
      "amount": "260.00",
      "dueDate": "2027-05-08"
    },
    {
      "amount": "257.14",
      "dueDate": "2027-05-22"
    }
  ],
  "sourceInteractionId": "int_HBR_CALL_91",
  "borrowerConfirmedAt": "2027-05-01T10: 18: 42-07: 00"
},
)

{
  "promiseId": "ptp_HBR_71",
  "caseId": "case_HBR_COL_51",
  "loanId": "loan_harbor_7X2K",
  "status": "active",
  "commitments": [
    {
      "amount": "260.00",
      "dueDate": "2027-05-08"
    },
    {
      "amount": "257.14",
      "dueDate": "2027-05-22"
    }
  ],
  "guardrailDecision": "within_policy",
  "version": 1
}

{
  "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"
}