Skip to content

Added Mock Server Link for better developer experience #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ankitjaininfo wants to merge 1 commit into
base: Latest
Choose a base branch
from
Open

Added Mock Server Link for better developer experience #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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) | <a href="https://beeceptor.com/openapi-mock-server/?utm_source=github&utm_campaign=debitsuccess&url=https://raw.githubusercontent.com/Debitsuccess/debitsuccess-api/refs/heads/Latest/Customer-Sign-up-API.v1.yaml" target="_blank"><img src="https://cdn.beeceptor.com/assets/images/buttons/mock-openapi-with-beeceptor.png" alt="Mock These APIs Instantly" style="height: 60px;"></a>|
|[Customer Services API](https://debitsuccess.stoplight.io/docs/debitsuccess-api/308f219028e8a-customer-services-api)| <a href="https://beeceptor.com/openapi-mock-server/?utm_source=github&utm_campaign=debitsuccess&url=https://raw.githubusercontent.com/Debitsuccess/debitsuccess-api/refs/heads/Latest/CustomerServicesApi.v1.yaml" target="_blank"><img src="https://cdn.beeceptor.com/assets/images/buttons/mock-openapi-with-beeceptor.png" alt="Mock These APIs Instantly" style="height: 60px;"></a>|
|[Payments API](https://debitsuccess.stoplight.io/docs/debitsuccess-api/d12556fc3ebfa-payments-api)|<a href="https://beeceptor.com/openapi-mock-server/?utm_source=github&utm_campaign=debitsuccess&url=https://raw.githubusercontent.com/Debitsuccess/debitsuccess-api/refs/heads/Latest/PaymentsAPI.v1.json" target="_blank"><img src="https://cdn.beeceptor.com/assets/images/buttons/mock-openapi-with-beeceptor.png" alt="Mock These APIs Instantly" style="height: 60px;"></a>|