Loans

Update a loan

PATCH/loans/{loan_id}

Updates a loan by its ID.

Path Parameters

loan_id

stringRequired

Unique identifier for the loan.

Body Parameters

allow_overpayment

booleanOptional

Indicates if a loan is able to be overpaid and have a principal_outstanding of less than $0. If false, payments that would result in a loan having a negative balance will be blocked.

auto_sell

booleanOptional

Indicates if seasoned principals/interests should be automatically sold to your platform.

description

stringOptional

The description of the loan in the Column dashboard.

interest_config_id

stringOptional

ID of the interest configuration used to accrue interest receivable daily. The same interest configuration can be shared across multiple loans.

is_business_seasoning_days

booleanOptional

Indicates if seasoning_days are business days or calendar days.

is_revolving

booleanOptional

Indicates whether or not the loan is revolving. If true the loan can have multiple disbursements.

loan_program_id

stringOptional

ID of the loan program for this loan. If this field is not set, your platform's default loan program will be used.

maturity_date

stringOptional

The maturity date of the loan. It is required if the loan is not revolving.

max_principal_balance

integerOptional

The max principal balance of the loan in cents. This is akin to a credit limit. Disbursements will fail if the resulting principal will be above the max principal. e.g. $1.75 would be represented by 175.

retained_by_column

booleanOptional

Indicates if this loan should be retained by Column. Loans retained by Column are not eligible for your platform to purchase.

seasoning_days

integerOptional

Number of days principal receivables will be seasoned.

status

stringOptional

The current status of the loan. Possible values: current, delinquent, charged_off, in_dispute, canceled, paid_off