API Reference›LMS API›Payments›Record an external payment

Record an external payment

POSThttps://sandbox.api.lendeasy.ai/v1/loans/{loanId}/payments/record-external Bearer token · RECORD_LMS_EXTERNAL_PAYMENT

Records money received outside LendEasy — lockbox, wire, import — without calling a payment rail. STAFF-sourced records require an evidence reference; a rationale is always required. Set postToFineract to false to record without posting, leaving the intent in RECORDED_EXTERNAL for reconciliation.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/loans/$LOAN_ID/payments/record-external \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": "260.00",
  "currency": "USD",
  "effectiveDate": "2027-05-08",
  "externalRecordRef": "lockbox-20270508-881",
  "source": "STAFF",
  "evidenceRef": "evd_LOCKBOX_8",
  "rationale": "Lockbox batch 881 posting."
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/loans/${loanId}/payments/record-external`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "amount": "260.00",
  "currency": "USD",
  "effectiveDate": "2027-05-08",
  "externalRecordRef": "lockbox-20270508-881",
  "source": "STAFF",
  "evidenceRef": "evd_LOCKBOX_8",
  "rationale": "Lockbox batch 881 posting."
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/loans/{loan_id}/payments/record-external",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "amount": "260.00",
  "currency": "USD",
  "effectiveDate": "2027-05-08",
  "externalRecordRef": "lockbox-20270508-881",
  "source": "STAFF",
  "evidenceRef": "evd_LOCKBOX_8",
  "rationale": "Lockbox batch 881 posting."
},
)

{
  "paymentId": 9012,
  "loanRef": "7204",
  "status": "RECORDED_EXTERNAL",
  "attemptNumber": 1
}

{
  "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.
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
amount required	string	Decimal monetary amount encoded as a string.
currency required	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.
evidenceRef required	string
rationale required	string

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/loans/$LOAN_ID/payments/record-external \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": "260.00",
  "currency": "USD",
  "effectiveDate": "2027-05-08",
  "externalRecordRef": "lockbox-20270508-881",
  "source": "STAFF",
  "evidenceRef": "evd_LOCKBOX_8",
  "rationale": "Lockbox batch 881 posting."
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/loans/${loanId}/payments/record-external`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "amount": "260.00",
  "currency": "USD",
  "effectiveDate": "2027-05-08",
  "externalRecordRef": "lockbox-20270508-881",
  "source": "STAFF",
  "evidenceRef": "evd_LOCKBOX_8",
  "rationale": "Lockbox batch 881 posting."
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/loans/{loan_id}/payments/record-external",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "amount": "260.00",
  "currency": "USD",
  "effectiveDate": "2027-05-08",
  "externalRecordRef": "lockbox-20270508-881",
  "source": "STAFF",
  "evidenceRef": "evd_LOCKBOX_8",
  "rationale": "Lockbox batch 881 posting."
},
)

{
  "paymentId": 9012,
  "loanRef": "7204",
  "status": "RECORDED_EXTERNAL",
  "attemptNumber": 1
}

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