Skip to main content

agents-u-cash (Python)

Zero-dependency Python client for the agents.u.cash API - the 402 Online Protocol for non-custodial agent payments. Works for both sides of the network: an agent selling (manage resources, watch settlements) and a buyer (fetch a 402 door, pay, and settle - automatically via on-chain detection, or instantly by submitting the tx hash). Supports ~40 native coins (Bitcoin + Lightning, Ethereum + 15 EVM L2s, Solana, Tron, XRP, USDT/USDC, USDC-on-Base gasless, UCASH) plus custom tokens on 20 chains (ERC-20 / TRC-20 / SPL / ...) - see agents.u.cash for the full live list.

Uses only the standard library (urllib). No dependencies. Python 3.7+.

Install

pip install agents-u-cash

Or copy agents_u_cash.py - it has no dependencies.

Sell (as an agent)

from agents_u_cash import AgentsUCash

# Get an API key once (wallet-first; works at $0 immediately - verify email optionally for free credit):
# key = AgentsUCash().signup(email="me@agent.dev", password="longpass")["api_key"]

agent = AgentsUCash(api_key="...")
agent.set_wallet("btc", "bc1q…")
agent.set_webhook("https://my.bot/webhook")

res = agent.create_resource(amount=0.05)               # priced resource
acc = agent.create_challenge(res["res_id"])             # what a buyer pays
# Share the payable link: https://agents.u.cash/r/{res_id}

settled = agent.get_settlements()                       # your earnings log

Buy (as a buyer)

from agents_u_cash import AgentsUCash

buyer = AgentsUCash()                                   # no key needed to buy
door = buyer.view_door(res_id)                          # the 402 door (JSON)
# 1. pick an entry, pay entry["payTo"] exactly entry["amount"] from your wallet (out of band)
# 2. the platform auto-detects the on-chain payment and settles it.
#    Optionally POST the tx hash to settle instantly instead:
result = buyer.verify(door["accepts"][0]["challengeId"], tx_hash)
# -> {"settled": True} | {"status": "pending", "confirmations": n, "required": m}

A human-friendly payable page is also available: buyer.view_door(res_id, html=True) returns the HTML.

UCP checkout sessions (buyer)

Multi-item, mixed-currency carts over the Universal Commerce Protocol. The merchant is resolved from the custom-domain base_url, or from a cloud merchant token on the shared host. No API key.

buyer = AgentsUCash()   # base_url = the merchant's domain (or the platform host + cloud)
cart = buyer.create_checkout(
    line_items=[{"item": {"id": res_id_a}, "quantity": 1}, {"item": {"id": res_id_b}, "quantity": 2}],
    currency="USD",            # optional: cart currency for mixed-currency carts
    cloud="<merchant-token>",  # only on the shared platform host
)
# -> {"id": ..., "status": "incomplete", "currency", "line_items", "totals", "ap2": {"merchant_authorization", "nonce"}}
ready = buyer.complete_checkout(cart["id"], cloud="<merchant-token>")
# -> ready_for_complete + payment_handlers[] (pay each challenge on-chain)
order = buyer.get_order(cart["id"], cloud="<merchant-token>")   # per-item fulfillment status

Optional AP2 (dev.ucp.shopping.ap2_mandate): pass complete_checkout(id, ap2={"checkout_mandate": ...}, cloud=...) with a buyer-signed SD-JWT-VC for holder-proof authorization. Responses are RFC 9421-signed (ES256) with the merchant key.

API

Method Auth Description
signup(email, password, primary_wallet=None) - Register; returns api_key
top_up(amount) key Create a ≥$1 top-up checkout (adds platform credit; activates if not yet)
get_agent() key Account snapshot (balance, wallets, webhook, earnings summary)
set_webhook(url) key Set the settlement webhook
set_wallet(asset, address) key Set your receive address for an asset
set_stripe(secret_key, product_id, webhook_secret, publishable_key=None) key Connect your Stripe account (card rail); verifies the key + product
get_stripe() key Masked Stripe config + the webhook endpoint to register
clear_stripe() key Disconnect your Stripe account
set_custom_token(type, code, contract_address, decimals, name, rate=None, rate_url=None) key Add a custom token (ERC-20/TRC-20/SPL); then set_wallet(asset=code, address=...) to set its receive address
get_custom_tokens() key List your custom tokens
delete_custom_token(code) key Remove a custom token
get_settings() key Read safe settings (confirmations, webhook url+secret, currency, payment prefs, notifications, branding)
set_settings(partial) key Partially update safe settings
get_integrations() key Read stored third-party integration credentials (Discord, Telegram, BigCommerce, Ecwid, Wix)
set_integrations(integrations) key Store third-party integration credentials
create_resource(amount, currency=None, accepted_assets=None, webhook_url=None) key Create a priced resource
get_resources(res_id=None) key List resources, or fetch one
create_challenge(res_id) key Build the multi-coin accepts[]
verify(challenge_id, hash) key optional Verify + settle (buyer-push: no key needed)
get_settlements() key Earnings log
view_door(res_id, html=False) - The public 402 door (JSON, or HTML)
create_checkout(line_items, currency=None, buyer=None, context=None, cloud=None) - UCP checkout session (multi-item, mixed-currency cart)
get_checkout(id, cloud=None) - Fetch a checkout session
complete_checkout(id, ap2=None, cloud=None) - Mint challenges -> ready_for_complete (optional AP2 mandate)
cancel_checkout(id, cloud=None) - Cancel a checkout session
get_order(id, cloud=None) - A checkout session as a UCP order (per-item fulfillment)
search_catalog(query=None, filters=None, pagination=None, cloud=None) - Search the merchant catalog
get_product(id, cloud=None) - Fetch a single catalog product by id
lookup_products(ids, cloud=None) - Batch catalog lookup by ids

All calls return the parsed response dict and raise AgentsUCashError on API errors (which carries .code and .status).

Error handling

from agents_u_cash import AgentsUCash, AgentsUCashError

try:
    agent.create_resource(amount=0.05)
except AgentsUCashError as e:
    print(e.code, e.status, e)   # e.g. 'uxc_agent_not_activated' 402 ...

Non-custodial: the platform never holds funds - every payTo is the seller's own wallet, and this client never sees your wallet keys.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

agents_u_cash-0.3.0.tar.gz (7.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

agents_u_cash-0.3.0-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

Details for the file agents_u_cash-0.3.0.tar.gz.

File metadata

  • Download URL: agents_u_cash-0.3.0.tar.gz
  • Upload date:
  • Size: 7.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for agents_u_cash-0.3.0.tar.gz
Algorithm Hash digest
SHA256 f6046a063239bb051969463f265d5b6b0ef56ccd4a43b331129c1b67bb9a3786
MD5 f446a8b47b4366dd156a9569754cf355
BLAKE2b-256 5ec032c518be2fd59715266fd08c1f591078472e41b0c77ca36240ba94dab787

See more details on using hashes here.

File details

Details for the file agents_u_cash-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: agents_u_cash-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 8.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for agents_u_cash-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3831276134e8c5f991578f106797738f22c8a1f5a85c0baec459fae8e01ddfed
MD5 44346e564687d11f7f963b84f7487458
BLAKE2b-256 ac646e61a877ac8fd8a6f0d53ec29082e5a95fc55c8513c297505c42d29d17af

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page