Schedules may be suspended (STATUS=S) in order to stop the processing of scheduled payments and then restored to ready status (STATUS=R) using this request.
Schedules may also be cancelled completely which is not reversible. When the schedule is cancelled all of the un-approved payments are removed as well.
When a schedule is restored then all payments that became due while it was suspended will be processed one each day until it is up to date. A schedule cannot be restored if, at the time of processing, more than 90 days has passed from the original scheduled due date on any of the pending payments. In this case, the payments must be updated with a new due date before restoring the schedule.
Completed schedules cannot be suspended, restored or cancelled.
Suspend Schedule
SUBTYPESS for suspend scheduleSCHEDIDRestore Schedule
SUBTYPESR for restore scheduleSCHEDIDCancel Schedule
SUBTYPESC for cancel scheduleSCHEDIDResponse to Suspend, Restore or Cancel Schedule
CODE0000 is approved; anything else is an error codeTEXTSUSPENDED, RESTORED, CANCELLED or the error descriptionAUTHSCHEDULEDATAExample: Suspend schedule
Request:
TERMID=TESTTERM&PASS=mypass&TYPE=L&SUBTYPE=SS&SCHEDID=123e4567‑e89b‑12d3-a456-426655440000Response:
CODE=0000&TEXT=SUSPENDED&SCHEDID=123e4567‑e89b‑12d3‑a456‑426655440000&PYMTS=DATE=20200921&AMT=100.00&REFNUM=6e66c812‑e620‑4750‑aef2‑8840006bb9de&RESULT=W&NOTIFY=N&CARDMASK=****6781]DATE=20201021&AMT=100.00&REFNUM=c176637b‑18c8‑4ad0‑9140‑8c9de456bac5&RESULT=W&NOTIFY=N&CARDMASK=]DATE=20201125&AMT=200.00&REFNUM=e0ac7b99‑d94d‑4b7a‑b895‑621e82e62a1e&RESULT=W&NOTIFY=N&CARDMASK=]&INVOICE=123456789&CARDMASK=****6781&CARDHASH=AFD6B61A6955A3B11B2ACEB4193EA981&CUSTNAME=JOHNSMITH&CUSTEMAIL=johnsmith@email.com&STATUS=S