Close an account down
REST API
Use the Close Account endpoint of Customer Services API to close an account. The account will be closed immediately and no outstanding balance will be collected.
POST https://<ServerURL>/CustomerServices/v1.0/accounts/{accountId}/close
AccountId is used to uniquely identify the exact account to be closed.
The close reason is defaulted to ‘Facility Request’. For details on account close reason, see Account Close Reason.
Soap WS
Close/cancel an account
CancelAccount is used to immediately cancel an active account within the Debitsuccess billing system.
It must be noted that the account will be closed straight away without collecting outstanding balance/fees.
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 messagesExternalAccountReferenceNo
An external unique reference for the customer account to be cancelled. At least one of the parameters (AccountReferenceNo, ExternalAccountReferenceNo) must be suppliedCancellationNotes
Reason for the cancellation. This is a required field
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:CancelAccount>
<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:CancellationNote>Facility request</deb1:CancellationNote>
</deb:request>
</deb:CancelAccount>
</soapenv:Body>
</soapenv:Envelope>
Sample response
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<ActivityId CorrelationId="9b4b7fa1-d504-4caa-82d7-2688c33df5e9" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">00000000-0000-0000-0000-000000000000</ActivityId>
</s:Header>
<s:Body>
<CancelAccountResponse xmlns="Debitsuccess.WebServices.WCF">
<CancelAccountResult xmlns:a="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:DateCreated>2020-07-01T11:03:18.0184813+12:00</a:DateCreated>
<a:Id>1ad7ecd1-bf23-47a2-859d-9562a77fb814</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>
</CancelAccountResult>
</CancelAccountResponse>
</s:Body>
</s:Envelope>
On this page:
- 1 REST API
- 2 Soap WS
- 2.1 Close/cancel an account
- 2.1.1 Sample request
- 2.1.2 Sample response
- 2.2 Adjust Account Minimum Term
- 2.2.1 Sample request
- 2.2.2 Sample response
- 2.3 Adjust Account Fixed Term
- 2.3.1 Sample request
- 2.3.2 Sample response
- 2.4 Related Articles
- 2.1 Close/cancel an account
Adjust Account Minimum Term
AdjustAccountMINIMUMTerm is used to change the account minimum term value.
Note that the term cannot be changed for fixed-term accounts.
AccountReferenceNo
System generated account reference for the customer account where the minimum term needs to be adjusted. At least one of the parameters (AccountReferenceNo, ExternalAccountReferenceNo) must be suppliedExternalAccountReferenceNo
An external unique reference for the customer account where the minimum term needs to be adjusted. At least one of the parameters (AccountReferenceNo, ExternalAccountReferenceNo) must be suppliedNewTerm
New minimum term (in months or payments)NewTermType
Months or Payments
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:AdjustAccountMinimumTerm>
<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:NewTerm>9</deb1:NewTerm>
<deb1:NewTermType>Months</deb1:NewTermType>
</deb:request>
</deb:AdjustAccountMinimumTerm>
</soapenv:Body>
</soapenv:Envelope>
Sample response
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<ActivityId CorrelationId="190ac5de-89e5-41bf-9250-0f6aa3d5cc3c" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">00000000-0000-0000-0000-000000000000</ActivityId>
</s:Header>
<s:Body>
<AdjustAccountMinimumTermResponse xmlns="Debitsuccess.WebServices.WCF">
<AdjustAccountMinimumTermResult xmlns:a="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:DateCreated>2020-07-02T12:24:11.3697168+12:00</a:DateCreated>
<a:Id>b6003a37-a752-4560-89d2-63c07a51cb2a</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:AccountReferenceNo i:nil="true"/>
<a:ExternalAccountReferenceNo i:nil="true"/>
<a:NewTotalValue>49.50</a:NewTotalValue>
</AdjustAccountMinimumTermResult>
</AdjustAccountMinimumTermResponse>
</s:Body>
</s:Envelope>
Adjust Account Fixed Term
AdjustAccountFixedTerm is used to change an ongoing account to a fixed-term account. The account will be closed at the end of the term when the total balance is collected
AccountReferenceNo
System generated account reference for the customer account to be cancelled. At least one of the parameters (AccountReferenceNo, ExternalAccountReferenceNo) must be suppliedExternalAccountReferenceNo
An external unique reference for the customer account that needs to be adjusted to a fixed term. At least one of the parameters (AccountReferenceNo, ExternalAccountReferenceNo) must be suppliedTerminationDate
This is an Optional field to allow a new termination date for the account to be submitted. Doing so will recalculate the total balance the account owes up until this date.
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:AdjustAccountFixedTerm>
<deb:request>
<deb1:User>
<deb1:Password>#QualIT</deb1:Password>
<deb1:Username>QualIT</deb1:Username>
</deb1:User>
<deb1:AccountReferenceNo>DEA2884304</deb1:AccountReferenceNo>
<deb1:ExternalAccountReferenceNo></deb1:ExternalAccountReferenceNo>
</deb:request>
</deb:AdjustAccountFixedTerm>
</soapenv:Body>
</soapenv:Envelope>
Sample response
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<ActivityId CorrelationId="499d091d-0fc6-4a0a-b94e-4aed05b5333a" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">00000000-0000-0000-0000-000000000000</ActivityId>
</s:Header>
<s:Body>
<AdjustAccountFixedTermResponse xmlns="Debitsuccess.WebServices.WCF">
<AdjustAccountFixedTermResult xmlns:a="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:DateCreated>2020-07-02T14:58:25.8129149+12:00</a:DateCreated>
<a:Id>72d62964-bc94-4337-99aa-ce3e5763a4d1</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:MinTermAmount>0</a:MinTermAmount>
</AdjustAccountFixedTermResult>
</AdjustAccountFixedTermResponse>
</s:Body>
</s:Envelope>
Related Articles
-
-
-
AdjustAccountMinimumTerm — Adjusts Account Minimum Term method will be used to alter the minimum term of on-going accounts.
-
CancelAccount — Allows you to cancel an existing account within the Debitsuccess billing system.
Related content
© 2021 Debitsuccess. All rights reserved