API Reference›Servicing Plane›Action requests›Prepare an action request

Prepare an action request

POSThttps://sandbox.api.lendeasy.ai/v1/servicing/action-requests Bearer token · PREPARE_ACTION

Freezes a typed, case-linked action payload and its execution context.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/action-requests \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "caseId": "case_HBR_COL_51",
  "loanId": "loan_harbor_7X2K",
  "actionType": "take_payment",
  "parameters": {
    "amount": "517.14",
    "currency": "USD",
    "effectiveDate": "2027-05-08",
    "paymentInstrumentId": "pi_HBR_ACH_04"
  },
  "previewToken": "prv_AR_71"
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/action-requests`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "caseId": "case_HBR_COL_51",
  "loanId": "loan_harbor_7X2K",
  "actionType": "take_payment",
  "parameters": {
    "amount": "517.14",
    "currency": "USD",
    "effectiveDate": "2027-05-08",
    "paymentInstrumentId": "pi_HBR_ACH_04"
  },
  "previewToken": "prv_AR_71"
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/action-requests",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "caseId": "case_HBR_COL_51",
  "loanId": "loan_harbor_7X2K",
  "actionType": "take_payment",
  "parameters": {
    "amount": "517.14",
    "currency": "USD",
    "effectiveDate": "2027-05-08",
    "paymentInstrumentId": "pi_HBR_ACH_04"
  },
  "previewToken": "prv_AR_71"
},
)

{
  "actionRequestId": "ar_HBR_811",
  "caseId": "case_HBR_COL_51",
  "actionType": "take_payment",
  "status": "prepared",
  "approvalRequired": false,
  "requestedHash": "sha256:49b1…72dd",
  "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
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
caseId required	string	Stable opaque servicing case identifier.
loanId required	string	Stable opaque loan identifier.
actionType required	string
parameters required	object	Strict action-type-specific parameters.
amount	string	Decimal monetary amount encoded as a string.
currency	string	ISO 4217 currency code.
effectiveDate	string	Business-effective date in ISO 8601 format.
paymentInstrumentId	string
previewToken required	string	Short-lived token binding the preview to facts, policies, and payload.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/action-requests \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "caseId": "case_HBR_COL_51",
  "loanId": "loan_harbor_7X2K",
  "actionType": "take_payment",
  "parameters": {
    "amount": "517.14",
    "currency": "USD",
    "effectiveDate": "2027-05-08",
    "paymentInstrumentId": "pi_HBR_ACH_04"
  },
  "previewToken": "prv_AR_71"
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/action-requests`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "caseId": "case_HBR_COL_51",
  "loanId": "loan_harbor_7X2K",
  "actionType": "take_payment",
  "parameters": {
    "amount": "517.14",
    "currency": "USD",
    "effectiveDate": "2027-05-08",
    "paymentInstrumentId": "pi_HBR_ACH_04"
  },
  "previewToken": "prv_AR_71"
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/action-requests",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "caseId": "case_HBR_COL_51",
  "loanId": "loan_harbor_7X2K",
  "actionType": "take_payment",
  "parameters": {
    "amount": "517.14",
    "currency": "USD",
    "effectiveDate": "2027-05-08",
    "paymentInstrumentId": "pi_HBR_ACH_04"
  },
  "previewToken": "prv_AR_71"
},
)

{
  "actionRequestId": "ar_HBR_811",
  "caseId": "case_HBR_COL_51",
  "actionType": "take_payment",
  "status": "prepared",
  "approvalRequired": false,
  "requestedHash": "sha256:49b1…72dd",
  "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"
}