Python SDK

Official Python SDK for OxaPay — accept crypto payments, exchanges, and payouts.

Installation

pip install oxapay-python

Quick start

from oxapay_python import OxaPayManager

oxapay = OxaPayManager(timeout=10)
res = (
    oxapay
    .payment("XXXXXX-XXXXXX-XXXXXX-XXXXXX")
    .generate_invoice({
        "amount": 10.5,
        "currency": "USDT",
    })
)

print(res)

Handling Webhooks (Payments & Payouts)

OxaPay sends HMAC header (sha512 over raw request body).

from oxapay_python import OxaPayManager
from oxapay_python.exceptions import WebhookSignatureException

raw_body = request.get_data(as_text=True)  # Flask example
headers = dict(request.headers)            # Flask example

oxapay = OxaPayManager()

# Merchant webhook
try:
    data = oxapay.webhook(merchant_api_key="XXXXXX-XXXXXX-XXXXXX-XXXXXX", raw_body=raw_body, headers=headers).get_data()
except WebhookSignatureException:
    pass

# Payout webhook
try:
    data = oxapay.webhook(payout_api_key="XXXXXX-XXXXXX-XXXXXX-XXXXXX", raw_body=raw_body, headers=headers).get_data()
except WebhookSignatureException:
    pass

# Both
try:
    data = oxapay.webhook(
        merchant_api_key="XXXXXX-XXXXXX-XXXXXX-XXXXXX",
        payout_api_key="XXXXXX-XXXXXX-XXXXXX-XXXXXX",
        raw_body=raw_body,
        headers=headers,
    ).get_data()
except WebhookSignatureException:
    pass

# Or skip verification
data = oxapay.webhook(raw_body=raw_body, headers=headers).get_data(verify=False)

---

Available methods

🔹payment

• generate_invoice – Create invoice & get payment URL. More details

• generate_white_label – White-label payment. More details

• generate_static_address – Create static deposit address. More details

• revoke_static_address – Revoke static address. More details

• static_address_list – List static addresses. More details

• information – Single payment information. More details

• history – Payment history list. More details

• accepted_currencies – Accepted currencies. More details

🔹account

• balance – Account balance. More details

🔹payout

• generate – Request payout. More details

• information – Single payout information. More details

• history – Payout history list. More details

🔹exchange

• swap_request – Swap request. More details

• swap_history – Swap history. More details

• swap_pairs – Swap pairs. More details

• swap_calculate – Swap pre-calc. More details

• swap_rate – Swap Quote rate. More details

🔹common

• prices – Market prices. More details

• currencies – Supported crypto. More details

• fiats – Supported fiats. More details

• networks – Supported networks. More details

• monitor – System status. More details

🔹webhook

• verify – Validates HMAC header (sha512 of raw body).

• get_data – Validates HMAC header and return webhook data. More details

---

Raw responses

By default, endpoints return the unwrapped data field. To receive the full API response (data, status, message, error, version), enable raw mode:

from oxapay_python import OxaPayManager

sdk = OxaPayManager(timeout=20, raw=True)
res = sdk.payment("MERCHANT_API_KEY").generate_invoice({"amount": 1, "currency": "USDT"})
print(res["data"])  # unwrap manually

Exceptions

All SDK exceptions extend oxapay.exceptions.OxaPayException:

• ValidationRequestException (HTTP 400)

• InvalidApiKeyException (HTTP 401)

• NotFoundException (HTTP 404)

• RateLimitException (HTTP 429)

• ServerErrorException (HTTP 500)

• ServiceUnavailableException (HTTP 503)

• HttpException (network/unknown)

• MissingApiKeyException (missing api key)

• MissingTrackIdException (missing track id)

• MissingAddressException (missing address)

• WebhookSignatureException (bad/missing HMAC)

• WebhookNotReceivedException (webhook request was not received)

Security Notes

• Verify webhook HMAC before use input data.

• Whitelist OxaPay IPs on your firewall (ask support).

• Use HTTPS everywhere.

• Store keys in .env, not code.

• Rotate keys regularly.

---

Testing (safe & offline)

This package uses pytest and responses for testing.

pip install -e ".[dev]"
pytest

Compatibility

• Python 3.8+

Security

If you discover a security vulnerability, please email [email protected]. Do not disclose publicly until it has been fixed.

Contributing

Pull requests are welcome. For major changes, open an issue first.

pip install -e ".[dev]"
ruff check .
pytest

License

Apache-2.0 — see LICENSE.

Changelog

See CHANGELOG.md for version history.

To view the OxaPay package on PyPI:

oxapay-pythonPyPI