Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 19 Current »

Change Customer Personal Details

REST API

Use the Customer endpoint of Customer Services API to change customer’s details such as FirstName, MiddleName, LastName, Title, DateOfBirth, Gender.

PUT https://<ServerURL>/CustomerServices/v1.0/customers/{customerId}

  • CustomerId is used to uniquely identify the exact customer to be updated

  • Possible enumerators for Gender are "male", "female", "unspecified", "non-binary"

  • dateOfBirth must be in the format YYYY-MM-DD

SOAP WS

Use the UpdateClientDetails call to update the customer’s Personal details. Only the attributes that are required to change need to be set in the request. As long as the other attributes are not set and are passed effectively as null, the currently recorded values will remain.

Sample Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:deb="Debitsuccess.WebServices.WCF" xmlns:deb1="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core">
   <soapenv:Header/>
   <soapenv:Body>
      <deb:UpdateClientDetails>
         <deb:request>
            <deb1:User>
               <deb1:Password>#vhtest1</deb1:Password>
               <deb1:Username>vhtest</deb1:Username>
            </deb1:User>
            <deb1:AccountReferenceNo>vhtest888994</deb1:AccountReferenceNo>
            <deb1:CustomerDetail>
               <deb1:DateOfBirth>1988-10-06</deb1:DateOfBirth>
               <deb1:FirstName>Joe</deb1:FirstName>
               <deb1:Gender>Male</deb1:Gender>
               <deb1:LastName>A</deb1:LastName>
               <deb1:MiddleName>k</deb1:MiddleName>
               <deb1:Title>Mr</deb1:Title>
            </deb1:CustomerDetail>
         </deb:request>
      </deb:UpdateClientDetails>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response Message

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <ActivityId CorrelationId="6c3b44c1-bf97-43b1-b5c2-9edc62069959" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">00000000-0000-0000-0000-000000000000</ActivityId>
   </s:Header>
   <s:Body>
      <UpdateClientDetailsResponse xmlns="Debitsuccess.WebServices.WCF">
         <UpdateClientDetailsResult xmlns:a="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:DateCreated>2020-06-09T18:03:03.5992395+12:00</a:DateCreated>
            <a:Id>31f9d28a-7b80-4779-a141-5722d8ce8438</a:Id>
            <a:ResponseNotes>
               <a:ResponseMessageNote>
                  <a:Code>00</a:Code>
                  <a:Note>Success</a:Note>
                  <a:NoteType>Info</a:NoteType>
               </a:ResponseMessageNote>
            </a:ResponseNotes>
            <a:Status>Succeed</a:Status>
         </UpdateClientDetailsResult>
      </UpdateClientDetailsResponse>
   </s:Body>
</s:Envelope>

Change Customer Email

REST API

Use the EmailAddress endpoint of Customer Services API to change the customer’s email address.

PUT https://<ServerURL>/CustomerServices/v1.0/customers/{customerId}/emailAddresses/{emailAddressId}

  • customerId and emailAddressId are used to uniquely identify the exact email address to be updated

  • EmailName is added as a new field that can be updated

  • Preferred is replaced by IsPrimary (i.e. possible value is True only. False is not allowed)

    • Notes: Each Customer can only have 1 email with IsPrimary=1. All other emails (if the customer has multiple email addresses) will have IsPrimary = 0. Updating an email address to isPrimary =1 will reset all existing email addresses belong to same the customer to IsPrimary=0. Email address is not allowed to be updated to IsPrimary=0 via this RestFul API.

    • If a customer has a Guarantor, the guarantor has an email address, then the guarantor’s email address will always be the preferred email address. Any attempt to update other non-guarantor email address to preferred will be ignored.

SOAP WS

The UpdateClientEmailAddress call is used to update Customers email address.

Sample Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:deb="Debitsuccess.WebServices.WCF" xmlns:deb1="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core">
   <soapenv:Header/>
   <soapenv:Body>
      <deb:UpdateClientEmailAddress>
         <deb:request>
            <deb1:DateCreated>2020-09-22</deb1:DateCreated>
            <deb1:Id>333</deb1:Id>
            <deb1:RequestInitiator>Kin333</deb1:RequestInitiator>
            <deb1:User>
               <deb1:Id>33333</deb1:Id>
               <deb1:Password>#Password</deb1:Password>
               <deb1:Username>Username</deb1:Username>
            </deb1:User>
            <deb1:AccountReferenceNo>DEA2884487</deb1:AccountReferenceNo>
            <deb1:ExternalAccountReferenceNo></deb1:ExternalAccountReferenceNo>
            <deb1:EmailAddress>
               <deb1:Id>123</deb1:Id>
               <deb1:Preferred>true</deb1:Preferred>
               <deb1:EmailAddress>Do@iteshi.masu</deb1:EmailAddress>
            </deb1:EmailAddress>
         </deb:request>
      </deb:UpdateClientEmailAddress>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response Message

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <ActivityId CorrelationId="b08725f5-2a1b-4e3f-8cce-de6caca22b0f" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">00000000-0000-0000-0000-000000000000</ActivityId>
   </s:Header>
   <s:Body>
      <UpdateClientEmailAddressResponse xmlns="Debitsuccess.WebServices.WCF">
         <UpdateClientEmailAddressResult xmlns:a="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:DateCreated>2020-09-22T13:45:52.9801649+12:00</a:DateCreated>
            <a:Id>7faa60f4-1491-4620-8e17-c752512c62c1</a:Id>
            <a:ResponseNotes>
               <a:ResponseMessageNote>
                  <a:Code>00</a:Code>
                  <a:Note>Success</a:Note>
                  <a:NoteType>Info</a:NoteType>
               </a:ResponseMessageNote>
            </a:ResponseNotes>
            <a:Status>Succeed</a:Status>
         </UpdateClientEmailAddressResult>
      </UpdateClientEmailAddressResponse>
   </s:Body>
</s:Envelope>

Change Customer Address

REST API

Use the Address endpoint of Customer Services API to change the customer’s address.

PUT https://<ServerURL>/CustomerServices/v1.0/customers/{customerId}/addresses/{addressId}

  • customerId and addressId are used to uniquely identify the exact address to be updated

  • CountryISOCode (i.e 3 characters)

  • Preferred is replaced by IsPrimary (i.e. possible value is True only. False is not allowed)

    • Notes: Each Customer can only have 1 address with IsPrimary=1. All other AddressType will have IsPrimary = 0. Updating an address to isPrimary =1 will reset all existing addresses belong to same the customer to IsPrimary=0. The address is not allowed to be updated to IsPrimary=0 via this RestFul API

SOAP WS

The UpdateClientAddress call is used to add new address details to a customer. Always enter the full address record in this call to update an address. If an address is already present of the same type, the original address will be marked as previous and held in the account history.

Sample Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:deb="Debitsuccess.WebServices.WCF" xmlns:deb1="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core">
   <soapenv:Header/>
   <soapenv:Body>
      <deb:UpdateClientAddress>
         <deb:request>
            <deb1:DateCreated>2020-09-22</deb1:DateCreated>
            <deb1:Id>333</deb1:Id>
            <deb1:RequestInitiator>Kin333</deb1:RequestInitiator>
            <deb1:User>
               <deb1:Id>33333</deb1:Id>
               <deb1:Password>#Password</deb1:Password>
               <deb1:Username>Username</deb1:Username>
            </deb1:User>
            <deb1:AccountReferenceNo>DEA2884487</deb1:AccountReferenceNo>
            <deb1:ExternalAccountReferenceNo></deb1:ExternalAccountReferenceNo>
            <deb1:NewAddress>
               <deb1:Id>123</deb1:Id>
               <deb1:Preferred>false</deb1:Preferred>
               <deb1:AddressType>Physical</deb1:AddressType>
               <deb1:City>Melbourne</deb1:City>
               <deb1:Country>Australia</deb1:Country>
               <deb1:Locality>street 2 point</deb1:Locality>
               <deb1:Postcode>5432</deb1:Postcode>
               <deb1:State>Victoria</deb1:State>
               <deb1:Street>Vic street 1234</deb1:Street>
               <deb1:Suburb>Notre</deb1:Suburb>
            </deb1:NewAddress>
         </deb:request>
      </deb:UpdateClientAddress>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response Message

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <ActivityId CorrelationId="4056b287-2e18-4c54-abd1-046b2986cc88" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">00000000-0000-0000-0000-000000000000</ActivityId>
   </s:Header>
   <s:Body>
      <UpdateClientAddressResponse xmlns="Debitsuccess.WebServices.WCF">
         <UpdateClientAddressResult xmlns:a="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:DateCreated>2020-09-22T13:52:30.3748174+12:00</a:DateCreated>
            <a:Id>b6432fd6-23d9-4820-81a8-9c073fbc1c58</a:Id>
            <a:ResponseNotes>
               <a:ResponseMessageNote>
                  <a:Code>00</a:Code>
                  <a:Note>Success</a:Note>
                  <a:NoteType>Info</a:NoteType>
               </a:ResponseMessageNote>
            </a:ResponseNotes>
            <a:Status>Succeed</a:Status>
         </UpdateClientAddressResult>
      </UpdateClientAddressResponse>
   </s:Body>
</s:Envelope>

Change Customer Phone Number

REST API

Use the Phone Number endpoint of Customer Services API to add a new customer phone number.

PUT https://<ServerURL>/CustomerServices/v1.0/customers/{customerId}/phoneNumbers/{phoneNumberId}

  • customerId and phoneNumberId are used to uniquely identify the exact phone number to be updated

  • CountryCode

  • Preferred is renamed to IsPrimary (i.e. possible value is True only. False is not allowed)

    • Notes: Each Customer can only have 1 phone number with IsPrimary=1. All other phone numbers (if a customer has multiple phone numbers) will have IsPrimary = 0. Updating a phone number to isPrimary =1 will reset all existing phone numbers belong to same the customer to IsPrimary=0. Phone number is not allowed to be updated to IsPrimary=0 via this RestFul API.

    • If a customer has a Guarantor and the guarantor has a mobile number, then the guarantor’s mobile number will always be the preferred phone number. Any attempt to update other non-guarantor phone numbers to preferred will be ignored.

SOAP WS

The UpdateClientPhoneNumber is used to add a new phone number to the customer. The full phone number record must be set in the API, except for the Name and StdCode field where it is optional (the name is required only for Emergency phone type).  If a phone number is already present of the same type, the original phone number will be marked as previous and held in the account history.

Sample Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:deb="Debitsuccess.WebServices.WCF" xmlns:deb1="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core">
   <soapenv:Header/>
   <soapenv:Body>
      <deb:UpdateClientPhoneNumber>
         <deb:request>
            <deb1:DateCreated>2020-09-22</deb1:DateCreated>
            <deb1:Id>333</deb1:Id>
            <deb1:RequestInitiator>Kin333</deb1:RequestInitiator>
            <deb1:User>
               <deb1:Id>33333</deb1:Id>
               <deb1:Password>#Password</deb1:Password>
               <deb1:Username>Username</deb1:Username>
            </deb1:User>
            <deb1:AccountReferenceNo>DEA2884487</deb1:AccountReferenceNo>
            <deb1:ExternalAccountReferenceNo></deb1:ExternalAccountReferenceNo>
            <deb1:PhoneNumber>
               <deb1:Preferred>true</deb1:Preferred>
               <deb1:CountryCode>Aus</deb1:CountryCode>
               <deb1:Number>333333333</deb1:Number>
               <deb1:PhoneNumberType>Emergency</deb1:PhoneNumberType>
            </deb1:PhoneNumber>
         </deb:request>
      </deb:UpdateClientPhoneNumber>
   </soapenv:Body>
</soapenv:Envelope>

Sample Request Message

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <ActivityId CorrelationId="8011fbee-38c5-495f-a99e-ff7d04576d0b" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">00000000-0000-0000-0000-000000000000</ActivityId>
   </s:Header>
   <s:Body>
      <UpdateClientPhoneNumberResponse xmlns="Debitsuccess.WebServices.WCF">
         <UpdateClientPhoneNumberResult xmlns:a="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:DateCreated>2020-09-22T14:00:07.1197872+12:00</a:DateCreated>
            <a:Id>d2d33b2d-c8a6-43cb-a783-9fdce0758d53</a:Id>
            <a:ResponseNotes>
               <a:ResponseMessageNote>
                  <a:Code>00</a:Code>
                  <a:Note>Success</a:Note>
                  <a:NoteType>Info</a:NoteType>
               </a:ResponseMessageNote>
            </a:ResponseNotes>
            <a:Status>Succeed</a:Status>
         </UpdateClientPhoneNumberResult>
      </UpdateClientPhoneNumberResponse>
   </s:Body>
</s:Envelope>

On this page:

  • No labels

© 2021 Debitsuccess. All rights reserved