SDK for integration with PhonePe PG APIs
Project description
PhonePe B2B PG SDK
A python library for integrating with PhonePe APIs.
Installation
Requires python 3.9 or later
pip install phonepe-pg-sdk-python
Quick start
To get your keys, please visit the Merchant Onboarding of PhonePe PG: Merchant Onboarding
You will need three things to get started: client-id, client-secret and client-version.
Create an instance of the StandardCheckoutClient class:
from phonepe.sdk.pg.payments.v2.standard_checkout_client import StandardCheckoutClient
from phonepe.sdk.pg.env import Env
client_id = "<YOUR_CLIENT_ID>"
client_secret = "<YOUR_CLIENT_SECRET>"
client_version = 1 # Insert your client version here
env = Env.SANDBOX # Change to Env.PRODUCTION when you go live
standard_phonepe_client = StandardCheckoutClient.get_instance(client_id=client_id,
client_secret=client_secret,
client_version=client_version,
env=env)
Initiate an order using Checkout Page
To init a pay request, we make a request object using StandardCheckoutPayRequest.build_request build_request.
Code:
from uuid import uuid4
from phonepe.sdk.pg.payments.v2.models.request.standard_checkout_pay_request import StandardCheckoutPayRequest
unique_order_id = str(uuid4())
ui_redirect_url = "https://www.merchant.com/redirect"
amount = 100
standard_pay_request = StandardCheckoutPayRequest.build_request(merchant_order_id=unique_order_id,
amount=amount,
redirect_url=ui_redirect_url)
standard_pay_response = standard_phonepe_client.pay(standard_pay_request)
checkout_page_url = standard_pay_response.redirect_url
The data will be in a StandardCheckoutPayResponse object.
The checkout_page_url you get can be handled by redirecting the user to that url on the front end.
Check status of order
View the state for the order we just initiated.
unique_order_id = "INSERT_YOUR_UNIQUE_ORDER_ID"
order_status_response = standard_phonepe_client.get_order_status(merchant_order_id=unique_order_id)
order_state = order_status_response.state
You will get the data OrderStatusResponse object.
For more details, please visit: https://developer.phonepe.com
License
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file phonepe_pg_sdk_python-2.1.9.tar.gz.
File metadata
- Download URL: phonepe_pg_sdk_python-2.1.9.tar.gz
- Upload date:
- Size: 69.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.20
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c2e05efcaf21944265275089ab6fe695d8b1f54c266e2c24d69381f04d5a8918
|
|
| MD5 |
5f986064bac4c199729b3c98e08b597e
|
|
| BLAKE2b-256 |
6ad8d11216710c6985823947db88b91d7b97e86237bc1ec6c5b70e00ee753df3
|
File details
Details for the file phonepe_pg_sdk_python-2.1.9-py3-none-any.whl.
File metadata
- Download URL: phonepe_pg_sdk_python-2.1.9-py3-none-any.whl
- Upload date:
- Size: 188.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.20
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d77dd9e96ae43132f5a134cf4337e3693b0561009fdd5711788c8cc33bb68ae2
|
|
| MD5 |
84f8767d9fe0d6c9e615e5766c00969e
|
|
| BLAKE2b-256 |
36bdd93b624dbb39d68045caccab48a243964eb5e06debfa3b4a4fc7b75b1ba2
|