LNURL-Pay
Usage
Rust
// Endpoint can also be of the form:
// lnurlp://domain.com/lnurl-pay?key=val
// lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4excttsv9un7um9wdekjmmw84jxywf5x43rvv35xgmr2enrxanr2cfcvsmnwe3jxcukvde48qukgdec89snwde3vfjxvepjxpjnjvtpxd3kvdnxx5crxwpjvyunsephsz36jf
let lnurl_pay_url = "lightning@address.com";
if let Ok(InputType::LnUrlPay { data: pd }) = parse(lnurl_pay_url).await {
let amount_msat = pd.min_sendable;
let optional_comment = Some("<comment>".to_string());
let optional_payment_label = Some("<label>".to_string());
let optional_validate_success_action_url = Some(true);
sdk.lnurl_pay(LnUrlPayRequest {
data: pd,
amount_msat,
comment: optional_comment,
payment_label: optional_payment_label,
validate_success_action_url: optional_validate_success_action_url,
})
.await?;
}
Swift
// Endpoint can also be of the form:
// lnurlp://domain.com/lnurl-pay?key=val
// lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4excttsv9un7um9wdekjmmw84jxywf5x43rvv35xgmr2enrxanr2cfcvsmnwe3jxcukvde48qukgdec89snwde3vfjxvepjxpjnjvtpxd3kvdnxx5crxwpjvyunsephsz36jf
var response: LnUrlPayResult?
let lnurlPayUrl = "lightning@address.com"
if let inputType = try? parse(input: lnurlPayUrl) {
if case.lnUrlPay(let `data`) = inputType {
let amountMsat = data.minSendable
let optionalComment = "<comment>"
let optionalPaymentLabel = "<label>"
let optionalValidateSuccessActionUrl = true
let req = LnUrlPayRequest(
data: data,
amountMsat: amountMsat,
comment: optionalComment,
paymentLabel: optionalPaymentLabel,
validateSuccessActionUrl: optionalValidateSuccessActionUrl
)
response = try? sdk.lnurlPay(req: req)
}
}
Kotlin
// Endpoint can also be of the form:
// lnurlp://domain.com/lnurl-pay?key=val
// lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4excttsv9un7um9wdekjmmw84jxywf5x43rvv35xgmr2enrxanr2cfcvsmnwe3jxcukvde48qukgdec89snwde3vfjxvepjxpjnjvtpxd3kvdnxx5crxwpjvyunsephsz36jf
val lnurlPayUrl = "lightning@address.com";
try {
val inputType = parse(lnurlPayUrl)
if (inputType is InputType.LnUrlPay) {
val requestData = inputType.data
val amountMsat = requestData.minSendable
val optionalComment = "<comment>";
val optionalPaymentLabel = "<label>";
val optionalValidateSuccessActionUrl = true;
val req = LnUrlPayRequest(
requestData,
amountMsat,
optionalComment,
optionalPaymentLabel,
optionalValidateSuccessActionUrl)
sdk.lnurlPay(req)
}
} catch (e: Exception) {
// handle error
}
React Native
// Endpoint can also be of the
// lnurlp://domain.com/lnurl-pay?key=val
// lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4excttsv9un7um9wdekjmmw84jxywf5x43rvv35xgmr2enrxanr2cfcvsmnwe3jxcukvde48qukgdec89snwde3vfjxvepjxpjnjvtpxd3kvdnxx5crxwpjvyunsephsz36jf
const lnurlPayUrl = 'lightning@address.com'
const input = await parse(lnurlPayUrl)
if (input.type === InputTypeVariant.LN_URL_PAY) {
const amountMsat = input.data.minSendable
const optionalComment = '<comment>'
const optionalPaymentLabel = '<label>'
const optionalValidateSuccessActionUrl = true
const lnUrlPayResult = await lnurlPay({
data: input.data,
amountMsat,
comment: optionalComment,
paymentLabel: optionalPaymentLabel,
validateSuccessActionUrl: optionalValidateSuccessActionUrl
})
}
Dart
/// Endpoint can also be of the form:
/// lnurlp://domain.com/lnurl-pay?key=val
/// lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4excttsv9un7um9wdekjmmw84jxywf5x43rvv35xgmr2enrxanr2cfcvsmnwe3jxcukvde48qukgdec89snwde3vfjxvepjxpjnjvtpxd3kvdnxx5crxwpjvyunsephsz36jf
String lnurlPayUrl = "lightning@address.com";
InputType inputType = await parse(input: lnurlPayUrl);
if (inputType is InputType_LnUrlPay) {
BigInt amountMsat = inputType.data.minSendable;
String optionalComment = "<comment>";
String optionalPaymentLabel = "<label>";
bool optionalValidateSuccessActionUrl = true;
LnUrlPayRequest req = LnUrlPayRequest(
data: inputType.data,
amountMsat: amountMsat,
comment: optionalComment,
paymentLabel: optionalPaymentLabel,
validateSuccessActionUrl: optionalValidateSuccessActionUrl,
);
LnUrlPayResult result = await breezSDKLiquid.instance!.lnurlPay(req: req);
print(result.data);
}
Python
# Endpoint can also be of the form:
# lnurlp://domain.com/lnurl-pay?key=val
# lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4excttsv9un7um9wdekjmmw84jxywf5x43rvv35xgmr2enrxanr2cfcvsmnwe3jxcukvde48qukgdec89snwde3vfjxvepjxpjnjvtpxd3kvdnxx5crxwpjvyunsephsz36jf
lnurl_pay_url = "lightning@address.com"
try:
parsed_input = breez_sdk_liquid.parse(lnurl_pay_url)
if isinstance(parsed_input, InputType.LN_URL_PAY):
amount_msat = parsed_input.data.min_sendable
optional_comment = "<comment>"
optional_payment_label = "<label>"
req = LnUrlPayRequest(parsed_input.data, amount_msat, optional_comment, optional_payment_label)
result = sdk.lnurl_pay(req)
return result
except Exception as error:
logging.error(error)
raise
Go
// Endpoint can also be of the form:
// lnurlp://domain.com/lnurl-pay?key=val
// lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4excttsv9un7um9wdekjmmw84jxywf5x43rvv35xgmr2enrxanr2cfcvsmnwe3jxcukvde48qukgdec89snwde3vfjxvepjxpjnjvtpxd3kvdnxx5crxwpjvyunsephsz36jf
lnurlPayUrl := "lightning@address.com"
if input, err := breez_sdk_liquid.Parse(lnurlPayUrl); err != nil {
switch inputType := input.(type) {
case breez_sdk_liquid.InputTypeLnUrlPay:
amountMsat := inputType.Data.MinSendable
optionalComment := "<comment>"
optionalPaymentLabel := "<label>"
lnUrlPayRequest := breez_sdk_liquid.LnUrlPayRequest{
Data: inputType.Data,
AmountMsat: amountMsat,
Comment: &optionalComment,
PaymentLabel: &optionalPaymentLabel,
}
if result, err := sdk.LnurlPay(lnUrlPayRequest); err != nil {
switch result.(type) {
case breez_sdk_liquid.LnUrlPayResultEndpointSuccess:
log.Printf("Successfully paid")
default:
log.Printf("Failed to pay")
}
}
}
}
C#
// Endpoint can also be of the form:
// lnurlp://domain.com/lnurl-pay?key=val
// lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4excttsv9un7um9wdekjmmw84jxywf5x43rvv35xgmr2enrxanr2cfcvsmnwe3jxcukvde48qukgdec89snwde3vfjxvepjxpjnjvtpxd3kvdnxx5crxwpjvyunsephsz36jf
var lnurlPayUrl = "lightning@address.com";
try
{
var input = BreezSdkLiquidMethods.Parse(lnurlPayUrl);
if (input is InputType.LnUrlPay lnurlp)
{
var amountMsat = lnurlp.data.minSendable;
var optionalComment = "<comment>";
var optionalPaymentLabel = "<label>";
var optionalValidateSuccessActionUrl = true;
var req = new LnUrlPayRequest(
lnurlp.data,
amountMsat,
optionalComment,
optionalPaymentLabel,
optionalValidateSuccessActionUrl);
var result = sdk.LnurlPay(req);
}
}
catch (Exception)
{
// Handle error
}
Developer note
By default when the LNURL-pay results in a success action with a URL, the URL is validated to check if there is a mismatch with the LNURL callback domain. You can disable this behaviour by setting the optional validationLnUrlPayRequest
param to false.