AdjustAccountFixedTerm

Usage



Changes a customer’s account to a fixed-term from on-going. 

Once this change is made the account will be closed when the total balance is collected.



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

TerminationDate

DateTime



Optional*

Optional – allows a new termination date for the account to be submitted. Doing so will recalculate the total balance the account owes up until this date.

* 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

MinTermAmount

String

Updated Termination Amount to be collected



Error Messages

Type

Error Code

Error Message

Warning

14050

Please note this account is already set to Fixed Term

Error

14079

Invalid Termination Date. Account has already been billed for the period covered by the Termination date

Error

14080

Invalid Request - The account currently has open-ended Suspension schedule

Error

14081

Termination date cannot be within current billing cycle

Info

14082

This account will be in credit at termination date

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

Related Pages



On this page:









© 2021 Debitsuccess. All rights reserved