getLightningReceiveRequest

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

Method Signature

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

Parameters

string

required

The ID of the invoice to check

Returns

LightningReceiveRequest | null

required

The Lightning receive request details, or null if not found or not accessible. Only the requester or receiver can query it; a wallet-history viewer grant does not grant access to the receive request. transfer may be absent while the request is still progressing.

Save the full request ID returned by createLightningInvoice(). Use request.transfer?.sparkId to join to Spark transfer history, and request.invoice.paymentHash for the Lightning payment. See payment correlation and units.

Example

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

Introduction

Wallets

Wallet Viewer

Utilities

Issuance

getLightningReceiveRequest

Method Signature

Parameters

Returns

Example

​Method Signature

​Parameters

​Returns

​Example

Method Signature

Parameters

Returns

Example