Probe

The LNURL-pay ingestion endpoint enables you to "probe" an lnurlpay paylink / lightning address to see its parameters. You can then use this information to determine if you will pay this link.

Probe the lnurlpay link / lightning address to get its parameters

GET https://<yourdomain>/v1/lnurlp/probe/:lnurlpay_encoded | :ln_address

Path Parameters

Name	Type	Description
lnurlpay_encoded	String	e.g. LNURL1DP68GUP69UHKCMNSV9UJUMR0VDSKCW3CXYCNZT....
ln_address	String	e.g. [e-mail]

200: OK lnurlpay retrieved details

{
    "minSendable": 1000, //msat
    "maxSendable": 10000000, //msat
    "commentAllowed": 0, //number of characters allowed in a comment when payment is sent
    "tag": "payRequest",
    "metadata": [
        [
            "text/plain",
            "LNURL PAY (via LNPay.co)"
        ]
    ],
    "callback": "http://some-service.com/v1/wallet/waklp_jW7vCpByJu1jKuFXT3UiRzB6/lnurlp/lnurlp_s9kmV724XtZvfxciXF"
}

500: Internal Server Error why the lnurl is invalid

{
    "name": "Exception",
    "message": "Invalid bech32 checksum",
    "code": 0,
    "type": "lnpay\\wallet\\exceptions\\InvalidLnurlpayLinkException",
}