Enable autopay for a facility

POST
Enables autopay for a facility

Path parameters

facility_idstringRequired

Request

This endpoint expects an object.
bank_accountobjectRequired
The bank account details to use for scheduled payments
amount_type"minimum_payment" or "statement_balance"Required
Allowed values: minimum_paymentstatement_balance

The type of autopay amount, either minimum_payment or statement_balance

additional_amountintegerOptional
The additional amount to pay on top of the minimum payment, in cents (e.g. 1000 = $10.00)

Response

This endpoint returns an object.
idstring
application_idstring

The application_id of the corresponding loan application for the facility

borrower_idstring

The borrower_id of the corresponding borrower the facility is for

loan_agreement_idstring

The loan_agreement_id of the corresponding loan agreement the facility is for

credit_typeenum
The type of credit production.
created_ondatetime
Timestamp the loan agreement object is created on
status"active" or "closed"
Allowed values: activeclosed
The status of the facility.
account_numberstring
The account number of the credit facility
transactionslist of objects
An array of transactions made (empty if no payments are due)
statementslist of objects
An array of statements for the loan (empty if no statements exist)
payments_duelist of objects
An array of payments due (empty if no payments are due)
termsobject
An object containing a summary of the terms of the facility.
remaining_statement_balanceinteger
The amount, in cents, of the last statement balance, less any payments made after the statement was created. Will be set to null until first statement is created.
remaining_minimum_balanceinteger
The minimum due, in cents, of the last statement minimum, less any payments made since the statement was created. Will be set to null until first statement is created.
amortization_schedulelist of objectsOptional
The amortization schedule of the loan
repayment_bank_detailsobjectOptional
The bank account information used to repay the loan
balanceintegerOptional
The remaining balance of the loan, in cents
interest_balanceintegerOptional
The current interest balance of the loan, in cents
payoff_balanceintegerOptional
The current payoff balance of the loan, in cents
origination_datestringOptional
The date the loan was originated (YYYY-MM-DD)
disbursement_datestringOptional
The date the loan was disbursed (YYYY-MM-DD)
remaining_termintegerOptional
The remaining term of the loan, in months
next_payment_amountintegerOptional
The amount of the next payment, in cents
next_payment_due_datestringOptional
The date the next payment is due (YYYY-MM-DD)
current_payment_due_datestringOptional
The date the current payment is due (YYYY-MM-DD)
last_payment_datestringOptional
The date the last payment was made (YYYY-MM-DD)
principal_paid_thrustringOptional
The date the principal is paid through (YYYY-MM-DD)
next_billing_datestringOptional
The next billing date of the loan (YYYY-MM-DD)
interest_accrued_thrustringOptional
The date the interest is accrued through (YYYY-MM-DD)
next_accrual_cutoff_datestringOptional
The next accrual cutoff date of the loan (YYYY-MM-DD)
scheduled_payoff_datestringOptional
The scheduled payoff date of the loan (YYYY-MM-DD)
autopayobjectOptional
Whether or not autopay is enabled for the facility.
documentsobjectOptional
The documents associated with the facility
last_statement_infoobjectOptional
The last statement information including date/amount.
in_grace_periodbooleanOptional
Whether the facility is in a grace period
in_introductory_promo_periodbooleanOptional
Whether the facility is in an introductory promotional period

Errors

Built with