Cancel AutoPay

This request allows you to cancel an AutoPayAutoPay - A tool that allows users to schedule payments to be processed and applied automatically at a date and time in the future. Payments that have been scheduled using this tool are often referred to as AutoPays. AutoPays can be scheduled inside of an account under Servicing > AutoPay. on a loan.

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 more information on how creating AutoPays works within the UI, take a look at our Using AutoPays article.

Database

For information on AutoPay database tables, take a look at the following articles:

{
    "Autopays": {
        "results": [
            {
                "id":938,
                "status": "autopay.status.cancelled",
                "__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.

Language
Authentication
Click Try It! to start a request and see the response here!