API Reference›Servicing Plane›Governed operations›Record an external payment

Record an external payment

POSThttps://sandbox.api.lendeasy.ai/v1/servicing/cases/{caseId}/external-paymentsImplementedBearer token ·RECORD_SERVICING_EXTERNAL_PAYMENT

Records a payment from an outside system and either posts it through the typed LMS boundary or creates reconciliation work.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/cases/$CASE_ID/external-payments \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "loanRef": "456",
  "amount": {
    "amount": 125,
    "currency": "USD"
  },
  "effectiveDate": "2026-07-25",
  "externalRecordRef": "lockbox-2026-1001",
  "source": "EXTERNAL",
  "postToLedger": true,
  "reason": "Verified lockbox receipt.",
  "evidenceIds": [
    8801
  ]
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/cases/${caseId}/external-payments`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "loanRef": "456",
  "amount": {
    "amount": 125,
    "currency": "USD"
  },
  "effectiveDate": "2026-07-25",
  "externalRecordRef": "lockbox-2026-1001",
  "source": "EXTERNAL",
  "postToLedger": true,
  "reason": "Verified lockbox receipt.",
  "evidenceIds": [
    8801
  ]
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/cases/{case_id}/external-payments",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "loanRef": "456",
  "amount": {
    "amount": 125,
    "currency": "USD"
  },
  "effectiveDate": "2026-07-25",
  "externalRecordRef": "lockbox-2026-1001",
  "source": "EXTERNAL",
  "postToLedger": true,
  "reason": "Verified lockbox receipt.",
  "evidenceIds": [
    8801
  ]
},
)

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

{
  "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
amount required	object	Decimal monetary value using the representation declared by this operation.
amount	integer	Decimal monetary value using the representation declared by this operation.
currency	string	ISO 4217 currency code.
effectiveDate required	string	Business-effective date in ISO 8601 format.
externalRecordRef required	string
source required	string	System or actor that originated the record.
postToLedger optional	boolean
reason required	string
evidenceIds required	array<integer>	Evidence records supporting the request.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/cases/$CASE_ID/external-payments \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "loanRef": "456",
  "amount": {
    "amount": 125,
    "currency": "USD"
  },
  "effectiveDate": "2026-07-25",
  "externalRecordRef": "lockbox-2026-1001",
  "source": "EXTERNAL",
  "postToLedger": true,
  "reason": "Verified lockbox receipt.",
  "evidenceIds": [
    8801
  ]
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/cases/${caseId}/external-payments`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "loanRef": "456",
  "amount": {
    "amount": 125,
    "currency": "USD"
  },
  "effectiveDate": "2026-07-25",
  "externalRecordRef": "lockbox-2026-1001",
  "source": "EXTERNAL",
  "postToLedger": true,
  "reason": "Verified lockbox receipt.",
  "evidenceIds": [
    8801
  ]
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/cases/{case_id}/external-payments",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "loanRef": "456",
  "amount": {
    "amount": 125,
    "currency": "USD"
  },
  "effectiveDate": "2026-07-25",
  "externalRecordRef": "lockbox-2026-1001",
  "source": "EXTERNAL",
  "postToLedger": true,
  "reason": "Verified lockbox receipt.",
  "evidenceIds": [
    8801
  ]
},
)

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

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