Skip to content

Add collateral to a loan

Request

Add collateral to a loan. Money is in whole cents and bpsAdvanceRate is in basis points (8500 = 85%). On a funded loan description and centsMarketValue are required, valueDate is the valuation date of the value, and the add appears in the loan history. Name the owners in owners, one or more businesses or people on the loan, or one owner in ownerType and ownerId sent together. Each must be on the loan, or the call returns 400 collateral.owner_not_on_loan. Before funding, with no owner, the item is owned by the borrower; on a funded loan an owner is required, or the call returns 400 collateral.owner_required.

Security
ApiKeyAuth
Path
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.

valueDatestring

Funded loan only: the valuation date of the current value, YYYY-MM-DD. Omitted means today.

curl -i -X POST \
  'https://api.pioneerft.com/api/public/v1/loans/{id}/collateral' \
  -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"
      }
    ],
    "valueDate": "string"
  }'

Responses

Collateral created

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" } }