LendingLoan

Update a loan

Updates a loan by its ID.

patch/loans/{loan_id}

Request

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

Path parameters

loan_idstring required

Request body

allow_overpaymentboolean nullable

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_sellboolean

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

descriptionstring nullable

The description of the loan in the Column dashboard.

interest_config_idstring

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

is_business_seasoning_daysboolean

Indicates if seasoning_days are business days or calendar days.

is_revolvingboolean nullable

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

loan_program_idstring

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

maturity_datestring date nullable

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

max_principal_balanceinteger nullable

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_columnboolean

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

seasoning_daysinteger

Number of days principal receivables will be seasoned.

statusstring nullable

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

Response

Successful response

allow_overpaymentboolean required

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_sellboolean required

Indicates if seasoned principals/interests should be automatically sold to your platform. Default: the value in the loan program.

canceled_atstring date-time nullable required

The timestamp the loan was canceled at. Returns null when not applicable.

charged_off_atstring date-time nullable required

The timestamp the loan was charged off. Returns null when not applicable.

collateral_bank_account_idstring

The bank account holding collateral for a secured loan.

collateral_locked_amountinteger required

The collateral amount currently locked for this loan, in cents.

created_atstring date-time required

The timestamp the loan was created

currencystring required

The currency of the loan. Currently only USD is supported.

delinquent_atstring date-time nullable required

The timestamp the loan was marked as delinquent. Returns null when not applicable.

descriptionstring required

The description of the loan in the Column dashboard

disputed_atstring date-time nullable required

The timestamp the loan was marked as disputed. Returns null when not applicable.

idstring required

The ID of the loan object

interest_config_idstring required

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

is_business_seasoning_daysboolean required

Indicates if seasoning_days are business days or calendar days.

is_revolvingboolean required

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

loan_program_idstring required

ID of the loan program for this loan.

maturity_datestring nullable required

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

max_principal_balanceinteger required

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.

paid_off_atstring date-time nullable required

The timestamp the loan is marked as paid off. Returns null when not applicable.

primary_signer_entity_idstring required

The Column entity_id which the loan is related to

retained_by_columnboolean required

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

seasoning_daysinteger required

Number of days principal receivables will be seasoned.

statusstring required

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

typestring required

The loan type. Possible values are unsecured and secured.

Example response

{
  "allow_overpayment": false,
  "auto_sell": false,
  "balances": {
    "interest_paid": "300",
    "interest_receivable": "54400",
    "principal_charged_off": "0",
    "principal_holding": "0",
    "principal_outstanding": "6666600",
    "principal_paid": "33300",
    "retained_interest_paid": "100",
    "retained_interest_receivable": "9800",
    "retained_principal_charged_off": "0",
    "retained_principal_outstanding": "1111100",
    "retained_principal_paid": "5500",
    "servicing_fee_payable": "560"
  },
  "canceled_at": null,
  "charged_off_at": null,
  "collateral_locked_amount": 0,
  "created_at": "2025-06-06T08:00:00Z",
  "currency": "USD",
  "delinquent_at": null,
  "description": "",
  "disputed_at": null,
  "id": "loan_2zEi4Q67eiQqyQkGXPqEzWXn5Q",
  "interest_config_id": "icfg_2zEi4VfLQfR06mm1fnAGcwcNT1D",
  "is_business_seasoning_days": false,
  "is_revolving": true,
  "loan_program_id": "lpgm_2zEi4QiopsBnyfuHQweFXc7Csi8",
  "maturity_date": "2025-07-30",
  "max_principal_balance": 100000000000,
  "paid_off_at": null,
  "primary_signer_entity_id": "enti_2zEi4U3gAGjdRAVHOJ19UkyG27K",
  "retained_by_column": false,
  "seasoning_days": 2,
  "status": "current",
  "type": "unsecured"
}

Changes

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