This is a simple api wrapper that implements both asynchronous and synchronous http requests to interact with Paystack APIs.
Project description
PayStackEase Library
PayStackEase API Library is a Python library that simplifies interacting with the Paystack API. It provides both asynchronous and synchronous wrappers for various Paystack functionalities, making it easier to integrate payment processing into your Python projects.
📝: Read more on paystack api documentation: Paystack API DOCUMENTATION
📝: Read more on paystackease api documentation: PayStackEase DOCUMENTATION
Getting Started
You should create a Paystack account to generate a Paystack Secret Key. You can see this in the settings page >> API keys and Webhook section.
⚠️: Warning: Do not expose your secret key or commit your secret key to git, or use them in client-side code.
💡: Take Note: Public key is to be used from your front-end when integrating using Paystack Inline. In this case you have to use you secret key
✅: Good: Set your secret key in environment variables as seen: PAYSTACK_SECRET_KEY=your-secret-key
Create a Virtual Environment
-
For Windows:
-
Create virtual environment
py -m venv <environment_name>
-
Activate the virtual environment
<environment_name>\Scripts\activate
-
-
For Unix/macOS
-
Create virtual environment
python3 -m venv <environment_name>
-
Activate the virtual environment
<environment_name>/bin/activate
-
Install paystackease library:
-
Install paystackease using pip.
pip install paystackease
-
Install paystackease using pipx.
pipx install paystackease
-
Install paystackease using poetry.
poetry add paystackease
If you want to download the sdist packages directly:
Download the wheel distribution file and install using pip
pip install paystackease-2.0.0-py3-none-any.whl
Download the source distribution file, and install using pip
pip install paystackease-2.0.0.tar.gz
To get a development version of paystackease
Clone from the dev
branch GitHub repository, unzip and install:
git clone -b dev https://github.com/cla-bit/PayStackEase.git
cd PayStackEase
pip install paystackease
API usage
Making a Transaction [Synchronous]
If after setting your secret key in environment variables, for a synchronous transaction process all you need to do is use the transaction API to make a transaction.
To create a transaction or initialize a transaction:
- import the Paystack API wrapper.
from paystackease import PayStackBase
- Create an instance to use the PaystackBase wrapper to interact with the Transaction API.
paystack_client = PayStackBase()
- Use the instance and call the transaction method to initialize a transaction
create_transaction = paystack_client.transactions.initialize(
email="johndoe@email.com",
amount=10000000)
print(f"Transaction Created: {create_transaction}")
✅: Good: You can check your Paystack account, go to the Transaction page, and you will see the transaction just created.
Other Tools
Similar to calling the PayStackBase, you can also call other tools to make your work easy. For example:
-
Account Type
from paystackease import AccountType
val1 = AccountType.PERSONAL.value
print(val1)
"personal"
-
Convert units to subunits:
from paystackease import convert_to_subunit
# amount should be in subunit in this case 10000 kobo = 100 naira
money = convert_to_subunit(100, Currency.NGN)
print(money)
10000
-
Channels
from paystackease import Channels
bank = Channels.BANK.value
print(bank)
"bank"
-
Currency
from paystackease import Currency
val1 = Currency.NGN.value
print(val1)
"NGN"
-
Document Type
from paystackease import DocumentType
val1 = DocumentType.IDENTITY_NUMBER.value
print(val1)
"identityNumber"
Others are: EventType, Interval, MobileMoney, PWT, QRCODE, RecipientType, ResendOTP, Resolution, RiskAction, SplitType, STATUS, etc.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file paystackease-2.3.0.tar.gz
.
File metadata
- Download URL: paystackease-2.3.0.tar.gz
- Upload date:
- Size: 46.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a048889258c1d4706c421b0b784e3355878707ce79553970c88edfe3ea1c853f |
|
MD5 | 71977a34982f5454f4dc52d6c02c94cd |
|
BLAKE2b-256 | 01d27a3a5ba561af8ac69bd8dff56a3ad0e38b72d019e1d8f2d0cf6a1a7268c3 |
File details
Details for the file paystackease-2.3.0-py3-none-any.whl
.
File metadata
- Download URL: paystackease-2.3.0-py3-none-any.whl
- Upload date:
- Size: 81.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | bddd61d71b7c505323a86609ec3c5476677d8cd983c6914018a2268bff56c0eb |
|
MD5 | b2bbc5d324af63a768d7fa230b3185e4 |
|
BLAKE2b-256 | a1428b85dbee976e798cda719becc46e0aef5e8e9e3dc08a0c537db01b6d7b6f |