Provides Direct API and Checkout methods for Lipad
Project description
Lipad Python SDK
Introduction
The Lipad Python SDK facilitates the integration of Lipad's Direct API and Checkout features into your Python applications. This comprehensive guide will assist you in the setup and utilization of the Lipad SDK.
Prerequisites
Before getting started, ensure you have the following:
- Python: Ensure that you have Python installed on your system. You can download Python from the official Python website.
- You have installed: requests, aiohttp, pycryptodome
- Lipad API credentials, including the IV Key, Consumer Secret, Consumer Key.
- Environment: Decide whether you want to work in the production or sandbox environment. Lipad provides different URLs for each environment, so choose accordingly.
Installation
-
Download the Lipad SDK: Download the Lipad SDK and include it in your project.
# Example using pip pip install lipad-sdk
-
Import the Lipad class and necessary libraries:
from lipad import Lipad import json import ayncio
-
Create an asynchronous main function.
async def main(): // Replace these values with your actual credentials iv_key = "your_iv_key"; consumer_secret = "your_consumer_secret"; consumer_key = "your_consumer_key" environment = "sandbox", "production"; charge_request_id = "your_charge_request_id"
-
Running the script
To execute the script and run the main function, add the following line at the end of your script:
if __name__ == "__main__": asyncio.run(main())
Checkout Usage
-
To initialize the Lipad class, provide the iv_key, consumer_key, consumer_secret, and environment parameters. The environment should be one of the following: 'production' or 'sandbox'.
lipad = new Lipad(iv_key, consumer_key, consumer_secret, environment);
-
Validate Payload
```bash payload = { "msisdn": "", "account_number": "", "country_code": "", "currency_code": "", "client_code": "", "due_date": "", "customer_email": "", "customer_first_name": "", "customer_last_name": "", "merchant_transaction_id": "", "preferred_payment_option_code": "", "callback_url": "", "request_amount": "", "request_description": "", "success_redirect_url": "", "fail_redirect_url": "", "invoice_number": "", "language_code": "en", "service_code": "", } lipad.validate_payload(payload)
-
Convert payload to JSON String and encrypt Payload
payload_json_string = json.dumps(payload) encrypted_payload = checkout.encrypt(payload_json_string) print("Encrypted Payload:", encrypted_payload)
-
Get Checkout Status
merchant_transaction_id = payload.get("merchant_transaction_id") print("Merchant Transaction ID:", merchant_transaction_id) checkout_data = await checkout.check_checkout_status(merchant_transaction_id) print("Checkout Data:", checkout_data)
-
Build Checkout URL
checkout_url = f"https://checkout2.dev.lipad.io/?access_key={access_key}&payload={encrypted_payload}" print("Checkout URL:", checkout_url)
Direct API Usage
-
To initialize the Lipad class, provide the iv_key, consumer_key, consumer_secret, and environment parameters. The environment should be one of the following: 'production' or 'sandbox'.
lipad = new Lipad(iv_key, consumer_key, consumer_secret, environment);
-
Direct Charge
await lipad.direct_charge(json.dumps(payload))
-
Get Charge Request Status
checkout_request_status = await checkout.get_charge_request_status( chargeRequestId ) print("Checkout Request Status", checkout_request_status)
License
This SDK is open-source and available under the MIT License.
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
File details
Details for the file lipad_sdk-1.0.5.tar.gz
.
File metadata
- Download URL: lipad_sdk-1.0.5.tar.gz
- Upload date:
- Size: 4.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.9.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 084ab5f807834570c54385c85a21f8bd2f6d656715823cb125d4a124f56732b0 |
|
MD5 | d753d61afea5cbd438b385f9dfaff031 |
|
BLAKE2b-256 | db5dbf9d6688972b78e8534874386bb1ec76b8de0031aa17456a28c497bf8d21 |
File details
Details for the file lipad_sdk-1.0.5-py3-none-any.whl
.
File metadata
- Download URL: lipad_sdk-1.0.5-py3-none-any.whl
- Upload date:
- Size: 4.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.9.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a714b8dcc78decd03990902b36af54de400816cedf74f25f72a3bec61fffc7ad |
|
MD5 | a3e84403dc13f02b8db28e5f1db0914f |
|
BLAKE2b-256 | 1975011efa9c9b757e5ca72571411093496392b46a57f29a19249e190fef6f1a |