Official Python SDK for VePay's Shariah-compliant eCommerce invoice financing API
Project description
VePay Python SDK
Official Python client for VePay — Shariah-compliant instant financing and business funding for global eCommerce marketplace sellers.
Features
- Shariah-Compliant: Flat service fees (1.0% - 2.0%). No interest rates, no hidden fees, and zero late compounding penalties.
- Invoice Financing (Instapay): Automate invoice drawing to advance up to 70% of store sales.
- Store Eligibility Check: Programmatically evaluate whether an eCommerce account qualifies for instant financing.
- Fully Documented: Complete Python type hinting and clear docstrings for IDE autocomplete.
Installation
Install via pip:
pip install vepay-sdk
Quickstart
Initialize the VePayClient using your api key generated in the VePay Seller Portal.
from vepay import VePayClient
# Initialize Client
client = VePayClient(
api_key="vp_live_abc123..." # Replace with your actual key
)
try:
# 1. Get Live Account Balance & Financing Limits
balance = client.get_balance()
print(f"Available Limit: {balance['availableLimit']} {balance['currency']}")
print(f"Pending Outstanding: {balance['pendingRepayment']} {balance['currency']}")
# 2. Draw 70% Advance on Store Invoice
if balance["availableLimit"] > 1000:
advance = client.request_advance(
store_id="amzn_store_us_1029",
amount=5000.00
)
print(f"Disbursement Initiated! ID: {advance['advanceId']}")
print(f"Advanced Amount: {advance['advancedAmount']}")
print(f"Flat Transaction Fee: {advance['serviceFee']} (No Interest)")
except Exception as e:
print(f"API Error occurred: {e}")
API Reference
VePayClient(api_key: str, base_url: str = "https://api.vepay.io/v1")
Initializes the client object.
client.check_eligibility(platform: str, monthly_sales: float, currency: str, country: str)
Evaluates platform sales metrics to determine credit capability.
result = client.check_eligibility(
platform="Amazon",
monthly_sales=45000.00,
currency="USD",
country="US"
)
client.request_advance(store_id: str, amount: float)
Initiates an invoice drawing request.
result = client.request_advance(
store_id="shopify_store_uk_7721",
amount=2500.00
)
client.get_balance()
Returns active limits and outstanding repayments.
balance = client.get_balance()
License
This project is licensed under the MIT License.
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
vepay_sdk-1.0.0.tar.gz
(3.7 kB
view details)
File details
Details for the file vepay_sdk-1.0.0.tar.gz.
File metadata
- Download URL: vepay_sdk-1.0.0.tar.gz
- Upload date:
- Size: 3.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e949f04958cf665cecc9a8be2dafbbf6850174762fa68fac7fbcbb0c62dc4788
|
|
| MD5 |
3863e7952595d6a957746ab23bc70a88
|
|
| BLAKE2b-256 |
526f17ffb43e16ad7fa3debde3e6f86a997ae5aab10261fba755b79356e67209
|