API Reference›LMS API›Merchant advances›Create a merchant remittance

Create a merchant remittance

POSThttps://sandbox.api.lendeasy.ai/v1/merchant-advances/{advanceId}/remittances Bearer token · CREATE_MERCHANT_REMITTANCE

Initiates or records a sales-based remittance and posts balance only after settlement.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/merchant-advances/$ADVANCE_ID/remittances \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "salesReportIds": [
    "msr_91DC"
  ],
  "amount": "1425.05",
  "currency": "USD",
  "paymentInstrumentId": "pi_NORTHSTAR_BANK_1",
  "rail": "ach_debit",
  "effectiveDate": "2026-09-10"
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/merchant-advances/${advanceId}/remittances`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "salesReportIds": [
    "msr_91DC"
  ],
  "amount": "1425.05",
  "currency": "USD",
  "paymentInstrumentId": "pi_NORTHSTAR_BANK_1",
  "rail": "ach_debit",
  "effectiveDate": "2026-09-10"
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/merchant-advances/{advance_id}/remittances",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "salesReportIds": [
    "msr_91DC"
  ],
  "amount": "1425.05",
  "currency": "USD",
  "paymentInstrumentId": "pi_NORTHSTAR_BANK_1",
  "rail": "ach_debit",
  "effectiveDate": "2026-09-10"
},
)

{
  "remittanceId": "rem_NORTHSTAR_81",
  "advanceId": "ma_northstar_6N8Q",
  "salesReportIds": [
    "msr_91DC"
  ],
  "amount": "1425.05",
  "currency": "USD",
  "status": "submitted",
  "effectiveDate": "2026-09-10",
  "remainingPurchasedAmount": "60000.00"
}

{
  "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.
advanceId required in path	string	Stable opaque advance 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
salesReportIds required	array<string>
amount required	string	Decimal monetary amount encoded as a string.
currency required	string	ISO 4217 currency code.
paymentInstrumentId required	string
rail required	string
effectiveDate required	string	Business-effective date in ISO 8601 format.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/merchant-advances/$ADVANCE_ID/remittances \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "salesReportIds": [
    "msr_91DC"
  ],
  "amount": "1425.05",
  "currency": "USD",
  "paymentInstrumentId": "pi_NORTHSTAR_BANK_1",
  "rail": "ach_debit",
  "effectiveDate": "2026-09-10"
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/merchant-advances/${advanceId}/remittances`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "salesReportIds": [
    "msr_91DC"
  ],
  "amount": "1425.05",
  "currency": "USD",
  "paymentInstrumentId": "pi_NORTHSTAR_BANK_1",
  "rail": "ach_debit",
  "effectiveDate": "2026-09-10"
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/merchant-advances/{advance_id}/remittances",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "salesReportIds": [
    "msr_91DC"
  ],
  "amount": "1425.05",
  "currency": "USD",
  "paymentInstrumentId": "pi_NORTHSTAR_BANK_1",
  "rail": "ach_debit",
  "effectiveDate": "2026-09-10"
},
)

{
  "remittanceId": "rem_NORTHSTAR_81",
  "advanceId": "ma_northstar_6N8Q",
  "salesReportIds": [
    "msr_91DC"
  ],
  "amount": "1425.05",
  "currency": "USD",
  "status": "submitted",
  "effectiveDate": "2026-09-10",
  "remainingPurchasedAmount": "60000.00"
}

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