Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/own-pay/OwnPay-Documentation/llms.txt

Use this file to discover all available pages before exploring further.

OwnPay is a self-hosted, open-source payment gateway platform that puts you in complete control of payment processing. Deploy it on your own infrastructure, manage multiple merchant brands from one installation, and integrate via a clean REST API — no third-party intermediaries, no per-transaction SaaS fees.

Get Started

Install OwnPay, meet system requirements, and complete your first payment in minutes.

Developer Quickstart

Generate API keys, create a payment intent, and handle webhooks in 5 minutes.

REST API Reference

Full endpoint reference: payments, transactions, refunds, customers, and API keys.

Plugin System

Extend OwnPay with gateway, addon, and theme plugins without modifying core code.

What is OwnPay?

OwnPay is infrastructure you deploy and own. Unlike SaaS payment processors, OwnPay runs entirely on your server — you control the database, credentials, and transaction ledger. A single installation supports multiple isolated merchant brands, each with their own customers, gateways, checkout domains, and staff.

Multi-Brand

Run multiple white-labeled merchant stores from one platform, each fully isolated.

Double-Entry Ledger

Every transaction is recorded with double-entry bookkeeping for guaranteed financial integrity.

Plugin Extensible

Add payment gateways, features, and themes through a structured plugin architecture.

API-First

REST API with scoped Bearer keys, webhook delivery logs, and HMAC signature verification.

Mobile SMS Gateway

Pair Android phones to auto-parse local mobile banking SMS alerts (bKash, Nagad, etc.).

RBAC Permissions

Role-based access control for staff across all brands with granular permission scopes.

Choose Your Path

1

Install OwnPay

Review system requirements and follow the installation guide to deploy on your server.
2

Configure Your First Brand

Log in as administrator, create a brand, and add a payment gateway.
3

Integrate via API

Generate an API key and follow the developer quickstart to create your first payment intent.
4

Go Live

Set up webhooks for payment notifications, configure custom domains, and enable two-factor auth for your team.

Explore the Documentation

User Guide

Administrator guide covering payments, gateways, brands, staff, reports, and system settings.

Core Concepts

Understand the architecture: multi-brand scoping, payment flow, roles, and webhooks.

SDK Integrations

PHP and Node.js SDKs, WooCommerce plugin, and language-specific integration guides.

Resources

Architecture overview, feature list, glossary, contributing guide, and roadmap.
OwnPay is licensed under AGPL-3.0. Source code and issue tracker are on GitHub. Interactive API documentation is available at docs.ownpay.org.

Build docs developers (and LLMs) love