Skip to content

Update collateral

Request

Update collateral. Money is in whole cents and bpsAdvanceRate is in basis points (8500 = 85%). A released item cannot be updated: the call returns 404. On a funded loan centsMarketValue cannot change (400 collateral.value_locked; use POST …/revalue), nor can bpsAdvanceRate (400 collateral.advance_rate_locked; use POST …/revalue) or centsManualPriorLien (400 collateral.liens_locked; use POST …/change-liens). owners replaces the owners of the item; ownerType and ownerId sent together, without owners, make that party the only owner. Each new owner must be a business or a person on the loan, or the call returns 400 collateral.owner_not_on_loan. An owner the item already has is not checked.

Security
ApiKeyAuth
Path
loanIdstringrequired
idstringrequired
Headers
Idempotency-Keystring, <= 255 characters

Optional opaque key (e.g. a UUID) to make this write safely retryable. A replay with the same key returns the original response instead of repeating the side effect.

Bodyapplication/json
descriptionstring
categorystring

Collateral category. GET /collateral-types lists the categories.

Enum:"Real Estate""Equipment""Vehicles""Financial Assets""General Business Assets"
centsMarketValueinteger, [ 0 .. 9007199254740991 ]

Market value in whole cents. 12345600 = $123,456.00

bpsAdvanceRateinteger, [ 0 .. 10000 ]

Advance rate in basis points, 0–10000 (8500 = 85%). Not inferred — supply it to drive net-collateral/LTV.

centsManualPriorLieninteger, [ 0 .. 9007199254740991 ]

A prior lien with no holder, in whole cents, added to the liens linked from the Debt Schedule (used in net collateral and LTV). 0 removes it.

ownerTypestring

The kind of the owner in ownerId: a business or a person on the loan. Send both or neither. Sent without owners, it is the only owner of the item. Sent with owners, it must name one of them, which becomes the main owner; another returns 400 input.invalid. An owner that is not on the loan returns 400 collateral.owner_not_on_loan.

Enum:"business""person"
ownerIdstring

The id of a business or a person on the loan, from GET /loans/{id}/entities, or the id that POST /loans/{id}/businesses or POST /loans/{id}/people returned.

ownersArray of objects, non-empty

Every owner of the item, one or more, each a business or a person on the loan; each new owner is checked. On PATCH it replaces the owners. The main owner (ownerType, ownerId in the response) is the one ownerType and ownerId name; without them it stays while it is one of owners, else it is the first. Left out on POST with no ownerType, the item is owned by the borrower. Left out on PATCH, the owners stay.

curl -i -X PATCH \
  'https://api.pioneerft.com/api/public/v1/loans/{loanId}/collateral/{id}' \
  -H 'Authorization: Bearer <YOUR_API Key_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: string' \
  -d '{
    "description": "string",
    "category": "Real Estate",
    "centsMarketValue": 0,
    "bpsAdvanceRate": 0,
    "centsManualPriorLien": 0,
    "ownerType": "business",
    "ownerId": "string",
    "owners": [
      {
        "type": "business",
        "id": "string"
      }
    ]
  }'

Responses

Collateral updated

Bodyapplication/json
dataobject(PublicCollateral)
Response
{ "data": { "id": "string", "loanId": "string", "description": "string", "descriptionParts": { "address": "string", "address2": "string", "city": "string", "state": "string", "zipCode": "string", "modelYear": -9007199254740991, "make": "string", "model": "string", "uniqueIdentifier": "string", "brokerage": "string", "item": "string" }, "category": "string", "centsMarketValue": -9007199254740991, "bpsAdvanceRate": -9007199254740991, "centsPriorLienAmount": -9007199254740991, "centsManualPriorLien": -9007199254740991, "ownerType": "string", "ownerId": "string", "owners": [ { "type": "business", "id": "string" } ], "valueDate": "string", "releaseDate": "string", "releaseReason": "string" } }