PaySuper Management API
PaySuper is a unique, simple payment toolkit designed to make developers self-reliant. It’s an open-source payment service with a highly customizable payment form, an intuitive API, and comprehensible, eye-catching reports.
PaySuper Management API is a REST API backend for the Dashboard and the Payment Form.
Table of Contents
API Reference
PaySuper Management API consists of public API methods which paths start with the /api/v1/
and are documented in the API Reference.
This project also contains internal API methods which paths start with /system/
and /admin/
.
Developing
Branches
We use the GitFlow as a branching model for Git.
Versioning
PaySuper Management API uses the endpoint versioning. The current version is /v1
.
Tests
Every API method is covered by tests. The tests classes located in the same directory internal/handlers
with code classes and have suffix _test
at the end of its titles.
Test resources located in the test
directory.
Terms
Accounting currency
PSP Currency
- used to save the amount of the payment transaction in the PSP accounting currency. PSP currency can be set using the environment variable named "PSP_ACCOUNTING_CURRENCY"
Merchant currency
- used to save the amount of the payment transaction in the merchant (projects owner) accounting currency. Merchant currency can be set using merchant settings in PSP control panel.
Payment system currency
- used to save the amount of the payment transaction in the payment system (payment methods owner) accounting currency. Payment system currency can be set using payment system settings in PSP admin panel.
Contributing, Support, Feature Requests
If you like this project then you can put a ⭐️ on it. It means a lot to us.
If you have an idea of how to improve PaySuper (or any of the product parts) or have general feedback, you're welcome to submit a feature request.
Chances are, you like what we have already but you may require a custom integration, a special license or something else big and specific to your needs. We're generally open to such conversations.
If you have a question and can't find the answer yourself, you can raise an issue and describe what exactly you're trying to do. We'll do our best to reply in a meaningful time.
We feel that a welcoming community is important and we ask that you follow PaySuper's Open Source Code of Conduct in all interactions with the community.
PaySuper welcomes contributions from anyone and everyone. Please refer to our contribution guide to learn more.
License
The project is available as open source under the terms of the GPL v3 License.