LendingSale

Create a loan sale

Creates a loan sale for a specific loan.

post/loans/{loan_id}/sales

Request

  • Base URL: https://api.column.com
  • URL: https://api.column.com/loans/{loan_id}/sales
  • Auth: HTTP basic

Path parameters

loan_idstring required

Headers

Idempotency-Keystring

Idempotency keys can be up to 255 characters long and are case sensitive. Column reserves the right to expire idempotency keys after 30 days. Only ASCII printable characters (code 32 - 126) are allowed for idempotency keys.

Request body

amountinteger

Amount in cents that will be purchased. This amount cannot exceed the current sale price of the loan. Either amount or percentage must be specified, but not both.

currency_codestring required

ISO 4217 currency code. It must be the same as the currency code on the loan.

descriptionstring

The description of the loan sale. Maximum: 255 characters.

percentagestring

Percentage of the current sale price of the loan to purchase (e.g., "0.80" for 80%). Maximum value: "1.00". Either amount or percentage must be specified, but not both.

purchase_funding_account_number_idstring

ID of the account number in your platform to fund this purchase. If this field is not set, the default purchase funding account number for the loan program of this loan will be used.

Response

Successful response

amountinteger required

The total sale amount in cents

created_atstring date-time required

The timestamp at which the loan sale was created

currency_codestring required

The currency code of the sale amount. Currently only USD is supported.

descriptionstring nullable required

The description of the loan sale

idstring required

The ID of the loan sale object

idempotency_keystring nullable required

The idempotency key specified in the loan sale

loan_idstring required

The ID of the loan being sold

paid_servicing_feeinteger required

The amount of servicing fees in cents paid to your platform by Column

purchase_funding_account_number_idstring required

The ID of the account number in your platform that was funded to complete this sale

sold_atstring date-time nullable required

The timestamp at which the loan sale was completed

sold_interest_receivableinteger required

The amount of interest receivable in cents sold to your platform

sold_principal_receivableinteger required

The amount of principal receivable in cents sold to your platform

updated_atstring date-time required

The timestamp at which the loan sale was last updated

Changes

No recorded changes to this operation across all 1 revision of this API.