PaySuper Billing Server

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.

Features

• 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).

Table of Contents

• Getting Started
  • Architecture
• Developing
  • Branches
  • Docker deployment
  • Starting the application
• Contributing
• License

Getting Started

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.

Architecture

Developing

Branches

We use the GitFlow as a branching model for Git.

Docker deployment

docker build -f Dockerfile -t paysuper_billing_service

docker run -d -e "MONGO_DSN=mongodb://127.0.0.1:27017/billing_repository" -e "CACHE_PROJECT_PAYMENT_METHOD_TIMEOUT=600" paysuper_billing_service

Starting the application

Billing 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.
• rebuild_accounting_entries - to rebuild accounting entries and order view for passed orderid. Full command looks like, for example, -task=rebuild_accounting_entries -orderid=5f0d19a5eb851d9ee7935ffa -force=true where -orderid is id of order, and -force is flag to delete old accounting entries (if exists) and create new ones.

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 :)

Environment variables

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.