API Reference›LMS API›Autopay›Enroll in autopay

Enroll in autopay

POSThttps://sandbox.api.lendeasy.ai/v1/loans/{loanId}/autopay Bearer token · ENROLL_LMS_AUTOPAY

Creates the loan’s single current enrollment from a verified instrument, timing policy, and amount policy. A Regulation E authorization reference is required to activate. FULL_DUE enrollments must leave enough statement lead time for the ten-day advance notice.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/loans/$LOAN_ID/autopay \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "instrumentId": 704,
  "authorizationRef": "evd_JUN_AP_73",
  "timingPolicy": {
    "initiateDaysBeforeDue": 0,
    "businessDayConvention": "FOLLOWING"
  },
  "amountPolicy": {
    "type": "FULL_DUE"
  }
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/loans/${loanId}/autopay`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "instrumentId": 704,
  "authorizationRef": "evd_JUN_AP_73",
  "timingPolicy": {
    "initiateDaysBeforeDue": 0,
    "businessDayConvention": "FOLLOWING"
  },
  "amountPolicy": {
    "type": "FULL_DUE"
  }
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/loans/{loan_id}/autopay",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "instrumentId": 704,
  "authorizationRef": "evd_JUN_AP_73",
  "timingPolicy": {
    "initiateDaysBeforeDue": 0,
    "businessDayConvention": "FOLLOWING"
  },
  "amountPolicy": {
    "type": "FULL_DUE"
  }
},
)

{
  "resourceId": 31
}

{
  "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.
loanId required in path	string	Stable opaque loan identifier.
LendEasy-Case optional in header	string	Open servicing-case reference for this borrower. Required on human servicing mutations when case management is enabled; automation never sends it.
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
instrumentId required	integer
authorizationRef required	string
timingPolicy required	object
initiateDaysBeforeDue	integer
businessDayConvention	string
amountPolicy required	object
type	string

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/loans/$LOAN_ID/autopay \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "instrumentId": 704,
  "authorizationRef": "evd_JUN_AP_73",
  "timingPolicy": {
    "initiateDaysBeforeDue": 0,
    "businessDayConvention": "FOLLOWING"
  },
  "amountPolicy": {
    "type": "FULL_DUE"
  }
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/loans/${loanId}/autopay`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "instrumentId": 704,
  "authorizationRef": "evd_JUN_AP_73",
  "timingPolicy": {
    "initiateDaysBeforeDue": 0,
    "businessDayConvention": "FOLLOWING"
  },
  "amountPolicy": {
    "type": "FULL_DUE"
  }
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/loans/{loan_id}/autopay",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "instrumentId": 704,
  "authorizationRef": "evd_JUN_AP_73",
  "timingPolicy": {
    "initiateDaysBeforeDue": 0,
    "businessDayConvention": "FOLLOWING"
  },
  "amountPolicy": {
    "type": "FULL_DUE"
  }
},
)

{
  "resourceId": 31
}

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