API Reference›Servicing Plane›Case effects›Retry a failed case effect

Retry a failed case effect

POSThttps://sandbox.api.lendeasy.ai/v1/servicing/cases/{caseId}/effects/{effectRef}ImplementedBearer token ·RETRY_SERVICING_CASE_EFFECT

Returns a terminal FAILED effect to PENDING; the workflow executor performs the same typed operation. Requires command=retry.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/cases/$CASE_ID/effects/$EFFECT_REF?command=retry \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "The transient downstream failure has been resolved."
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/cases/${caseId}/effects/${effectRef}?command=retry`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "reason": "The transient downstream failure has been resolved."
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/cases/{case_id}/effects/{effect_ref}?command=retry",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "reason": "The transient downstream failure has been resolved."
},
)

{
  "effectRef": "effect-cancel-autopay-1001-1",
  "status": "PENDING",
  "resourceId": 1001
}

{
  "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.
effectRef required in path	string	Stable opaque effectRef identifier.
command required in query	string	The only supported command variant. One of `retry`.
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
reason required	string

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/cases/$CASE_ID/effects/$EFFECT_REF?command=retry \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "The transient downstream failure has been resolved."
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/cases/${caseId}/effects/${effectRef}?command=retry`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "reason": "The transient downstream failure has been resolved."
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/cases/{case_id}/effects/{effect_ref}?command=retry",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "reason": "The transient downstream failure has been resolved."
},
)

{
  "effectRef": "effect-cancel-autopay-1001-1",
  "status": "PENDING",
  "resourceId": 1001
}

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