UpdateClientPhoneNumber

Usage

Allows the customer’s phone number to be updated.

Any existing phone number of the specified type held by Debitsuccess will be marked as Phone Number Type = Previous and replaced by the phone number data supplied in this message.

If an account has guarantor details then the guarantor contact information (phone number and email address) will always be the preferred contact for the account.

Parameters

Name	Data Type	Length		Description

Name	Data Type	Length		Description
DateCreated				Date/time message was processed
User
Id				Unique ID for the user
Username	String		Required	Provided by Debitsuccess
Password	String		Required	Provided by Debitsuccess
RequestInitiator	String	100	Optional	Allows requesting user to be logged
AccountReferenceNo	String	15	Optional^*	Debitsuccess account reference
ExternalAccountReferenceNo	String	50	Optional^*	External account reference
PhoneNumber
Id				ID for the request
PhoneNumberType	Enum		Required	Home, Mobile, Work, Emergency
CountryCode	Enum			Unique country identifier
STDCode	String	4		Maximum length of 4 characters
Number	String	75	Required	Maximum length of 75 characters Allowed characters: `alphanumeric # + - ( ) * _ [space] , ; : . /`
Name	String	50		Required for emergency phone type
Preferred	Boolean			Customer’s preferred phone number (true or false)

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

Response

Name	Data Type	Description

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 Message

Type	Error Code	Error Message

Type	Error Code	Error Message
Error	12023	Missing phone number parameter
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
Error	14122	Name field is required for emergency phone type.
Error	13029	Invalid Phone STD
Info	00	Success
Error	14206	Invalid Number
Warning	14030	Preferred is set to FALSE as customers with Guarantor’s contact are not allowed to update other phone numbers to Preferred

Related Pages

Page:

Update customer's information

On this page:

1 Usage
2 Parameters
3 Response
4 Error Message
5 Related Pages

REST API

PUT Phone number