Onboarding Customers.

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 ongoing 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 the 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 them in your website and save payment details in Debitsuccess systems.

Open

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.