API Reference›LMS API›Autopay›Configure an autopay failure policy

Configure an autopay failure policy

PUThttps://sandbox.api.lendeasy.ai/v1/autopay/failure-policies/{rail} Bearer token · CONFIGURE_LMS_AUTOPAY_FAILURE_POLICY

Replaces the full policy for one rail — base retry rules and the complete return-code list. The rail path segment is ACH or CARD.

Request

curl -X PUT https://sandbox.api.lendeasy.ai/v1/autopay/failure-policies/$RAIL \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "automaticRetry": true,
  "retryAfterBusinessDays": 2,
  "maxRetryAttempts": 2,
  "maxConsecutiveFailedCycles": 3,
  "runNextScheduledCycle": true,
  "exhaustionAction": "REVIEW_REQUIRED",
  "returnCodes": [
    {
      "returnCode": "R01",
      "retryAllowed": true,
      "instrumentAction": "KEEP",
      "autopayAction": "CONTINUE",
      "caseAction": "NONE",
      "recommendedAction": "NONE",
      "treatAsUnauthorized": false
    }
  ]
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/autopay/failure-policies/${rail}`, {
  method: "PUT",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "automaticRetry": true,
  "retryAfterBusinessDays": 2,
  "maxRetryAttempts": 2,
  "maxConsecutiveFailedCycles": 3,
  "runNextScheduledCycle": true,
  "exhaustionAction": "REVIEW_REQUIRED",
  "returnCodes": [
    {
      "returnCode": "R01",
      "retryAllowed": true,
      "instrumentAction": "KEEP",
      "autopayAction": "CONTINUE",
      "caseAction": "NONE",
      "recommendedAction": "NONE",
      "treatAsUnauthorized": false
    }
  ]
}),
});

requests.put(
  f"https://sandbox.api.lendeasy.ai/v1/autopay/failure-policies/{rail}",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "automaticRetry": true,
  "retryAfterBusinessDays": 2,
  "maxRetryAttempts": 2,
  "maxConsecutiveFailedCycles": 3,
  "runNextScheduledCycle": true,
  "exhaustionAction": "REVIEW_REQUIRED",
  "returnCodes": [
    {
      "returnCode": "R01",
      "retryAllowed": true,
      "instrumentAction": "KEEP",
      "autopayAction": "CONTINUE",
      "caseAction": "NONE",
      "recommendedAction": "NONE",
      "treatAsUnauthorized": false
    }
  ]
},
)

{
  "resourceId": 2
}

{
  "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	Tenant selector: lowercase letters, digits, and hyphens, 1-64 characters. Exactly one instance; the only tenant selector honored.
rail required in path	string	Stable opaque rail identifier.
Idempotency-Key optional in header	string	Optional stable key (1-50 chars) for this one logical mutation. Replays of a completed request return the original result with x-served-from-cache: true; an in-flight duplicate returns 409 with Retry-After. Omitted keys are server-generated per attempt.

Body parameters

Field	Type	Description
automaticRetry required	boolean
retryAfterBusinessDays required	integer
maxRetryAttempts required	integer
maxConsecutiveFailedCycles required	integer
runNextScheduledCycle required	boolean
exhaustionAction required	string
returnCodes required	array<object>
returnCode	string
retryAllowed	boolean
instrumentAction	string
autopayAction	string
caseAction	string
recommendedAction	string
treatAsUnauthorized	boolean

Request

curl -X PUT https://sandbox.api.lendeasy.ai/v1/autopay/failure-policies/$RAIL \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "automaticRetry": true,
  "retryAfterBusinessDays": 2,
  "maxRetryAttempts": 2,
  "maxConsecutiveFailedCycles": 3,
  "runNextScheduledCycle": true,
  "exhaustionAction": "REVIEW_REQUIRED",
  "returnCodes": [
    {
      "returnCode": "R01",
      "retryAllowed": true,
      "instrumentAction": "KEEP",
      "autopayAction": "CONTINUE",
      "caseAction": "NONE",
      "recommendedAction": "NONE",
      "treatAsUnauthorized": false
    }
  ]
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/autopay/failure-policies/${rail}`, {
  method: "PUT",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "automaticRetry": true,
  "retryAfterBusinessDays": 2,
  "maxRetryAttempts": 2,
  "maxConsecutiveFailedCycles": 3,
  "runNextScheduledCycle": true,
  "exhaustionAction": "REVIEW_REQUIRED",
  "returnCodes": [
    {
      "returnCode": "R01",
      "retryAllowed": true,
      "instrumentAction": "KEEP",
      "autopayAction": "CONTINUE",
      "caseAction": "NONE",
      "recommendedAction": "NONE",
      "treatAsUnauthorized": false
    }
  ]
}),
});

requests.put(
  f"https://sandbox.api.lendeasy.ai/v1/autopay/failure-policies/{rail}",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "automaticRetry": true,
  "retryAfterBusinessDays": 2,
  "maxRetryAttempts": 2,
  "maxConsecutiveFailedCycles": 3,
  "runNextScheduledCycle": true,
  "exhaustionAction": "REVIEW_REQUIRED",
  "returnCodes": [
    {
      "returnCode": "R01",
      "retryAllowed": true,
      "instrumentAction": "KEEP",
      "autopayAction": "CONTINUE",
      "caseAction": "NONE",
      "recommendedAction": "NONE",
      "treatAsUnauthorized": false
    }
  ]
},
)

{
  "resourceId": 2
}

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