# Debitsuccess Rest API Reference #### With Debitsuccess, you can: - Onboard new customers using account templates. - Manage customer details, payment schedules, account information, view payment history, and much more. - Process casual payments, set up direct debits, capture new payment details, process real-time payment, and collect payments at clubs. Dig into our [documentation and quickstarts](https://debitsuccess.atlassian.net/wiki/spaces/DDE/overview) to get started with our APIS, understand our system, use cases, SOAP APIs, webhooks and much more. The Debitsuccess API referencedocumentation has you covered with interactive API console, code samples in your favorite languages, and comprehensive examples. --- ![get-started-icon](https://img.icons8.com/cotton/128/000000/launch-rocket.png) ## Getting Started Integrating Debitsuccess into your platform can begin as soon as you contact us, requiring only four steps: 1. Contact us via the [Debitsuccess website](https://www.debitsuccess.com.au/api-web-services/). One of our Business Development Managers will be in touch with you. You will then receive an email with credentials and endpoint details for the sandbox environment. 2. Obtain your [API keys](https://debitsuccess.stoplight.io/docs/debitsuccess-api/docs/Introduction/2-Authentication.md) so Debitsuccess can authenticate your API requests. 3. Test your integration in our [sandbox environment](https://debitsuccess.atlassian.net/wiki/spaces/DDE/pages/984778280/Quick+Start#Sandbox). 4. Deploy your integration in our [production environment](https://debitsuccess.atlassian.net/wiki/spaces/DDE/pages/984778280/Quick+Start#Production). --- ![tutorial-icon](https://img.icons8.com/cotton/128/000000/abc.png) ## Tutorials Have a particular problem you're looking to solve? [Explore these use cases](https://debitsuccess.atlassian.net/wiki/spaces/DDE/pages/986156090/Use+Cases). --- ![search-in-cloud](https://img.icons8.com/cotton/64/000000/search-in-cloud.png) ## Explore APIs Take a look at our APIs and imagine what you could build. ![](https://drive.google.com/uc?export=view&id=1wPPYU8jy4qL02sUMw4plbrFeC_uTDF_E) Use this API to Sign up new customers. **Host URL:** https://oc-test.debitsuccess.com/DirectEntry/api/v1.0 **Resources:** - [Getting Started](https://debitsuccess.atlassian.net/wiki/spaces/DDE/pages/984778280/Quick+Start) - [API Reference](https://debitsuccess.stoplight.io/docs/debitsuccess-api/Customer-Sign-up-API.v1.yaml) - [Try out API](https://debitsuccess.stoplight.io/docs/debitsuccess-api/Customer-Sign-up-API.v1.yaml/paths/~1accounttemplates/post) ![](https://drive.google.com/uc?export=view&id=1gmkI7FnAhla_QJXDPIksTD10vdrS_hU3) Use this API to manage customer account, customer details, schedules get payment history etc. **Host URL:** https://oc-test.debitsuccess.com/payments/v1.0 **Resources:** - [Getting Started](https://debitsuccess.atlassian.net/wiki/spaces/DDE/pages/984778280/Quick+Start) - [API Reference](https://debitsuccess.stoplight.io/docs/debitsuccess-api/CustomerServicesApi.yaml) - [Try out API](https://debitsuccess.stoplight.io/docs/debitsuccess-api/CustomerServicesApi.yaml/paths/~1customers/post) ![](https://drive.google.com/uc?export=view&id=1JayBpSpqPi6tTsozcnd2D7KesIjHALd6) Use this API to Process casual payments, set up direct debits, capture new payment details, process real-time payment, and collect payments at clubs. **Host URL:** https://oc-test.debitsuccess.com/payments/v1.0 **Resources:** - [Getting Started](https://debitsuccess.atlassian.net/wiki/spaces/DDE/pages/984778280/Quick+Start) - [API Reference](https://debitsuccess.stoplight.io/docs/debitsuccess-api/PaymentsAPI.v1.json) - [Try out API](https://debitsuccess.stoplight.io/docs/debitsuccess-api/PaymentsAPI.v1.json/paths/~1account~1creditcard/post) ![](https://drive.google.com/uc?export=view&id=1VrjRQqDmjB5tNIJZL9kgfODk8XvEECmP) Easily embed these widgets into your website and customize it to match your product theme. - [Payment Method Capture Widget](../Widgets/Payment-Capture-Widget.md) - [Realtime Payment Widget](../Widgets/Real-time-payment-widget.md) --- ![faqs-icon](https://img.icons8.com/cotton/64/000000/scroll--v1.png) ## FAQs **How do I get a test account?** Talk to your account manager or business development manager. We will then create a set of credentials for our sandbox environment. **What host URL do I connect to for test and production?** Test Environment: https://oc-test.debitsuccess.com Production Environment: https://oc.debitsuccess.com **Do I use the same URL for both NZ and Australian clients/customers?** Yes. For testing your application against Debitsuccess web-services, you can use the following URL for Australian and New Zealand facilities: https://oc-test.services.debitsuccess.com/DSWebService/ **What payment methods does Debitsuccess support?** We support Bank account transfer (direct debit), and accept the following cards: Visa, Master Card, Amex on request. For more information see, Payment Methods Supported. **How do I find out what changes to the web services are coming up or have been deployed?** Any changes to the APIs will be listed in the REST and SOAP change history. Major upcoming changes will be listed on the future changes page. We will typically deploy into the test environment before pushing a change into production. **How do I control the outcome of a payment? ** Only pre-approved test credit card and bank numbers should be used as a payment method for simulating particular outcomes, see Data for Test Environment. Click [here for more FAQs.](https://debitsuccess.atlassian.net/wiki/spaces/DDE/pages/984777895/FAQs) --- ![support-icon](https://img.icons8.com/cotton/64/000000/technical-support.png) ## We're Here to Help Get in touch and let us know how we can help. Debitsuccess has an expert Integration Support Team who will assist you through your integration journey with us. You may request support anytime simply by emailing us. [TestAPI.Support@debitsuccess.com](mailto:TestAPI.Support@debitsuccess.com) [LiveAPI.Support@debitsuccess.com](mailto:LiveAPI.Support@debitsuccess.com) For any other queries, contact our Account Management team: AUS – [account.m@debitsuccess.com](mailto:account.m@debitsuccess.com) or on 1300 473 463 NZ – [nzaccountmanager@debitsuccess.co.nz](mailto:nzaccountmanager@debitsuccess.co.nz)