This sub-resource allows the user to cancel a given sell order item. Only LISTED/PENDING sell order items can be canceled
Operation: PUT
URL: https://api.lendingclub.com/api/lcx/v1/secondary/investors/{investor-id}/orders/sell-order/{order-id}/items/{item-id}
Path Parameters:
Name | Type | Required | Description |
---|---|---|---|
Investor-id | Integer | Yes | Investor’s Actor ID |
Order-id | Integer | Yes | Sell order ID |
Item-id | Integer | Yes | Sell order item ID |
Body Parameters:
Name | Type | Required | Description |
---|---|---|---|
status | String | Yes | Only CANCELED is allowed |
Supported formats: JSON
Payload Schema:
{
"status": "CANCELED"
}
Response Parameters:
Name | Type | Description |
---|---|---|
askPriceBasis | String | Only PRINCIPAL is supported |
askPricePercent | BigDecimal | The starting ask price of the item vs par.1.0 is 100% or par |
noteId | Integer | Unique LC assigned id for the Note |
loanId | Integer | Unique LC assigned id for the loan. This is the same as the id loan attribute returned in the loan Listing result operation |
status | String | Status of the sell order item |
statusReason | String | Reason of the current status |
statusDate | Date | Timestamp when status was lastly updated in ISO format |
Date | Start listing date of the item in ISO format. The item will show up in get loan listings call at the next global listing time after the specified startListingDate | |
listingExpirationDate | Date | Listing expiration date of the item in ISO format. It is capped at 30 days after startListingDate |
pricePlan | Object | Price plan of this item. Only need this in the request payload if you need to configure price tick down plan |
reservedAskPricePercent | BigDecimal | Reserved price of the item vs par. 1.0 is 100% or par. The Item will be delisted if its price drops below this value |
tickPercent | BigDecimal | The percentage of daily ticking down vs par. 1.0 is 100% or par |
Sample Response:
{
"id": 727020,
"statusDate": "2021-04-01T21:31:35.048Z",
"status": "CANCELED",
"statusReason": "MANUAL",
"noteId": "215470136",
"loanId": "169052568",
"askPricePercent": 1,
"askPriceBasis": "PRINCIPAL",
"startListingDate": "2021-05-03T16:00:00.000Z",
"listingExpirationDate": "2021-05-25T16:00:00.000Z",
"pricePlan": {
"tickPercent": -0.02,
"reservedAskPricePercent": 0.8
}
}
HTTP status summary:
Code | Description |
---|---|
200 | Success |
400 | Validation or business error |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
452 | Market closed |
500 | Unexpected failure |