API ReferenceFacilities

Create autopay ACH authorization

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.

Path parameters

facility_idstringRequired

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

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
statusenum
The status of the facility.
Allowed values:
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)

balancesobject
A deeper view of what makes up the facility balance, all in cents
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 objects or null
The amortization schedule of the loan
repayment_bank_detailsobject or null
The bank account information used to repay the loan
balanceinteger or null
The remaining balance of the loan, in cents
origination_datestring or null

The date the loan was originated (YYYY-MM-DD)

disbursement_datestring or null

The date the loan was disbursed (YYYY-MM-DD)

remaining_terminteger or null
The remaining term of the loan, in months
next_payment_amountinteger or null
The amount of the next payment, in cents
next_payment_due_datestring or null

The date the next payment is due (YYYY-MM-DD)

current_payment_due_datestring or null

The date the current payment is due (YYYY-MM-DD)

last_payment_datestring or null

The date the last payment was made (YYYY-MM-DD)

principal_paid_thrustring or null

The date the principal is paid through (YYYY-MM-DD)

next_billing_datestring or null

The next billing date of the loan (YYYY-MM-DD)

interest_accrued_thrustring or null

The date the interest is accrued through (YYYY-MM-DD)

next_accrual_cutoff_datestring or null

The next accrual cutoff date of the loan (YYYY-MM-DD)

scheduled_payoff_datestring or null

The scheduled payoff date of the loan (YYYY-MM-DD)

autopayobject or null
Whether or not autopay is enabled for the facility.
documentsobject or null
The documents associated with the facility
last_statement_infoobject or null

The last statement information including date/amount.

in_grace_periodboolean or null
Whether the facility is in a grace period
in_introductory_promo_periodboolean or null
Whether the facility is in an introductory promotional period
interest_balanceinteger or nullDeprecated

The current interest balance of the loan, in cents (deprecated - see balances field)

payoff_balanceinteger or nullDeprecated

The current payoff balance of the loan, in cents (deprecated - see balances field)

Errors