Loans
Create a payment
Creates a payment for a loan. Read more.
Body Parameters
account_number_id
stringOptionalID 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.
amount
integerOptionalAmount in cents for principal and interest payments. At least one of amount or principal_amount must be specified.
bank_account_id
stringOptionalID 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.
currency
stringRequiredThe currency of the payment. Currently only USD is supported.
description
stringOptionalThe description of the loan payment. Maximum: 127 characters.
ignore_retained_balances
booleanOptionalIndicates whether this payment should be applied to sold balances only. Read more.
is_offline
booleanOptionalIndicates if this payment is an offline payment. Default value: false.
loan_id
stringRequiredThe ID of the loan to which the payment is being made. The principal_outstanding of the loan will decrease by the payment amount.
principal_amount
integerOptionalAmount in cents for principal payments. At least one of amount or principal_amount must be specified.