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

Withdraw a merchant advance

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

Withdraw a merchant advance with a versioned commercial decision and reasons.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/merchant-advances/$ADVANCE_ID/withdraw \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "reasonCodes": [
    "merchant_request"
  ],
  "expectedVersion": 2
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/merchant-advances/${advanceId}/withdraw`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "reasonCodes": [
    "merchant_request"
  ],
  "expectedVersion": 2
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/merchant-advances/{advance_id}/withdraw",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "reasonCodes": [
    "merchant_request"
  ],
  "expectedVersion": 2
},
)

{
  "advanceId": "ma_northstar_6N8Q",
  "previousStatus": "submitted",
  "status": "withdrawn",
  "version": 3
}

{
  "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
reasonCodes required	array<string>
expectedVersion required	integer

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/merchant-advances/$ADVANCE_ID/withdraw \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "reasonCodes": [
    "merchant_request"
  ],
  "expectedVersion": 2
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/merchant-advances/${advanceId}/withdraw`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "reasonCodes": [
    "merchant_request"
  ],
  "expectedVersion": 2
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/merchant-advances/{advance_id}/withdraw",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "reasonCodes": [
    "merchant_request"
  ],
  "expectedVersion": 2
},
)

{
  "advanceId": "ma_northstar_6N8Q",
  "previousStatus": "submitted",
  "status": "withdrawn",
  "version": 3
}

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