This is the full file; follow it from Part 1. # OpenReceive + Stripe agent directions: add BTC, USDT & USDC checkout to a Stripe app (FastAPI) ```sh # READ THIS FIRST: this file is 55 KB and a summary drops required steps. Download it whole: curl -fsSL https://openreceive.org/agent-directions/stripe/add/fastapi/full.md # Skip the download only if you already have all of it: pasted, read from disk or fetched raw. ``` **In brief** (Part 1 has the details): - Stripe stays exactly as it is. Add Pay with BTC, USDT & USDC next to it; never change how card payments work. - Before installing or editing anything, ask the user for a receive-only NWC code. One question per message. - Next ask for the LSC code, then Part 1's one pricing question. Never ask for or read a Stripe key. - Never echo a code or put one in a shell command. Do not suggest rotating a code pasted here. - Part 3's quickstart is not the end: after it, do Part 1 steps 5 and 6, then hand over. Part 3 describes OpenReceive 0.4.23. Parts 1 and 2 are the Stripe design from https://openreceive.org/processors/stripe. # Part 1: add BTC, USDT & USDC checkout to this Stripe app This app already takes card payments through Stripe. You are adding a second way to pay, "Pay with BTC, USDT & USDC", through OpenReceive. Stripe keeps working exactly as it does now: the same prices, the same webhook endpoint, the same API version, the same billing for every existing card customer. This file has three parts: - **Part 1** (this part): the order of work for this app. - **Part 2**: the design, which says what to build. - **Part 3**: OpenReceive's own directions for this framework, including the full quickstart. Follow it for everything about OpenReceive, with the changes listed in step 4 below. If this app does not use Stripe at all, stop and tell the user these are the directions for an app that already uses Stripe. The new-app directions are at the same URL with `/new/` in place of `/add/`. ## 1. The codes Do Part 3's Step 0 exactly: ask for the receive-only NWC code, then the LSC code, one question per message, and save each one yourself. Do not ask for, read, print or change any Stripe key. This app already has its keys, and nothing you build calls Stripe. ## 2. Read the app (no edits) Find, by reading the code: 1. **The Stripe code**: where checkout sessions or payment intents are created, the webhook route and handler, and which events it handles. 2. **The success path**: the code that runs when a card payment succeeds and gives the customer their plan, credits or product. This becomes what settle calls. 3. **What is sold**: subscription plans, credit packs or usage, one-time products. Note each one's card price and where it lives (Stripe price ids in config, environment or the database). 4. **Every access check**: each place that reads the Stripe subscription or plan to allow a feature, an API call or a limit. 5. **The tests**: how to run them. Run them once now. Fix nothing unrelated, but note any that already fail. ## 3. One pricing question Ask in one message, filled in from what you found. For plans: > BTC, USDT and USDC are paid up front, so plans become prepaid passes: 60, 180 > or 365 days at 10%, 20% and 26% off the monthly card price. For example, > at $/month would be $<60d> / $<180d> / $<365d>. Credit packs > would cost the same as by card. Reply "ok", or tell me what to change. Leave out the credit pack sentence if the app sells none. If it sells only one-time products, ask instead: "BTC, USDT & USDC checkout will sell the same products at the same prices. Reply "ok", or tell me what to change." ## 4. The OpenReceive quickstart (Part 3), with these changes - **The payable row is the OpenReceive order** from Part 2, not an existing card order model. If the app already has an orders or payments table that fits, add Part 2's columns to it instead of creating a new table. - **`authorize`, `amount_for` and `on_paid`** follow Part 2's "OpenReceive hooks". `on_paid` calls settle and nothing else. - **Do not hand over after the quickstart.** Part 3's "After the quickstart: hand over, then stop" applies at the end of step 6 below, not here. When the quickstart is done (its doctor check is clean), continue with step 5. ## 5. The Stripe side, in this order 1. **Extract, don't rewrite.** Move the grant code from the success path into functions that settle can call: grant a plan period, grant credits, deliver a product. The Stripe webhook keeps calling the same code with the same inputs and gets the same result. Card behavior must not change. If card payments already create order rows, keep them. Don't add card order rows just for this. 2. **Pass access**: the access row, pass records and credit lots from Part 2 (credits only if the app has them), with migrations through the app's own tooling. 3. **One access helper.** Route every access check you found in step 2 through it, so a pass unlocks exactly what the same plan by card unlocks. 4. **Pass prices** stored with the plans (or packs, or products), separate from Stripe's price ids, with the answer from step 3. 5. **The "Pay with BTC, USDT & USDC" endpoint.** Check what is being bought against the catalog. Refuse a pass while a card plan is live, with Part 2's message. Create the OpenReceive order with its saved price and a fresh reference, then send the customer to that order's checkout page. 6. **The checkout page** for one OpenReceive order, reachable from the customer's account. It mounts the OpenReceive checkout from Part 3. When the order is already paid, show "Payment received" and what it bought instead. 7. **The pricing page**: Part 2's toggle and pass cards next to the existing card plans. Leave the card buttons and their flow untouched. 8. **Expiry**: the sweeper on the app's existing scheduler, if it has one, and reminder emails if the app already sends email. With neither, the access helper's `paid_until > now` check is enough. ## 6. Check, then hand over - Run the test suite again. Every test that passed in step 2 must still pass. - Add tests: settle run twice grants once, extending a pass from `max(now, paid_until)`, a refused pass while a card plan is live, and the access helper for card only, pass only, and both. - Check the app's Stripe intake against Part 2's "Stripe intake". Change nothing there. Note the most important gap for the hand-over. Now follow Part 3's "After the quickstart: hand over, then stop", with these changes: - The link is the checkout page of a real unpaid OpenReceive order: a 60-day pass of the cheapest plan, or the cheapest pack or product if there are no plans. - One of the five lines says card checkout is unchanged. - If you noted a Stripe intake gap, name it in one more line, the only line allowed beyond five. --- # Part 2: the design This is the design both modes build. It runs in production next to Stripe. Use this app's own names, ORM, migrations and conventions for everything below. The table and column names here describe roles, not required names. ## The flow ```text Stripe webhook (verified, stored, processed) ──┐ ├──▶ settle(order) ──▶ grant OpenReceive on_paid (inside its transaction) ──┘ ``` Card payments keep coming through Stripe. BTC, USDT and USDC payments come through OpenReceive. Both call ONE settle function. Nothing downstream of settle may care which payment method was used. ## Data **Orders.** One row per purchase, whatever the payment method: - `payment_method`: `card` or `openreceive` - `kind`: `card_plan_period`, `pass`, `credit_pack` or `product` (only the kinds this app sells) - `amount_cents` in the app's currency (USD unless the app already prices in something else), integer cents. Revenue is always fiat, never sats. - `status`: `pending`, then `paid` (plus whatever refund states the app already tracks) - `reference`: for OpenReceive orders, an opaque random string (for example 12 lowercase letters and digits), unique, set when the order is created. Never the row id: ids leak order counts and let anyone guess other checkout URLs. - what was bought: the plan and days for a pass, the pack for a pack, the product or line items for a product - the Stripe ids for card orders (invoice, checkout session, payment intent), each unique If the app already has an orders, payments or purchases table that fits, add these columns to it instead of creating a new one. **Pass access.** At most one live row per account: `account`, `plan`, `paid_until`. It is the prepaid equivalent of a subscription. Keep a record of each pass bought (`account`, `plan`, `days`, `order`, `credits`) for history and support. **Card access** stays where Stripe's subscription state already lives, synced from Stripe webhooks. A row that holds a Stripe subscription id is a card row forever. Only the Stripe sync writes to it. Never write pass access onto it. **Credits**, only if the app sells usage: - One lot per grant: `account`, `source` (card plan, pass, pack, gift), `granted`, `remaining`, `expires_at` (empty means never). - An append-only ledger of grants and spends, each entry with a unique idempotency key. - Spend lots that expire before lots that don't: plan and pass lots first, then packs. Within a group, oldest first. - Lock the account's lots while spending so two requests cannot spend the same credit. ## settle(order) ```text settle(order): in one database transaction: lock the order row if order.status is paid: return # replay, retry or second path mark the order paid case order.kind: card_plan_period → grant the period's credits (key: card plan + period start) pass → extend pass access, grant pass credits (key: pass id) credit_pack → grant pack credits, never expire (key: pack purchase id) product → this app's existing fulfillment after commit: emails, receipts, live updates, background jobs ``` - Every grant writes under a unique key, so a replayed event cannot grant twice even if the order check were bypassed. - OpenReceive runs `on_paid` INSIDE its own settlement transaction. If settle raises, settlement rolls back and OpenReceive retries on its next reconcile pass, so settle must be safe to run again. Anything that leaves the database (email, websocket broadcast, job enqueue) runs only after the outermost transaction commits. ## Prepaid passes - Lengths: 60, 180 and 365 days by default. Show 60 first. A length the merchant doesn't sell has no price; refuse it on the server, so an old browser tab can never create a $0 pass. - Price: card monthly price × days/30 × (1 − discount), rounded to whole dollars. Default discounts: 10% for 60 days, 20% for 180, 26% for 365. Store the pass prices with the plans, separate from Stripe's price ids. A plan sold only as a pass never gets a Stripe price id. - Extend: `paid_until = max(now, paid_until) + days`. The access row takes the plan of the pass just bought, so a higher plan upgrades the remaining time. - Credits: the plan's monthly credits × days/30, rounded, granted at once, expiring at the new `paid_until`. - Never auto-renews. Show "One-time pass, no auto-renew" next to every pass price. Keep the buy button enabled for the customer's current plan, so they can renew early. - A sweeper (the app's scheduler or a periodic job) ends pass access when `paid_until` passes. It never touches card rows. Access checks compare `paid_until` to now, so access ends on time even if the sweeper is late. - If the app sends email: remind 7 days before `paid_until`, and on the day. ## When a customer has both - **A card plan is live** (active, trialing or past due, even if set to cancel at period end): refuse passes, both in the UI (disabled button) and on the server (in the endpoint that creates the OpenReceive order). Copy: "You have a card plan. Prepaid passes become available once it ends. Credit packs are available any time." - **The customer holds a pass, then starts a card plan:** both run. The pass keeps its days. Do not cancel the pass access row when a card plan starts. - **A pass order paid after a card plan started:** settle it normally on the pass access row. Never move it onto the card row. - **Features** come from the single best plan the customer currently has, by card or by pass. Credits add up across both. - **One access helper decides everything:** what plan the account is on and whether it is entitled, from card rows (Stripe status active, trialing or past due) and the pass access row (`paid_until > now`). Every feature check, API gate and limit calls this helper. Route existing scattered checks through it. ## OpenReceive hooks Part 3 explains the hooks. In this design they map like this: - **The payable row is the OpenReceive order.** Create it in the app's own "Pay with BTC, USDT & USDC" endpoint, before the checkout opens. Its `reference` is what the checkout and OpenReceive see. - **`authorize`:** the reference must belong to a pending or paid OpenReceive order owned by the signed-in account. Holding a reference is a claim, not proof. - **`amount_for`:** returns the order's saved `amount_cents` as a decimal string, with a description such as "Plus, 60-day pass". Never a value from the request, never a live catalog lookup, never a float. - **`on_paid`:** finds the OpenReceive order by reference and calls settle. Nothing else. Every "Pay with BTC, USDT & USDC" click may create a new pending order. That is fine. Abandoned pending orders cost nothing. The checkout page for an order must stay reachable from the customer's account (for example `/orders//pay`), because that page is also where a payer claims a swap refund. ## Stripe intake In add mode, check the app's existing Stripe code against these rules and report gaps in your hand-over. Don't rewrite it. In new mode, build it this way. - Verify the webhook signature, store the event under its Stripe event id (unique), answer 200, then process it. Retry failed events. A periodic re-list of recent events catches missed deliveries. - Events: `checkout.session.completed`, `customer.subscription.created`, `customer.subscription.updated`, `customer.subscription.deleted`, `invoice.paid`. Re-fetch the subscription from Stripe before applying it, because events arrive out of order. - Fulfillment happens only in the webhook, through settle. The success redirect only shows a message. - Card checkout uses Stripe Checkout (`mode: subscription` for plans, `mode: payment` for packs and products) with the account id in metadata. ## The pricing page - Name the second payment method by its coins: "BTC, USDT & USDC". If the app has no swap provider configured (no LSC code), it takes BTC only, so say "BTC" instead everywhere below. - One toggle, "Pay with card" / "Pay with BTC, USDT & USDC", controls the whole plan grid and pack list. Remember the choice per account if the app has accounts. - Card mode shows plans that have Stripe prices. BTC, USDT & USDC mode shows plans that have pass prices. Decide this from the data, not from hard-coded plan names. - Pass plan cards: a 60 / 180 / 365 day switch, the price "/ 60 days", the credits "granted at once", "One-time pass, no auto-renew", and a "Pay with BTC, USDT & USDC" button. - The account page shows how the plan is paid: "Card (renews monthly)" or "Prepaid pass, until ". Card-only buttons such as "Manage payment method" appear only for card plans. ## Never - Never write pass access onto a row that holds a Stripe subscription. - Never fulfill on a redirect, a client callback or a payer-supplied amount. - Never grant without a unique key. - Never change Stripe prices, products, webhook endpoint or API version in an app that already takes card payments. - Never call Stripe from `amount_for` or `on_paid`. --- # Part 3: OpenReceive agent directions (FastAPI) **Step 0 in brief** (Step 0 below has the details): - Before installing or editing anything, ask the user for a receive-only NWC code. One question per message. - Next ask for the LSC code. If the user wants stablecoins, USDT, USDC, ETH, SOL or crypto, do not ask yes/no first. - The user only pastes codes into this chat. Never ask them to edit .env or run a command to save one. - Write each code into .env yourself, as Step 0 says. Never echo it or put it in a shell command. - Do not suggest rotating or revoking a code because it was pasted here. - Start the quickstart only once the NWC code is saved, and the LSC code is saved or the user said "Bitcoin only". These directions describe OpenReceive 0.4.23. Add OpenReceive to a FastAPI application — the app you are already working in. You do not need a copy of the OpenReceive source: the engine is on PyPI (`openreceive[fastapi]`), the checkout UI is on npm, and the quickstart is appended to this file in full, so you can do the whole integration without fetching anything. Prefer the published packages and the routes the router serves — do not reimplement wallet RPC, settlement, or pricing. Do not clone the OpenReceive repository into this app, and do not copy a demo's models (`ShopOrder`, a signed-cookie visitor, an in-memory catalog) over tables that already exist. Find this application's order, product, and user models — whatever they are actually named — and map the three hooks onto those. Keep this application's frontend framework, authentication and database. Pick the UI package that matches the frontend that is already here (`@openreceive/react`, `/vue`, `/svelte`, `/angular`, or `/elements` for plain HTML or Jinja templates) — do not add React to an HTMX app. Keep FastAPI's dependency system: the auth dependency this app already resolves its user with is what `authorize` should call on `context.request`, and the database OpenReceive gets is a sync SQLAlchemy `Engine` for the SAME database this app already uses. ## What OpenReceive is A payment library that runs inside YOUR server. It is an `APIRouter` (`openreceive_router`, included under `/openreceive`) that serves its HTTP routes inside the application you are editing, issues Lightning invoices against a wallet the merchant already controls, and calls back into your code when one settles. There is no OpenReceive account and no API key, and OpenReceive never holds the funds — the sats land in the wallet the merchant connected. The one required credential is a receive-only NWC code (Nostr Wallet Connect): a string from the merchant's wallet that can create invoices and read their status, and cannot spend. A swap provider (an "LSC" code) optionally lets the payer send USDT, USDC, ETH or SOL instead, converted into that same Lightning payment. Step 0 collects those credentials from the user; you write three hooks — `authorize`, `amountFor`, `onPaid`; OpenReceive supplies invoices, polling, settlement and the checkout UI. It never owns orders, users, prices, or fulfillment. ## Step 0 — ask for the two codes, one question at a time Before anything else, check one file: the project's `.env`, if it exists. `grep -E '^(NWC_URI|LSC_URI_PRIMARY)=.' .env | cut -d= -f1` names the codes it sets without printing them. Check with that, here and after each write, not by reading the file, and never print the values. A code that is already set is not asked for again; if both are set, skip to step 5 (making the server load the file), then the quickstart. Otherwise your next action is a question to the user. Do not install packages, edit the app, write `.env.example`, or search anywhere else before asking it. Do not read deploy config (compose files, platform secrets), Docker containers, or process environments, and never run `printenv`. A new shop has neither code yet: hunting for one burns the turn and can leak other secrets into the transcript. Two server-only URIs are needed before the quickstart: - `NWC_URI` — a receive-only Nostr Wallet Connect code, `nostr+walletconnect://…`. Required for Bitcoin. - `LSC_URI_PRIMARY` — a Lightning Swap Connect URI, `lightning+swapconnect://…`. Required for USDT, USDC, ETH and SOL. Skip it only when the user says they want Bitcoin alone. The user never edits an environment file. They paste each code into the chat; you store it. Ask one question per message. 1. **First message — the NWC code, and nothing else.** Ask for it and walk them through getting it: > To receive payments I need a receive-only wallet code. In Rizful: open > the menu, tap NWC, choose Receive-only NWC code, and tap Copy > (https://openreceive.org/get_a_nwc_code_to_receive_payments). If you would > rather run your own wallet, Alby Hub works too: Connections → Add > Connection → Read Only. Paste the code here and I will store it. Do not mention `.env`, exports, or "tell me when it's set". 2. **When they paste it.** If it does not start with `nostr+walletconnect://`, ask them to copy the receive-only code again. Otherwise write `NWC_URI=` into the project's `.env` with your file-editing tool, creating the file if needed. Never write it with a shell command (`echo`, `printf`, a heredoc, `python -c`): the command line shows the code. Make sure `.gitignore` covers `.env` (and `.dockerignore`, if the app has one). Never echo the value, commit it, or put it in client code. Reply only that it is saved, then ask the next question. 3. **Second message — swaps.** If the user asked for stablecoins, USDT, USDC, ETH, SOL, altcoins or "crypto" (as in "Bitcoin and stablecoin payments"), this message IS the walkthrough below: send it as it is, and do not ask yes or no first. Otherwise ask whether payers should also be able to pay with USDT, USDC, ETH or SOL, then give the walkthrough. The walkthrough: > Go to https://lightning-swap.com, sign in for API keys, create a key, and > copy the whole URI (https://openreceive.org/set_up_swap_provider). Paste > it here and I will store it — or say "Bitcoin only" and I will continue > without it. Mention FixedFloat only if they already use it. 4. **When they paste it.** If it does not start with `lightning+swapconnect://`, ask them to copy it again. Otherwise add `LSC_URI_PRIMARY=` to the same `.env` with the file-editing tool, never a shell command. Swaps are now on, so build the refund route back (the swap non-negotiable below) as part of this integration. If they chose Bitcoin only, leave `LSC_URI_PRIMARY` unset and skip that route. 5. **Make the server load the file — yourself.** OpenReceive reads `os.environ`, and a `.env` file on disk is not in it. Start the dev server with `uvicorn --env-file .env` (update the app's run script or Procfile, not just your own command). When it is started with Docker Compose, give the service `env_file: .env`. Restart the server after writing the file. Do not invent placeholder URIs. Start the quickstart only once `NWC_URI` is saved and `LSC_URI_PRIMARY` is saved or explicitly declined. The first boot runs the receive-only preflight: if it reports spend methods such as `pay_invoice`, remove `NWC_URI` from `.env` and ask for a receive-only code again. Never set the spend-capable override to get past it. After the router is wired, run `openreceive doctor --app :app`. It reports `NWC_URI` presence without printing it, probes the wallet, and names any hook still on a placeholder and whether the migration ran. Exit code 1 is a finding to fix, not a reason to skip the check. ### Upgrading an existing install This is not the opening move of a new integration. When OpenReceive is ALREADY installed here, the doctor above is the first check. Compare the installed `openreceive` (`pip show openreceive`) and `@openreceive/browser` against the release named at the top of this file: the headless display models below do not exist in older versions, and the first tile click throws with nothing saying why. Upgrade first. Only then start the quickstart. ## After the quickstart — hand over, then stop The quickstart is done when `openreceive doctor --app :app --url ` is clean and this app serves the checkout page for one of its orders. Doctor names any failed check and exits nonzero; fix it before going on. Give the user that checkout link. The browser check in the quickstart's step 6 (payment-method icons, wallet logos, a pay tutorial) is theirs: name it in one line of your closing message, and do not run it yourself. You cannot pay the invoice: the code is receive-only. Do not pay, settle or mark an order paid, and do not look for a way to (a wallet control port, a test endpoint, another wallet). If the user wants a real settlement test, they pay on that link from their own wallet, and `on_paid` marks the order paid. Setup ends here. Your last message starts "Setup is finished" and has at most five short lines (about 80 characters each): the link, the methods it offers, and one line of what to look at. Send nothing after it. Do not list what changed, copy out the quickstart's browser checklist, offer more work, or end the message on a question. - The link is to a real unpaid order. Keep that order; do not delete it. - When this app's orders belong to a session or cookie, the user's browser cannot open the order you made. Then the link is the shop's own page: "Open and click Buy: it opens the checkout." Do not explain order ownership or mention your test order. - Name the methods it offers: Bitcoin, plus USDT, USDC, ETH and SOL when `LSC_URI_PRIMARY` is saved. Do not mention minimums, and never say a coin will not work or will not be offered. ## Non-negotiables The quickstart below has the code. These are the rules it cannot state for itself, and they hold for every integration. - OpenReceive never owns orders, users, prices, or fulfillment. The section below is how those tables sit next to the library — not a second order model, and not a Prisma/Drizzle relation to `openreceive_payments`. - Keep `NWC_URI` / `LSC_URI_*` server-only. Never put them in browser code, logs, or assets. - Do not suggest rotating, revoking or replacing a code because it was pasted into this chat; that is the supported path. - Work only in this application. Never read or run anything from another project on this machine (its `node_modules`, tools or source), for any reason. A browser and Playwright are not part of setup. - Restart only this app's server, on the port it already uses: stop the process you started, or the one listening on that port, by its pid (or restart its Compose service). Never `pkill` or `killall` by name: that stops other people's servers too. Start it the way this project already does (its README, Procfile, compose file or package script), on its own port, not a port you pick. - Run commands where the app runs. When a compose file builds it, run its package manager, generators, migrations and doctor inside that service (`docker compose exec` or `run`), and rebuild the image after adding a package. This machine's language version and database path are not the app's. - To check that the running app sees the codes, run doctor: it reports each one as present or missing and never prints a value. Never print the environment (`printenv`, `env`, `docker compose config`), even filtered to names. - The host owns the price. `amount_for` reads it from your own data; reject payer-supplied amounts. - `authorize` runs on every request, and the `resource` it receives is a CLAIM the payer made, not proof. Read the Starlette request's session, cookie or auth dependency; never trust a body field. - `on_paid` must be idempotent. Its database fulfillment commits once per `reference` — your order id, one per thing you fulfill, created before checkout, kept across retries, never reused. A fresh id per page load lets one order be paid twice. - Receive-only NWC is required; a spend-capable code fails closed at boot unless explicitly overridden. - There is NO merchant-initiated refund of a settled Lightning payment, because the wallet cannot spend. Swap refunds — a payer reclaiming a deposit that never converted — are the only refund OpenReceive performs, and only from the `refund_required` provider state. Do not build, promise, or imply a Lightning refund path. - IF YOU TURN SWAPS ON, BUILD THE ROUTE BACK. A deposit that arrives short or late becomes `refund_required`, and the payer claims it on a SECOND VISIT, after leaving your page to fetch an address from another wallet. Three things must exist or that money is unreachable through your UI: a per-order URL your server serves (`/checkout/:reference` — `syncUrl` on ``, `sync-url` or `resumable` on ``), your own order-summary route to restore the order from, and the ATTEMPT. `/checkouts/prepare` returns no attempts, so a checkout rebuilt from the reference alone opens on the method grid. Re-picking the same coin (`POST /swaps`) re-serves the committed attempt — but only while it is live, and the shadow invoice behind a swap lasts about half an hour, after which the same click mints a NEW deposit address and the refund is off-screen. Keep the `payment_hash` and reopen the attempt with `POST /swaps/status`, which has no such window. On the drop-ins: `resumePaymentHash`, fed from `onState`, on ``; the `resume-payment-hash` attribute, fed from the `openreceive-state` event (`event.detail.state.payment_hash`), on ``. https://openreceive.org/guides/swap-refunds.md - Show the payer WHAT THEY ARE BUYING. Return an optional `description` beside the price from `amount_for` and both drop-ins render it above the amount. Without it the checkout is a QR and "$1.00" with no sign of what the dollar is for. - Show the payer the transaction record: `createTransactionDetails(...)` rows, collapsed behind a caret, on the live checkout AND on the receipt. A payment hash and a deposit txid are the only evidence a payer has that they paid you. `` / `` already render this panel and the `description` — these two rules cost you code only on a custom UI or your own receipt page, never a reason to replace the drop-in. (It returns no rows while the rail is `checkout_lock` — before the payer has chosen anything there is no transaction — so render the caret only when the rows are non-empty.) - Include the router under the prefix — `app.include_router( openreceive_router(host, engine=engine), prefix="/openreceive")` — and give the app `lifespan=openreceive_lifespan(host, engine=engine)` so a bad wallet stops the deploy. Do not add a CSRF layer for these routes: FastAPI has none and the engine's `Sec-Fetch-Site: cross-site` refusal is the protection. Behind a reverse proxy run uvicorn with `--proxy-headers`, or `rate_limiting` counts the proxy as the one payer. - The engine is synchronous by design: the router's endpoint runs in Starlette's threadpool. Do not wrap it in `async def` code of your own, and do not hand OpenReceive an async database session — it wants a sync SQLAlchemy `Engine`. - HTTP JSON is snake_case, and so is the Python API (`payment_hash`, `amount_msats`). - Money is integers or decimal strings — never binary floats. ## Your tables, not ours `openreceive scaffold payments --alembic` (or `--sql`) emits `openreceive_payments` and `openreceive_meta` for THIS application's database. That is the whole persistence OpenReceive needs. It does not replace your orders, users, or products, and you do not join them. - **Find this app's models first.** They may be named `Order`, `Invoice`, `Booking`, `Product`, `Variant`, `User`, `Account` — anything. Wire the hooks to those. Do not generate a parallel `ShopOrder` / `ShopProduct` / `ShopUser` stack. - **The payable row's id is the `reference`.** Create it before checkout, keep it across retries, never reuse it. Pass that id to `` / ``. A fresh id per page load lets one order be paid twice. - **Products (or the catalog) are the price authority.** Order creation reads live prices into the order (snapshot line items if this app has them). `amount_for` reads only that order — never a payer-supplied amount, never a live catalog lookup that could re-price a cart already placed. Return `{"currency", "value"}` as a decimal STRING, plus a `description` of what they are buying. - **Users own the order; OpenReceive never sees them.** `authorize` uses the same ownership check this app already uses on the order show / pay page — the `current_user` dependency, a session cookie, whatever it is, resolved from `context.request`. `context.resource["reference"]` is a claim the payer sent, not proof. - **The order is unpaid or paid.** Do not copy `pending` / `expired` / `failed` / `attention` onto it. Those are attempt statuses on `openreceive_payments`. An expired invoice does not cancel the order; a later checkout may mint another attempt. The library refuses a new checkout under a reference that already settled (409). - **Pass a sync SQLAlchemy `Engine` for this app's database.** Do not add an ORM relationship from Order to `openreceive_payments`, and do not implement `PaymentRepository` unless no SQLAlchemy engine can reach this database. `reference` is not unique (many attempts per order). Fulfillment is a guarded transition on YOUR order row inside `on_paid` — `UPDATE … WHERE state = 'awaiting_payment'` (or this app's equivalent) through `settlement.connection`, the settlement transaction's own connection, not a second session from your ORM. Database writes only in the hook; emails, jobs, and pushes in `after_paid` or after commit. ## If you build your own checkout UI The drop-ins (``, ``) already obey all of this. This list is the short form of https://openreceive.org/guides/checkout-ux.md, for a UI built on `@openreceive/browser/headless`. Read that before writing components. - Check Bitcoin → Switch payment method → Bitcoin: the grid must hide the Lightning invoice, then restore the same bolt11 without another mint. - `createCheckoutController` is the engine. Do not hand-roll a poll loop. - `createCheckoutStatusModel` for the status line. Do not draw a Cart → Pay → Done stepper. Read the model's `phase`, not the snapshot's. - `resolveWizardSelection` decides whether to ask "which network?". A one-network asset starts the swap from the tile. Key `selectedAssetByGroup` by group (`USDT`), valued by `pay_in_asset` (`USDT_TRON`). - `createMethodGridDisplay` for tiles, including `limitMessage` so an unavailable method says the minimum in the payer's currency. - `createSwapDisplayModel` → `display.copyRows` for deposits: address, memo, and the bare amount each get a copy row. Render `swap.networkWarning*` as the model gives it. - `swap.deposit_amount` is the only amount a payer is told to send. Never put a fiat valuation of it (`swap.fee.pay_in_fiat`) next to a stablecoin amount: "$50.03" under "50.05 USDC" reads as a typo, and the payer asks which one to send. The one fiat figure on a USDT/USDC deposit panel is the cart total (`payout_fiat`); express "you send" and the fee in the token. Use `createSwapFeeBreakdown(fee, swap)` — with the swap, not the fee alone — and it applies this for you; SOL and ETH keep a fiat breakdown. - `createCheckoutSession` owns mint and swap start. To start swaps, pass its `swap` option (`selection`, `prefix`, `fetch`) together. Without it `startSwap` reports through `onError`. - `createQrSvg` is async. Use `createQrSvgController` so you do not render `[object Promise]`. - `checkoutLabels` for every payer-facing string. Only write copy it lacks. - `stageSwapRefund` then `confirmSwapRefund` — only the second submits. Validate with `getSwapRefundFormError`. Treat `409` as a normal outcome. - Pass `{ resumable: true }` to `createSwapDisplayModel` when the payer has a URL they can come back to, and render `display.refundReturnLabel`. Resume helpers (`createGuestCheckoutResume`, `createGuestOrderFetcher`) are on `@openreceive/browser`, not `/headless`. - A refund replaces the deposit panel. On `refund_required` also drop "switch payment method". - No "Open wallet" button on desktop. - Wallet suggestions: `getPaymentWizardRoutes()` + `createWizardRouteDisplays`. Lightning only. Logos are data URIs; tutorial images load from a JavaScript chunk. For a custom headless UI, load it when a tutorial opens and look up the returned table by the tutorial's `path`: ```js import { loadPayTutorialImages } from "@openreceive/browser/headless"; const images = await loadPayTutorialImages(); const src = images[tutorial.path]; // data URI for the selected tutorial ``` Render `src` as the image source and update your UI after loading. Existing display objects do not update: their `tutorial.image` stays `undefined` if created before loading. Alternatively, await the loader, recreate the displays with `createWizardRouteDisplays`, and render the new `tutorial.image`. Show the caption while loading or if loading fails; never use an empty image source. Deploy all JavaScript chunks and allow `data:` in CSP `img-src`. For missing images, check CSP errors, failed chunks, and stale displays. Registry paths are lookup keys; there is no asset option or image route. ## More documentation Fetch one when the moment comes. Each is raw markdown, so a plain GET is enough; drop the `.md` for the same page a person would read. - https://openreceive.org/guides/authorization.md — before you write `authorize` - https://openreceive.org/guides/environment-variables.md — every variable, and what is deliberately not one - https://openreceive.org/guides/storage.md — the payment tables and the attempt state machine - https://openreceive.org/guides/supabase.md — when the database is Supabase: its pooler, its certificate, and locking the tables away from its Data API - https://openreceive.org/guides/frontend-checkout.md — the drop-in's props, attributes and slots - https://openreceive.org/guides/checkout-ux.md — read before building any custom UI - https://openreceive.org/guides/headless-checkout.md — the controller, the display models, refunds - https://openreceive.org/guides/provider-registry.md — where the wallet logos and pay tutorials come from: inside the JavaScript, nothing to serve. This is the page that owns the image rule, not the summary in checkout-ux.md - https://openreceive.org/guides/automated-swaps.md — only if `LSC_URI_PRIMARY` is set - https://openreceive.org/guides/swap-refunds.md — the refund flow, and the route back to it. Read it before you turn swaps on - https://openreceive.org/guides/lightning-swap-connect.md — what an `LSC_URI_*` code actually is - https://openreceive.org/guides/price-feeds.md — where the fiat→sats rate comes from, and how to replace it - https://openreceive.org/guides/host-testing.md — testing your three hooks without a live wallet or provider - https://openreceive.org/guides/rate-limiting.md — before a public shop goes live - https://openreceive.org/guides/security.md and https://openreceive.org/guides/deploying.md — before this goes anywhere real - https://openreceive.org/guides/api-reference.md — every route, option and error code - https://openreceive.org/guides/custom-checkout-route.md — advanced: replacing the shipped adapter's routes with your own - https://openreceive.org/guides/react-material-ui-recipe.md — a worked custom UI on a component library - https://openreceive.org/guides/flask-recipe.md — the same engine as a Flask Blueprint, if this app is Flask after all - https://openreceive.org/guides.md — the index, if what you need is not above Questions, or a problem with the library itself: https://openreceive.org/contact - https://openreceive.org/guides/payment-safety-upgrade.md — coordinated upgrades and reviewed repair of existing attempts --- ## The quickstart, in full Inlined verbatim so this file needs no network access — follow it once Step 0 passes. The page it comes from is https://openreceive.org/guides/quickstart-fastapi. ## FastAPI quickstart FastAPI + React. Requires Python ≥ 3.10, FastAPI ≥ 0.115 (Starlette ≥ 0.40) and a SQLAlchemy 2 `Engine` for OpenReceive's two tables. ### 1. Install ```sh pip install "openreceive[fastapi]" npm install @openreceive/react ``` OpenReceive is one Python distribution with framework extras. `openreceive[fastapi]` brings FastAPI, Starlette and SQLAlchemy. The base package includes the wallet client (websockets, coincurve, cryptography), the HTTP engine and the `openreceive` CLI. The npm package is the checkout UI for your frontend. On a different stack, swap the two: use `openreceive[django]` with the Django quickstart. A page without a bundler uses `@openreceive/elements` instead of React. | | Packages | | -------- | ----------------------------------------------------------------------------------------------------------------------------- | | Server | `openreceive[fastapi]`, `openreceive[django]`, `openreceive[sqlalchemy]` (Flask and plain WSGI/ASGI: the Flask recipe) | | Frontend | `@openreceive/react`, `@openreceive/vue`, `@openreceive/svelte`, `@openreceive/angular`, `@openreceive/elements` (plain HTML) | Use `uv` or a virtualenv on Python 3.10 or newer. A system Python 3.9 cannot install the package. ### 2. Migrate the payment tables ```sh openreceive scaffold payments --alembic --dialect postgres # or sqlite | mysql ``` `openreceive scaffold payments --alembic` writes one Alembic revision into `alembic/versions/`. The DDL is frozen in the file, and it creates two tables: - `openreceive_payments`, the payment attempts - `openreceive_meta`, the reconcile gate Set the revision's `down_revision` to your current head (`alembic heads`). Then apply it the way you apply your own revisions: `alembic upgrade head`. The command never opens a database connection. → [openreceive scaffold payments](https://openreceive.org/guides/api-reference.md#openreceive-scaffold-payments-python) No Alembic? `openreceive scaffold payments --sql --dialect postgres` prints the same DDL. Feed it to `psql`, a Flyway file, or whatever runs your migrations. In code, `payments_schema_sql(dialect)` from `openreceive.storage.sql` returns the same string. OpenReceive owns the tables' logic at runtime: locking, write-once settlement, and the reconciliation state machine. There is nothing else to generate. Details: [Payment storage](https://openreceive.org/guides/storage.md). ### 3. Add wallet credentials Put the credentials in the server's environment. That can be a `.env` your process manager loads, `uvicorn --env-file .env`, or your secret store: ```dotenv NWC_URI= LSC_URI_PRIMARY= LSC_URI_BACKUP= ``` 1. Get a receive-only NWC code from a compatible wallet ([get one here](https://openreceive.org/get_a_nwc_code_to_receive_payments)). Put it in `NWC_URI`. 2. Optional: set up a [swap provider](https://openreceive.org/set_up_swap_provider). Put its connection string in `LSC_URI_PRIMARY`, and a second one in `LSC_URI_BACKUP` if you have one. Never put these values in browser code. Your app refuses to start if the NWC code also advertises spend methods such as `pay_invoice`. Create a receive-only code instead ([Security](https://openreceive.org/guides/security.md)). OpenReceive reads `os.environ`, so a `.env` file on disk is not enough on its own. `uvicorn --env-file .env` loads one in development. In production, the process manager or secret store injects the values. [Environment variables](https://openreceive.org/guides/environment-variables.md) lists every variable. ### 4. Wire OpenReceive The wiring takes twelve lines: - your three hooks as a `Host` - a router included under a prefix - a lifespan that checks the wallet at startup The router builds the wallet client from `NWC_URI` and mounts the framework-free engine. There is no background reconciler, meaning no job that checks pending payments on a timer. Settlement runs during normal requests instead, through the durable reconcile gate. ```python from fastapi import FastAPI from sqlalchemy import create_engine from openreceive.fastapi import openreceive_lifespan, openreceive_router from openreceive.server import Host from .app import current_user, orders # your existing models and auth dependency # OpenReceive's own sync Engine for its two tables — the SAME database as # your orders, its own connection pool. On SQLite give it a dedicated Engine. engine = create_engine("postgresql+psycopg://…") host = Host( # The price for a reference — here, your order id — from your own data; # OpenReceive converts it into the Lightning invoice. Return None when # there is nothing to pay for. `value` is a decimal STRING from the order # row, never a float and never a request param. `description` is what the # payer is buying, in your own words. amount_for=lambda reference: ( {"currency": "USD", "value": str(order.total), "description": order.summary} if (order := orders.find(reference)) else None ), # Your own access check: may this caller do this action to this reference? # `context.request` is the untouched Starlette Request — reuse the same # dependency your order page uses. `context.resource["reference"]` is a # claim the payer's browser sent, not proof. authorize=lambda context: orders.viewer_may( current_user(context.request), context.resource["reference"], context.action ), # INSIDE the settlement transaction; runs only for the reference's first # settled attempt. Use `settlement.connection` (that transaction) for the # order write, never a second session. The WHERE clause is the lock. on_paid=lambda settlement: settlement.connection.execute( orders.claim_paid(settlement.reference, settlement.paid_at) ), ) # The router carries the options. Build it before the lifespan: through # 0.4.21 the lifespan bound first and refused the router's options. router = openreceive_router( host, engine=engine, # Recommended for public web shops: `rate_limiting=True` caps invoice # creation at 60 per client IP per hour. Leave it off (the default) for # point-of-sale deployments, where many payers share the terminal's IP. rate_limiting=True, ) app = FastAPI(lifespan=openreceive_lifespan(host, engine=engine)) app.include_router(router, prefix="/openreceive") ``` `authorize` receives the Starlette `Request`. Cookies, headers, and whatever `SessionMiddleware` or auth dependency this app already has are readable there. FastAPI ships no session of its own, so you must bind the payer's `reference` to something the request proves. Behind a reverse proxy, run uvicorn with `--proxy-headers`. Otherwise `rate_limiting` counts the proxy as the one payer. **There is no CSRF layer to add.** FastAPI has no CSRF (cross-site request forgery) layer, and OpenReceive does not want one. Every mounted route refuses a request whose `Sec-Fetch-Site` header says `cross-site`. That stops another origin's page from minting or refunding on a logged-in payer's behalf. The Express and Fastify adapters rely on exactly the same protection. Its limit is the header itself. A client that does not send it, such as a non-browser or an old browser, is not refused. So `authorize` stays the actual boundary. [Security](https://openreceive.org/guides/security.md) has the full account. `openreceive_lifespan` runs the receive-only wallet preflight when uvicorn starts. It stops the process if the code is missing, unreachable, or able to spend. That way the deploy fails instead of the first payer. Pass `lazy=True` for tests and for build steps that have no secrets. The first request then checks the wallet, and requests get `503 WALLET_UNAVAILABLE` until the check passes. → [openreceive_router](https://openreceive.org/guides/api-reference.md#openreceive_router) · [openreceive_lifespan](https://openreceive.org/guides/api-reference.md#openreceive_lifespan) · [the authorize context](https://openreceive.org/guides/api-reference.md#the-authorize-context) `rate_limiting=True` is for public web shops. Leave it off for point-of-sale, where many payers share one IP. → [Rate limiting](https://openreceive.org/guides/rate-limiting.md) An optional worker, `openreceive notifications --app main:app`, listens for wallet payment notifications so settlement does not wait for the next page load. → [openreceive notifications](https://openreceive.org/guides/api-reference.md#openreceive-notifications) Your app also needs an ordinary order-creation route that validates the cart, prices with exact decimal math, and returns the order id the page will pass as the `reference`. OpenReceive never prices from payer input. The `reference` is a string you choose, and it is the fulfillment identity: your order id. Use one per thing you fulfill, create it before checkout, keep it across retries, and never reuse it. OpenReceive never looks inside it, but the reference still matters: - `on_paid` commits fulfillment once per reference. - A new checkout under a reference that already settled is refused with 409. - A fresh id per page load lets one order be paid twice. Naming boundary: the Python API is snake_case (`payment_hash`, `amount_msats`), and so is everything on the wire. The mounted HTTP routes and the browser snapshots use the same names. ### 5. Render checkout ```tsx import { Checkout } from "@openreceive/react"; import "@openreceive/react/styles.css"; ; ``` The checkout renders, polls, and settles itself. `@openreceive/react` and `@openreceive/elements` each ship a compiled `styles.css`. Each sheet is self-contained, so a plain `` works with no build step. Each is also scoped: every rule applies only inside what OpenReceive renders. Serve the compiled `styles.css` without Tailwind processing. Import it from JavaScript if your bundler handles CSS, or use a plain ``. Do not `@import` it into your app's Tailwind entry. Its rules have low specificity, so your page's styles can override checkout styles. Scoping does not prevent that. `` is complete as rendered. It already shows the `description` from `amountFor` and the collapsed transaction-details panel. Do not build a custom UI to show them. The display rules for them become your job only if you replace the drop-in component ([Checkout UX](https://openreceive.org/guides/checkout-ux.md)). Match the host page's theme. By default the checkout follows the payer's stored choice, then the system color scheme. If this page always uses one theme, lock it with ``. On the custom element, set the `theme` attribute. Locking the theme keeps a white card off a dark page. CSS variables under `data-theme` style the checkout. [Frontend checkout](https://openreceive.org/guides/frontend-checkout.md) lists the settings you can change. Everything the checkout draws ships inside the JavaScript: the payment-method icons, the wallet logos, and the pay tutorials. There is no image file to copy or serve, and no asset option to set. Deploy your normal JavaScript and CSS build output, including any generated JavaScript chunks. Bundlers with code splitting can wait to load tutorial screenshots until a tutorial first opens. Single-file builds, including the standalone checkout, include them from the start. If your Content-Security-Policy has a strict `img-src`, allow `data:` ([Provider registry](https://openreceive.org/guides/provider-registry.md#assets)). That is the whole loop. Your server owns the price and the order. The payer gets an invoice. `onPaid` runs inside the settlement transaction. If that transaction rolls back, the callback may run again. For delivery to outside systems, use an outbox in your app: record the message in the transaction and send it after commit. A page without a bundler renders the same checkout as a custom element: `` from `@openreceive/elements`. You can also serve its standalone build from your static directory. Buy a Button is a runnable illustration of the boundary (`examples/buttons/server/fastapi`). It is not a template to copy models from. It keeps products, visitors and orders in SQLite, and the three hooks are the only bridge to OpenReceive. It is the smallest correct FastAPI integration of the packaged checkout. Map that shape onto the models in THIS app. ### 6. Verify ```sh openreceive doctor --app main:app ``` `openreceive doctor` checks Python, `NWC_URI`, and swap-provider configuration. It also probes the wallet relay to confirm the code is receive-only. With `--app module:attr` (your FastAPI app, the router, or an `OpenReceiveApp`), it also confirms the migration ran and names any hook still on a placeholder. Add `--url http://localhost:8000` to confirm the routes are mounted. Every failing line states its own fix, and the command exits with code 1 when anything fails. `openreceive debug-report` prints the same output as a redacted support report. → [openreceive doctor](https://openreceive.org/guides/api-reference.md#openreceive-doctor-python) Then open the checkout in a browser, confirm the payment-method icons and wallet logos render, and open a wallet's pay tutorial to check its screenshots. If an image is missing, inspect the console for CSP violations and the Network panel for failed JavaScript chunks. Allow `data:` in `img-src` and deploy the complete build output. Do not add image routes, copy package source images, or use registry `icon_path` / tutorial `path` keys as browser URLs. Swap credentials (`LSC_URI_*`) stay server-side too. The provider order id and token live in the attempt's server-only `swap_data` column. They never reach a response or a log ([Automated swaps](https://openreceive.org/guides/automated-swaps.md)).