UpdateClientPhoneNumber

Owned by chitra.b (Unlicensed)
Last updated: May 12, 2021

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

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

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

TypeError CodeError Message
Error12023Missing phone number parameter
Error02Invalid user credentials
Error12016Missing required reference number. Must provide either ExternalAccountReferenceNo or AccountReferenceNo or both.
Error08There is no record found with this criteria
Error10Account is not active
Error07Multiple accounts found with this criteria
Error14122Name field is required for emergency phone type.
Error13029Invalid Phone STD
Info00Success
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

On this page:

REST API

PUT Phone number 




© 2021 Debitsuccess. All rights reserved