Python SDK

The UQPAY Python SDK provides typed access to Account Center, Global Account, Global Acquiring, Card Issuance, and Supporting Services. It includes automatic authentication, request retries, webhook verification, PGP authorization decisions, and sandbox transaction simulation.

PyPI

uqpay

The SDK requires Python 3.11 or later. Version 1.2.0 is its first release in the coordinated client release line.

Installation

pip install uqpay

Quick start

Before you begin, create a sandbox account and create API keys.

Sandbox
Production

from uqpay import UQPayClient

client = UQPayClient(client_id="your-client-id", api_key="your-api-key", environment="sandbox")

from uqpay import UQPayClient

client = UQPayClient(client_id="your-client-id", api_key="your-api-key", environment="production")

Configuration

client = UQPayClient(
    client_id="your-client-id",
    api_key="your-api-key",
    environment="sandbox",       # "sandbox" (default) or "production"
    timeout=30.0,                # request timeout in seconds
    max_retries=2,               # automatic retries on transient errors
    log_level="none",            # "none" | "error" | "warn" | "info" | "debug"
    redact_fields=["card_number", "cvc"],
)

You can also provide credentials through environment variables:

export UQPAY_CLIENT_ID="your-client-id"
export UQPAY_API_KEY="your-api-key"

Authentication

The SDK uses your client_id and api_key to retrieve a UQPAY Access Token, caches it, and retrieves a new Token before the current one expires. You do not need to manage Tokens manually.

Stablecoin Account (Ramp) is not included in the current SDK product scope.

Per-request options

Set idempotency, sub-account, timeout, and retry behavior for an individual request:

result = client.banking.payouts.create(
    {...},
    request_options={
        "idempotency_key": "unique-key",
        "on_behalf_of": "sub-account-id",
        "timeout": 60,
        "max_retries": 0,
    },
)

Pagination

All list methods accept page_number and page_size:

page = 1
while True:
    result = client.issuing.cards.list({"page_number": page, "page_size": 50})
    items = result.get("items") or result.get("list") or []
    if not items:
        break
    for card in items:
        print(card["card_id"])
    page += 1

Resources

Explore the available API namespaces.

Webhooks

Verify incoming webhook signatures.

Authorization decision

Handle PGP-encrypted card authorization decisions.

Error handling

Handle typed SDK errors and retries.

MCP

CLI

SDKs

PyPI

Installation

Quick start

Configuration

Authentication

Per-request options

Resources

Webhooks

Authorization decision

Error handling

PyPI

​Installation

​Quick start

​Configuration

​Authentication

​Per-request options

​Pagination

Resources

Webhooks

Authorization decision

Error handling

Installation

Quick start

Configuration

Authentication

Per-request options

Pagination