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

Adjust total value of the account

REST API

Use the Update Account endpoint of Customer Services API to adjust the total value of the account.

PUT https://<ServerURL>/CustomerServices/v1.0/accounts/{accountId}

Provide the following:

  • contractAmount
    contractAmount can be changed to a different value only for fixedTerm accounts. If a new Term value is provided, contractAmount will be auto recalculate again based on the new Term value.

SOAP API

Use the AdjustAccountTotalValue call to change the total value of the account.

When the Account Total Value is changed, the account is automatically converted to a Fixed Term account.

Collections will end once the Total Value has been paid. The account will remain open, but automatically close when it reaches the end of the contract period.

The Total Value of an Account is the minimum amount the Customer must pay before the Account can be closed without further penalties. All Accounts, whatever their contract or Payment Schedule have this value stored in the MinTermTotalValue field of GetCustomerAccountByAccountId.

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:AdjustAccountTotalValue>
        <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:CurrentTotalValue>0</deb1:CurrentTotalValue>
            <deb1:NewTotalValue>100</deb1:NewTotalValue>
         </deb:request>
      </deb:AdjustAccountTotalValue>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <ActivityId CorrelationId="a12e2eb6-3ae4-4fa9-a8f4-e46ec62d4a0b" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">00000000-0000-0000-0000-000000000000</ActivityId>
   </s:Header>
   <s:Body>
      <AdjustAccountTotalValueResponse xmlns="Debitsuccess.WebServices.WCF">
         <AdjustAccountTotalValueResult xmlns:a="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:DateCreated>2020-10-23T15:24:31.3199435+13:00</a:DateCreated>
            <a:Id>bc32f2d7-345b-4c5e-858b-2a65bdf778b0</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>
         </AdjustAccountTotalValueResult>
      </AdjustAccountTotalValueResponse>
   </s:Body>
</s:Envelope>

Adjust the minimum term of the Account

AdjustAccountMINIMUMTerm is used to change the minimum term of on ongoing account.

Not applicable for fixed-term accounts.

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:AdjustAccountMinimumTerm>
         <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>DEA2884204</deb1:AccountReferenceNo>
            <deb1:ExternalAccountReferenceNo></deb1:ExternalAccountReferenceNo>
            <deb1:NewTerm>9</deb1:NewTerm>
            <deb1:NewTermType>Months</deb1:NewTermType>
      </deb:AdjustAccountMinimumTerm>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <ActivityId CorrelationId="0f408836-cb3a-43b4-8c0b-cc95be8a6ebe" 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-11-05T15:48:24.8411134+13:00</a:DateCreated>
            <a:Id>b0a49ab0-f2e5-4584-a54b-414bfb042e74</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>

Change Log

Upcoming APIs and Features

Debitsuccess is always improving how we deliver our service. As part of delivering updated features, we may make some changes that impact how some of our existing APIs return data.

<!-- theme: success -->

Please note that these features are in our roadmap for the next three months but we do not have a definite ETA.

  • A new endpoint for customer services API will be introduced to transfer an account from one business account to another.

  • New customer services API endpoint to create, get, and update guarantor details will soon be available.

  • Enhancement to the Realtime Payment Widget to support account payments.

May 25, 2021

Enhancement to populate standardized 403 error messages when the client attempts to execute API request with the resources provided in the request URL that has not been authorized to them. There are four types of resources i.e., account, customer, business, and business account where each type will return error code 403 with standard errors message depending on the resource type.

May 20, 2021

  • Introduced a new endpoint for customer services API that will retrieve customer payment schedule statuses and other details for Gateway Model accounts.

  • Implemented multilevel permission checks for GET Payment History endpoints by filter off all records that the client do not have access to.

  • Fix to stop 'Overdue' mail if Account has a new schedule created (via POST Account/POST Schedule) to start immediately but after the billing cycle for the day has completed. This is to prevent sending an overdue email to the customer.

May 11, 2021

The Realtime Payment Widget allows you to securely make real-time payments to businesses (Casual Payments). Integration partners can embed this widget into their website and customize it to match their product theme. Widget is essentially an iframe to capture credit card details and use Debitsuccess Payments API to make payments.

Mar 23, 2021

The RestAPI GET Account(s) is enhanced to return the DD Stop reason field in the API Response. If the account status ‘PaymentStopped’ is set to true and has a CollectionStopReason assigned, then it will be shown in the GET Account(s) API response CollectionStopReason field, else an empty string will be returned.

Mar 16, 2010

Introduced a new field Active as an input parameter for GET BusinessAccounts. This field will act as a filter to allow users to retrieve Active or non-Active Business Accounts. Leaving this field as Null/empty will retrieve all Business Accounts.

Feb 23, 2021

Implemented a new REST APIGet Payment Token(for Casual Payment) that generates and returns a PayNow URL link so that integrators can access the link to make a casual payment for a business account.

Feb 11, 2021

A new REST API Get PaymentToken (for Account Payment) has been implemented to generate and return a PayNow URL link so that integrators can access the link to make payment to an account.

Jan 26, 2021

  • The GET Account(s) response message now includes AccountNotes and PaymentMethodToken to be consistent with the POST Account API response.

  • The POST Account response message has been updated with additional 23 fields similar to the response for GET Account.

Oct 29, 2020

All Debitsuccess REST APIs are now available in the production environment. Please contact us to obtain your credentials before using them on production.

Oct 22, 2020

Customer Services REST API is now available in the production environment. Customer API allows the integrator to create, delete, and update the personal and contact detail information of a customer. Fetch specific customer information and list all customers’ details.

On this page:

  • No labels

© 2021 Debitsuccess. All rights reserved