Skip to main content

A Python API wrapper designed to streamline Paystack integrations within Python projects.

Project description

pystack.

A Python API wrapper designed to streamline Paystack integrations within Python projects, (Django, Flask, etc) Paystack does not natively provide an sdk or wrapper client for Python. I was working on a project once and I found myself writing boilerplate code rather than focusing on integrating payments into my service.

Features

  • Initiate and verify payments with Paystack.
  • Resolve card BIN to get card details.
  • Resolve account number to get account details.
  • Simplify recurring charges and subscriptions with Paystack.

Getting Started

The package is available on PyPi. In any project, run: pip3 install pystack.

Usage

  • The first thing to do is to install the PystackClient.
from pystack import PystackClient
  • Obtain your key from Paystack. You could get your key by following these instructions: Paystack Docs
  • Using the pystack client, create an object with your key.
# Create a PaystackClient object
paystack_client = PystackClient(pystack_key=YOUR_KEY)
  • You're set to go.

Making Payments

Below is an example of how the pystack module helps you skip the shenanigans and focus on the payments.

from pystack import PystackClient

# Replace 'YOUR_KEY' with your actual Paystack secret key.
YOUR_KEY = 'YOUR_KEY'

# Create a PaystackClient object
pystack = PystackClient(pystack_key=YOUR_KEY)

# Now we initiate a payment
amount = 5000  # The amount to send in the request
email = 'pystack@pystack.com'  # The customer's email address
payment_response = pystack.initiatePayment(amount=amount, email=email)

Look how much boilerplate code you saved above.

Verifying Transactions

You can also verify transactions through though the pystack module. Here is an example:

from pystack import PystackClient

# Replace 'YOUR_KEY' with your actual Paystack secret key.
YOUR_KEY = 'YOUR_KEY'

# Create a PaystackClient object
pystack = PystackClient(pystack=YOUR_KEY)

# Now we initiate a payment
amount = 5000  # The amount to send in the request
email = 'pystack@pystack.com'  # The customer's email address
payment_response = pystack.initiatePayment(amount=amount, email=email)

# Condition to verify the payment
if payment_response['status']:
    transaction_reference = payment_response['data']['reference']
    verification_response = pystack.verifyPayment(reference=transaction_reference)

    if verification_response['status']:
        print("Payment was successful.")
    else:
        print("Payment verification failed.")
else:
    print("Payment initiation failed.")

Like wise there are other things you could do with Pystack, such as recurring charges, subscriptions, etc. It's up to you to decide what you want to do, and then use it.

License

This project is licensed under the MIT License - see the LICENSE file 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

pystack-sdk-0.1.0.tar.gz (3.5 kB view details)

Uploaded Source

Built Distribution

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

pystack_sdk-0.1.0-py3-none-any.whl (3.2 kB view details)

Uploaded Python 3

File details

Details for the file pystack-sdk-0.1.0.tar.gz.

File metadata

  • Download URL: pystack-sdk-0.1.0.tar.gz
  • Upload date:
  • Size: 3.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for pystack-sdk-0.1.0.tar.gz
Algorithm Hash digest
SHA256 30a919200ec82286b2348fe39d84d4a3e3e7bc0d78d413c7acf5c2aa20e7d0ae
MD5 4118fe95605ecac9c8b2fdbc07043fdf
BLAKE2b-256 42e69b2ee9a55c28d6d514ad85c0e2b38dc062c43e7d196a9bfcf3da906cefd6

See more details on using hashes here.

File details

Details for the file pystack_sdk-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: pystack_sdk-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 3.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for pystack_sdk-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0080c74b25bf353bf689ceda4545721c4e6dc9cc4e514d2896445b201e156eb8
MD5 8fd3cd04f6f48f147ae033bef37f084e
BLAKE2b-256 90b8b81a0ebb089a68443aad0a3ea71c3802cbcbb79cd3cc3002bcd5fa786e46

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