API Reference›Servicing Plane›Governed operations›Prepare a customer-authorized payment

Prepare a customer-authorized payment

POSThttps://sandbox.api.lendeasy.ai/v1/servicing/cases/{caseId}/payment-requestsImplementedBearer token ·CREATE_SERVICING_PAYMENT_REQUEST

Executes a grounded authorized payment immediately when allowed or creates the exact approval/manual request required by policy.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/cases/$CASE_ID/payment-requests \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "loanRef": "456",
  "instrumentId": 7001,
  "amount": {
    "amount": 202.36,
    "currency": "USD"
  },
  "valueDate": "2026-08-01",
  "authorizationRef": "auth-9f2",
  "reason": "Customer authorized the cure payment."
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/cases/${caseId}/payment-requests`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "loanRef": "456",
  "instrumentId": 7001,
  "amount": {
    "amount": 202.36,
    "currency": "USD"
  },
  "valueDate": "2026-08-01",
  "authorizationRef": "auth-9f2",
  "reason": "Customer authorized the cure payment."
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/cases/{case_id}/payment-requests",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "loanRef": "456",
  "instrumentId": 7001,
  "amount": {
    "amount": 202.36,
    "currency": "USD"
  },
  "valueDate": "2026-08-01",
  "authorizationRef": "auth-9f2",
  "reason": "Customer authorized the cure payment."
},
)

{
  "outcome": "COMPLETED",
  "paymentRef": "payment-9001",
  "resourceId": 9001
}

{
  "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.
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
loanRef required	string
instrumentId required	integer
amount required	object	Decimal monetary value using the representation declared by this operation.
amount	number	Decimal monetary value using the representation declared by this operation.
currency	string	ISO 4217 currency code.
valueDate required	string
authorizationRef required	string
reason required	string

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/cases/$CASE_ID/payment-requests \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "loanRef": "456",
  "instrumentId": 7001,
  "amount": {
    "amount": 202.36,
    "currency": "USD"
  },
  "valueDate": "2026-08-01",
  "authorizationRef": "auth-9f2",
  "reason": "Customer authorized the cure payment."
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/cases/${caseId}/payment-requests`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "loanRef": "456",
  "instrumentId": 7001,
  "amount": {
    "amount": 202.36,
    "currency": "USD"
  },
  "valueDate": "2026-08-01",
  "authorizationRef": "auth-9f2",
  "reason": "Customer authorized the cure payment."
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/cases/{case_id}/payment-requests",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "loanRef": "456",
  "instrumentId": 7001,
  "amount": {
    "amount": 202.36,
    "currency": "USD"
  },
  "valueDate": "2026-08-01",
  "authorizationRef": "auth-9f2",
  "reason": "Customer authorized the cure payment."
},
)

{
  "outcome": "COMPLETED",
  "paymentRef": "payment-9001",
  "resourceId": 9001
}

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