Web Services Change History

May 10, 2022

A new SOAP API, GetRefundStatus is created to utilise the new fields ExternalAccountReferenceNo and ExternalRefundIdentifier in the existing InitiateRefund endpoint. The API provides the ability to users (specifically Education) to submit and track the status of a refund.

September 2, 2021

Minor change in PostCustomerAccount, the MiddleName field now allows a maximum of 40 characters instead of 20.

July 15, 2021

In this release, three new fields ContractPrefix, AccountRef, and ErrorCode are included in the API response of SOAP WS GetCustomerPaymentByStatusForDateRange which is used to extract the transaction status for Gateway Model Accounts. This will allow users to know for each transaction which account and business account it belongs to, and what is the error if the transaction is not being processed successfully.

July 8, 2021

The EmailAddress field of SOAP WS request UpdateGuarantorDetails is now mandatory. This will update the customer’s preferred contact accordingly based on the availability of EmailAddress and MobilePhone fields provided.

June 3, 2021

If an account or one-off schedule is created to start on a non-working day, the customer will be billed on the next working day. This behaviour is changed for the following SOAP API calls:

• PostCustomerAccount

• PostCustomerAccountForExistingCustomer

• CreateSchedule 

April 23, 2021

This release includes the following features:

1. Populate Collection Stop Reason as ‘Manual Payment Stop’ when WS StopPayment successfully executed and clear the Collection Stop Reason when WS ResumePayment is successfully executed.

2. Reject WS ResumePayment request if Collection Stop Reason is not ‘Manual Payment Stop’

3. SOAP WS to show a proper error message when the system encounters a Time Out instead of throwing an ‘Unknown Exception’ error.

4. SOAP WS PostCustomerAccount and PostCustomerAccountForExistingCustomer will show a proper error message when fields have exceeded their maximum length allowed instead of throwing an ‘Unknown Exception’ error.

March 25, 2021

1. Changes to WS UpdateClientEmailAddress and UpdateClientPhoneNumber, when updating contacts to 'Preferred' for Customers with Guarantor info. If a customer account has guarantor details then the guarantor contact information (phone number and email address) will always be the preferred contact for the account. 

2. Fix on CreateSchedule WS to display a proper error message 14139 when the Description field exceeded max length.

March 9, 2021

A new validation has been added in UpdateGuarantorDetails WS to ensure that the age of the guarantors is at least 18 based on the DOB field provided in the request.

February 18, 2021

Enhancement to enable users to capture Mobile numbers and email addresses when creating/update guarantor details via WS UpdateGuarantorDetails.

February 4, 2021

This release includes the following features:

1. WS GetCustomerPaymentByStatusForDateRange and GetPaymentHistoryByStatusForDateRange to verify the date range provided (i.e. EndDate - StartDate) must be equal or less than 31 days. Notes: This was previously set as 1 month.

2. WS GetFacilityAccountConfiguration to return PenaltyFeeAmount and PenaltyFeePayer in response

December 1, 2020

A new method GetCustomerPaymentByStatusForAccountId has been implemented that will return the active one-off schedules belonging to the AccountReferenceNo or ExternalAccountReferenceNo provided in the request.

October 1, 2020

Introduced a new SOAP request GetCustomerPaymentByStatusForDateRange. Use the new SOAP API to query one-off payment schedules status by providing the contract prefix, status of the pay schedule, and status effective date range.

March 26, 2020

The PostCustomerAccountForExistingCustomer API has been enhanced to allow integrators to post multiple add-on accounts. Currently, when using PostCustomerAccountforExistingCustomer to create a sub-account, there is a restriction that only one sub-account can be added. We have removed that restriction and allowed multiple sub-accounts to be associated with one primary account.

December 30, 2019

The GetPaymentHistoryWithFeesByDateRange method now returns both fees and charges (non-fee payments such as recurring payments, suspensions, one-off etc.) so that this method can be used to retrieve all types of schedules.

October 16, 2019

Introduced GetCommmissionConfiguration method. This API returns the list of commission configurations based on how many payment types have been set up for that facility.

September 27, 2019

GetPaymentHistory does not currently return information regarding the commission amount Debitsuccess have deducted from a transaction in the response message. To address this issue, a new field CommissionAmount is added to the response message of the following API methods:

• GetPaymentHistoryForDateRange

• GetPaymentHistoryWithFeesByDateRange

• GetPaymentHistoryByAccountID

• GetPaymentHistoryWithFeesByAccountID

The commission amount is calculated as a percentage of the corresponding Payment Type. Fees (of any type marked with **) do not have a CommissionAmount so the field will display as blank/null.

September 20, 2019

The web service messages that return the payment history of accounts include the retry count so that integrators are provided with more information about transactions. A new field RetryCount has been added to the response messages of the following API methods:

• GetPaymentHistoryForDateRange

• GetPaymentHistoryWithFeesByDateRange

• GetPaymentHistoryByAccountID

• GetPaymentHistoryWithFeesByAccountID

RetryCount is the number of attempts made to process the transaction if the payment fails. This can happen if there are insufficient funds in the customer's bank account. If the count is 0, it means it is the initial attempt and the retry count for this transaction is not available.