Developer documentation

Choose the track that matches what you are building.

Integrate through the API

Use the Greenfield REST API to connect a commerce application, automate a BTCPay Server instance, or build a client library.

• Get started and plan an integration
• Authenticate and request permissions
• Use cURL, Node.js, or PHP
• Implement or change API endpoints

The interactive API reference is available at /docs on every BTCPay Server instance and at docs.btcpayserver.org (opens new window).

Build a plugin

Plugins are in-process .NET extensions. They can add services, controllers, UI, hooks, permissions, data, and API endpoints.

• Get started
• Architecture and lifecycle
• UI extension points and hooks
• Global search
• Authentication and permissions
• Data and migrations
• API and Swagger
• Testing and compatibility
• Build and publish

BTCPay Server owns the plugin framework contracts and local packaging tool documented here. The plugin template (opens new window) owns scaffolding and development setup, while Plugin Builder (opens new window) owns hosted builds, releases, and listing policy.