Update collateral

Request

Update collateral. Money is in whole cents and bpsAdvanceRate is in basis points (8500 = 85%).

Security

ApiKeyAuth

Path

loanIdstringrequired

idstringrequired

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/jsonrequired

descriptionstring

categorystring

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 ]

Manually-entered prior lien in whole cents (used in net-collateral/LTV).

ownerTypestring

Enum:"person""business"

ownerIdstring

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": "string",
    "centsMarketValue": 0,
    "bpsAdvanceRate": 0,
    "centsManualPriorLien": 0,
    "ownerType": "person",
    "ownerId": "string"
  }'

Responses

Collateral updated

Bodyapplication/json

dataobject(PublicCollateral)

Response

{
  "data": {
    "id": "string",
    "loanId": "string",
    "description": "string",
    "category": "string",
    "centsMarketValue": -9007199254740991,
    "bpsAdvanceRate": -9007199254740991,
    "centsPriorLienAmount": -9007199254740991,
    "centsManualPriorLien": -9007199254740991,
    "ownerType": "string",
    "ownerId": "string"
  }
}