Alby Developer Guide
Alby Wallet API
Ask or search…
K
Links
Comment on page

Invoices

Generate invoices and read incoming transactions.

Create an invoice

Scope needed: invoices:create
Creates a new invoice to receive lightning payments.
post
https://api.getalby.com/invoices

Get incoming invoice history

Scope needed: invoices:read
Lists all settled incoming invoices, including boostagram and LNURL metadata.
get
https://api.getalby.com/invoices/incoming

Get outgoing invoice history

Scope needed: transactions:read
Lists all settled outgoing invoices, including boostagrams information.
get
https://api.getalby.com/invoices/outgoing

Get all invoice history

Scope needed: invoices:read
Combination of incoming and outgoing invoice histories. Possible query parameters are the same as above.
get
https://api.getalby.com/invoices

Get a specific invoice

Scope needed: invoices:read
Get details about specific invoice. Can be both incoming or outgoing.
Unsettled invoices can only be retrieved if they were created through the Alby API or Nostr Wallet Connect (using https://nwc.getalby.com/). Unsettled Invoices created directly using the Lndhub API will return a 404.
get
https://api.getalby.com/invoices
/{payment_hash}

Decode an invoice

Decode an invoice. Will also add the alias of the receiving node & route hints (LSP's).
get
https://api.getalby.com/decode/bolt11/{bolt11_invoice}
Decode an invoice
Last modified 21d ago