webUPI.sendPaymentToLightning()

Request that the user sends a UPI payment that will be converted into a Lightning Network payment. The web app provides a BOLT-11 invoice and a callback URL. The function will return an acknowledgment if the payment initiation is successful.

Method

async function sendPaymentToLightning(args: SendPaymentToLightningArgs): SendPaymentToLightningResponse;

Parameters

interface SendPaymentToLightningArgs {
  invoice: string; // The BOLT-11 invoice for the Lightning Network payment
  callbackUrl: string; // The URL that the UPI app or cryptocurrency exchange will notify upon completion of the payment
}

Response

interface SendPaymentToLightningResponse {
  acknowledgment: string; // A message acknowledging the initiation of the payment
}

Code Example

try {
    const paymentArgs = {
        invoice: 'lnbc100...', // BOLT-11 invoice provided by the merchant
        callbackUrl: '<http://example.com/callback>' // URL to send a notification to when the payment has been processed
    };
    const response = await webUPI.sendPaymentToLightning(paymentArgs);
    console.log(response.acknowledgment);
} catch (error) {
    // Payment failed
    console.log(error);
}

Please note that the actual implementation would depend on the specific UPI app, the cryptocurrency exchange, and the payment gateway used. Also, this function's successful execution does not mean the payment has been completed, only that it has been initiated. The web app should listen for a notification at the provided callback URL to confirm when the payment has been processed.