Description:
pesapalv3 1.0.0
pesapal
Unofficial SDK wrapper for the pesapal v3 payments API.
Requirements
python version >= 3.8
Installation
pip install pesapal-v3
Usage
from pesapal_v3 import Pesapal
client = Pesapal(consumer_key, consumer_secret)
Supported endpoints
Register IPN
ipn_url = "https://example.com/ipn/notifications"
ipn = client.register_ipn_url(ipn_url=ipn_url)
if ipn.status != "200":
# error occured registering your IPN
print(ipn.error)
else:
# IPN successfully registered
print(ipn)
List registered IPNs
ipns = client.get_registered_ipns()
print(ipns)
Submit order request
order_request = {
"id": "s945e4af-80a5-4ec1-8706-e03f8332fb04",
"currency": "KES",
"amount": 350.00,
"description": "Thank you for this SDK",
"callback_url": "https://example.com/cancellation",
"notification_id": "fe078e53-78da-4a83-aa89-e7ded5c456e6",
"billing_address": {
"email_address": "john.doe@example.com",
"phone_number": "0723xxxxxx",
"country_code": "KE",
"first_name": "John",
"middle_name": "",
"last_name": "Doe",
"line_1": "Pesapal Limited",
"line_2": "",
"city": "",
"state": "",
"postal_code": "",
"zip_code": ""
}
}
request = client.submit_order_request(order_request=order_request)
Transaction status
status = client.get_transaction_status(order_tracking_id="b945e4af-80a5-4ec1-8706-e03f8332fb04")
Subscriptions
order_request = {
"id": "s945e4af-80a5-4ec1-8706-e03f8332fb04",
"currency": "KES",
"amount": 350.00,
"description": "Thank you for this SDK",
"callback_url": "https://example.com/cancellation",
"notification_id": "fe078e53-78da-4a83-aa89-e7ded5c456e6",
"billing_address": {
"email_address": "john.doe@example.com",
"phone_number": "0723xxxxxx",
"country_code": "KE",
"first_name": "John",
"middle_name": "",
"last_name": "Doe",
"line_1": "Pesapal Limited",
"line_2": "",
"city": "",
"state": "",
"postal_code": "",
"zip_code": ""
},
"account_number": "555-678",
"subscription_details": {
"start_date": "24-01-2023",
"end_date": "31-12-2023",
"frequency": "DAILY"
}
}
request = client.submit_order_request(order_request=order_request, is_subscription=True)
print(request)
Refund
refund =
{
"confirmation_code": "AA11BB22",
"amount": "100.00",
"username": "John Doe",
"remarks": "Service not offered"
}
client.refund(refund)
Support
For any issues, bugs you can raise an issue on the project issues board.
For compliments and gigs you can reach out to the developer via email martinmshale@gmail.com.
For service level issues, reach out to Pesapal.
Lastly, I need the developer juice to produce more of these open source solutions. Be among the few who have supported these effort by buying me a coffee.
License
For personal and professional use. You cannot resell or redistribute these repositories in their original state.
Customer Reviews
There are no reviews.
