API Reference›LMS API›Payment instruments›Deactivate a payment instrument

Deactivate a payment instrument

POSThttps://sandbox.api.lendeasy.ai/v1/customers/{customerId}/payment-instruments/{instrumentId}/deactivate Bearer token · UPDATE_LMS_PAYMENT_INSTRUMENT

Stops future use and cascades dependent autopay enrollments into review. Idempotent: deactivating an inactive instrument is a no-op.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/customers/$CUSTOMER_ID/payment-instruments/$INSTRUMENT_ID/deactivate \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "reasonCode": "CUSTOMER_REQUEST",
  "comment": "Account closed at bank."
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/customers/${customerId}/payment-instruments/${instrumentId}/deactivate`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "reasonCode": "CUSTOMER_REQUEST",
  "comment": "Account closed at bank."
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/customers/{customer_id}/payment-instruments/{instrument_id}/deactivate",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "reasonCode": "CUSTOMER_REQUEST",
  "comment": "Account closed at bank."
},
)

{
  "resourceId": 704
}

{
  "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.
customerId required in path	string	Stable opaque customer identifier.
instrumentId required in path	string	Stable opaque instrument 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
reasonCode required	string	Configured structured reason code.
comment required	string

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/customers/$CUSTOMER_ID/payment-instruments/$INSTRUMENT_ID/deactivate \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "reasonCode": "CUSTOMER_REQUEST",
  "comment": "Account closed at bank."
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/customers/${customerId}/payment-instruments/${instrumentId}/deactivate`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "reasonCode": "CUSTOMER_REQUEST",
  "comment": "Account closed at bank."
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/customers/{customer_id}/payment-instruments/{instrument_id}/deactivate",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "reasonCode": "CUSTOMER_REQUEST",
  "comment": "Account closed at bank."
},
)

{
  "resourceId": 704
}

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