> For the complete documentation index, see [llms.txt](https://ninjapay.gitbook.io/webupi-protocol/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ninjapay.gitbook.io/webupi-protocol/webupi-x-web3-bridge/get-started/webupi.requestlightninginvoice.md).

# webUPI.requestLightningInvoice()

Request a Lightning Network invoice from the UPI provider. The web app provides the payment amount either in satoshis or in INR, and the function returns a BOLT-11 invoice. The function could also optionally provide a price quote in INR.

#### Method

```jsx

async function requestLightningInvoice(args: RequestLightningInvoiceArgs): RequestLightningInvoiceResponse;

```

#### Parameters

```jsx

interface RequestLightningInvoiceArgs {
  amountSats?: number; // Optional: The amount to be paid in satoshis
  amountInr?: number; // Optional: The amount to be paid in INR
  requestQuote?: boolean; // Optional: Whether to request a price quote in INR
}

```

#### Response

```jsx

interface RequestLightningInvoiceResponse {
  invoice: string; // The BOLT-11 invoice for the Lightning Network payment
  quote?: number; // Optional: The price quote in INR, if requested
}

```

#### Code Example

```jsx

try {
    const requestArgs = {
        amountSats: 100000, // Amount in satoshis to be paid
        // Alternatively, specify amount in INR:
        // amountInr: 1000,
        requestQuote: true // Request a price quote in INR
    };
    const response = await webUPI.requestLightningInvoice(requestArgs);
    console.log(response.invoice); // BOLT-11 invoice
    if (response.quote) {
        console.log(response.quote); // Price quote in INR, if requested
    }
} catch (error) {
    // Request failed
    console.log(error);
}

```

In this version of the function, the amount to be paid can be specified either in satoshis or in INR, but not both. The UPI provider will then generate a Lightning Network invoice for that amount. The specifics of the implementation would again depend on the particular UPI app and the exchange rate used.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://ninjapay.gitbook.io/webupi-protocol/webupi-x-web3-bridge/get-started/webupi.requestlightninginvoice.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.