# OpenReceive

> Open-source libraries for accepting inbound Bitcoin Lightning payments
> directly into a wallet the application owner controls, plus a BTCPay Server
> plugin that does the same for a BTCPay store. OpenReceive never holds funds,
> has no accounts or API keys, and connects through a receive-only Nostr
> Wallet Connect (NWC) code. This index describes OpenReceive 0.4.19.

Every documentation link below is raw markdown — fetch it directly, no browser
needed. Appending `.md` to any guide page URL returns the same document as
markdown.

## Start here

- [Express Quickstart (Node)](https://openreceive.org/guides/quickstart-node.md)
- [Fastify Quickstart](https://openreceive.org/guides/quickstart-fastify.md)
- [FastAPI Quickstart](https://openreceive.org/guides/quickstart-fastapi.md)
- [Django Quickstart](https://openreceive.org/guides/quickstart-django.md)
- [Next.js Quickstart](https://openreceive.org/guides/quickstart-next.md)
- [Rails Quickstart](https://openreceive.org/guides/quickstart-rails.md)
- [PHP Quickstart (plain PHP)](https://openreceive.org/guides/quickstart-php.md)
- [Laravel Quickstart](https://openreceive.org/guides/quickstart-laravel.md)
- [BTCPay Server Quickstart](https://openreceive.org/guides/quickstart-btcpay.md)
- [WordPress + WooCommerce Quickstart](https://openreceive.org/guides/quickstart-woocommerce.md)
- [Agent Directions: Node.js](https://openreceive.org/agent-directions/node/full.md): self-contained agent directions, quickstart included
- [Agent Directions: Fastify](https://openreceive.org/agent-directions/fastify/full.md): self-contained agent directions, quickstart included
- [Agent Directions: Next.js](https://openreceive.org/agent-directions/next/full.md): self-contained agent directions, quickstart included
- [Agent Directions: FastAPI](https://openreceive.org/agent-directions/fastapi/full.md): self-contained agent directions, quickstart included
- [Agent Directions: Django](https://openreceive.org/agent-directions/django/full.md): self-contained agent directions, quickstart included
- [Agent Directions: Rails](https://openreceive.org/agent-directions/rails/full.md): self-contained agent directions, quickstart included
- [Agent Directions: PHP](https://openreceive.org/agent-directions/php/full.md): self-contained agent directions, quickstart included
- [Agent Directions: Laravel](https://openreceive.org/agent-directions/laravel/full.md): self-contained agent directions, quickstart included
- [Agent Directions: BTCPay Server](https://openreceive.org/agent-directions/btcpay/full.md): self-contained agent directions, quickstart included
- [Agent directions (WordPress + WooCommerce)](https://openreceive.org/agent-directions/woocommerce/full.md): self-contained agent directions, quickstart included

## Guides

The index is [/guides.md](https://openreceive.org/guides.md).

- [Bitcoin Checkout in v0](https://openreceive.org/guides/v0.md)
- [BTCPay Plugin Reference](https://openreceive.org/guides/btcpay-reference.md)
- [Node ORM Recipes](https://openreceive.org/guides/node-orms.md)
- [Authorization](https://openreceive.org/guides/authorization.md)
- [Rate Limiting](https://openreceive.org/guides/rate-limiting.md)
- [Frontend Checkout](https://openreceive.org/guides/frontend-checkout.md)
- [Checkout UX](https://openreceive.org/guides/checkout-ux.md)
- [Headless Checkout](https://openreceive.org/guides/headless-checkout.md)
- [Automated Swaps](https://openreceive.org/guides/automated-swaps.md)
- [Swap Refunds](https://openreceive.org/guides/swap-refunds.md)
- [Lightning Swap Connect URI](https://openreceive.org/guides/lightning-swap-connect.md)
- [Environment Variables](https://openreceive.org/guides/environment-variables.md)
- [Payment Storage](https://openreceive.org/guides/storage.md)
- [Payment Safety Upgrade and Repair](https://openreceive.org/guides/payment-safety-upgrade.md)
- [Deploying OpenReceive](https://openreceive.org/guides/deploying.md)
- [Testing Your OpenReceive Integration](https://openreceive.org/guides/host-testing.md)
- [API Reference](https://openreceive.org/guides/api-reference.md)
- [Security](https://openreceive.org/guides/security.md)
- [Provider Registry](https://openreceive.org/guides/provider-registry.md)
- [Price Feeds](https://openreceive.org/guides/price-feeds.md)
- [React Material UI Recipe](https://openreceive.org/guides/react-material-ui-recipe.md)
- [Flask Recipe](https://openreceive.org/guides/flask-recipe.md)
- [Writing Your Own Checkout Route](https://openreceive.org/guides/custom-checkout-route.md)
- [WordPress Hosting Requirements](https://openreceive.org/guides/wordpress-hosting.md)

## Machine-readable specifications

- [OpenReceive HTTP OpenAPI](https://openreceive.org/openapi.yaml): the normative contract for every mounted route

## Agent resources

- [Using OpenReceive with coding agents](https://openreceive.org/agents.md): skills, install commands, and which artifact answers which question
- [Agent skills](https://github.com/OpenReceive/openreceive/tree/master/skills): integrate-openreceive and debug-openreceive-payment — `npx skills add OpenReceive/openreceive`, or Claude Code `/plugin marketplace add OpenReceive/openreceive`
- [Contributor rules](https://github.com/OpenReceive/openreceive/blob/master/AGENTS.md): the invariants for changes to OpenReceive itself
- [GitHub repository](https://github.com/OpenReceive/openreceive)
