This sub-resource allows the user to update a BUY order. Currently, this sub-resource may only be used to cancel an order.
Operation: PUT
URL: https://api.lendingclub.com/api/lcx/v1/secondary/investors/{investor-id}/orders/buy-order/{id}
Path Parameters:
Name | Type | Required | Description |
---|---|---|---|
Id | Integer | Yes | ID number of the order |
Investor-id | Integer | Yes | Investor’s Actor ID |
Query Parameters: None
Supported formats: JSON
Request Payload: JSON request for submit order
Body Parameters:
Name | Type | Required | Description |
---|---|---|---|
status | String | Yes | Status of the order – values can be: CANCELED |
Payload Schema:
{
"status": "CANCELED"
}
Response Parameters:
Name | Type | Description |
---|---|---|
orderId | Integer | Unique ID of a successfully listed order |
StatusDate | String | Date when the status of the BUY order was created or last changed |
failReason | String | If the buy order has failed, the reason for the failure will be displayed in the response. |
bidPricePercent | BigDecimal | Bid price percentage vs par 1.0 is 100% or par |
noteId | Integer | Unique LC assigned ID for the Note |
Id | Integer | |
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. |
roomName | String | Room Name |
status | String | Status of the order – values can be: PENDING LISTED CONFIRMED EXECUTED EXECUTION_FAILED CANCELED REJECTED |
Sample Response:
{
"orderId": 12345,
“roomName”: “ROOM-123”,
"items": [
{
"statusDate": {},
"failReason": null,
"bidPricePercent": "1.0",
"noteId": "6789",
"id": 123,
"loanId": "45678",
"status": "CONFIRMED"
}
]
}
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 |