Next.js quickstart

Next.js App Router + React. Requires Node ≥ 22 and Next ≥ 15 (App Router).

1. Install

npm install @openreceive/next @openreceive/react

Install the adapter for your server and the UI package for your frontend. The wallet client, HTTP handler, and contracts come along as dependencies. The openreceive package is only the CLI, and npx openreceive … below needs no install. On a different stack, swap the two packages; the rest of this guide stays the same.

  Packages
Server @openreceive/next, @openreceive/express, @openreceive/fastify
Frontend @openreceive/react, @openreceive/vue, @openreceive/svelte, @openreceive/angular, @openreceive/elements (plain HTML)

Express: quickstart-node.md · Fastify: quickstart-fastify.md. This page is the Next.js one. An agent given the Express guide goes wrong on Next.js in three places: Next needs no dotenv, no app.use, and it needs a client component for the checkout.

On a fresh project, create-next-app scaffolds the App Router for you. You need no env loader, because Next loads .env.local itself. Install your ORM before step 2 (npm install prisma @prisma/client on the Prisma path). openreceive scaffold emits files for the ORM you name, but it never installs that ORM.

Some editor sandboxes run npm with ignore-scripts. That setting skips Prisma’s engine download and esbuild’s binary postinstall. If a typecheck or build fails only in such an environment, the environment is the cause, not your code.

2. Migrate the payment tables

npx openreceive scaffold payments --orm prisma   # or drizzle | typeorm | sequelize | knex

openreceive scaffold payments writes one schema or migration file for your ORM, plus a wiring guide. It never touches a database. → openreceive scaffold payments

Then run the generated migration the way you normally do (for example npx prisma migrate dev). OpenReceive runs the tables’ logic at runtime, so there is nothing else to generate. Details: Payment storage, Node ORM recipes.

No ORM? You can pass a bare driver handle (pg, node:sqlite, better-sqlite3) as the db in step 4. The scaffold has no flavor for it. Instead of scaffolding, run the same DDL once yourself, using paymentsSchemaSql(dialect) from @openreceive/http. Your adapter already pulls that package in, but this import is yours, so install it too: npm install @openreceive/http.

3. Add wallet credentials

Create a server-only .env.local. Next loads it into process.env on its own, so do not add dotenv. Never prefix these variables with NEXT_PUBLIC_, because that would inline them into the browser bundle.

NWC_URI=
LSC_URI_PRIMARY=
LSC_URI_BACKUP=
  1. Get a receive-only NWC code from a compatible wallet (get one here). Put it in NWC_URI.
  2. Optional: set up a 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).

In production, supply the same variables through your host’s secret manager or process environment. .env.local is for development, and create-next-app gitignores it. → Environment variables.

4. Wire OpenReceive

One catch-all route file takes your hooks and a database handle. The adapter builds the wallet client and the host, and returns the GET/POST exports the App Router expects. 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. That is what makes it safe on serverless hosts.

// app/openreceive/[...openreceive]/route.ts
import { openReceiveNextHandlers } from "@openreceive/next";
import { db, orders, sessions } from "@/lib/app"; // your existing database handle and models

// The wallet relay and your database driver need Node, never the Edge runtime,
// and a payment route must never be cached or statically rendered.
export const runtime = "nodejs";
export const dynamic = "force-dynamic";

export const { GET, POST } = openReceiveNextHandlers({
  wallet: { nwc: process.env.NWC_URI! }, // receive-only NWC code; your app refuses to start otherwise
  storage: {
    db, // pg Pool/Client, node:sqlite, better-sqlite3, or a custom adapter
    onPaid: async ({ reference, paidAt, query }) => {
      // Settlement transaction; runs only for the first settled attempt for a
      // reference. The WHERE clause is the lock: a second fulfillment path of
      // yours (admin action, replayed job) updates zero rows and does nothing.
      // Use `query` here, not your ORM's other connection. `?` on sqlite, `$1`
      // on postgres.
      const claimed = await query(
        "UPDATE orders SET state = 'paid', paid_at = ? WHERE id = ? AND state = 'awaiting_payment' RETURNING id",
        [paidAt, reference],
      );
      if (claimed.length === 0) return;
    },
  },
  // The price for a reference — here, your order id — from your own data;
  // OpenReceive converts it into the Lightning invoice. Return null 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.
  amountFor: async (reference) => {
    const order = await orders.find(reference);
    return order
      ? {
          currency: "USD",
          value: order.total.toString(),
          description: `${order.lines.length} items`,
        }
      : null;
  },
  // Your own access check: may this caller do this action to this reference?
  // `resource.reference` is your own order id, sent back by the payer's
  // browser — a claim, not proof — already validated as a non-empty string.
  // `request` is the Web Request; read cookies or headers from it the way you
  // would in any route handler (`native` is the same NextRequest).
  authorize: async ({ action, request, resource }) =>
    orders.viewerMay(
      await sessions.currentUser(request),
      resource.reference,
      action,
    ),
  // Recommended for public web shops: caps invoice creation at 60 per client IP
  // per hour. A web Request has no socket IP, so on Next this ALSO needs an
  // IP source: `trustProxyIpHeader: true` reads the first hop of
  // x-forwarded-for, which is safe only when YOUR reverse proxy or hosting
  // platform sets it (Vercel, Cloudflare and most load balancers do). Without
  // an IP source the adapter refuses to construct rather than run an
  // inactive limiter. Leave both off for point-of-sale deployments, where
  // many payers share the terminal's IP.
  rateLimiting: true,
  trustProxyIpHeader: true,
});

The route file is a server module. It imports your database handle and reads process.env, so no client component may import anything from it. The default prefix is /openreceive, which is the directory the file sits in. If you put the catch-all under another directory, pass a matching prefix.

Sometimes the options are themselves async, such as a database opened lazily or a wallet client shared with a worker. Then build the handlers per request instead of at module load. The Buy a Button example does exactly this:

async function handle(request: Request): Promise<Response> {
  const { GET, POST } = openReceiveNextHandlers(await httpOptions());
  return request.method === "GET" ? GET(request) : POST(request);
}
export { handle as GET, handle as POST };

The first request checks the wallet. Later OpenReceive requests also settle pending invoices, so a payer who closes the tab is still covered. authorize runs on every request. → openReceiveNextHandlers · authorize context

rateLimiting: true is for public web shops. Leave it off for point-of-sale, where many payers share one IP. → Rate limiting

An optional worker, startNotificationWorker({ service, host }), listens for wallet payment notifications so settlement does not wait for the next page load. It is a separate long-lived Node process, not a route. On a serverless host, skip it and rely on the request-path settlement described above. → startNotificationWorker

You can also compose the pieces yourself (createOpenReceive + createHost) when you need a shared wallet client or a custom repository. → createOpenReceive · createHost

Your app also needs an ordinary route that creates the order. It validates the cart, computes the price with exact decimal math, and returns the order id. The page passes that id as the reference. OpenReceive never takes a price from payer input.

The reference is a string you choose, and it identifies what gets fulfilled. Use your order id. Make it:

OpenReceive never looks inside the reference, but it relies on it:

Naming boundary: TypeScript APIs use camelCase fields (paymentHash, amountMsats). Everything on the wire is snake_case (payment_hash, amount_msats). The wire means the mounted HTTP routes and the browser snapshots.

5. Render checkout

<Checkout> polls and holds state, so it is a client component. Put it in a file that starts with "use client", and import the stylesheet from that same module. The page that renders it can stay a server component.

// app/checkout/[reference]/order-checkout.tsx
"use client";

import { Checkout } from "@openreceive/react";
import "@openreceive/react/styles.css";

export function OrderCheckout({ reference }: { reference: string }) {
  return <Checkout reference={reference} prefix="/openreceive" />;
}

// app/checkout/[reference]/page.tsx — the order's own, resumable URL
import { OrderCheckout } from "./order-checkout";

export default async function CheckoutPage({
  params,
}: {
  params: Promise<{ reference: string }>;
}) {
  const { reference } = await params;
  return <OrderCheckout reference={reference} />;
}

/checkout/[reference] is deliberately a page of its own rather than a modal on the cart. A payer with a swap deposit in flight has no account and no email from you. This URL is the only thing that brings them back to their payment, so it has to survive a reload and a bookmark (Swap refunds).

Do not render the checkout for a reference the current session may not see. The page can read the session and return 404 before it renders, and authorize refuses the routes regardless.

The checkout renders, polls, and settles itself. The compiled styles.css sheets (@openreceive/react, @openreceive/elements) are self-contained and scoped: every rule applies only inside what OpenReceive renders. You need no transpilePackages entry, because the packages ship plain ESM.

Serve the compiled styles.css without Tailwind processing: import it from JavaScript (with a CSS-capable bundler) or use a plain <link rel="stylesheet">. Do not @import it into the host Tailwind entry. Its zero-specificity rules allow host styles to override checkout styles; scoping does not prevent that.

<Checkout> 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).

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 <Checkout theme="dark" … />. 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 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).

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.

Buy a Button is a runnable illustration of this boundary (examples/buttons/server/nextjs-fullstack). It is not a template to copy models from. It has products, visitors, and orders, and the three hooks are the only bridge to OpenReceive. Its shop routes are three-line App Router wrappers, and /checkout/[reference] is the resumable page. Map that shape onto the models in THIS app.

6. Verify

npx openreceive doctor

openreceive doctor checks Node, NWC_URI, and the swap-provider configuration. It also probes the wallet relay to confirm the code is receive-only. Add --db <file-or-url> to confirm the migration ran. Add --url http://localhost:3000 to confirm the routes are mounted. Every failing line states its own fix. → openreceive doctor

Then open the checkout in a browser. Confirm the payment-method icons and wallet logos render. Open a wallet’s pay tutorial to check its screenshots. If an image is missing, look in the console for CSP violations and in the Network panel for failed JavaScript chunks. To fix it, allow data: in img-src and deploy the complete build output. Do not add image routes or copy package source images. Do not use registry icon_path or tutorial path keys as browser URLs.

Next

More on wiring, storage, and routes: Authorization, Payment storage, API reference.