SOAP Web Services

The SOAP web services provide a set of methods for onboarding customers. It allows you to either make a single request to load all required information or make multiple requests depending on your process and requirements (for example you may use PostCustomerAccount to load customer, account and schedule information but then use the DS hosted form (initiated by calling GetPaymentToken) to capture the payment method information (credit card or bank account) to reduce your exposure to PCI assessment requirements.

The below use cases detail some of the common requirements you will have:

Retrieve business information (fees, commissions, T&Cs)

Create a customer account for an on-going gym membership

On-board a customer account for a fixed cost course or product

On-board a customer account for gateway payments

Capture payment method details using hosted payments form

Load a recurring schedule / Load a one off schedule

RESTful APIs

The RESTful APIs provide similar functionality to SOAP and the use cases in that section also apply to REST.

Embeddable JavaScript Payment Capture Widget

The REST APIs do not currently support use of the hosted payment form to capture credit card or bank account information, but we do provide a Payment Capture Widget to allow you to securely capture payment details (credit card and bank account) by embedding it in your website and save payment details in Debitsuccess systems.

Web Direct Entry (WDE)

It is a web-based application that allows the customer to complete the Direct Debit form on-site on-screen rather than on paper including their personal signatures. This application is integrated with the Debitsuccess Portal.

Device agnostic - can be used on any PC, iPad, or tablet
Interactive portal for customer to sign up onsite guided by staff
The contract is emailed to customer and business once submitted
Credit card details are validated before submission
Recurring and one-off payments are accepted
Promotional and multiple recurring payment schedules can be added
The contract is loaded into Debitsuccess instantly
Both customer and client staff signatures are required to submit the contract
Entering contracts as a Data Entry Tool available and offline contracts can be downloaded

Online Management Gateway (OMG)

OMG is a web-app used for onboarding customers remotely. With OMG’s Direct Debit Request (DDR) form, there is no need for the prospective customer to visit the facility in-person, instead, a URL can be linked to their website or the social media pages to create a purchase. This application is integrated with the Debitsuccess Portal.

Allows customers to sign up via a webpage styled by a client
The payment plan is configured by client and pre-populated on the webpage
The customer is required to add personal and banking details
Can be displayed on the client’s website, emailed to prospects, posted on social networks, or used in marketing campaigns
No signature required
Can sign up a minor with guarantor information required
The contract is loaded into Debitsuccess instantly
Welcome email text can be configured by the client and the PDF Contract is emailed to customer’s email address once submitted

For detailed information, see Online Management Gateway.

Online Management Gateway API (OMG API)

The online management gateway API allows the creation of an account template using REST API. The account templates are used to signup new customers via OMG’s Direct Debit Request (DDR) form of Debitsuccess Online management gateway web application.

The current implementation of OMG API exposes two endpoints:

Account Templates endpoint - to create account template based on the details provided.
Diagnostics - to ping the API

For detailed information, see Documentation on Online Management Gateway API.

Browser not supported