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

Create a merchant advance

POSThttps://sandbox.api.lendeasy.ai/v1/merchant-advances Bearer token · CREATE_MERCHANT_ADVANCE

Creates a receivables-purchase application with explicit purchase price, purchased amount, sales remittance, and reporting terms.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/merchant-advances \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "merchantId": "party_NORTHSTAR_4",
  "productId": "prod_MERCHANT_ADVANCE_1",
  "externalId": "northstar-advance-2026",
  "terms": {
    "purchasePrice": "48000.00",
    "purchasedAmount": "60000.00",
    "currency": "USD",
    "remittanceRate": "0.12",
    "reportingFrequency": "daily",
    "expectedMonthlySales": "50000.00"
  }
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/merchant-advances`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "merchantId": "party_NORTHSTAR_4",
  "productId": "prod_MERCHANT_ADVANCE_1",
  "externalId": "northstar-advance-2026",
  "terms": {
    "purchasePrice": "48000.00",
    "purchasedAmount": "60000.00",
    "currency": "USD",
    "remittanceRate": "0.12",
    "reportingFrequency": "daily",
    "expectedMonthlySales": "50000.00"
  }
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/merchant-advances",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "merchantId": "party_NORTHSTAR_4",
  "productId": "prod_MERCHANT_ADVANCE_1",
  "externalId": "northstar-advance-2026",
  "terms": {
    "purchasePrice": "48000.00",
    "purchasedAmount": "60000.00",
    "currency": "USD",
    "remittanceRate": "0.12",
    "reportingFrequency": "daily",
    "expectedMonthlySales": "50000.00"
  }
},
)

{
  "advanceId": "ma_northstar_6N8Q",
  "externalId": "northstar-advance-2026",
  "merchantId": "party_NORTHSTAR_4",
  "productId": "prod_MERCHANT_ADVANCE_1",
  "status": "submitted",
  "currency": "USD",
  "purchasePrice": "48000.00",
  "purchasedAmount": "60000.00",
  "remainingPurchasedAmount": "60000.00",
  "remittanceRate": "0.12",
  "projectedCompletionDate": "2027-07-04",
  "version": 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.
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
merchantId required	string
productId required	string
externalId required	string	Caller-controlled identifier unique within the tenant and resource type.
terms required	object
purchasePrice	string
purchasedAmount	string
currency	string	ISO 4217 currency code.
remittanceRate	string
reportingFrequency	string
expectedMonthlySales	string

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/merchant-advances \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "merchantId": "party_NORTHSTAR_4",
  "productId": "prod_MERCHANT_ADVANCE_1",
  "externalId": "northstar-advance-2026",
  "terms": {
    "purchasePrice": "48000.00",
    "purchasedAmount": "60000.00",
    "currency": "USD",
    "remittanceRate": "0.12",
    "reportingFrequency": "daily",
    "expectedMonthlySales": "50000.00"
  }
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/merchant-advances`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "merchantId": "party_NORTHSTAR_4",
  "productId": "prod_MERCHANT_ADVANCE_1",
  "externalId": "northstar-advance-2026",
  "terms": {
    "purchasePrice": "48000.00",
    "purchasedAmount": "60000.00",
    "currency": "USD",
    "remittanceRate": "0.12",
    "reportingFrequency": "daily",
    "expectedMonthlySales": "50000.00"
  }
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/merchant-advances",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "merchantId": "party_NORTHSTAR_4",
  "productId": "prod_MERCHANT_ADVANCE_1",
  "externalId": "northstar-advance-2026",
  "terms": {
    "purchasePrice": "48000.00",
    "purchasedAmount": "60000.00",
    "currency": "USD",
    "remittanceRate": "0.12",
    "reportingFrequency": "daily",
    "expectedMonthlySales": "50000.00"
  }
},
)

{
  "advanceId": "ma_northstar_6N8Q",
  "externalId": "northstar-advance-2026",
  "merchantId": "party_NORTHSTAR_4",
  "productId": "prod_MERCHANT_ADVANCE_1",
  "status": "submitted",
  "currency": "USD",
  "purchasePrice": "48000.00",
  "purchasedAmount": "60000.00",
  "remainingPurchasedAmount": "60000.00",
  "remittanceRate": "0.12",
  "projectedCompletionDate": "2027-07-04",
  "version": 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": []
}