CancelAccount

Usage



Allows you to cancel an existing account within the Debitsuccess billing system.



Parameters

Name

Data Type

Length



Description

User









  • Username

String



Required

Provided by Debitsuccess

  • Password

String



Required

Provided by Debitsuccess

String

100

Optional

Optional – allows requesting user to be logged

String

15

Optional*

Debitsuccess account reference

String

50

Optional*

External account reference

String

30

Required

Reason for cancellation.


If an account with an overdue penalty fee is transferred within the facility group, include the word "transferred" in the cancellation note to set the Cancellation Reason to 'Transfer'. This will bypass the Debt Collection Process for this account else the Cancellation Reason will be defaulted to 'Facility Request'

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

Response 

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

Error Messages



Type

Error Code

Error Message

Error

02

Invalid user credentials

Error

08

There is no record found with this criteria

Error

07

Multiple accounts found with this criteria

Error

10

Account is not active

Error

12016

Missing required reference number. Must provide either ExternalAccountReferenceNo or AccountReferenceNo or both

Error

09

Failed to complete the process

Related Pages



On this page:



REST API









© 2021 Debitsuccess. All rights reserved