LendingPayments

Create a payment

Creates a payment for a loan. Read more.

post/loans/payments

Request

  • Base URL: https://api.column.com
  • URL: https://api.column.com/loans/payments
  • Auth: HTTP basic

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

account_number_idstring

ID of the source account number. Source account is required if this payment is not offline, or the loan is not completely owned by your platform. Either bank_account_id or account_number_id must be specified.

amountinteger

Amount in cents for principal and interest payments. At least one of amount or principal_amount must be specified.

bank_account_idstring

ID of the source bank account. Source account is required if this payment is not offline, or the loan is not completely owned by your platform. Either bank_account_id or account_number_id must be specified.

currencystring required

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

descriptionstring

The description of the loan payment. Maximum: 127 characters.

ignore_retained_balancesboolean

Indicates whether this payment should be applied to sold balances only. Read more.

is_offlineboolean

Indicates if this payment is an offline payment. Default value: false.

loan_idstring required

The ID of the loan to which the payment is being made. The principal_outstanding of the loan will decrease by the payment amount.

principal_amountinteger

Amount in cents for principal payments. At least one of amount or principal_amount must be specified.

Response

Successful response

account_number_idstring required

The unique ID of the account to which the payment was made

amountinteger required

Total payment amount in cents

bank_account_idstring required

The bank account to which funds are paid back to

collection_account_number_idstring required

ID of your collections account number

collection_bank_account_idstring required

ID of your collections account

created_atstring date-time required

The timestamp the loan payment was created

currencystring required

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

descriptionstring required

The description of the loan payment in the Column dashboard

effective_atstring date-time required

The timestamp the loan payment was marked effective

idstring required

The ID of the loan payment object

idempotency_keystring required

The idempotency key specified in the loan payment. Returns an empty string "" when not set.

ignore_retained_balancesboolean required

Indicates whether the loan payment was applied to sold balances only. Read more.

interest_amountinteger required

Total paid interest receivable

is_offlineboolean required

Indicates whether the loan payment was made offline

loan_idstring required

The ID of the loan object the loan payment is associated to

principal_amountinteger required

Amount of the payment applied to the loan principal

retained_interest_amountinteger required

Paid interest receivable owned by Column

retained_principal_amountinteger required

Paid principal amount owned by Column

statusstring required

The current status of the loan payment. Possible values: completed, or returned.

Example response

{
  "account_number_id": "acno_2zI1Da9Ro0dvk6HT2gla1H0UTyS",
  "amount": 1000,
  "bank_account_id": "bacc_2zI1DavEbJQbbOIJeExDVJczhqM",
  "collection_account_number_id": "",
  "collection_bank_account_id": "",
  "created_at": "2025-08-03T16:05:12Z",
  "currency": "USD",
  "description": "first payment",
  "effective_at": "2025-08-03T16:05:12Z",
  "id": "lpmt_30mdxZgaXqKELJ5xRVKKj2x3Vrz",
  "idempotency_key": "",
  "ignore_retained_balances": false,
  "interest_amount": 200,
  "is_offline": false,
  "loan_id": "loan_30mcttnSZBlSahXy6LUFzbeemlk",
  "principal_amount": 800,
  "retained_interest_amount": 0,
  "retained_principal_amount": 0,
  "status": "completed"
}

Changes

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