Creates an unsigned autopay ACH authorization document for a specified facility. This is a required step before enabling autopay. The user must agree to automatic ACH withdrawals before Pier can initiate payments. This document is automatically signed by the user when you call POST /enable_autopay.
The application_id
of the corresponding loan application for the facility
The borrower_id
of the corresponding borrower the facility is for
The loan_agreement_id
of the corresponding loan agreement the facility is for
The type of credit production.
Timestamp the loan agreement object is created on
The status of the facility.
The account number of the credit facility
An array of transactions made (empty if no payments are due)
An array of statements for the loan (empty if no statements exist)
A deeper view of what makes up the facility balance, all in cents
An array of payments due (empty if no payments are due)
An object containing a summary of the terms of the facility.
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.
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.
The amortization schedule of the loan
The bank account information used to repay the loan
The remaining balance of the loan, in cents
The date the loan was originated (YYYY-MM-DD)
The date the loan was disbursed (YYYY-MM-DD)
The remaining term of the loan, in months
The amount of the next payment, in cents
The date the next payment is due (YYYY-MM-DD)
The date the current payment is due (YYYY-MM-DD)
The date the last payment was made (YYYY-MM-DD)
The date the principal is paid through (YYYY-MM-DD)
The next billing date of the loan (YYYY-MM-DD)
The date the interest is accrued through (YYYY-MM-DD)
The next accrual cutoff date of the loan (YYYY-MM-DD)
The scheduled payoff date of the loan (YYYY-MM-DD)
Whether or not autopay is enabled for the facility.
The documents associated with the facility
The last statement information including date/amount.
Whether the facility is in a grace period
Whether the facility is in an introductory promotional period
The current interest balance of the loan, in cents (deprecated - see balances field)
The current payoff balance of the loan, in cents (deprecated - see balances field)