REST API

Debitsuccess APIs are REST-based with resource-oriented URLs and use HTTP based response codes to indicate API errors. We have grouped our APIs by function, each API contains the resources you will need to integrate into your interface to allow you to access the features for a different area of the Debitsuccess service.

Widgets

Embed our widgets into your website and customize them to match your product theme.

Resources

Customer Sign-up API

Onboard new customers using account templates.

Host URL:

Test: https://oc-test.debitsuccess.com/DirectEntry/api/v1.0

Live: https://oc.debitsuccess.com/DirectEntry/api/v1.0

Resources

Online Management Gateway API

Customer Services API

Manage customer details, payment schedules, account information, view payment history, and much more.

Host URL:

Test: https://oc-test.debitsuccess.com/CustomerServices/v1.0

Live: https://oc.debitsuccess.com/CustomerServices/v1.0

Identity URLs:

OC-Test : https://oc-test.debitsuccess.com/Identity
OC-SBOX : https://oc-sbox.debitsuccess.com/Identity
Production : https://oc.debitsuccess.com/Identity

Resources

Payments API

Process casual payments, set up direct debits, capture new payment details, process real-time payment, and collect payments at clubs.

Host URL:

Test: https://oc-test.debitsuccess.com/payments/v1.0

Live: https://oc.debitsuccess.com/payments/v1.0

Resources

Quick Links

Get Started
Authentication HTTP Requests Response Codes Change history SDK

Other Resources
Release Updates Reference Glossary