DeletePaySchedule

Usage

Deletes an existing future payment schedule.

Name	Data Type	Length		Description
User
Username	String		Required	Provided by Debitsuccess
Password	String		Required	Provided by Debitsuccess
RequestInitiator	String	100	Optional	Optional – allows requesting user to be logged
AccountReferenceNo	String	15	Optional^*	Debitsuccess account reference
ExternalAccountReferenceNo	String	50	Optional^*	External account reference
PayScheduleId	Integer		Required	Schedule to delete

_{* At least one of the following parameters must be supplied:}AccountReferenceNo, ExternalAccountReferenceNo

Name	Data Type	Description
DateCreated	DateTime	Date/time message was processed
Id	String	Unique ID for the message
ResponseNotes ()		Collection of validation messages
Code	String
Note	String
NoteType	Enum	Error, Warning, Info
Status	Enum	Failed, Succeed, Unknown

Type	Error Code	Error Message
Error	02	Invalid user credentials
Error	12016	Missing required reference number. Must provide either ExternalAccountReferenceNo or AccountReferenceNo or both.
Error	08	There is no record found with this criteria
Error	10	Account is not active
Error	07	Multiple accounts found with this criteria
Error	13131	PaySchedule for given PayScheduleId not found
Error	13134	Cannot delete schedules of class Miscellaneous.
Error	13132	PaySchedule already started
Error	13133	Cannot delete the only scheduled payment of the account.
Error	13135	Cannot delete scheduled payment with a gap between previous scheduled payment.
Error	13136	Cannot delete active scheduled payment with no subsequent scheduled payment.
Info	00	Success

There are no items with the selected labels at this time.

On this page:

REST API

DELETE Schedule (Recurring)

OR