Set the register's pledge on a loan, or clear the named released pledge; while set the loan cannot be sold, participated out or have its servicing transferred (the ledger's service identity with lending:collateral:encumber only)

POST/lending-collateral/loans/{id}/encumbrance

Only the ledger's own service identity svc_ledger holding lending:collateral:encumber (never staff, another service or an API key) may call it; any other caller is refused 403 forbidden. A new pledge is refused 409 conflict while another holds the loan; the same pledge only moves forward; a clear names its released pledge. While encumbered the loan cannot be participated out or have its servicing transferred.

Path parameters

idstringRequired

Headers

Idempotency-KeystringOptional

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

encumbranceobject or nullOptional

Nil clears

5 child attributes

atstring · date-timeRequired

lender_idintegerRequired

lender_namestringRequired

pledge_idintegerRequired

statestringRequired

Reserved, pledged or releasing

pledge_idintegerOptional

With a nil encumbrance, the released pledge being cleared; a clear naming another pledge is refused

Returns

200 OK

The Collateral Loan object.

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503