API Reference›LMS API›Autopay›List autopay failure policies

List autopay failure policies

GEThttps://sandbox.api.lendeasy.ai/v1/autopay/failure-policies Bearer token · READ_LMS_AUTOPAY_FAILURE_POLICY

Returns the tenant’s per-rail failure policy, including retry rules and per-return-code overrides. Unknown return codes always fail closed into review.

Request

curl https://sandbox.api.lendeasy.ai/v1/autopay/failure-policies \
  -H "Authorization: Bearer $TOKEN"

await fetch(`https://sandbox.api.lendeasy.ai/v1/autopay/failure-policies`, {
  method: "GET",
  headers: { Authorization: `Bearer ${token}` },
});

requests.get(
  f"https://sandbox.api.lendeasy.ai/v1/autopay/failure-policies",
  headers={"Authorization": f"Bearer {token}"},
)

{
  "rails": [
    {
      "rail": "ACH",
      "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
        },
        {
          "returnCode": "R10",
          "retryAllowed": false,
          "instrumentAction": "INVALIDATE",
          "autopayAction": "CANCELLED",
          "caseAction": "OPEN_PAYMENT_FAILURE",
          "recommendedAction": "CANCEL_AUTOPAY",
          "treatAsUnauthorized": true
        }
      ]
    }
  ]
}

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

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.

Request

curl https://sandbox.api.lendeasy.ai/v1/autopay/failure-policies \
  -H "Authorization: Bearer $TOKEN"

await fetch(`https://sandbox.api.lendeasy.ai/v1/autopay/failure-policies`, {
  method: "GET",
  headers: { Authorization: `Bearer ${token}` },
});

requests.get(
  f"https://sandbox.api.lendeasy.ai/v1/autopay/failure-policies",
  headers={"Authorization": f"Bearer {token}"},
)

{
  "rails": [
    {
      "rail": "ACH",
      "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
        },
        {
          "returnCode": "R10",
          "retryAllowed": false,
          "instrumentAction": "INVALIDATE",
          "autopayAction": "CANCELLED",
          "caseAction": "OPEN_PAYMENT_FAILURE",
          "recommendedAction": "CANCEL_AUTOPAY",
          "treatAsUnauthorized": true
        }
      ]
    }
  ]
}

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