This request retrieves all scheduled AutoPay information for an entire tenant.
AutoPays allow users to schedule automatically processed payments. Note the following when using this request:
This request will retrieve every scheduled AutoPay for the entire tenant account. As such, the response may be quite long.
This request uses the AutoPays endpoint which is a nested object within the Loans entity.
AutoPays can be configured in numerous ways, but they need to be set up manually. Use the PUT Create AutoPay request to do so.
For an example of how AutoPays work within the UI, take a look at our Scheduling a New AutoPay article.
Database
For information regarding AutoPay database tables, take a look at the following articles:
Database – AutoPay Main Table (loan_autopay_entity)
Database – Defaults Autopay (defaults_autopay)
Database – Holding Account Autopay Info (holding_account_autopay_entity)