[New] Suspending an account

Suspend account for the payment cycle

Suspend an account

SuspendAccountForNumberOfPaymentCycles is used to suspend an existing account within the Debitsuccess billing system.

AccountReferenceNo
System generated account reference for the customer account to be cancelled. At least one of the parameters (AccountReferenceNo, ExternalAccountReferenceNo) must be supplied
AccountCode is returned when you retrieve account details using one of the GetCustomerAccount messages
ExternalAccountReferenceNo
External unique reference for the customer account to be cancelled. At least one of the parameters (AccountReferenceNo, ExternalAccountReferenceNo) must be supplied
minimumEffectiveDate
NumberOfPaymentCycles
SuspensionFee
SuspensionFeeFrequency
DDStop
ODMailStop

Sample request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:deb="Debitsuccess.WebServices.WCF" xmlns:deb1="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core">
   <soapenv:Header/>
   <soapenv:Body>
      <deb:SuspendAccountForNumberOfPaymentCycles>
         <deb:request>

            <deb1:User>
               <deb1:Password>testPassword</deb1:Password>
               <deb1:Username>testUser</deb1:Username>
            </deb1:User>
            <deb1:AccountReferenceNo>ABC12345</deb1:AccountReferenceNo>
            <deb1:ExternalAccountReferenceNo></deb1:ExternalAccountReferenceNo>
            <deb1:MinimumEffectiveDate>2022-03-31</deb1:MinimumEffectiveDate>
            <deb1:NumberOfPaymentCycles>5</deb1:NumberOfPaymentCycles>
            <deb1:SuspensionFee>10</deb1:SuspensionFee>
            <deb1:SuspensionFeeFrequency>Monthly</deb1:SuspensionFeeFrequency>
            <deb1:DDStop>true</deb1:DDStop>
            <deb1:ODMailStop>true</deb1:ODMailStop>
         </deb:request>
      </deb:SuspendAccountForNumberOfPaymentCycles>
   </soapenv:Body>
</soapenv:Envelope>

Sample response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <ActivityId CorrelationId="9603581e-c4c8-4a36-ad63-5cbf54e1ad7a" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">00000000-0000-0000-0000-000000000000</ActivityId>
   </s:Header>
   <s:Body>
      <SuspendAccountForNumberOfPaymentCyclesResponse xmlns="Debitsuccess.WebServices.WCF">
         <SuspendAccountForNumberOfPaymentCyclesResult xmlns:a="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:DateCreated>2020-07-01T14:43:36.230952+12:00</a:DateCreated>
            <a:Id>2708102e-2a9d-43ae-9482-d887452b1918</a:Id>
            <a:ResponseNotes>
               <a:ResponseMessageNote>
                  <a:Code>00</a:Code>
                  <a:Note>Success</a:Note>
                  <a:NoteType>Info</a:NoteType>
               </a:ResponseMessageNote>
            </a:ResponseNotes>
            <a:Status>Succeed</a:Status>
            <a:ScheduleId>48132090</a:ScheduleId>
            <a:SuspensionEndDate>2022-09-22T00:00:00</a:SuspensionEndDate>
            <a:SuspensionStartDate>2022-04-23T00:00:00</a:SuspensionStartDate>
         </SuspendAccountForNumberOfPaymentCyclesResult>
      </SuspendAccountForNumberOfPaymentCyclesResponse>
   </s:Body>
</s:Envelope>

On this page:

Suspend account for the date range