- Created by chitra.b (Unlicensed) , last modified on Aug 05, 2020
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 14 Next »
Suspend account for the payment cycle
SuspendAccountForNumberOfPaymentCycles is used to suspend an existing account within the Debitsuccess billing system.
AccountReferenceNo
System generated account reference for the customer account to be suspended. At least one of the parameters (AccountReferenceNo, ExternalAccountReferenceNo) must be supplied
AccountCode is returned when you retrieve account details using one of the GetCustomerAccount messagesExternalAccountReferenceNo
External unique reference for the customer account to be suspended. At least one of the parameters (AccountReferenceNo, ExternalAccountReferenceNo) must be suppliedminimumEffectiveDate
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 between dates
SuspendAccountBetweenDates is used to suspend an existing account within the Debitsuccess billing system.
AccountReferenceNo
System generated account reference for the customer account to be suspended. At least one of the parameters (AccountReferenceNo, ExternalAccountReferenceNo) must be supplied
AccountCode is returned when you retrieve account details using one of the GetCustomerAccount messagesExternalAccountReferenceNo
External unique reference for the customer account to be suspended. At least one of the parameters (AccountReferenceNo, ExternalAccountReferenceNo) must be suppliedEndDate
StartDate
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:SuspendAccountBetweenDates> <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:EndDate>2021-03-31</deb1:EndDate> <deb1:StartDate>2020-07-30</deb1:StartDate> <deb1:SuspensionFee>10</deb1:SuspensionFee> <deb1:SuspensionFeeFrequency>Monthly</deb1:SuspensionFeeFrequency> <deb1:DDStop>true</deb1:DDStop> <deb1:ODMailStop>true</deb1:ODMailStop> </deb:request> </deb:SuspendAccountBetweenDates> </soapenv:Body> </soapenv:Envelope>
Sample response
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Header> <ActivityId CorrelationId="a8a1e872-074e-43aa-8aa8-4e9772c8be9e" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">00000000-0000-0000-0000-000000000000</ActivityId> </s:Header> <s:Body> <SuspendAccountBetweenDatesResponse xmlns="Debitsuccess.WebServices.WCF"> <SuspendAccountBetweenDatesResult xmlns:a="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:DateCreated>2020-07-01T15:46:12.3133592+12:00</a:DateCreated> <a:Id>0f287d65-0621-48b2-b501-cb0874de47f7</a:Id> <a:ResponseNotes> <a:ResponseMessageNote> <a:Code>14010</a:Code> <a:Note>Suspension is not aligned with payment schedule and will result in pro rata payments.</a:Note> <a:NoteType>Warning</a:NoteType> </a:ResponseMessageNote> <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>48132091</a:ScheduleId> <a:SuspensionEndDate>2021-03-31T00:00:00</a:SuspensionEndDate> <a:SuspensionStartDate>2020-07-30T00:00:00</a:SuspensionStartDate> </SuspendAccountBetweenDatesResult> </SuspendAccountBetweenDatesResponse> </s:Body> </s:Envelope>
- No labels
0 Comments