Edit AutoPay

This request allows you to edit an existing 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..

General

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

  • This request will edit an existing AutoPay logged on an account. There is a wealth of configuration settings available, and we recommend taking some time to look at each parameter in the payload.
  • This request is sent through the Loans endpoint, so the id and __update parameters are required in the Autopays object for the changes to take place.
  • A scheduled AutoPay may fail when it's processed. This may happen if the customer's payment account is invalid or if the selected processor for the payment is incorrect.

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, see 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": [
               {
                    "id": 265,
                    "__update": true,
                    "name": "Updated AutoPay Name",
                    "type": "autopay.type.single",
                    "paymentExtraTowards": "payment.extra.periods.next",
                    "amountType": "autopay.amountType.static",
                    "paymentType": 1,
                    "chargeServiceFee": false,
                    "processCurrent": true,
                    "retryDays": 0,
                    "postPaymentUpdate": false,
                    "methodType": "autopay.methodType.echeck",
                    "recurringFrequency": "autopay.recurringFrequency.monthly",
                    "recurringDateOption": "autopay.recurringDate.processDate",
                    "schedulingType": "autoapay.schedulingType.bankingDayPrior",
                    "processDateCondition": "bankingDays",
                    "payoffAdjustment": false,
                    "chargeOffRecovery": false,
                    "processZeroOrNegativeBalance": true,
                    "recurringPeriods": 1,
                    "lastDayOfMonthEnabled": false,
                    "primaryPaymentMethodId": 416,
                    "paymentMethodAccountType": "bankacct.type.checking",
                    "paymentMethodAuthType": "payment.echeckauth.WEB",
                    "ccProcessor": 125,
                    "baProcessor": 129,
                    "amount": 10,
                    "processDateTime": "2022-04-28 06:00:00",
                    "applyDate": "2022-04-29"
               }
          ]
     }
}

🚧

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. This request is a bit different: You will need to input a few values yourself before sending this request.

To receive a 200 response, you will need to update the applyDate and processDateTime fields yourself. The other fields in this payload are already filled, but feel free experiment a bit and change them.

If you would like to try this request with your own tenant account, make sure to change the headers to match your own authentication information.

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