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.
Billing Server is a core and heart of all PaySuper for a payment processing business logic. It is designed to be mediator micro-service for Management API covering all REST API for based interfaces for Dashboard and Payment Form. PaySuper Management API is documented in the API Reference.
Learn more about a payments flow and PaySuper Checkout integration.
| PaySuper Service Architecture | |
|---|---|
| ✨ | Checkout integration. PaySuper JS SDK is designed to integrate a Checkout Form on a merchant's website or a game client. |
| 💵 | Frontend for a payment form. PaySuper Checkout Form is a frontend for a sigle-page application with a payment form. |
| 📊 | Frontend for a merchant. PaySuper Dashboard is the BFF server and frontend to interact with all PaySuper related features for merchants. |
| 🔧 | API Backend. PaySuper Management API is a REST API backend for the PaySuper Dashboard and the PaySuper Checkout Form. Public API methods are documented in the API Reference. |
| 💳 | Payment processing. Billing Server is a micro-service that provides with any payment processing business logic. |
-
Support for the payment tokens for the order and user data.
-
PaySuper can securely store your customer’s billing address and the payment method data to prefill the Checkout Form with. The customer has to agree for this to happen.
-
VAT/Sales tax have a clear and automatic calculation.
-
Payment Link feature.
-
Detailed statistics for each transaction.
-
Transparent payout calculation.
-
Recurring invoices (work is in progress).
Billing Server is designed to be cloud agnostic application. In general we use Kubernetes based installation to launch PaySuper in a dev environment cloud and AWS for production.
We use the GitFlow as a branching model for Git.
docker build -f Dockerfile -t paysuper_billing_service .
docker run -d -e "MONGO_HOST=127.0.0.1:27017" -e "MONGO_DB="paysuper" ... e="CACHE_PROJECT_PAYMENT_METHOD_TIMEOUT=600" paysuper_billing_serviceBilling Server application can be started in 2 modes:
- as microservice, to maintain rates requests from other components of system. This mode does not requests any rates
- as console app, to run the tasks, that passed as command line argument
Console mode can be used with cron schedule.
To start app in console mode you must set -task flag in command line to one of these values:
vat_reports- to update vat reports data. This task must be run every day, at the end of day.royalty_reports- to build royalty reports for merchants. This task must be run once on a week.royalty_reports_accept- to auto-accept toyalty reports. This task must be run daily.
Notice: for vat-reports task you may pass an report date (from past only!) for that you need get an report.
Date passed as date parameter, in YYYY-MM-DD format
Example: $ paysuper-billing-server.exe -task=vat_reports -date="2018-12-31" runs VAT reports calculation for
last day of December, 2018.
To run application as microservice simply don't pass any flags to command line :)
| Name | Description |
|---|---|
| MONGO_DSN | MongoBD DSN connection string |
| MONGO_DIAL_TIMEOUT | MongoBD dial timeout in seconds |
| PSP_ACCOUNTING_CURRENCY | PaySuper accounting currency |
| METRICS_PORT | Http server port for health and metrics request |
| CENTRIFUGO_SECRET | Centrifugo secret key |
| CENTRIFUGO_API_SECRET | Centrifugo API secret key |
| BROKER_ADDRESS | RabbitMQ url address |
| CARD_PAY_API_URL | CardPay API url to process payments, more in documentation |
| CACHE_REDIS_ADDRESS | A seed list of host:port addresses of cluster nodes |
| CACHE_REDIS_PASSWORD | Password for connection string |
| CACHE_REDIS_POOL_SIZE | PoolSize applies per cluster node and not for the whole cluster |
| CACHE_REDIS_MAX_RETRIES | Maximum retries for connection |
| CACHE_REDIS_MAX_REDIRECTS | The maximum number of retries before giving up |
| CACHE_REDIS_VERSION | Version of cache (if you need to flush all cache) |
| CUSTOMER_COOKIE_PUBLIC_KEY | Base64 encoded RSA public key - used for encrypt customer browser cookies content. Minimal length of RSA public key must be 4096 |
| CUSTOMER_COOKIE_PRIVATE_KEY | Base64 encoded RSA private key - used for decrypt customer browser cookies content. Minimal length of RSA private key must be 4096 |
| REDIS_HOST | Redis server host |
| REDIS_PASSWORD | Password to access to Redis server |
| CENTRIFUGO_MERCHANT_CHANNEL | Centrifugo channel name to send notifications to merchant |
| CENTRIFUGO_FINANCIER_CHANNEL | Centrifugo channel name to send notifications to financier |
| EMAIL_NOTIFICATION_FINANCIER_RECIPIENT | Email of financier, to get vat reports notification |
| EMAIL_CONFIRM_URL | Url to use in template of confirmation email |
| EMAIL_CONFIRM_TEMPLATE | Confirmation email template name |
| EMAIL_NEW_ROYALTY_REPORT_TEMPLATE | New royalty report notification email template name |
| EMAIL_UPDATE_ROYALTY_REPORT_TEMPLATE | Royalty report update notification email template name |
| EMAIL_VAT_REPORT_TEMPLATE | New vat report notification email template name |
| EMAIL_NEW_PAYOUT_TEMPLATE | New payout notification email template name |
| HELLO_SIGN_DEFAULT_TEMPLATE | License agreement template identifier in HelloSign |
| HELLO_SIGN_AGREEMENT_CLIENT_ID | Client application identifier in HelloSign for Merchant Agreement sign |
| KEY_DAEMON_RESTART_INTERVAL | Starting frequency in seconds of the script to check the locked keys and return them to the stack. |
| EMAIL_ACTIVATION_CODE_TEMPLATE | Postmark Email template id for sending to user with activation code |
| PAYLINK_MIN_PRODUCTS | Minimum number of products allowed for one payment link (must be >= 1) |
| PAYLINK_MAX_PRODUCTS | Maximum number of products allowed for one payment link |
| EMAIL_MERCHANT_NEW_ONBOARDING_REQUEST_TEMPLATE | New onboarding request letter to merchant template |
| EMAIL_ADMIN_NEW_ONBOARDING_REQUEST_TEMPLATE | New onboarding request letter to admin template |
| EMAIL_MERCHANT_ONBOARDING_REQUEST_COMPLETE_TEMPLATE | Onboarding request complated letter to merchant template |
| EMAIL_ONBOARDING_ADMIN_RECIPIENT | Email of onboarding administrator |
| MIGRATIONS_LOCK_TIMEOUT | Timeout for process db migrations on app start |
| USER_INVITE_TOKEN_SECRET | Secret key for generation invitation token of user |
| USER_INVITE_TOKEN_TIMEOUT | Timeout in hours for lifetime of invitation token of user |
| DASHBOARD_URL | URL of dashboard for generate links in a notifications |
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.
The project is available as open source under the terms of the GPL v3 License.