vonpay-checkout

Python SDK for the Von Payments Checkout API. Create hosted checkout sessions, verify webhook signatures, and validate signed return redirects.

Install

pip install vonpay-checkout

Requires: Python 3.9+, httpx 0.27+

Quick start

from vonpay.checkout import VonPayCheckout, VonPayError

client = VonPayCheckout("vp_sk_test_...")

session = client.sessions.create(
    amount=1499,
    currency="USD",
    country="US",
    success_url="https://example.com/order/123/confirm",
)

print(session.checkout_url)
# https://checkout.vonpay.com/checkout?session=vp_cs_test_...

Discrete-lifecycle API

The payment_intents, refunds, tokens, and capabilities namespaces give server-side control over payment intents, alongside the existing hosted-checkout sessions flow.

# Create a payment intent (auth + capture)
intent = client.payment_intents.create(
    amount=1499,
    currency="usd",
    capture_method="automatic",
    metadata={"order_id": "ord_42"},
    idempotency_key="ord_42-charge-1",
)
print(intent.id, intent.status)  # "vpi_live_…", "succeeded"

# Auth-only + later capture (fulfillment-on-ship)
auth = client.payment_intents.create(amount=1499, currency="usd", capture_method="manual")
client.payment_intents.capture(auth.id, amount_to_capture=1499)

# Refund a captured intent (partial or full)
refund = client.refunds.create(payment_intent=intent.id, amount=500)

# Create a reusable token for save-card / MIT flows
token = client.tokens.create(buyer_id="buyer_42", setup_for_future_use="off_session")

# Read the merchant's processor capability matrix before invoking optional ops
caps = client.capabilities.get()
if caps.supported_operations.partial_refund:
    # partial refunds supported — safe to offer partial-refund UI
    ...

Features

Typed session / webhook / error objects — full CheckoutSession, SessionStatus, WebhookEvent, VonPayError types.
Webhook verification — webhooks.construct_event(raw_body, signature_header, signing_secret) parses the x-vonpay-signature: t=<unix>,v1=<hex> header, verifies HMAC-SHA256 over f"{t}.{raw_body}" keyed by your per-endpoint signing secret (whsec_…), and enforces the freshness window (≤5 min old / ≤30 sec future). Accepts multiple v1= entries for zero-downtime secret rotation.
Test events — check event.test_event FIRST (2.7.0+). It is True only on an event synthesized by "Send test event"; livemode does not tell you this. Return 2xx and do nothing else — a test event can carry a real session's ids.
Re-read a payment — payment_intents.retrieve(id) (2.7.0+) returns its stored state. On a 3-D Secure return page use it, with the id you stored at create time, instead of the URL's query params.
Return confirmation — client.sessions.confirm_return(params, session_secret) verifies the signature and confirms server-side that the payment succeeded, returning ReturnOutcome(paid, signature_valid, status, reason). Use this, and branch on paid. ⛔ verify_return_signature() is DEPRECATED and STOPS WORKING on or after 2026-10-13 — the redirect stops carrying sig / status / amount / currency / transaction_id at all, so there will be nothing to verify and it will refuse every return. Migrate before that date. (It was also never usable as merchant-side proof: the signature uses a platform-wide secret no merchant was ever issued.) It proves a message is AUTHENTIC, and a declined payment is signed just as validly, so a true from it was never proof of payment either. ⚠️ reason == "still_pending" means the charge is in flight (the ordinary 3-D Secure case) — show a neutral "confirming your payment", never a failure. ⚠️ paid: true still does not mean safe to fulfil: record which session IDs you have already fulfilled, and prefer fulfilling from the charge.succeeded webhook. ⚠️ Not session.succeeded — that event is emitted internally but is not subscribable: it is absent from the merchant subscription catalog, which accepts an unknown event key, stores nothing and returns success. An endpoint subscribed to it receives nothing, forever, with no error raised at any layer. charge.succeeded is the fulfilment event.
Auto-retry — exponential backoff on 429 / 5xx with Retry-After header support.
Request ID tracing — every response includes X-Request-Id for support tickets.

Documentation

License

MIT

Metadata

Release files for vonpay-checkout 2.9.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for vonpay-checkout 2.9.0
File	Size	Uploaded
vonpay_checkout-2.9.0.tar.gz	120.8 kB	Sep 23, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for vonpay-checkout 2.9.0
File	Interpreter	ABI	Platform	Reset
vonpay_checkout-2.9.0-py3-none-any.whl 96.4 kB Sep 23, 2026	Python 3	none	any	Details

Total release size: 217.2 kB

Release files / vonpay_checkout-2.9.0.tar.gz

Download URL	vonpay_checkout-2.9.0.tar.gz
Size	120.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`37b39ebcdf7c7bcb5e4ec88974f4740776d470f637baf5c230d4f1578643240c`
BLAKE2b-256 checksum How to use checksums	`1d09ad28bb0a34fe12b26f876dd9ec8f28ebf40277cdd55d0fa7f88cfb2b8dbb`
Upload date	Sep 23, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/Von-Payments/vonpay
Publishing commit: github.com/Von-Payments/vonpay/tree/3ca8668f3abb56e804392eeca0b1c8092171bec5

Workflow

Publishing configuration: github.com/Von-Payments/vonpay/blob/3ca8668f3abb56e804392eeca0b1c8092171bec5/.github/workflows/publish-pypi.yml
Publishing logs: github.com/Von-Payments/vonpay/actions/runs/35874126092/attempts/1

Artifact

Subject: vonpay_checkout-2.9.0.tar.gz
SHA-256 checksum: 37b39ebcdf7c7bcb5e4ec88974f4740776d470f637baf5c230d4f1578643240c Verifying attestations

Release files / vonpay_checkout-2.9.0-py3-none-any.whl

Download URL	vonpay_checkout-2.9.0-py3-none-any.whl
Size	96.4 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`8c436903b28b56f8b4085f60770eec48154c2352ffa3752f7eaef6bf325f7b5d`
BLAKE2b-256 checksum How to use checksums	`34f0643a9bd60d7ac724da6380b53feb20789cf28291d0ef139b823a01920878`
Upload date	Sep 23, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/Von-Payments/vonpay
Publishing commit: github.com/Von-Payments/vonpay/tree/3ca8668f3abb56e804392eeca0b1c8092171bec5

Workflow

Publishing configuration: github.com/Von-Payments/vonpay/blob/3ca8668f3abb56e804392eeca0b1c8092171bec5/.github/workflows/publish-pypi.yml
Publishing logs: github.com/Von-Payments/vonpay/actions/runs/35874126092/attempts/1

Artifact

Subject: vonpay_checkout-2.9.0-py3-none-any.whl
SHA-256 checksum: 8c436903b28b56f8b4085f60770eec48154c2352ffa3752f7eaef6bf325f7b5d Verifying attestations