UpdateGuarantorDetails

Usage

Allows Guarantor’s phone details to be updated, including phone number, name, and address.

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
User
Id
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
NewGuarantorDetails
City	String	50	Required - NZ Optional - AUS
Country	Enum		Required	Australia, NewZealand, HongKong, Singapore, and UnitedStatesOfAmerica
DateOfBirth	DateTime		Required	Date must be in the format YYYY-MM-DD
EmailAddress	String	75	Required	Email Address
FirstName	String		Required	First name of the guarantor. FirstName+LastName must < 30 characters
HomePhone	String	20	Optional	Home phone number
LastName	String		Required	Last name of the guarantor. FirstName+LastName must < 30 characters
Locality	String	60	Optional	Address line 2.
MobilePhone	String	20	Optional	Mobile phone number
Postcode	String	10	Required
Relationship	String	50	Required	Guarantor's relationship with the customer
State	String		Required - NZ Optional - AUS
Street	String	50	Required	Street address
Suburb	String	50	Optional - NZ Required - AUS	Suburb address
WorkPhone	String	20	Optional	Work phone number

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

_{** A full address is concatenated with Street, Locality, Suburb, City, State, Postcode, Country with maximum length of 100. Anything exceeded will be trimmed.}

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

Type	Error Code	Error Message
Error	14093	Relation field cannot be more than 20 characters long.
Error	14094	City field cannot be more than 50 characters long.
Error	14095	Street field cannot be more than 50 characters long.
Error	14096	PostCode 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
Error	14092	{Name} field is required
Info	00	Success
Error	14205	Invalid Mobile Phone
Error	13014	Invalid Email Address
Error	14124	Locality cannot exceed 60 characters.
Error	100	Invalid enum value '' cannot be deserialized into type 'Debitsuccess.Framework.Country'. Ensure that the necessary enum values are present and are marked with EnumMemberAttribute attribute if the type has DataContractAttribute attribute. There was an error deserializing the object of type Debitsuccess.WebServices.Core.RequestAdjustGuarantorDetails. The value '' cannot be parsed as the type 'DateTime'.
Error	12027	Missing Street parameter
Error	12026	Missing or invalid Postcode parameter
Error	12024	Missing City Parameter
Error	12025	Missing Suburb parameter
Error	12028	Missing State parameter
Error	14129	FirstName and LastName fields cannot be more than 29 characters.
Error	14130	HomePhone field cannot be more than 20 characters long.
Error	14131	WorkPhone field cannot be more than 20 characters long.
Error	14132	MobilePhone field cannot be more than 20 characters long.
Error	14133	EmailAddress field cannot be more than 75 characters long.
Error	14134	State field cannot be more than 20 characters long.
Error	14126	Suburb cannot exceed 50 characters.
Error	14136	Guarantor must be at least 18 years old
Error	14205	Invalid Home Phone
Error	14205	Invalid Work Phone
Error	14135	Invalid FirstName
Error	14135	Invalid LastName
Error	14135	Invalid Relationship
Error	14135	Invalid State
Error	14135	Invalid Suburb
Error	14135	Invalid City
Error	14135	Invalid Locality
Error	14135	Invalid Postcode

Related Pages

Filter by label

There are no items with the selected labels at this time.

On this page:

Debitsuccess Developer Documentation