Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Usage


Excerpt

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

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

CancellationNote

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


TypeError CodeError Message
Error02Invalid user credentials
Error08There is no record found with this criteria
Error07Multiple accounts found with this criteria
Error10Account is not active
Error12016Missing required reference number. Must provide either ExternalAccountReferenceNo or AccountReferenceNo or both
Error09Failed to complete the process

Related Pages

Filter by label (Content by label)
showLabelsfalse
spacesDDE
showSpacefalse
sorttitle
typepage
cqllabel = "cancelaccount" and type = "page" and space = "DDE" and ancestor = "986156090"
labelsdocumentation-space-sample


Panel

On this page:

Table of Contents


Panel
titleREST API

/wiki/spaces/DDE/pages/985137181