Cancel AutoPay

General

AutoPays allow users to schedule automatically processed payments. Here's what you need to know about this request:

• This request will cancel a scheduled AutoPay on an account.
• Instead of using a DELETE method in the request, an AutoPay is cancelled by updating its status to status.autopay.cancelled.
• A successful request will remove the AutoPay from the LoanPro UI and update its deleted value in the database.

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)

{
    "Autopays": {
        "results": [
            {
                "status": "autopay.status.cancelled",
                "__id": 938,
                "__update": true
            }
        ]
    }
}

❗️

Try It Instructions

Our requests often provide sample payload information so that you can receive a 200 response from simply hitting the Try It button. Since this is a request that removes something, this one is a bit different.

To receive a 200 response from the Try It button, you will have to try this request with your own tenant credentials. If you plan on doing so, make sure to change the headers to match your own authentication information. However, you can view a sample of a 200 response in our sample responses section above the Try It button.