Skip to main content

Modern, test-driven Python client for the Paystack API — built to save you time integrating into Python projects.

Project description

Paystack API Wrapper

PyPI Version Python Versions Build Coverage License

A clean, intuitive, and reliable Python wrapper for the Paystack API.

This library was built to eliminate repetitive boilerplate when integrating Paystack into your Python projects, while emphasizing modern design, robust error handling, and a test-driven foundation. Covers the full API with clean abstractions, so you can focus on building features—not handling payments.

See the Paystack API docs for reference, and explore the Usage Guide for practical examples.


Installation

pip install paystack-api-wrapper

Quick Start

  1. Initialize the client with your secret key

    (Best practice: store your secret key as an environment variable PAYSTACK_SECRET_KEY.)

    import os
    from paystack import PaystackClient, APIError
    
    secret_key = os.getenv("PAYSTACK_SECRET_KEY")
    client = PaystackClient(secret_key=secret_key)
    
  2. Make an API call (e.g., initialize a transaction):

    try:
        data, meta = client.transactions.initialize(
            email="customer@example.com",
            amount=50000,  # amount in kobo
            currency="NGN"
        )
        print("Transaction initialized:", data)
        # {'authorization_url': '...', 'access_code': '...', 'reference': '...'}
    
    except APIError as e:
        print(f"API error: {e.message}")
    

See the Full Usage Guide for details on handling responses, pagination, and advanced error management.


Available APIs

The client exposes all major Paystack API resources as properties:

  • apple_pay
  • bulk_charges
  • charge
  • customers
  • dedicated_virtual_accounts
  • direct_debit
  • disputes
  • integration
  • miscellaneous
  • payment_pages
  • payment_requests
  • plans
  • products
  • refunds
  • settlements
  • subaccounts
  • subscriptions
  • terminal
  • transactions
  • transaction_splits
  • transfers
  • transfers_control
  • transfer_recipients
  • verification
  • virtual_terminal

Contributing

Contributions are welcome! Check out the contributing guide to get started.


License

MIT © Joseph Ezekiel – see LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

paystack_api_wrapper-2.tar.gz (125.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

paystack_api_wrapper-2-py3-none-any.whl (57.5 kB view details)

Uploaded Python 3

File details

Details for the file paystack_api_wrapper-2.tar.gz.

File metadata

  • Download URL: paystack_api_wrapper-2.tar.gz
  • Upload date:
  • Size: 125.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.7

File hashes

Hashes for paystack_api_wrapper-2.tar.gz
Algorithm Hash digest
SHA256 881ffd6425f56257f236dec2e069402c7e14b52fd4bd5711aae1dc3d48cdd4f2
MD5 8bef633bc9da72a6436c1e65fbb74206
BLAKE2b-256 3d5af502c12142e90be484de56f6740dc5a913a643c1795986bbc8e649a1db4b

See more details on using hashes here.

File details

Details for the file paystack_api_wrapper-2-py3-none-any.whl.

File metadata

File hashes

Hashes for paystack_api_wrapper-2-py3-none-any.whl
Algorithm Hash digest
SHA256 de1bc4ce05055d4d3b2ef4a0d4d01c41f61d881553f2bd7941f9927413b25bc6
MD5 f457bf8b43d4a6ab7138330019cf9016
BLAKE2b-256 8b6c686ec355612e355fa6d67d544d57471ff5ecab503a1f9284605dcfa28a92

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page