Skip to main content
Creates a Lightning invoice for receiving payments via the SparkWallet.

Method Signature

interface CreateLightningInvoiceParams {
  amountSats: number;
  description?: string;
  expirySeconds?: number;
}

async createLightningInvoice(params: CreateLightningInvoiceParams): Promise<LightningReceiveRequest>;

Parameters

amountSats
number
required
Amount in satoshis to receive
description
string
Description of the payment
expirySeconds
number
Invoice expiry time in seconds

Returns

request
LightningReceiveRequest
required
Lightning receive request details

Example

const invoice = await wallet.createLightningInvoice({
  amountSats: 1000,
  description: "Payment for services",
  expirySeconds: 3600 // 1 hour
});

console.log("Lightning invoice:", invoice.invoice);
console.log("Payment hash:", invoice.paymentHash);