This sub-resource allows the user to list loans for sale on the market.
Operation: POST
URL: https://api.lendingclub.com/api/lcx/v1/secondary/investors/{investor-id}/orders/sell-order
Path Parameters:
Name | Type | Required | Description |
---|---|---|---|
Investor-id | Integer | Yes | Investor’s Actor ID |
Body Parameters:
Name | Type | Required | Description |
---|---|---|---|
orderCategory | String | No | Category of the sell order. Possible values are INDIVIDUAL and BASKET. |
orderType | String | Yes | The value must be set as "LIMIT" |
allOrNoneFlag | Boolean | No | This parameter is only applicable to BASKET sell order. If it is set to true, all loans in the basket must be settled/canceled at the same time; if it is set to false, the basket allows partial settlement. The default value is set at "false" |
description | String | No | Optional description of the sell order |
roomName | String | Yes | The name of the room where the sell order will be created. The default value is the public room name "CENTRAL_MARKET" |
items | Array | Yes | The array of items in the sell order |
askPriceBasis | String | Yes | Only "PRINCIPAL" is supported |
askPricePercent | BigDecimal | Yes | The starting ask price of the item vs par. 1.0 is 100% or par |
askInterestPercent | BigDecimal | No | The interest percent sought (vs par). Valid values are 0 or 1. If absent, defaults to 1. 1 is 100% or par |
noteId | Integer | Yes | Unique LC assigned id for the Note |
loanId | Integer | Yes | Unique LC assigned id for the loan. This is the same as the id loan attribute returned in the loan Listing result operation |
startListingDate | Date | No | Start listing date of the item in ISO format. The item will show up in |
listingExpirationDate | Date | No | Listing expiration date of the item in ISO format. It is capped at 30 calendar days after startListingDate |
pricePlan | Object | No | Price plan of this item. Only need this in the request payload if you need to configure price tick down plan |
reservedAskPricePercent | BigDecimal | No | Reserved price of the item vs par. 1.0 is 100% or par. The Item will be |
tickPercent | BigDecimal | No | The percentage of daily ticking down vs par. 1.0 is 100% or par. Only negative values are allowed in this field |
Supported formats:JSON
Payload Schema:
{
"allOrNoneFlag": false,
"description": "Test sell order (optional)",
"orderCategory": "INDIVIDUAL",
"orderType": "LIMIT",
"roomName": "CENTRAL_MARKET",
"items": [
{
"askPriceBasis": "PRINCIPAL",
"askPricePercent": 1.01,
"askInterestPercent": "0”,
"loanId": 12345678,
"noteId": 87654321,
"startListingDate": "2021-05-01T09:00:00.000-07:00",
"listingExpirationDate": "2021-05-15T09:00:00.000-07:00",
"pricePlan": {
"reservedAskPricePercent": 0.85,
"tickPercent": -0.01
}
},
{
"askPriceBasis": "PRINCIPAL",
"askPricePercent": 1
"loanId": 11111111,
"noteId": 22222222,
"startListingDate": "2021-05-02T09:00:00.000-07:00",
"listingExpirationDate": "2021-05-25T09:00:00.000-07:00",
"pricePlan": {
"reservedAskPricePercent": 0.8,
"tickPercent": -0.02
}
}
]
}
Response Parameters:
Name | Type | Description |
---|---|---|
investorId | Integer | Investor’s Actor ID |
orderCategory | String | Category of the sell order. Possible values are INDIVIDUAL and BASKET |
orderType | String | LIMIT |
allOrNoneFlag | Boolean | This parameter is only applicable to BASKET sell order. If it is set to true, all loans in the basket must be settled/canceled at the same time; if it is set to false, the basket allows partial settlement |
description | String | Optional description of the sell order |
roomName | String | The name of the room where the sell order is created |
items | Array | The array of items in the sell order |
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 |
statusDate | Date | Timestamp when status was lastly updated in ISO format |
startListingDate | 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 |
excludedItems | Array | The array of excluded items in the sell order |
exclusionReason | String | Reason of exclusion for the item |
Sample Response:
{
"id": 463016,
"investorId": "202101826",
"orderType": "LIMIT",
"orderCategory": "INDIVIDUAL",
"description": "Test sell order (optional)",
"roomName": "CENTRAL_MARKET",
"allOrNoneFlag": false,
"items": [
{
"id": 727017,
"statusDate": "2021-04-01T20:54:01.581Z",
"status": "PENDING",
"noteId": "215414933",
"loanId": "169060877",
"askPricePercent": 1.01,
"askPriceBasis": "PRINCIPAL",
"startListingDate": "2021-05-03T16:00:00.000Z",
"listingExpirationDate": "2021-05-15T16:00:00.000Z",
"pricePlan": {
"tickPercent": -0.01,
"reservedAskPricePercent": 0.85
}
}
],
"excludedItems": [
{
"noteId": "21547013",
"loanId": "169052568",
"exclusionReason": "note-does-not-exist"
}
]
}
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 |