AdjustAccountMinimumTerm
Usage
Adjusts Account Minimum Term method will be used to alter the minimum term of on-going accounts.
‘Term’ or ‘Term Type’ cannot be changed using this method when the account is set to a fixed term.
Parameters
Name | Data Type | Length | Description | |
---|---|---|---|---|
User | ||||
| String | Required | Provided by Debitsuccess | |
| 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 |
New Term | Int | Required | New minimum term in months or payments | |
New Term Type | String | Required | Months, Payments |
* 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 | |
| String | |
| String | |
| Enum | Error, Warning, Info |
Status | Enum | Failed, Succeed, Unknown |
NewTotalValue | Decimal (10,2) | New total value of the account |
Error Messages
Type | Error Code | Error Message |
---|---|---|
Error | 14114 | No active payment schedule found for this account. |
Error | 12002 | Missing client first name |
Warning | 14020 | DateTime field '{0}' contains time part, but the time is ignored by message. |
Error | 13200 | Title field cannot be more than 10 characters long. |
Error | 02 | Invalid user credentials |
Error | 12016 | Missing required reference number. Must provide either ExternalAccountReferenceNo or AccountReferenceNo or both. |
Error | 08 | There is no record found with this criteria |
Error | 10 | Account is not active |
Error | 07 | Multiple accounts found with this criteria |
Info | 00 | Success |
Error | 14048 | Term or Term Type cannot be changed when account is set to fixed term. Please use AdjustAccountTotalValue instead |
Error | 14049 | Both NewTerm and NewTermType must be provided. |
Error | 13004 | Invalid value for Account's Term |
Related pages
On this page:
© 2021 Debitsuccess. All rights reserved