payhere-python 1.0.0

Unofficial Python SDK for PayHere Payment Gateway

PayHere Python SDK

Unofficial Python SDK for integrating with the PayHere payment gateway. This library simplifies the process of creating payment requests, verifying payment signatures, and handling responses from PayHere.

Features

• Create payment hashes
• Verify webhook signatures
• Support for sandbox and production environments
• Easy-to-use API

Installation

You can install the package via pip:

pip install payhere-python

Usage

from payhere import PayHere, generate_payment_hash, verify_payment_signature


# Initialize the PayHere client
payhere = PayHere(
    merchant_id="YOUR_MERCHANT_ID", # need for payment hash generation
    merchant_secret="YOUR_MERCHANT_SECRET", # need for payment hash generation
    app_id="YOUR_APP_ID", # not need for payment hash generation
    app_secret="YOUR_APP_SECRET", # not need for payment hash generation
    sandbox_enabled=True, # default is True
    request_timeout=20 # default is 20 seconds
)


# Generate a payment hash can be done in 2 ways:
"""
Generate payment hash is required to create a payment request from the client side.
(Do not create payment hash on the client side in production, always do it on the server side for security reasons.)
"""

# 1. Using the PayHere client instance
payment_hash = payhere.generate_payment_hash(
    order_id="ORDER123",
    amount="1000.00",
    currency="LKR"
)

# 2. Using the standalone function
payment_hash = generate_payment_hash(
    order_id="ORDER123",
    amount="1000.00",
    currency="LKR",
    merchant_id="YOUR_MERCHANT_ID",
    merchant_secret="YOUR_MERCHANT_SECRET"
)

# Verify payment signature. This can also be done in 2 ways:
"""
Verify payment signature is required to validate the data received from PayHere webhooks. They send the payment data along with a signature to ensure data integrity.
"""

# 1. Using the PayHere client instance
is_valid = payhere.verify_payment_signature(data={
        # all the data received from PayHere webhook with other fields
        "merchant_id": "YOUR_MERCHANT_ID",
        "order_id": "ORDER123",
        "payhere_amount": "1000.00",
        "payhere_currency": "LKR",
        "status_code": "2",
        "md5sig": "RECEIVED_SIGNATURE"
    }
)

# 2. Using the standalone function
is_valid = verify_payment_signature(data={
        # all the data received from PayHere webhook with other fields
        "merchant_id": "YOUR_MERCHANT_ID",
        "order_id": "ORDER123",
        "payhere_amount": "1000.00",
        "payhere_currency": "LKR",
        "status_code": "2",
        "md5sig": "RECEIVED_SIGNATURE"
    },
    merchant_id="YOUR_MERCHANT_ID", # need for signature verification
    merchant_secret="YOUR_MERCHANT_SECRET" # need for signature verification
)

# Retrieve payment/order details
# app_id and app_secret are needed for this method
# Make sure to handle exceptions properly in production code.
try:
    payment_details = payhere.get_payment_details(order_id="ORDER123")
    print(payment_details)
except PayHereError as e:
    print(f"Error retrieving payment details: {str(e)}")


# Process a refund
# app_id and app_secret are needed for this method
# there is 2 types of refunds available: full and partial
# In production, you may need to contact PayHere support to enable refunds on your account.

# 1. Full refund
"""
With this implementation, a full refund is processed for the entire amount of the original payment. even the fees charged by PayHere are included in the refund.
"""

try:
    refund_response = payhere.refund_payment(
        payment_id=156432454,
        reason="Customer requested a full refund",
        refund_type="full"
    )
    print(refund_response)
except PayHereError as e:
    print(f"Error processing refund: {str(e)}")


# 2. Partial refund
"""With this implementation, a partial refund is processed for a specified amount of the original payment. The fees charged by PayHere are not included in the refund.
"""

try:
    refund_response = payhere.refund_payment(
        payment_id=156432454,
        reason="Customer requested a partial refund",
        refund_type="partial",
        amount=500.00  # specify the amount for partial refund
    )
    print(refund_response)
except PayHereError as e:
    print(f"Error processing refund: {str(e)}")

In production, you may need to contact PayHere support to enable refunds on your account. [e-mail]

Support PayHere API

• Payment Details Retrieval
• Full Refund
• Partial Refund
• Payment Hash Generation
• Payment notify Signature Verification

Guides to Integrate PayHere Sandbox for Development and Testing

Payhere Sandbox Account Setup Guide

1. You can create a sandbox account for testing purposes by https://sandbox.payhere.lk/ website.
2. Create a sandbox account there then you will redirect to sandbox dashboard.

3. In sandbox Dashboard, there is a menu called Integrations.

4. In Integrations you can create a new application by clicking + Add Domain/App button. If your application is website choose Domain or if your application is mobile app choose App. For website domain you can use localhost for testing purpose.

Note: Do note put any server running port like localhost:3000. Just hostname 5. After create that you can see your Merchant Secret in table and Merchant ID in top of page

6. Now you can use that Merchant ID and Merchant Secret in your application to test payments in sandbox environment.

7. For App ID and App Secret you can go to Settings menu in dashboard and create a new api key.

8. For the api key you can give access that which api features does that key can access. For this SDK you need to enable Payment Retrieval access. Remember to add http://localhost in the Allowed Origins for development

9. After create that you can see your App ID and App Secret in the api keys table. to see the app id and secret you need to click the View Credentials button.

Checkout Flow

License

This project is licensed under the GNU GPL v3 LICENSE.

You are free to use, modify, and distribute this software, including for commercial purposes,
as long as all derivative works remain open source and credit the original author. Please refer to the LICENSE file for more details.

Author

Kavindu Harshitha (apexkv)

GitHub: apexkv

Website: apexkv.com

Email: [e-mail]

Contributing

Contributions are welcome! Please feel free to submit issues and pull requests.

Used Libraries

• PayHere - The payment gateway this SDK is built for.
• Requests - HTTP library used for making API requests.
• Pydantic - Data validation and settings management using Python type annotations.

Copyright

Copyright (c) 2026 Kavindu Harshitha(apexkv). Licensed under the GNU GPL v3.