mobiska 0.1.0

Python SDK for the Mobiska REST API

Mobiska Python SDK

The official Python SDK for the Mobiska REST API — payments and SMS for businesses across Africa.

Installation

pip install mobiska

Quick Start

Configuration

Credentials can be provided via keyword arguments or environment variables:

MOBISKA_USER_NAME=your_client_key
MOBISKA_PASSWORD=your_secret_key
MOBISKA_SERVICE_ID=1
MOBISKA_SMS_SENDER_ID=YourSender      # SMS only
MOBISKA_API_URL=https://api.mobiska.com  # optional, this is the default

SMS

from mobiska import InitSMS

# Uses env vars when no arguments are passed
sms = InitSMS()

# Or pass credentials explicitly
sms = InitSMS(
    username="your_client_key",
    password="your_secret_key",
    service_id=1,
    sender_id="YourSender",
)

# Send a message
response = sms.send_sms("0540000000", "Welcome to Mobiska!")
print(response["response_code"])

# Send to multiple recipients
sms.send_sms(["0540000000", "0200000000"], "Batch message")

# Check balance
balance = sms.check_balance()
print(balance["response_data"]["sms_balance"])

Payments

from mobiska import InitPayment

payment = InitPayment(
    username="your_client_key",
    password="your_secret_key",
    service_id=2,
)

# Make a payment
result = payment.make_payment(
    reference="Order #123",
    nickname="MyShop",
    transaction_id="txn_001",
    trans_type="CTM",
    customer_number="0541840988",
    nw="MTN",
    amount=100,
    payment_option="MOM",
    callback_url="https://example.com/webhook",
    currency_code="GHS",
)

# Check transaction status
status = payment.check_transaction_status("txn_001")
print(status["response_data"]["status"])

# Account lookup (single)
info = payment.payment_account_lookup(pan="0541840988", nw="MTN")
print(info["response_data"]["name"])

# Account lookup (batch)
accounts = payment.payment_account_lookup(accounts=[
    {"pan": "0541840988", "nw": "MTN"},
    {"pan": "0201234567", "nw": "VOD"},
])

Advanced options

Both InitSMS and InitPayment accept timeout, retry_count, and retry_delay:

sms = InitSMS(timeout=10, retry_count=3, retry_delay=0.5)

Error Handling

from mobiska import (
    AuthenticationError,
    NotFoundError,
    RateLimitError,
    ValidationError,
    APIError,
)

try:
    payment.make_payment(...)
except ValidationError as e:
    print(f"Invalid input: {e}")
except AuthenticationError:
    print("Check your credentials.")
except RateLimitError:
    print("Slow down — rate limit hit.")
except APIError as e:
    print(f"Server error ({e.status_code}): {e}")

Development

# Create a virtual environment and install
python3 -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"

# Run tests
pytest

# Format code
black mobiska tests

# Lint
ruff check mobiska tests

License

MIT

Mobiska Python SDK

The official Python SDK for the Mobiska REST API.

Installation

pip install mobiska

Quick Start

from mobiska import MobiskaClient

client = MobiskaClient(api_key="your-api-key")

# GET request
users = client.get("/users")

# POST request
new_user = client.post("/users", json={"name": "Alice"})

# PATCH request
client.patch(f"/users/{new_user['id']}", json={"name": "Alice Updated"})

# DELETE request
client.delete(f"/users/{new_user['id']}")

Error Handling

from mobiska import MobiskaClient, AuthenticationError, NotFoundError, RateLimitError

try:
    client.get("/users/999")
except AuthenticationError:
    print("Check your API key.")
except NotFoundError:
    print("Resource not found.")
except RateLimitError:
    print("Slow down — rate limit hit.")

Development

# Install with dev dependencies
pip install -e ".[dev]"

# Run tests
pytest

# Format code
black mobiska tests

# Lint
ruff check mobiska tests

License

MIT