Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.spark.money/llms.txt

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

Gets the status of a Lightning receive request (invoice) for the SparkWallet.

​
Method Signature

async getLightningReceiveRequest(id: string): Promise<LightningReceiveRequest | null>

​
Parameters

​
id
string
required
The ID of the invoice to check

​
Returns

​
request
LightningReceiveRequest | null
required
The Lightning receive request details or null if not found

​
Example

const receiveRequest = await wallet.getLightningReceiveRequest("request-id");
if (receiveRequest) {
  console.log("Invoice status:", receiveRequest.status);
}