Official AfconWave Python SDK — Pan-African payments, payouts, crypto, refunds & disputes.
Project description
afconwave — Official Python SDK
The official Python client library for the AfconWave Payments API.
Features
- ✅ Python 3.8+ compatible
- 🌍 Payments, Payouts, and Refunds in one library
- 🔒 Secure API key handling
- 🔔 Webhook signature verification helper
- 🧪 Sandbox-ready with test keys
Installation
pip install afconwave
Quick Start
from afconwave import AfconWave
afw = AfconWave(secret_key="sk_test_your_key_here")
Usage Guide
Create a Payment
payment = afw.create_payment(
amount=5000, # Amount in minor units (5000 = 50 XAF)
currency="XAF",
description="Order #1234",
callback_url="https://yoursite.com/payment/callback",
customer={
"name": "Jean Dupont",
"email": "jean@example.com",
"phone": "+237600000000",
},
metadata={"order_id": "ORD-1234"}
)
print(payment["checkout_url"]) # Redirect user here
print(payment["id"]) # e.g., pay_507f191e8180f
Retrieve a Payment
payment = afw.retrieve_payment("pay_507f191e8180f")
print(payment["status"]) # "pending" | "success" | "failed"
print(payment["amount"])
print(payment["paid_at"])
Create a Payout
payout = afw.create_payout(
amount=10000,
currency="XAF",
recipient={
"phone": "+237600000001",
"network": "MTN", # "MTN" | "ORANGE" | "MOOV" | "WAVE"
"name": "Marie Kamga",
},
reference="PAYOUT-REF-001"
)
print(payout["status"]) # "pending" | "success" | "failed"
List Payments
result = afw.list_payments(limit=20, status="success")
for payment in result["data"]:
print(payment["id"], payment["amount"], payment["status"])
Webhook Verification
Verify that incoming webhooks are genuinely from AfconWave:
import hashlib
import hmac
from flask import Flask, request, abort
app = Flask(__name__)
WEBHOOK_SECRET = "your_webhook_secret"
@app.route("/webhooks/afconwave", methods=["POST"])
def handle_webhook():
signature = request.headers.get("X-AfconWave-Signature", "")
payload = request.get_data(as_text=True)
expected = hmac.new(
WEBHOOK_SECRET.encode(),
payload.encode(),
hashlib.sha256
).hexdigest()
if not hmac.compare_digest(expected, signature):
abort(400, "Invalid signature")
event = request.get_json()
if event["event"] == "payment.success":
print("Payment received:", event["data"]["id"])
elif event["event"] == "payment.failed":
print("Payment failed")
elif event["event"] == "payout.success":
print("Payout delivered")
return "OK", 200
Error Handling
from afconwave import AfconWave, AfconWaveError
afw = AfconWave(secret_key="sk_test_...")
try:
payment = afw.create_payment(amount=5000, currency="XAF", callback_url="...")
except AfconWaveError as e:
print(f"API Error {e.status_code}: {e.message}")
except Exception as e:
print(f"Unexpected error: {e}")
Configuration
| Parameter | Type | Default | Description |
|---|---|---|---|
secret_key |
str |
required | Your AfconWave secret API key |
base_url |
str |
https://api.afconwave.com/v1 |
API base URL |
timeout |
int |
30 |
Request timeout (seconds) |
Sandbox / Testing
Use test keys prefixed with sk_test_ for sandbox mode. No real transactions occur.
afw = AfconWave(secret_key="sk_test_...")
Django / Flask Integration
Django (example view)
from django.http import JsonResponse
from django.views.decorators.csrf import csrf_exempt
from afconwave import AfconWave
afw = AfconWave(secret_key="sk_live_...")
def create_checkout(request):
payment = afw.create_payment(
amount=int(request.POST["amount"]),
currency="XAF",
callback_url="https://yoursite.com/payment/success",
)
return JsonResponse({"checkout_url": payment["checkout_url"]})
Documentation
Full API documentation: docs.afconwave.com
License
MIT © AfconWave
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
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 afconwave-1.1.0.tar.gz.
File metadata
- Download URL: afconwave-1.1.0.tar.gz
- Upload date:
- Size: 6.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a916016ee0f151f3f2d109126dc4945729f44bde2fc0b202ecf73ececafaa2b0
|
|
| MD5 |
80af9561890b9a8368ddb8ec32449dae
|
|
| BLAKE2b-256 |
bb01cb746255ff4169a937116ce47cd6edc23a557fed5c45c60636bf05f18197
|
File details
Details for the file afconwave-1.1.0-py3-none-any.whl.
File metadata
- Download URL: afconwave-1.1.0-py3-none-any.whl
- Upload date:
- Size: 6.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b11c876aa594bace3dbda56d00ba72ec5a44b8c64bacbbbde48a3cb22239c3b6
|
|
| MD5 |
d501e89bbccbd39f2a512220529f0d34
|
|
| BLAKE2b-256 |
24d82b95144aee1d7cc129e4e872cb6672ea5f9c8796e1d55065c3203c66bafa
|