diff --git a/README.md b/README.md index e01102b..88f7074 100644 --- a/README.md +++ b/README.md @@ -1 +1,13 @@ -This repository contains documentation available on https://debitsuccess.stoplight.io/ +[Debitsuccess](https://debitsuccess.com.au/) is a trusted provider of recurring payment solutions across Australia and New Zealand, helping businesses automate direct debit and credit card billing. The Debitsuccess Payments API enables seamless integration with their payment platform, allowing developers to manage customers, create payment arrangements, and track transactions programmatically. + +This repository contains the latest version of the [Debitsuccess REST API reference documentation](https://debitsuccess.stoplight.io), maintained via Stoplight. This is the primary resource for developers integrating with Debitsuccess's RESTful APIs for managing customers, payments, and billing arrangements. + +### Mock Server + +You can create an API mock server using the OpenAPI contract definitions. This is a faster way to start integrations with Debitsuccess while the API enablement, account setup and access keys are being created. Here are the direct links to Beeceptor, where you can create a one-click API mock server with test data. + +| API Name | Mock Server | +|--------------|-----| +|[Customer Sign-up API (OMG API)](https://debitsuccess.stoplight.io/docs/debitsuccess-api/152afee9d8a8d-customer-sign-up-api) | Mock These APIs Instantly| +|[Customer Services API](https://debitsuccess.stoplight.io/docs/debitsuccess-api/308f219028e8a-customer-services-api)| Mock These APIs Instantly| +|[Payments API](https://debitsuccess.stoplight.io/docs/debitsuccess-api/d12556fc3ebfa-payments-api)|Mock These APIs Instantly|