Get Started
Welcome to the Sticitt Partner API. This platform allows third-party integrators to interact seamlessly with the Sticitt payment ecosystem.
Whether you are building a simple checkout flow for a school or a complex enterprise management system, this guide will help you choose the right path.
1. Choose your Integration Type
To ensure you have the most efficient integration experience, we categorize partners into two distinct groups.
Payment Integrators
For third parties who simply need to accept payments. If you are a ticketing platform, a tuck shop POS, or an event organizer wanting to let users pay via Sticitt, this is you. You will primarily utilize our Payment and Terminal APIs alongside our JavaScript SDK to process transactions.
Enterprise Partners
For platforms managing the full financial lifecycle. If you are a large-scale administrator requiring the ability to onboard new Merchants (schools), create Wallets for users, and manage detailed transaction histories, you fit the Enterprise category.
Head over to the Authentication guide to get your API keys and make your first request.
2. Explore the API Modules
The Partner API is modular. Depending on your partner type, you will interact with specific domains of the system.
Domain Breakdown
To help you navigate the documentation, here is a quick summary of what each API module controls.
| API Domain | Description | Relevant For |
|---|---|---|
| Payment API | The core payment engine. Use this to initiate payments, check payment status, and retrieve payment history. | All Partners |
| Terminal API | Manage merchant terminals, and push payments to terminals. | All Partners |
| Merchant API | Allows for the onboarding and management of Merchants (e.g., Schools) and the retrieval of their comprehensive transaction logs. | Enterprise Only |
| Wallet API | Allows for the creation and management of user Wallets (e.g., for Parents or Students), querying balances, and executing payments on their behalf. | Enterprise Only |
3. Your Integration Roadmap
Ready to write code? Follow these steps to get your integration running.
- Get Credentials: You cannot generate your own Client ID and Secret. You must contact Sticitt directly to have your partner account verified and credentials issued.
- Select Environment: Point your requests to our Sandbox (Test) environment during development.
- Authenticate: Learn how to exchange your credentials for a Bearer Token.
- Build the Flow: Follow our Payment Lifecycle guide to make your first transaction.
If you have not received your credentials yet, or if you are unsure which integration type fits your business model, please reach out to our technical team at technology@sticitt.co.za.