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 10 Current »

REST API

Use the Accounts endpoint of Customer Services API to retrieve:

  • one Account if AccountID is provided or

  • a list of all Full Service Accounts associated with the Customer as provided via CustomerID or

  • a list of all Full Service Accounts associated with the Business Account as provided via BusinessAccountID

GET https://<ServerURL>/CustomerServices/v1.0/accounts[?customerId][&accountStatus][&closeReason][&from][&to][&dateType][&businessAccountId][&nextCursor][&limit][&accountExternalId]

  • from and to fields indicate the start date and end date of the date range for the search. Both fields are optional

  • DateType indicates if the date range refers to

    • Start date, Load Date, last Update Date or Close Date

  • Beside date range, more filters are available to retrieve the accounts data, i.e.

    • customerId, accountStatus, closeReason, businessAccountId

  • NextCursor and Limit fields are available to allow pagination retrieval

  • This API only retrieve data at account level. Other data (i.e., Customer, Contacts, Payment Method, Schedule) can be retrieved individually in separate APIs. Refer to the Rest API reference.

SOAP WS

The GetCustomerAccountForDateRange retrieves the details of accounts that have been loaded or updated within a specified date range. For example, when a new account is loaded, an account overdue status is changed, or an account is closed.

Sample request

<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:GetCustomerAccountForDateRange>
         <deb:request>
            <deb1:DateCreated>2020-08-10</deb1:DateCreated>
            <deb1:Id>123</deb1:Id>
            <deb1:RequestInitiator>ReqInit1</deb1:RequestInitiator>
            <deb1:User>
               <deb1:Password>#password</deb1:Password>
               <deb1:Username>usernam</deb1:Username>
            </deb1:User>
            <deb1:EndDate>2020-07-11</deb1:EndDate>
            <deb1:StartDate>2020-07-09</deb1:StartDate>
         </deb:request>
      </deb:GetCustomerAccountForDateRange>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <ActivityId CorrelationId="14768bf0-c2a1-4954-9b65-fecb12188ab3" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">00000000-0000-0000-0000-000000000000</ActivityId>
   </s:Header>
   <s:Body>
      <GetCustomerAccountForDateRangeResponse xmlns="Debitsuccess.WebServices.WCF">
         <GetCustomerAccountForDateRangeResult xmlns:a="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:DateCreated>2020-08-10T16:44:51.5453614+12:00</a:DateCreated>
            <a:Id>2f228826-07f9-42fe-b6ad-04a2394c49f5</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>
            <a:Accounts>
               <a:Account>
                  <a:Id i:nil="true"/>
                  <a:AccountCode>DEA2_test</a:AccountCode>
                  <a:AccountNotes>This account created for testing</a:AccountNotes>
                  <a:AccountReferenceNo>DEA2885109</a:AccountReferenceNo>
                  <a:AccountTemplate i:nil="true"/>
                  <a:CancelReason i:nil="true"/>
                  <a:CatchUpAmount>0</a:CatchUpAmount>
                  <a:CatchUpEndDate>0001-01-01T00:00:00</a:CatchUpEndDate>
                  <a:ContractPrefix>DEA2</a:ContractPrefix>
                  <a:CurrentFrequency>Weekly</a:CurrentFrequency>
                  <a:CurrentInstalment>50.00</a:CurrentInstalment>
                  <a:Customer>
                     <a:Id i:nil="true"/>
                     <a:Contacts>
                        <a:Id i:nil="true"/>
                        <a:Addresses>
                           <a:Address>
                              <a:Id i:nil="true"/>
                              <a:Preferred>true</a:Preferred>
                              <a:AddressType>Postal</a:AddressType>
                              <a:City>Brisbane</a:City>
                              <a:Country>Australia</a:Country>
                              <a:Locality>Northcote</a:Locality>
                              <a:Postcode>4000</a:Postcode>
                              <a:State>Queensland</a:State>
                              <a:Street>5 The warehouse way</a:Street>
                              <a:Suburb>Northcote</a:Suburb>
                           </a:Address>
                        </a:Addresses>
                        <a:Emails>
                           <a:Email>
                              <a:Id i:nil="true"/>
                              <a:Preferred>true</a:Preferred>
                              <a:EmailAddress>sergey.i@debitsuccess.com</a:EmailAddress>
                           </a:Email>
                        </a:Emails>
                        <a:Phones>
                           <a:Phone>
                              <a:Id i:nil="true"/>
                              <a:Preferred>true</a:Preferred>
                              <a:CountryCode>Aus</a:CountryCode>
                              <a:Name>John</a:Name>
                              <a:Number>264 5555</a:Number>
                              <a:PhoneNumberType>Home</a:PhoneNumberType>
                              <a:StdCode>09</a:StdCode>
                           </a:Phone>
                        </a:Phones>
                     </a:Contacts>
                     <a:CustomerDetail>
                        <a:DateOfBirth>2000-01-01T00:00:00</a:DateOfBirth>
                        <a:FirstName>Sergey</a:FirstName>
                        <a:Gender>Male</a:Gender>
                        <a:LastName>Idelson</a:LastName>
                        <a:MiddleName>KC</a:MiddleName>
                        <a:Title>Mr</a:Title>
                     </a:CustomerDetail>
                  </a:Customer>
                  <a:DateAccountClosed>0001-01-01T00:00:00</a:DateAccountClosed>
                  <a:DateAccountLoaded>2020-07-09T11:55:15.397</a:DateAccountLoaded>
                  <a:DateAccountStarted>2020-07-26T00:00:00</a:DateAccountStarted>
                  <a:ExternalAccountReferenceNo>9v0XFDAhzH273AhzzUvx7UbQ04wQSfvL4ygesO5IfIwn9Oyt5K</a:ExternalAccountReferenceNo>
                  <a:FixedTerm>false</a:FixedTerm>
                  <a:LastBillingDate>0001-01-01T00:00:00</a:LastBillingDate>
                  <a:LastReversalReason i:nil="true"/>
                  <a:LastUpdatedDate>2020-07-09T11:55:15.397</a:LastUpdatedDate>
                  <a:MinTermTotalValue>250.00</a:MinTermTotalValue>
                  <a:NextBillingDate>2020-07-26T00:00:00</a:NextBillingDate>
                  <a:OneOffSchedules i:nil="true"/>
                  <a:OutstandingBalance>0</a:OutstandingBalance>
                  <a:OutstandingBalanceWithoutFees>0</a:OutstandingBalanceWithoutFees>
                  <a:OverdueAmount>0</a:OverdueAmount>
                  <a:OverdueAmountWithoutFees>0</a:OverdueAmountWithoutFees>
                  <a:OverdueStatus>0</a:OverdueStatus>
                  <a:PaymentInAdvanceAmount>0</a:PaymentInAdvanceAmount>
                  <a:PaymentInAdvanceEndDate>0001-01-01T00:00:00</a:PaymentInAdvanceEndDate>
                  <a:PaymentStopEndDate>0001-01-01T00:00:00</a:PaymentStopEndDate>
                  <a:PaymentsStopped>false</a:PaymentsStopped>
                  <a:Paymethod>
                     <a:Id i:nil="true"/>
                     <a:AccountHolder>Name on card</a:AccountHolder>
                     <a:AccountNo>411111XXXXXX1111</a:AccountNo>
                     <a:AccountType>CreditCard</a:AccountType>
                     <a:CreditCardType>Visa</a:CreditCardType>
                     <a:ExpiryDate>2021-12-31T00:00:00</a:ExpiryDate>
                  </a:Paymethod>
                  <a:ProjectedFinishDate i:nil="true"/>
                  <a:RecurringSchedules>
                     <a:PaySchedule>
                        <a:Id i:nil="true"/>
                        <a:Description>from automation check</a:Description>
                        <a:Installment>50.00</a:Installment>
                        <a:PaymentFrequency>Weekly</a:PaymentFrequency>
                        <a:ScheduleId>66437790</a:ScheduleId>
                        <a:EndDate>0001-01-01T00:00:00</a:EndDate>
                        <a:StartDate>2020-08-15T00:00:00</a:StartDate>
                     </a:PaySchedule>
                  </a:RecurringSchedules>
                  <a:Suspended>false</a:Suspended>
                  <a:SuspensionEndDate>0001-01-01T00:00:00</a:SuspensionEndDate>
                  <a:SuspensionSchedules i:nil="true"/>
                  <a:Term>5</a:Term>
                  <a:TermType>Payments</a:TermType>
                  <a:CurrentBalance>0</a:CurrentBalance>
                  <a:CurrentBalanceWithoutFees>0</a:CurrentBalanceWithoutFees>
               </a:Account>
               <a:Account>
                  <a:Id i:nil="true"/>
                  <a:AccountCode>DEA2_test</a:AccountCode>
                  <a:AccountNotes>This account created for testing</a:AccountNotes>
                  <a:AccountReferenceNo>DEA2885110</a:AccountReferenceNo>
                  <a:AccountTemplate i:nil="true"/>
                  <a:CancelReason i:nil="true"/>
                  <a:CatchUpAmount>0</a:CatchUpAmount>
                  <a:CatchUpEndDate>0001-01-01T00:00:00</a:CatchUpEndDate>
                  <a:ContractPrefix>DEA2</a:ContractPrefix>
                  <a:CurrentFrequency>FourWeekly</a:CurrentFrequency>
                  <a:CurrentInstalment>10.00</a:CurrentInstalment>
                  <a:Customer>
                     <a:Id i:nil="true"/>
                     <a:Contacts>
                        <a:Id i:nil="true"/>
                        <a:Addresses>
                           <a:Address>
                              <a:Id i:nil="true"/>
                              <a:Preferred>true</a:Preferred>
                              <a:AddressType>Postal</a:AddressType>
                              <a:City>Brisbane</a:City>
                              <a:Country>Australia</a:Country>
                              <a:Locality>Northcote</a:Locality>
                              <a:Postcode>4000</a:Postcode>
                              <a:State>Queensland</a:State>
                              <a:Street>5 The warehouse way</a:Street>
                              <a:Suburb>Northcote</a:Suburb>
                           </a:Address>
                        </a:Addresses>
                        <a:Emails>
                           <a:Email>
                              <a:Id i:nil="true"/>
                              <a:Preferred>true</a:Preferred>
                              <a:EmailAddress>test@debitsuccess.com</a:EmailAddress>
                           </a:Email>
                        </a:Emails>
                        <a:Phones>
                           <a:Phone>
                              <a:Id i:nil="true"/>
                              <a:Preferred>true</a:Preferred>
                              <a:CountryCode>Aus</a:CountryCode>
                              <a:Name>John</a:Name>
                              <a:Number>264 5555</a:Number>
                              <a:PhoneNumberType>Home</a:PhoneNumberType>
                              <a:StdCode>09</a:StdCode>
                           </a:Phone>
                        </a:Phones>
                     </a:Contacts>
                     <a:CustomerDetail>
                        <a:DateOfBirth>2000-01-01T00:00:00</a:DateOfBirth>
                        <a:FirstName>Sergey</a:FirstName>
                        <a:Gender>Male</a:Gender>
                        <a:LastName>Idelson</a:LastName>
                        <a:MiddleName>KC</a:MiddleName>
                        <a:Title>Mr</a:Title>
                     </a:CustomerDetail>
                  </a:Customer>
                  <a:DateAccountClosed>0001-01-01T00:00:00</a:DateAccountClosed>
                  <a:DateAccountLoaded>2020-07-09T08:28:04.707</a:DateAccountLoaded>
                  <a:DateAccountStarted>2020-07-26T00:00:00</a:DateAccountStarted>
                  <a:ExternalAccountReferenceNo>MEL35</a:ExternalAccountReferenceNo>
                  <a:FixedTerm>false</a:FixedTerm>
                  <a:LastBillingDate>0001-01-01T00:00:00</a:LastBillingDate>
                  <a:LastReversalReason i:nil="true"/>
                  <a:LastUpdatedDate>2020-07-09T08:28:04.707</a:LastUpdatedDate>
                  <a:MinTermTotalValue>50.00</a:MinTermTotalValue>
                  <a:NextBillingDate>2020-07-26T00:00:00</a:NextBillingDate>
                  <a:OneOffSchedules i:nil="true"/>
                  <a:OutstandingBalance>0</a:OutstandingBalance>
                  <a:OutstandingBalanceWithoutFees>0</a:OutstandingBalanceWithoutFees>
                  <a:OverdueAmount>0</a:OverdueAmount>
                  <a:OverdueAmountWithoutFees>0</a:OverdueAmountWithoutFees>
                  <a:OverdueStatus>0</a:OverdueStatus>
                  <a:PaymentInAdvanceAmount>0</a:PaymentInAdvanceAmount>
                  <a:PaymentInAdvanceEndDate>0001-01-01T00:00:00</a:PaymentInAdvanceEndDate>
                  <a:PaymentStopEndDate>0001-01-01T00:00:00</a:PaymentStopEndDate>
                  <a:PaymentsStopped>false</a:PaymentsStopped>
                  <a:Paymethod>
                     <a:Id i:nil="true"/>
                     <a:AccountHolder>Name on card</a:AccountHolder>
                     <a:AccountNo>411111XXXXXX1111</a:AccountNo>
                     <a:AccountType>CreditCard</a:AccountType>
                     <a:CreditCardType>Visa</a:CreditCardType>
                     <a:ExpiryDate>2021-12-31T00:00:00</a:ExpiryDate>
                  </a:Paymethod>
                  <a:ProjectedFinishDate i:nil="true"/>
                  <a:RecurringSchedules>
                     <a:PaySchedule>
                        <a:Id i:nil="true"/>
                        <a:Description i:nil="true"/>
                        <a:Installment>10.00</a:Installment>
                        <a:PaymentFrequency>FourWeekly</a:PaymentFrequency>
                        <a:ScheduleId>66437788</a:ScheduleId>
                        <a:EndDate>0001-01-01T00:00:00</a:EndDate>
                        <a:StartDate>2020-07-26T00:00:00</a:StartDate>
                     </a:PaySchedule>
                  </a:RecurringSchedules>
                  <a:Suspended>false</a:Suspended>
                  <a:SuspensionEndDate>0001-01-01T00:00:00</a:SuspensionEndDate>
                  <a:SuspensionSchedules i:nil="true"/>
                  <a:Term>5</a:Term>
                  <a:TermType>Payments</a:TermType>
                  <a:CurrentBalance>0</a:CurrentBalance>
                  <a:CurrentBalanceWithoutFees>0</a:CurrentBalanceWithoutFees>
               </a:Account>
            </a:Accounts>
         </GetCustomerAccountForDateRangeResult>
      </GetCustomerAccountForDateRangeResponse>
   </s:Body>
</s:Envelope>

On this page:

  • No labels

0 Comments

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account.
 

© 2021 Debitsuccess. All rights reserved