SuspendAccountForNumberOfPaymentCycles

Usage

Allows a customer’s payments to be suspended for a number of payment cycles after a given date.

Name	Data Type	Length		Description

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
MinimumEffectiveDate	DateTime		Required	The date after which (on the next payment cycle) that the suspension will start
NumberOfPaymentCycles	Integer		Required	The number of payment cycles to suspend payments for
SuspensionFee	Decimal (10, 2)		Required	Amount to charge for the suspension
SuspensionFeeFrequency	Enum		Required if suspension fee > 0	How often the fee should be charged during the suspension. OneOff, Weekly, Fortnightly, FourWeekly, Monthly, BiMonthly, Quarterly
StopDirectDebits	Boolean		Optional	If set to True the DD Stop flag will be enabled which will stop any direct debits being made on the account. This will default to False if left blank.
StopOverdueMail	Boolean		Optional	If set to True a setting will be enabled at the time of suspension to stop any overdue mail being sent to the account holder (if not already). Validation will check if the account is overdue prior to the suspension and if so overdue mail will not be stopped. This will default to False if left blank.

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

Name	Data Type	Description

Name	Data Type	Description
DateCreated	DateTime	Date/time message was processed
Id	String	Unique ID for the message
ResponseNotes ()		Collection of validation messages
ResponseMessageNote()
Code	String
Note	String
NoteType	Enum	Error, Warning, Info
Status	Enum	Failed, Succeed, Unknown
ScheduleId	String
SuspensionEndDate	DateTime	The date on which the suspension shall end.
SuspensionStartDate	DateTime	The date on which the suspension shall start.

Type	Error Code	Error Message

Type	Error Code	Error Message
Error	13009	Invalid MinimumEffectiveDate.The date must be in the future.
Error	13095	Frequency must not be NotSpecified when fee is not 0.00
Error	13094	Frequency must be NotSpecified or OneOff when fee is 0.00
Error	13096	Fee must not be smaller than 0.00
Error	13097	Number of payment cycles must be at least
Warning	14020	DateTime field '{0}' contains time part, but the time is ignored by message.
Warning	14021	Decimal field '{0}' contains more than 2 decimal points that were ignored by 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	14100	Suspension Start Date cannot be prior to the Account Start Date.
Error	13092	No payment schedule found for suspension period
Error	13091	New suspension ('{0}' - '{1}') overlaps with an existing suspension ('{2}' - '{3}')
Warning	14011	Suspension end date '{0}' is after the payment schedule finish date '{1}'.
Info	00	Success

On this page: