Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/nicosaporiti/buda-lightning-invoice/llms.txt

Use this file to discover all available pages before exploring further.

Buda Lightning Invoice is a server-side API that bridges the Buda.com exchange with the Bitcoin Lightning Network. It lets any frontend or application create BOLT11 invoices and verify payment confirmations without ever touching Buda credentials directly — all authentication happens securely on the server.

Quickstart

Run the service locally and make your first invoice in minutes

API Reference

Full endpoint documentation with request/response schemas

Configuration

Environment variables and server configuration options

Deploy to Fly.io

One-command deployment using the included fly.toml

How It Works

The service acts as a secure wrapper: your Buda.com API credentials live exclusively in server-side environment variables. Clients call simple unauthenticated HTTP endpoints to create invoices and poll for payment status.
1

Configure credentials

Add your BUDA_API_KEY and BUDA_API_SECRET to a .env file. These never leave the server.
2

Start the server

Run npm run dev to start on localhost:3001 (or the port you configure).
3

Create an invoice

POST /newinvoice with an amount in satoshis and a description. Get back a BOLT11 payment request.
4

Verify payment

POST /status with the invoice string. The API checks Buda’s confirmed deposits and returns a boolean.

Key Features

BOLT11 Invoice Creation

Generate Lightning invoices directly from Buda.com via POST /newinvoice with satoshi amounts and custom memos.

Payment Verification

Confirm payments by checking Buda deposit history. Returns true only for confirmed deposits.

Lightning Address

Full LNURL-pay protocol support (LUD-06, LUD-09) — use your domain as an email-style Lightning Address.

Zero Client Auth

All Buda API calls are HMAC-SHA384 signed server-side. No credentials are exposed to API consumers.

Build docs developers (and LLMs) love