/
UpdateClientAddress

UpdateClientAddress

May 12, 2021

Usage



Allows you to update a customer’s address details. 

Any existing address of the specified type held by Debitsuccess will be marked as AddressType = Previous and replaced by the address data supplied in this message.



Parameters

Name

Data Type

Length



Description

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

NewAddress

 

 

 

 

  • AddressType

Enum





Physical/Postal

  • Street

String

60





  • Suburb

String

50



Maximum length 50 characters

  • City

String

50



Maximum length 50 characters

  • State

Enum





See table

  • Country

Enum





Australia, NewZealand, UnitedStatesOfAmerica

  • Postcode

String

10



Maximum length 10 characters

  • Preferred

Boolean





Customer’s preferred address (true or false)

  • Locality

String







* 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

12027

Missing Street parameter

Error

13016

Invalid address type

Error

14123

Street cannot exceed 60 characters.

Error

14124

Locality cannot exceed 60 characters.

Error

14125

City cannot exceed 50 characters.

Error

14126

Suburb cannot exceed 50 characters.

Error

13203

<Field name> field cannot be more than <maxlength> characters.

Error

12026

Missing or invalid Postcode parameter

Error

13302

Invalid State - please refer to the API documentation for valid values.

Error

12024

Missing City parameter

Error

12025

Missing Suburb parameter

Error

12028

Missing State parameter

Error

12034

Missing Locality 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

Info

00

Success

Related Pages

On this page:

REST API

PUT Address







© 2021 Debitsuccess. All rights reserved