python-getpaid-core

Framework-agnostic payment processing core.

python-getpaid-core is the foundation of the Getpaid ecosystem. It provides the abstract interfaces, semantic payment update engine, and plugin registry needed to build a robust payment system without coupling your logic to a specific web framework or payment provider.

Installation

pip install python-getpaid-core

Quick Start: Creating a Custom Processor

To implement a new payment backend, subclass BaseProcessor and implement at least prepare_transaction.

from getpaid_core import BaseProcessor
from getpaid_core.types import TransactionResult

class MyPaymentProcessor(BaseProcessor):
    slug = "my-provider"
    display_name = "My Payment Provider"
    accepted_currencies = ["USD", "EUR"]

    async def prepare_transaction(self, **kwargs) -> TransactionResult:
        # Generate payment link or form data
        return TransactionResult(
            redirect_url=f"https://api.provider.com/pay/{self.payment.id}",
            method="GET"
        )

Registering your Processor

Register your processor using entry points in your pyproject.toml so it can be discovered by the registry:

[project.entry-points."getpaid.backends"]
my-provider = "my_package.processors:MyPaymentProcessor"

Architecture Overview

• BaseProcessor: The abstract base class that all payment gateway plugins must implement. It provides the standard interface for transaction preparation, callback handling, charging, and refunds.
• PaymentFlow: Manages the payment lifecycle using semantic payment update objects. It ensures that payments move between states (e.g., NEW -> PREPARED -> PAID) according to strict business rules.
• PluginRegistry: A central service for discovering and managing payment processors registered via getpaid.backends entry points.
• State Engine: Applies semantic payment and fraud events to payment objects, merges provider metadata, and tracks idempotent provider event IDs.

API Summary

Ecosystem

getpaid-core is the heart of a larger ecosystem designed to make payment processing easy in any Python web application.

Framework Wrappers

• django-getpaid — Official Django integration.
• litestar-getpaid — Official Litestar integration.
• fastapi-getpaid — Official FastAPI integration.

Processor Plugins

• python-getpaid-payu — PayU backend.
• python-getpaid-paynow — Paynow backend.
• python-getpaid-bitpay — BitPay backend.
• python-getpaid-przelewy24 — Przelewy24 backend.

License

This project is licensed under the MIT License.